o W_Dl@sxdZddlmZmZmZmZddlmZddlm Z m Z ddl m Z ddl mZmZdd lmZmZdd lmZmZmZmZmZdd lmZmZmZmZmZmZm Z Gd d d eZ!GdddeZ"GdddeZ#GdddeZ$GdddeZ%GdddeZ&GdddeZ'GdddeZ(GdddeZ)GdddeZ*Gd d!d!eZ+Gd"d#d#eZ,Gd$d%d%eZ-d&S)'z!Custom element classes for tables)absolute_importdivisionprint_functionunicode_literals) parse_xml)WD_CELL_VERTICAL_ALIGNMENTWD_ROW_HEIGHT_RULE)InvalidSpanError)nsdeclsqn)EmuTwips)ST_MergeST_TblLayoutType ST_TblWidthST_TwipsMeasureXsdInt)BaseOxmlElement OneAndOnlyOne OneOrMoreOptionalAttributeRequiredAttribute ZeroOrOne ZeroOrMorec@s$eZdZdZedeZedeZdS) CT_HeightzP Used for ```` to specify a row height and row height rule. w:valzw:hRuleN) __name__ __module__ __qualname____doc__rrvalr hRuler$r$?D:\Projects\ConvertPro\env\Lib\site-packages\docx\oxml\table.pyrs 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)z The ```` 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)selfidxZgrid_coltcr$r$r%tc_at_grid_col's   zCT_Row.tc_at_grid_colcC|j|S)ze The index of this ```` element within its parent ```` element. ) getparenttr_lstindexr*r$r$r%tr_idx5z CT_Row.tr_idxcC|j}|dur dS|jS)zd Return the value of `w:trPr/w:trHeight@w:hRule`, or |None| if not present. N)trPrtrHeight_hRuler*r6r$r$r%r7=zCT_Row.trHeight_hRulecC|}||_dSN)get_or_add_trPrr7r*valuer6r$r$r%r7H cCr5)zb Return the value of `w:trPr/w:trHeight@w:val`, or |None| if not present. N)r6 trHeight_valr8r$r$r%r@Mr9zCT_Row.trHeight_valcCr:r;)r<r@r=r$r$r%r@Xr?cCs|d|dSNrinsert)r*tblPrExr$r$r%_insert_tblPrEx]szCT_Row._insert_tblPrExcCs,|j}|dur||dS|d|dSrA)rDZaddnextrC)r*r6rDr$r$r% _insert_trPr`szCT_Row._insert_trPrcCtSr;)CT_Tcnewr2r$r$r%_new_tcgzCT_Row._new_tcN)rrr r!rrDr6rr,r-propertyr3r7setterr@rErFrJr$r$r$r%r&s&      r&c@seZdZdZedZedZedZe ddZ e j ddZ e dd Z d d Z ed d Ze ddZej ddZeddZeddZeddZeddZdS)CT_Tblz ```` element zw:tblPrz w:tblGridzw:trcC|jj}|dur dS|jS)z Value 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*rQr$r$r%bidiVisual_valsszCT_Tbl.bidiVisual_valcCs(|j}|dur |dS||_dSr;)rPZ_remove_bidiVisualZget_or_add_bidiVisualr")r*r>rPr$r$r%rRs cCs t|jjS)z; The number of grid columns in this table. )lentblGrid gridCol_lstr2r$r$r% col_counts zCT_Tbl.col_countccs$|jD] }|jD]}|Vq qdS)z Generate 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)r0r')r*trr,r$r$r%iter_tcss   zCT_Tbl.iter_tcscCst||||S)z Return a new `w:tbl` element having *rows* rows and *cols* columns with *width* distributed evenly between the columns. )r_tbl_xml)clsrowscolswidthr$r$r%new_tblszCT_Tbl.new_tblcCrO)zk Value of `w:tblPr/w:tblStyle/@w:val` (a table style id) or |None| if not present. N)rPtblStyler"r*r_r$r$r% tblStyle_valszCT_Tbl.tblStyle_valcCs(|j}||dur dS||_dS)z Set 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)rP_remove_tblStyle _add_tblStyler")r*ZstyleIdrPr$r$r%ras cCs@|dkr t||ntd}dtd|||||||fS)Nrz %s%s w)rr _tblGrid_xml_trs_xml)rZr[r\r] col_widthr$r$r%rYs  zCT_Tbl._tbl_xmlcCs,d}t|D] }|d|j7}q|d7}|S)Nz z z rangetwipsrZrVrgxmlir$r$r%res  zCT_Tbl._tblGrid_xmlcCs*d}t|D] }|d|||7}q|S)Nz %s )ri_tcs_xml)rZZ row_countrVrgrlrmr$r$r%rfs  zCT_Tbl._trs_xmlcCs$d}t|D] }|d|j7}q|S)Nrnzj rhrkr$r$r%ros zCT_Tbl._tcs_xmlN)rrr r!rrPrTrrWrLrRrMrVrX classmethodr^rarYrerfror$r$r$r%rNks4          rNc@seZdZdZedddZdS) CT_TblGridz ```` element, child of ````, holds ```` elements that define column count, width, etc. z w:gridCol)zw:tblGridChangeZ successorsN)rrr r!rZgridColr$r$r$r%rqsrqc@s&eZdZdZedeZeddZdS) CT_TblGridColzX ```` element, child of ````, defines a table column. w:wcCr.)zn The index of this ```` element within its parent ```` element. )r/rUr1r2r$r$r% gridCol_idxr4zCT_TblGridCol.gridCol_idxN) rrr r!rrrdrLrur$r$r$r%rss  rsc@eZdZdZedeZdS)CT_TblLayoutTypez ```` element, specifying whether column widths are fixed or can be automatically adjusted based on content. w:typeN)rrr r!rrtyper$r$r$r%rwsrwc@seZdZdZdZededddZededddZed ed ddZed ed ddZ [e d dZ e j ddZ e ddZ e j ddZ 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:tblPrChanger{rNrrr|r}r cCr5)z Member 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;)Z _remove_jcZ get_or_add_jcr")r*r>rr$r$r%r+s  cCs$|j}|dur dS|jdkrdSdS)z Return |False| if there is a ```` child with ``w:type`` attribute set to ``'fixed'``. Otherwise return |True|. NTfixedF) tblLayoutry)r*rr$r$r%autofit3szCT_TblPr.autofitcCs |}|r d|_dSd|_dS)Nrr)Zget_or_add_tblLayoutry)r*r>rr$r$r%r>scCr5)z{ Return the value of the ``val`` attribute of the ```` child or |None| if not present. N)r_r"r`r$r$r%styleCr9zCT_TblPr.stylecCs$||dur dS|j|ddS)N)r")rbrcr*r>r$r$r%rNs)rrr r!_tag_seqrr_rQrrrLrrMrrr$r$r$r%rz s(      rzc@s>eZdZdZedeZedeZe ddZ e j ddZ dS) CT_TblWidthzo Used for ```` and ```` elements and many others, to specify a table-related width. rtrxcCs|jdkrdSt|jS)zt Return the EMU length value represented by the combined ``w:w`` and ``w:type`` attributes. dxaN)ryrrdr2r$r$r%r]as  zCT_TblWidth.widthcCsd|_t|j|_dS)Nr)ryrrjrdrr$r$r%r]ksN) rrr r!rrrdrryrLr]rMr$r$r$r%rVs    rc@seZdZdZedZedZedZe ddZ ddZ e d d Z e j d d Z d d Ze ddZddZeddZe ddZe ddZe ddZej ddZe ddZej ddZddZe d d!ZdGd#d$Zd%d&Ze d'd(Zd)d*Zd+d,Ze d-d.Zd/d0Zd1d2Z d3d4Z!d5d6Z"d7d8Z#e d9d:Z$e d;d<Z%e d=d>Z&e d?d@Z'e dAdBZ(e dCdDZ)e dEdFZ*d"S)HrHz`w:tc` table cell elementzw:tcPrw:pw:tblcCs4|jdur|j}|dur|jtjkr|jS|jdS)z The 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_belowrCONTINUEbottom_tr_idx)r*Ztc_belowr$r$r%rxs  z CT_Tc.bottomcCs,g}|j}|dur||||dd<dS)aU Remove 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_contentcC|j}|dur dS|jS)z The 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(r9zCT_Tc.grid_spancCr:r;)get_or_add_tcPrr(r*r>rr$r$r%r(r?ccs6tdtdtdf}|D] }|j|vr|VqdS)z Generate 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)zQ The grid column index at which this ```` element appears. ) _grid_colr2r$r$r%leftsz CT_Tc.leftcCs4||\}}}}|jj||}||||S)z Return 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_tblr0r-_grow_to)r*other_tctoprheightr]top_tcr$r$r%merges z CT_Tc.mergecCstdtdS)zz Return a new ```` element, containing an empty paragraph as the required EG_BlockLevelElt. z rd)rr )rZr$r$r%rIs z CT_Tc.newcCs |j|jS)a The 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(r2r$r$r%rights z CT_Tc.rightcCs$|jdus |jtjkr|jS|jjS)zK The top-most row index in the vertical span of this cell. N)rrRESTARTr _tc_aboverr2r$r$r%rsz CT_Tc.topcCr5)z~ The 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%rr9z CT_Tc.vMergecCr:r;)rrrr$r$r%rr?cCr5)z Return the EMU length value represented in the ``./w:tcPr/w:tcW`` child element or |None| if not present. N)rr]rr$r$r%r]r9z CT_Tc.widthcCr:r;)rr]rr$r$r%r]r?cCs(|jr|jr|j|j7_dSdSdS)z Add 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'r1sum)r*rWr+Z preceding_tcsr$r$r%rs zCT_Tc._grid_colNcsTfdd}|dur n|}||||dkr(j|d|dSdS)z Grow this cell to *width* grid columns and *height* rows by expanding horizontal spans and creating continuation cells to form vertical spans. cs |urtjSdkr dStjSNr)rrr)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. rrBrr$r$r% _insert_tcPr#s zCT_Tc._insert_tcPrcCs:t|}t|dkrdS|d}t|jdkrdSdS)zS True if this cell contains only a single empty ```` element. rFrT)listrrSr_lst)r* block_itemspr$r$r% _is_empty,s  zCT_Tc._is_emptycCsH||urdS|jr dS||D]}||q||dS)z Append 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_to9s  zCT_Tc._move_content_tocCrGr;)rNrIr2r$r$r%_new_tblIrKzCT_Tc._new_tblcCs|d}|r |dSdS)z The `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:tcrNZxpath)r*Z following_tcsr$r$r%_next_tcLs zCT_Tc._next_tccCs||dS)z? Remove this `w:tc` element from the XML tree. N)r/remover2r$r$r%_removeUsz CT_Tc._removecCsJt|}|d}|jtdkrdS|}t|jdkrdS||dS)zm Remove the last content element from this cell if it is an empty ```` element. rNr)rrrr rSrr)r*rZlast_content_elmrr$r$r%r[s zCT_Tc._remove_trailing_empty_pcCspdd}dd}||||||t|j|j}t|j|j}t|j|j}t|j|j}||||||fS)z Return 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 rectangularrrr rr)abr$r$r%raise_on_inverted_Los 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)rrZtop_mostotherZ left_mostr$r$r%raise_on_tee_shapedus  z3CT_Tc._span_dimensions..raise_on_tee_shaped)minrrmaxrr)r*rrrrrrrr$r$r%ris zCT_Tc._span_dimensionscCs4|||j|kr||||j|ks ||_dS)ab Incorporate 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%rs   zCT_Tc._span_to_widthcsLfdd}j}|||||j|j7_|dS)a Extend 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)r r()next_tcrr*r$r%raise_on_invalid_swallows z8CT_Tc._swallow_next_tc..raise_on_invalid_swallowN)rrrr(r)r*rrrrr$rr%rs    zCT_Tc._swallow_next_tccC|ddS)z= The tbl element this tc element appears in. z./ancestor::w:tbl[position()=1]rrr2r$r$r%rz CT_Tc._tblcCs|j|jS)zS The `w:tc` element immediately above this one in its grid column. ) _tr_abover-rr2r$r$r%rrzCT_Tc._tc_abovecCs|j}|dur dS||jS)zO The tc element immediately below this one in its grid column. N) _tr_belowr-r)r*Ztr_belowr$r$r%rs zCT_Tc._tc_belowcCr)z< The tr element this tc element appears in. z./ancestor::w:tr[position()=1]rrr2r$r$r%rrz CT_Tc._trcCs0|jj}||j}|dkrtd||dS)z The 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)rr0r1rr)r*r0r3r$r$r%rs   zCT_Tc._tr_abovecCs8|jj}||j}z||dWStyYdSw)z The tr element next in sequence after the tr this cell appears in, or |None| if this cell appears in the last row. rN)rr0r1r IndexErrorrr$r$r%rs  zCT_Tc._tr_belowcCs|jj|jS)zM The row index of the tr element this tc element appears in. )rr0r1rr2r$r$r%rsz CT_Tc._tr_idxr;)+rrr r!rrrrtblrLrrr(rMrrrrprIrrrr]rrrrrrrrrrrrrrrrrrrrr$r$r$r%rHqsx                        rHc@seZdZdZdZededddZededddZed ed ddZed ed ddZ [e d dZ e j ddZ e ddZ e j ddZ e ddZej ddZe ddZej ddZdS)CT_TcPrz> ```` 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:tcPrChangerrNrrrrr cCr)z{ The integer number of columns this cell spans. Determined by ./w:gridSpan/@val, it defaults to 1. Nr)gridSpanr")r*rr$r$r%r(r9zCT_TcPr.grid_spancCs"||dkr||_dSdSr)Z_remove_gridSpanZget_or_add_gridSpanr"rr$r$r%r( cCr5)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_valrzCT_TcPr.vAlign_valcCs"|dur |dS||_dSr;)Z_remove_vAlignZget_or_add_vAlignr"rr$r$r%rscCr5)zw The value of the ./w:vMerge/@val attribute, or |None| if the w:vMerge element is not present. N)rr")r*rr$r$r%r#r9zCT_TcPr.vMerge_valcCs"||dur||_dSdSr;)Z_remove_vMergeZ _add_vMerger"rr$r$r%r.rcCr5)z Return 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]4r9z CT_TcPr.widthcCr:r;)Zget_or_add_tcWr])r*r>rr$r$r%r]?r?)rrr r!rrrrrrrLr(rMrrr]r$r$r$r%rs0        rc@s^eZdZdZdZededddZ[eddZej d dZed d Z e j d d Z dS) CT_TrPrz= ```` element, defining table row properties )rzw:divIdz w:gridBeforez w:gridAfterz w:wBeforezw:wAfterz w:cantSplit w:trHeightz w:tblHeaderr~r}zw:hiddenzw:inszw:delz w:trPrChangerrNrrcCr5)zU Return the value of `w:trHeight@w:hRule`, or |None| if not present. N)trHeightr#r*rr$r$r%r7RzCT_TrPr.trHeight_hRulecC(|dur |jdur dS|}||_dSr;)rget_or_add_trHeightr#r*r>rr$r$r%r7\ cCr5)zS Return the value of `w:trHeight@w:val`, or |None| if not present. N)rr"rr$r$r%r@crzCT_TrPr.trHeight_valcCrr;)rrr"rr$r$r%r@mr) rrr r!rrrrLr7rMr@r$r$r$r%rEs    rc@rv) CT_VerticalJcz:`w:vAlign` element, specifying vertical alignment of cell.rN)rrr r!rr r"r$r$r$r%rusrc@s eZdZdZedeejdZdS) CT_VMergezQ ```` element, specifying vertical merging behavior of a cell. r)defaultN)rrr r!rrrr"r$r$r$r%rzsrN).r!Z __future__rrrrrnrZ enum.tabler r exceptionsr nsr r sharedrrZ simpletypesrrrrrZxmlchemyrrrrrrrrr&rNrqrsrwrzrrHrrrrr$r$r$r%s4  $LIV0