U cqe1l@sdZddlmZddlmZmZmZddlmZm Z ddl m Z ddl m Z mZddlmZddlmZmZmZmZmZdd lmZmZmZmZmZmZmZdd lm Z m!Z!erdd 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$3/tmp/pip-unpacked-wheel-gx5hpqp3/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:tccCsJd}|jD]2}||kr|S||j7}||kr td|q tddS)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 boundsN)tc_lst grid_span ValueError)selfidxZgrid_coltcr$r$r%tc_at_grid_col0s  zCT_Row.tc_at_grid_colcCs|j|S)zSThe index of this ```` element within its parent ```` element.) getparenttr_lstindexr*r$r$r%tr_idx>sz CT_Row.tr_idxcCs|j}|dkrdS|jS)zJReturn the value of `w:trPr/w:trHeight@w:hRule`, or |None| if not present.N)trPrtrHeight_hRuler*r3r$r$r%r4DszCT_Row.trHeight_hRulecCs|}||_dSN)get_or_add_trPrr4r*valuer3r$r$r%r4LscCs|j}|dkrdS|jS)zHReturn the value of `w:trPr/w:trHeight@w:val`, or |None| if not present.N)r3 trHeight_valr5r$r$r%r:QszCT_Row.trHeight_valcCs|}||_dSr6)r7r:r8r$r$r%r:YscCs|d|dSNrinsert)r*tblPrExr$r$r%_insert_tblPrEx^szCT_Row._insert_tblPrExcCs*|j}|dk r||n |d|dSr;)r>Zaddnextr=)r*r3r>r$r$r% _insert_trPras zCT_Row._insert_trPrcCstSr6)CT_Tcnewr1r$r$r%_new_tchszCT_Row._new_tcN)rrr r!rr>r3rr,r-propertyr2r4setterr:r?r@rCr$r$r$r%r&)s$     r&c@seZdZdZedZedZedZe ddZ e j ddZ e dd Z d d Z ed d d ddddZe ddZej ddZed d d ddddZeddZeddZeddZdS)CT_Tblz```` element.zw:tblPrz w:tblGridzw:trcCs|jj}|dkrdS|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*rHr$r$r%bidiVisual_valsszCT_Tbl.bidiVisual_valcCs&|j}|dkr|n ||_dSr6)rGZ_remove_bidiVisualZget_or_add_bidiVisualr")r*r9rGr$r$r%rI~s cCs t|jjS)z)The number of grid columns in this table.)lentblGrid gridCol_lstr1r$r$r% col_countszCT_Tbl.col_countccs"|jD]}|jD] }|VqqdS)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)r/r')r*trr,r$r$r%iter_tcss  zCT_Tbl.iter_tcsintr)rowscolswidthreturncCst||||S)zReturn a new `w:tbl` element having `rows` rows and `cols` columns. `width` is distributed evenly between the columns. )r _tbl_xml)clsrQrRrSr$r$r%new_tblszCT_Tbl.new_tblcCs|jj}|dkrdS|jS)zYValue of `w:tblPr/w:tblStyle/@w:val` (a table style id) or |None| if not present.N)rGtblStyler"r*rXr$r$r% tblStyle_valszCT_Tbl.tblStyle_valcCs(|j}||dkrdS||_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)rG_remove_tblStyle _add_tblStyler")r*ZstyleIdrGr$r$r%rZs strcCs@|dkrt||ntd}dtd|||||||fS)Nrz %s%s w)rr _tblGrid_xml_trs_xml)rVrQrRrS col_widthr$r$r%rUs   zCT_Tbl._tbl_xmlcCs,d}t|D]}|d|j7}q |d7}|S)Nz z z rangetwipsrVrMraxmlir$r$r%r_s  zCT_Tbl._tblGrid_xmlcCs*d}t|D]}|d|||7}q |S)Nz %s )rc_tcs_xml)rVZ row_countrMrarfrgr$r$r%r`s  zCT_Tbl._trs_xmlcCs$d}t|D]}|d|j7}q |S)Nrhzj rbrer$r$r%ris zCT_Tbl._tcs_xmlN)rrr r!rrGrKrrNrDrIrErMrO classmethodrWrZrUr_r`rir$r$r$r%rFls2        rFc@seZdZdZedddZdS) CT_TblGridzw```` element, child of ````, holds ```` elements that define column count, width, etc.z w:gridCol)zw:tblGridChange successorsN)rrr r!rZgridColr$r$r$r%rksrkc@s&eZdZdZedeZeddZdS) CT_TblGridColzJ```` element, child of ````, defines a table column.w:wcCs|j|S)z\The index of this ```` element within its parent ```` element.)r.rLr0r1r$r$r% gridCol_idxszCT_TblGridCol.gridCol_idxN) rrr r!rrr^rDrpr$r$r$r%rns rnc@seZdZdZedeZdS)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%rqsrqc@seZdZdZdZededddZededddZed ed ddZed ed ddZ [e d dZ e j ddZ e ddddZ e j ddddZ 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:tblPrChangeruNrlrvrwrz cCs|j}|dkrdS|jS)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% alignmentszCT_TblPr.alignmentcCs&||dkrdS|}||_dSr6)Z _remove_jcZ get_or_add_jcr")r*r9rr$r$r%r+s boolrTcCs|j}|dkrdS|jdkS)zg|False| when there is a `w:tblLayout` child with `@w:type="fixed"`. Otherwise |True|. NTfixed) tblLayoutrs)r*rr$r$r%autofit3szCT_TblPr.autofit)r9cCs|}|rdnd|_dS)Nrr)Zget_or_add_tblLayoutrs)r*r9rr$r$r%r<scCs|j}|dkrdS|jS)ziReturn the value of the ``val`` attribute of the ```` child or |None| if not present.N)rXr"rYr$r$r%styleAszCT_TblPr.stylecCs$||dkrdS|j|ddS)N)r")r[r\r*r9r$r$r%rJs)rrr r!_tag_seqrrXrHrrrDrrErrr$r$r$r%rts&   rtc@s>eZdZdZedeZedeZe ddZ e j ddZ dS) CT_TblWidthzeUsed for ```` and ```` elements and many others, to specify a table-related width.rorrcCs|jdkrdSt|jS)zbReturn the EMU length value represented by the combined ``w:w`` and ``w:type`` attributes.dxaN)rsrr^r1r$r$r%rS\s zCT_TblWidth.widthcCsd|_t|j|_dS)Nr)rsrrdr^rr$r$r%rSdsN) rrr r!rrr^rrsrDrSrEr$r$r$r%rRs   rc@seZdZUdZded<ded<ded<ded <ed Zed Zed Z e d dZ ddZ e ddZ e jddZ e ddddZddZe ddZddZeddZe d d!Ze d"d#Ze d$d%Zejd&d%Ze d'd(Zejd)d(Zd*d+Ze d,d-ZdSd/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)TrAz`w:tc` table cell element.zCallable[[], CT_P]Zadd_pz List[CT_P]Zp_lstz List[CT_Tbl]Ztbl_lstzCallable[[CT_Tbl], CT_Tbl]Z _insert_tblzw:tcPrw:pw:tblcCs4|jdk r*|j}|dk r*|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*Ztc_belowr$r$r%rws  z CT_Tc.bottomcCs,g}|j}|dk r||||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*Z new_childrenrr$r$r% clear_contents  zCT_Tc.clear_contentcCs|j}|dkrdS|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(szCT_Tc.grid_spancCs|}||_dSr6)get_or_add_tcPrr(r*r9rr$r$r%r(szList[CT_P | CT_Tbl]rcCs |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:tblZxpathr1r$r$r%inner_content_elementsszCT_Tc.inner_content_elementsccs4tdtdtdf}|D]}|j|kr|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*Zblock_item_tagschildr$r$r%iter_block_itemss zCT_Tc.iter_block_itemscCs|jS)z?The grid column index at which this ```` element appears.) _grid_colr1r$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_tblr/r-_grow_to)r*other_tctoprheightrStop_tcr$r$r%merges z CT_Tc.mergecCstdtdS)zhReturn a new ```` element, containing an empty paragraph as the required EG_BlockLevelElt.z r^)r r )rVr$r$r%rBsz 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(r1r$r$r%rightsz CT_Tc.rightcCs$|jdks|jtjkr|jS|jjS)z9The top-most row index in the vertical span of this cell.N)rr RESTARTr _tc_aboverr1r$r$r%rsz CT_Tc.topcCs|j}|dkrdS|jS)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%rsz CT_Tc.vMergecCs|}||_dSr6)rrrr$r$r%rscCs|j}|dkrdS|jS)zqReturn the EMU length value represented in the ``./w:tcPr/w:tcW`` child element or |None| if not present.N)rrSrr$r$r%rSsz CT_Tc.widthcCs|}||_dSr6)rrSrr$r$r%rSscCs |jr|jr|j|j7_dS)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)rS)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|] }|jVqdSr6)r().0r,r$r$r% sz"CT_Tc._grid_col..)_trr'r0sum)r*rNr+Z preceding_tcsr$r$r%rs zCT_Tc._grid_colNcsPfdd}|dkrn|}||||dkrLj|d|dS)zGrow this cell to `width` grid columns and `height` rows by expanding horizontal spans and creating continuation cells to form vertical spans.cs |k rtjSdkrdStjSNr{)r rr)rrr*r$r%rs z"CT_Tc._grow_to..vMerge_valNr{)_span_to_widthrr)r*rSrrrr$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.rr<rr$r$r% _insert_tcPrs zCT_Tc._insert_tcPrcCs:t|}t|dkrdS|d}t|jdkr6dSdS)zATrue if this cell contains only a single empty ```` element.r{FrT)listrrJr_lst)r* block_itemspr$r$r% _is_emptys  zCT_Tc._is_emptycCsH||kr dS|jrdS||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_prrZ_new_p)r*rZ block_elementr$r$r%_move_content_to%s  zCT_Tc._move_content_tocCstSr6)rFrBr1r$r$r%_new_tbl3szCT_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*Z following_tcsr$r$r%_next_tc6s zCT_Tc._next_tccCs||dS)z-Remove this `w:tc` element from the XML tree.N)r.remover1r$r$r%_remove=sz CT_Tc._removecCsJt|}|d}|jtdkr&dS|}t|jdkr`` element.rNr)rrrr rJrr)r*rZlast_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.cSsD|j|jkr |j|jkr td|j|jkr@|j|jkr@tddSNzrequested span not rectangularrrrrr)abr$r$r%raise_on_inverted_LRsz3CT_Tc._span_dimensions..raise_on_inverted_LcSs|j|jkr||fn||f\}}|j|jkr@|j|jkr@td|j|jkrT||fn||f\}}|j|jkr|j|jkrtddSrr)rrZtop_mostotherZ 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_dimensionscCs,|||j|kr"|||q ||_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,|dkrtdj|jkr(tddS)Nznot enough grid columnszspan is not rectangular)rr()next_tcrr*r$r%raise_on_invalid_swallowsz8CT_Tc._swallow_next_tc..raise_on_invalid_swallowN)rrrr(r)r*rrrrr$rr%r{s   zCT_Tc._swallow_next_tccCs|ddS)z+The tbl element this tc element appears in.z./ancestor::w:tbl[position()=1]rrr1r$r$r%rsz CT_Tc._tblcCs|j|jS)zAThe `w:tc` element immediately above this one in its grid column.) _tr_abover-rr1r$r$r%rszCT_Tc._tc_abovecCs|j}|dkrdS||jS)z=The tc element immediately below this one in its grid column.N) _tr_belowr-r)r*Ztr_belowr$r$r%rszCT_Tc._tc_belowcCs|ddS)z*The tr element this tc element appears in.z./ancestor::w:tr[position()=1]rrr1r$r$r%rsz CT_Tc._trcCs0|jj}||j}|dkr$td||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{)rr/r0rr)r*r/r2r$r$r%rs  zCT_Tc._tr_abovecCs>|jj}||j}z||dWStk r8YdSXdS)zzThe tr element next in sequence after the tr this cell appears in, or |None| if this cell appears in the last row.r{N)rr/r0r IndexErrorrr$r$r%rs  zCT_Tc._tr_belowcCs|jj|jS)z;The row index of the tr element this tc element appears in.)rr/r0rr1r$r$r%rsz CT_Tc._tr_idx)N)-rrr r!__annotations__rrrrZtblrDrrr(rErrrrrjrBrrrrSrrrrrrrrrrrrrrrrrrrrr$r$r$r%rAjs                        rAc@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:tcBordersryzw:noWrapzw:tcMarzw:textDirectionz w:tcFitTextw:vAlignz w:hideMarkz w:headersz w:cellInsz w:cellDelz w:cellMergez w:tcPrChangerNrlrrr cCs|j}|dkrdS|jS)zsThe integer number of columns this cell spans. Determined by ./w:gridSpan/@val, it defaults to 1. Nr{)gridSpanr")r*rr$r$r%r(szCT_TcPr.grid_spancCs||dkr||_dSr)Z_remove_gridSpanZget_or_add_gridSpanr"rr$r$r%r(scCs|j}|dkrdS|jS)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*rr$r$r% vAlign_valszCT_TcPr.vAlign_valcCs"|dkr|dS||_dSr6)Z_remove_vAlignZget_or_add_vAlignr"rr$r$r%rscCs|j}|dkrdS|jS)zeThe value of the ./w:vMerge/@val attribute, or |None| if the w:vMerge element is not present.N)rr")r*rr$r$r%rszCT_TcPr.vMerge_valcCs||dk r||_dSr6)Z_remove_vMergeZ _add_vMerger"rr$r$r%rscCs|j}|dkrdS|jS)zReturn the EMU length value represented in the ```` child element or |None| if not present or its type is not 'dxa'.N)tcWrS)r*rr$r$r%rSsz CT_TcPr.widthcCs|}||_dSr6)Zget_or_add_tcWrS)r*r9rr$r$r%rS s)rrr r!rrrrrrrDr(rErrrSr$r$r$r%rs.       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:tblHeaderrxrwzw:hiddenzw:inszw:delz w:trPrChangerr}NrlcCs|j}|dkrdS|jS)zCReturn the value of `w:trHeight@w:hRule`, or |None| if not present.N)trHeightr#r*rr$r$r%r4=szCT_TrPr.trHeight_hRulecCs(|dkr|jdkrdS|}||_dSr6)rget_or_add_trHeightr#r*r9rr$r$r%r4EscCs|j}|dkrdS|jS)zAReturn the value of `w:trHeight@w:val`, or |None| if not present.N)rr"rr$r$r%r:LszCT_TrPr.trHeight_valcCs(|dkr|jdkrdS|}||_dSr6)rrr"rr$r$r%r:Ts) rrr r!rrrrDr4rEr:r$r$r$r%r&s   rc@seZdZdZedeZdS) 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__rtypingrrrZdocx.enum.tablerrZdocx.exceptionsrZ docx.oxml.nsr r Zdocx.oxml.parserr Zdocx.oxml.simpletypesr r rrrZdocx.oxml.xmlchemyrrrrrrrZ docx.sharedrrZdocx.oxml.text.paragraphrrrr&rFrkrnrqrtrrArrrrr$r$r$r%s6   $   C{ Q__6