o 'f1l@sdZddlmZddlmZmZmZddlmZm Z ddl m Z ddl m Z mZddlmZddlmZmZmZmZmZdd lmZmZmZmZmZmZmZdd lm Z m!Z!erddd l"m#Z#dd lm$Z$Gd ddeZ%GdddeZ&GdddeZ'GdddeZ(GdddeZ)GdddeZ*GdddeZ+GdddeZ,GdddeZ-Gdd d eZ.Gd!d"d"eZ/Gd#d$d$eZ0Gd%d&d&eZ1d'S)(z"Custom element classes for tables.) annotations) TYPE_CHECKINGCallableList)WD_CELL_VERTICAL_ALIGNMENTWD_ROW_HEIGHT_RULE)InvalidSpanError)nsdeclsqn) parse_xml)ST_MergeST_TblLayoutType ST_TblWidthST_TwipsMeasureXsdInt)BaseOxmlElement OneAndOnlyOne OneOrMoreOptionalAttributeRequiredAttribute ZeroOrMore ZeroOrOne)EmuTwips)CT_P)Lengthc@s$eZdZdZedeZedeZdS) CT_HeightzFUsed for ```` to specify a row height and row height rule.w:valzw:hRuleN) __name__ __module__ __qualname____doc__rrvalrhRuler$r$G/home/ubuntu/flask/venv/lib/python3.10/site-packages/docx/oxml/table.pyr"s rc@seZdZdZedZedZedZddZ e ddZ e d d Z e j d d Z e d d Zej dd ZddZddZddZdS)CT_Rowz```` element.z w:tblPrExzw:trPrzw:tccCsFd}|jD]}||kr|S||j7}||krtd|qtd)zThe ```` element appearing at grid column `idx`. Raises |ValueError| if no ``w:tc`` element begins at that grid column. rzno cell on grid column %dzindex out of bounds)tc_lst grid_span ValueError)selfidxgrid_coltcr$r$r%tc_at_grid_col0s   zCT_Row.tc_at_grid_colcC|j|S)zSThe index of this ```` element within its parent ```` element.) getparenttr_lstindexr*r$r$r%tr_idx>z CT_Row.tr_idxcC|j}|dur dS|jS)zJReturn the value of `w:trPr/w:trHeight@w:hRule`, or |None| if not present.N)trPrtrHeight_hRuler*r7r$r$r%r8DzCT_Row.trHeight_hRulecC|}||_dSN)get_or_add_trPrr8r*valuer7r$r$r%r8L cCr6)zHReturn the value of `w:trPr/w:trHeight@w:val`, or |None| if not present.N)r7 trHeight_valr9r$r$r%rAQr:zCT_Row.trHeight_valcCr;r<)r=rAr>r$r$r%rAYr@cCs|d|dSNrinsert)r*tblPrExr$r$r%_insert_tblPrEx^szCT_Row._insert_tblPrExcCs,|j}|dur||dS|d|dSrB)rEaddnextrD)r*r7rEr$r$r% _insert_trPraszCT_Row._insert_trPrcCtSr<)CT_Tcnewr3r$r$r%_new_tchzCT_Row._new_tcN)rrr r!rrEr7rr-r.propertyr4r8setterrArFrHrLr$r$r$r%r&)s&      r&c@seZdZdZedZedZedZe ddZ e j ddZ e dd Z d d Z ed!ddZe ddZej ddZed"ddZeddZeddZeddZd S)#CT_Tblz```` element.zw:tblPrz w:tblGridzw:trcC|jj}|dur dS|jS)zValue of `w:tblPr/w:bidiVisual/@w:val` or |None| if not present. Controls whether table cells are displayed right-to-left or left-to-right. N)tblPr bidiVisualr")r*rSr$r$r%bidiVisual_valsszCT_Tbl.bidiVisual_valcCs(|j}|dur |dS||_dSr<)rR_remove_bidiVisualget_or_add_bidiVisualr")r*r?rRr$r$r%rT~s cCs t|jjS)z)The number of grid columns in this table.)lentblGrid gridCol_lstr3r$r$r% col_counts zCT_Tbl.col_countccs$|jD] }|jD]}|Vq qdS)zGenerate each of the `w:tc` elements in this table, left to right and top to bottom. Each cell in the first row is generated, followed by each cell in the second row, etc. N)r1r')r*trr-r$r$r%iter_tcss   zCT_Tbl.iter_tcsrowsintcolswidthrreturncCst||||S)zReturn a new `w:tbl` element having `rows` rows and `cols` columns. `width` is distributed evenly between the columns. )r _tbl_xml)clsr]r_r`r$r$r%new_tblszCT_Tbl.new_tblcCrQ)zYValue of `w:tblPr/w:tblStyle/@w:val` (a table style id) or |None| if not present.N)rRtblStyler"r*rer$r$r% tblStyle_valszCT_Tbl.tblStyle_valcCs(|j}||dur dS||_dS)zSet the value of `w:tblPr/w:tblStyle/@w:val` (a table style id) to `styleId`. If `styleId` is None, remove the `w:tblStyle` element. N)rR_remove_tblStyle _add_tblStyler")r*styleIdrRr$r$r%rgs strcCs@|dkr t||ntd}dtd|||||||fS)Nrz %s%s w)rr _tblGrid_xml_trs_xml)rcr]r_r` col_widthr$r$r%rbs  zCT_Tbl._tbl_xmlcCs,d}t|D] }|d|j7}q|d7}|S)Nz z z rangetwipsrcrZroxmlir$r$r%rms  zCT_Tbl._tblGrid_xmlcCs*d}t|D] }|d|||7}q|S)Nz %s )rq_tcs_xml)rc row_countrZrortrur$r$r%rns   zCT_Tbl._trs_xmlcCs$d}t|D] }|d|j7}q|S)Nrvzj rprsr$r$r%rws zCT_Tbl._tcs_xmlN)r]r^r_r^r`rrarP)r]r^r_r^r`rrark)rrr r!rrRrXrr[rNrTrOrZr\ classmethodrdrgrbrmrnrwr$r$r$r%rPls4         rPc@seZdZdZedddZdS) CT_TblGridzw```` element, child of ````, holds ```` elements that define column count, width, etc.z w:gridCol)zw:tblGridChange successorsN)rrr r!rgridColr$r$r$r%rzsrzc@s&eZdZdZedeZeddZdS) CT_TblGridColzJ```` element, child of ````, defines a table column.w:wcCr/)z\The index of this ```` element within its parent ```` element.)r0rYr2r3r$r$r% gridCol_idxr5zCT_TblGridCol.gridCol_idxN) rrr r!rrrlrNrr$r$r$r%r~s  r~c@eZdZdZedeZdS)CT_TblLayoutTypez|```` element, specifying whether column widths are fixed or can be automatically adjusted based on content.w:typeN)rrr r!rr typer$r$r$r%rsrc@seZdZdZdZededddZededddZed ed ddZed ed ddZ [e d dZ e j ddZ e dddZ e j dddZ e ddZej ddZdS)CT_TblPrz}```` element, child of ````, holds child elements that define table properties such as style and borders.) w:tblStylezw:tblpPrz w:tblOverlap w:bidiVisualzw:tblStyleRowBandSizezw:tblStyleColBandSizezw:tblWw:jcw:tblCellSpacingzw:tblIndz w:tblBordersw:shd w:tblLayoutz w:tblCellMarz w:tblLookz w:tblCaptionzw:tblDescriptionz w:tblPrChangerNr{rrr cCr6)zMember of :ref:`WdRowAlignment` enumeration or |None|, based on the contents of the `w:val` attribute of `./w:jc`. |None| if no `w:jc` element is present. N)jcr")r*rr$r$r% alignmentzCT_TblPr.alignmentcCs&||dur dS|}||_dSr<) _remove_jc get_or_add_jcr")r*r?rr$r$r%r+s  raboolcCs|j}|dur dS|jdkS)zg|False| when there is a `w:tblLayout` child with `@w:type="fixed"`. Otherwise |True|. NTfixed) tblLayoutr)r*rr$r$r%autofit3szCT_TblPr.autofitr?cCs |}|r d|_dSd|_dS)Nrr)get_or_add_tblLayoutr)r*r?rr$r$r%r<scCr6)ziReturn the value of the ``val`` attribute of the ```` child or |None| if not present.N)rer"rfr$r$r%styleAzCT_TblPr.stylecCs$||dur dS|j|ddS)N)r")rhrir*r?r$r$r%rJs)rar)r?r)rrr r!_tag_seqrrerSrrrNrrOrrr$r$r$r%rs(     rc@s>eZdZdZedeZedeZe ddZ e j ddZ dS) CT_TblWidthzeUsed for ```` and ```` elements and many others, to specify a table-related width.rrcCs|jdkrdSt|jS)zbReturn the EMU length value represented by the combined ``w:w`` and ``w:type`` attributes.dxaN)rrrlr3r$r$r%r`\s  zCT_TblWidth.widthcCsd|_t|j|_dS)Nr)rrrrrlrr$r$r%r`dsN) rrr r!rrrlrrrNr`rOr$r$r$r%rRs   rc@seZdZUdZded<ded<ded<ded <ed Zed Zed Z e d dZ ddZ e ddZ e jddZ e dSddZddZe ddZddZeddZe d d!Ze d"d#Ze d$d%Zejd&d%Ze d'd(Zejd)d(Zd*d+Ze d,d-ZdTd/d0Zd1d2Ze d3d4Zd5d6Zd7d8Ze d9d:Z d;d<Z!d=d>Z"d?d@Z#dAdBZ$dCdDZ%e dEdFZ&e dGdHZ'e dIdJZ(e dKdLZ)e dMdNZ*e dOdPZ+e dQdRZ,d.S)UrJz`w:tc` table cell element.zCallable[[], CT_P]add_pz List[CT_P]p_lstz List[CT_Tbl]tbl_lstzCallable[[CT_Tbl], CT_Tbl] _insert_tblzw:tcPrw:pw:tblcCs4|jdur|j}|dur|jtjkr|jS|jdS)zThe row index that marks the bottom extent of the vertical span of this cell. This is one greater than the index of the bottom-most row of the span, similar to how a slice of the cell's rows would be specified. Nr)vMerge _tc_belowr CONTINUEbottom_tr_idx)r*tc_belowr$r$r%rws  z CT_Tc.bottomcCs,g}|j}|dur||||dd<dS)aMRemove all content child elements, preserving the ```` element if present. Note that this leaves the ```` element in an invalid state because it doesn't contain at least one block-level element. It's up to the caller to add a ````child element as the last content element. N)tcPrappend)r* new_childrenrr$r$r% clear_contents  zCT_Tc.clear_contentcC|j}|dur dS|jS)zzThe integer number of columns this cell spans. Determined by ./w:tcPr/w:gridSpan/@val, it defaults to 1. Nr)rr(r*rr$r$r%r(zCT_Tc.grid_spancCr;r<)get_or_add_tcPrr(r*r?rr$r$r%r(r@raList[CT_P | CT_Tbl]cCs |dS)zGenerate all `w:p` and `w:tbl` elements in this document-body. Elements appear in document order. Elements shaded by nesting in a `w:ins` or other "wrapper" element will not be included. z./w:p | ./w:tblxpathr3r$r$r%inner_content_elementss zCT_Tc.inner_content_elementsccs6tdtdtdf}|D] }|j|vr|VqdS)zpGenerate a reference to each of the block-level content elements in this cell, in the order they appear.rrzw:sdtN)r tag)r*block_item_tagschildr$r$r%iter_block_itemss zCT_Tc.iter_block_itemscCs|jS)z?The grid column index at which this ```` element appears.) _grid_colr3r$r$r%leftsz CT_Tc.leftcCs4||\}}}}|jj||}||||S)zReturn the top-left ```` element of a new span formed by merging the rectangular region defined by using this tc element and `other_tc` as diagonal corners.)_span_dimensions_tblr1r._grow_to)r*other_tctoprheightr`top_tcr$r$r%merges z CT_Tc.mergecCstdtdS)zhReturn a new ```` element, containing an empty paragraph as the required EG_BlockLevelElt.z rl)r r )rcr$r$r%rKr5z CT_Tc.newcCs |j|jS)aThe grid column index that marks the right-side extent of the horizontal span of this cell. This is one greater than the index of the right-most column of the span, similar to how a slice of the cell's columns would be specified. )rr(r3r$r$r%rights z CT_Tc.rightcCs$|jdus |jtjkr|jS|jjS)z9The top-most row index in the vertical span of this cell.N)rr RESTARTr _tc_aboverr3r$r$r%rsz CT_Tc.topcCr6)zlThe value of the ./w:tcPr/w:vMerge/@val attribute, or |None| if the w:vMerge element is not present.N)r vMerge_valrr$r$r%rrz CT_Tc.vMergecCr;r<)rrrr$r$r%rr@cCr6)zqReturn the EMU length value represented in the ``./w:tcPr/w:tcW`` child element or |None| if not present.N)rr`rr$r$r%r`rz CT_Tc.widthcCr;r<)rr`rr$r$r%r`r@cCs(|jr|jr|j|j7_dSdSdS)zAdd the width of `other_tc` to this cell. Does nothing if either this tc or `other_tc` does not have a specified width. N)r`)r*rr$r$r% _add_width_ofs zCT_Tc._add_width_ofcCs2|j}|j|}|jd|}tdd|DS)z*The grid column at which this cell begins.Ncss|]}|jVqdSr<)r().0r-r$r$r% sz"CT_Tc._grid_col..)_trr'r2sum)r*r[r+ preceding_tcsr$r$r%rs zCT_Tc._grid_colNcsTfdd}|dur n|}||||dkr(j|d|dSdS)zGrow this cell to `width` grid columns and `height` rows by expanding horizontal spans and creating continuation cells to form vertical spans.cs |urtjSdkr dStjSNr)r rr)rrr*r$r%rs z"CT_Tc._grow_to..vMerge_valNr)_span_to_widthrr)r*r`rrrr$rr%rs zCT_Tc._grow_tocCs|d||S)z``tcPr`` has a bunch of successors, but it comes first if it appears, so just overriding and using insert(0, ...) rather than spelling out successors.rrCrr$r$r% _insert_tcPrs zCT_Tc._insert_tcPrcCs:t|}t|dkrdS|d}t|jdkrdSdS)zATrue if this cell contains only a single empty ```` element.rFrT)listrrWr_lst)r* block_itemspr$r$r% _is_emptys  zCT_Tc._is_emptycCsH||urdS|jr dS||D]}||q||dS)zoAppend the content of this cell to `other_tc`, leaving this cell with a single empty ```` element.N)r_remove_trailing_empty_prr_new_p)r*r block_elementr$r$r%_move_content_to%s  zCT_Tc._move_content_tocCrIr<)rPrKr3r$r$r%_new_tbl3rMzCT_Tc._new_tblcCs|d}|r |dSdS)zThe `w:tc` element immediately following this one in this row, or |None| if this is the last `w:tc` element in the row.z./following-sibling::w:tcrNr)r* following_tcsr$r$r%_next_tc6s zCT_Tc._next_tccCs||dS)z-Remove this `w:tc` element from the XML tree.N)r0remover3r$r$r%_remove=sz CT_Tc._removecCsJt|}|d}|jtdkrdS|}t|jdkrdS||dS)z[Remove the last content element from this cell if it is an empty ```` element.rNr)rrrr rWrr)r*rlast_content_elmrr$r$r%rAs zCT_Tc._remove_trailing_empty_pcCspdd}dd}||||||t|j|j}t|j|j}t|j|j}t|j|j}||||||fS)zReturn a (top, left, height, width) 4-tuple specifying the extents of the merged cell formed by using this tc and `other_tc` as opposite corner extents.cSsH|j|jkr|j|jkrtd|j|jkr |j|jkr"tddSdSNzrequested span not rectangularrrrrr)abr$r$r%raise_on_inverted_LRs z3CT_Tc._span_dimensions..raise_on_inverted_LcSs|j|jkr ||fn||f\}}|j|jkr |j|jkr td|j|jkr*||fn||f\}}|j|jkr@|j|jkrBtddSdSrr)rrtop_mostother left_mostr$r$r%raise_on_tee_shapedXs  z3CT_Tc._span_dimensions..raise_on_tee_shaped)minrrmaxrr)r*rrrrrrrr$r$r%rMs zCT_Tc._span_dimensionscCs4|||j|kr||||j|ks ||_dS)aZIncorporate and then remove `w:tc` elements to the right of this one until this cell spans `grid_width`. Raises |ValueError| if `grid_width` cannot be exactly achieved, such as when a merged cell would drive the span width greater than `grid_width` or if not enough grid columns are available to make this cell that wide. All content from incorporated cells is appended to `top_tc`. The val attribute of the vMerge element on the single remaining cell is set to `vMerge`. If `vMerge` is |None|, the vMerge element is removed if present. N)rr(_swallow_next_tcr)r* grid_widthrrr$r$r%rks   zCT_Tc._span_to_widthcsLfdd}j}|||||j|j7_|dS)aExtend the horizontal span of this `w:tc` element to incorporate the following `w:tc` element in the row and then delete that following `w:tc` element. Any content in the following `w:tc` element is appended to the content of `top_tc`. The width of the following `w:tc` element is added to this one, if present. Raises |InvalidSpanError| if the width of the resulting cell is greater than `grid_width` or if there is no next `` element in the row. cs,|durtdj|jkrtddS)Nznot enough grid columnszspan is not rectangular)rr()next_tcrr*r$r%raise_on_invalid_swallows z8CT_Tc._swallow_next_tc..raise_on_invalid_swallowN)rrrr(r)r*rrrrr$rr%r{s    zCT_Tc._swallow_next_tccC|ddS)z+The tbl element this tc element appears in.z./ancestor::w:tbl[position()=1]rrr3r$r$r%rz CT_Tc._tblcCs|j|jS)zAThe `w:tc` element immediately above this one in its grid column.) _tr_abover.rr3r$r$r%rrzCT_Tc._tc_abovecCs|j}|dur dS||jS)z=The tc element immediately below this one in its grid column.N) _tr_belowr.r)r*tr_belowr$r$r%rs zCT_Tc._tc_belowcCr)z*The tr element this tc element appears in.z./ancestor::w:tr[position()=1]rrr3r$r$r%rrz CT_Tc._trcCs0|jj}||j}|dkrtd||dS)zThe tr element prior in sequence to the tr this cell appears in. Raises |ValueError| if called on a cell in the top-most row. rzno tr above topmost trr)rr1r2rr)r*r1r4r$r$r%rs   zCT_Tc._tr_abovecCs8|jj}||j}z||dWStyYdSw)zzThe tr element next in sequence after the tr this cell appears in, or |None| if this cell appears in the last row.rN)rr1r2r IndexErrorrr$r$r%rs  zCT_Tc._tr_belowcCs|jj|jS)z;The row index of the tr element this tc element appears in.)rr1r2rr3r$r$r%rsz CT_Tc._tr_idx)rarr<)-rrr r!__annotations__rrrrtblrNrrr(rOrrrrryrKrrrr`rrrrrrrrrrrrrrrrrrrrr$r$r$r%rJjs                           rJc@seZdZdZdZededddZededddZed ed ddZed ed ddZ [e d dZ e j ddZ e ddZ e j ddZ e ddZej ddZe ddZej ddZdS)CT_TcPrz5```` element, defining table cell properties.) w:cnfStylew:tcW w:gridSpanzw:hMergew:vMergez w:tcBordersrzw:noWrapzw:tcMarzw:textDirectionz w:tcFitTextw:vAlignz w:hideMarkz w:headersz w:cellInsz w:cellDelz w:cellMergez w:tcPrChangerNr{rrr cCr)zsThe integer number of columns this cell spans. Determined by ./w:gridSpan/@val, it defaults to 1. Nr)gridSpanr")r*rr$r$r%r(rzCT_TcPr.grid_spancCs"||dkr||_dSdSr)_remove_gridSpanget_or_add_gridSpanr"rr$r$r%r(cCr6)zValue of `w:val` attribute on `w:vAlign` child. Value is |None| if `w:vAlign` child is not present. The `w:val` attribute on `w:vAlign` is required. N)vAlignr")r*r r$r$r% vAlign_valrzCT_TcPr.vAlign_valcCs"|dur |dS||_dSr<)_remove_vAlignget_or_add_vAlignr"rr$r$r%r scCr6)zeThe value of the ./w:vMerge/@val attribute, or |None| if the w:vMerge element is not present.N)rr")r*rr$r$r%rrzCT_TcPr.vMerge_valcCs"||dur||_dSdSr<)_remove_vMerge _add_vMerger"rr$r$r%rr cCr6)zReturn the EMU length value represented in the ```` child element or |None| if not present or its type is not 'dxa'.N)tcWr`)r*rr$r$r%r`rz CT_TcPr.widthcCr;r<)get_or_add_tcWr`)r*r?rr$r$r%r` r@)rrr r!rrrrrr rNr(rOr rr`r$r$r$r%rs0       rc@s^eZdZdZdZededddZ[eddZej d dZed d Z e j d d Z dS) CT_TrPrz4```` element, defining table row properties.)rzw:divIdz w:gridBeforez w:gridAfterz w:wBeforezw:wAfterz w:cantSplit w:trHeightz w:tblHeaderrrzw:hiddenzw:inszw:delz w:trPrChangerrNr{cCr6)zCReturn the value of `w:trHeight@w:hRule`, or |None| if not present.N)trHeightr#r*rr$r$r%r8=r:zCT_TrPr.trHeight_hRulecC(|dur |jdur dS|}||_dSr<)rget_or_add_trHeightr#r*r?rr$r$r%r8E cCr6)zAReturn the value of `w:trHeight@w:val`, or |None| if not present.N)rr"rr$r$r%rALr:zCT_TrPr.trHeight_valcCrr<)rrr"rr$r$r%rATr) rrr r!rrrrNr8rOrAr$r$r$r%r&s   rc@r) CT_VerticalJcz:`w:vAlign` element, specifying vertical alignment of cell.rN)rrr r!rrr"r$r$r$r%r\src@s eZdZdZedeejdZdS) CT_VMergezG```` element, specifying vertical merging behavior of a cell.r)defaultN)rrr r!rr rr"r$r$r$r%rbsrN)2r! __future__rtypingrrrdocx.enum.tablerrdocx.exceptionsr docx.oxml.nsr r docx.oxml.parserr docx.oxml.simpletypesr r rrrdocx.oxml.xmlchemyrrrrrrr docx.sharedrrdocx.oxml.text.paragraphrrrr&rPrzr~rrrrJrrrrr$r$r$r%s8   $   C{ Q__6