^jcdZddlmZddlZddlmZmZmZmZm Z m Z m Z m Z m Z ddlmZddlmZmZddlmZddlmZmZmZdd lmZer dd lmZdd lmZd)d ZGd de Z!e dZ"Gdde#Z$GddZ%Gdde%Z&Gdde%Z'GddZ(Gdde(Z)Gdde(Z*Gdde(Z+Gd d!e(Z,Gd"d#e(Z-Gd$d%e(Z.Gd&d'ej"e$(Z/y)*z?Enabling declarative definition of lxml custom element classes.) annotationsN) TYPE_CHECKINGAnyCallableDictListSequenceTupleTypeTypeVar)etree) ElementBase_Element)InvalidXmlError)NamespacePrefixedTagnsmapqn) lazyproperty) BaseXmlEnum)BaseSimpleTypecHtj|dd}t|S)z[Serialize `element` to human-readable XML suitable for tests. No XML declaration. unicodeT)encoding pretty_print)r tostring XmlString)elementxmls T/var/www/html/metafoliadorv2/venv/lib/python3.12/site-packages/docx/oxml/xmlchemy.pyserialize_for_readingr s ..94 HC S>cfeZdZdZej dZd dZd dZd dZ d dZ e d dZ y) rz]Provides string comparison override suitable for serialized XML that is useful for tests.z)( *)([^<]*)?$ct|tsy|j}|j}t|t|k7ryt ||D]\}}|j ||ryy)NFT) isinstancestr splitlineslenzip _eq_elm_strs)selfotherlines lines_otherline line_others r__eq__zXmlString.__eq__5sp%%!&&( u:[) ) #E; 7  D*$$T:6 r!c&|j| SN)r0)r*r+s r__ne__zXmlString.__ne__As;;u%%%r!cX|j}|j}t|S)zReturn a sequence of attribute strings parsed from `attrs`. Each attribute string is stripped of whitespace on both ends. )stripsplitsorted)r*attrsattr_lsts r _attr_seqzXmlString._attr_seqDs%  ;;=hr!c|j|\}}}}|j|\}}} } ||k7ry|j||j|k7ry|| k7ry|| k7ryy)zZReturn True if the element in `line_2` is XML equivalent to the element in `line`.FT) _parse_liner:) r*r.line_2frontr8closetextfront_2attrs_2close_2text_2s rr)zXmlString._eq_elm_strsMsv%)$4$4T$:!ueT,0,<,>% DNN7$; ; G  6>r!c|jj|}|ytddDcgc]}|j|c}\}}}}||||fScc}w)zI(front, attrs, close, text) 4-tuple result of parsing XML element `line`.)rFrFrF)_xml_elm_line_pattmatchrangegroup)clsr.rJnr>r8r?r@s rr<zXmlString._parse_line\s^&&,,T2 =!=B1a[$IU[[^$I!ueTeUD((%JsAN)r+objectreturnbool)r8r%rPz List[str])r.r%r=r%)r.r%rPzTuple[str, str, str, str]) __name__ __module__ __qualname____doc__recompilerIr0r3r:r) classmethodr<r!rrr)sC$$PQ &  ))r!r_TceZdZdZddZy)MetaOxmlElementzMetaclass for BaseOxmlElement.ctttttt t f}|jD]$\}}t||s|j||&yr2) OneAndOnlyOne OneOrMoreOptionalAttributeRequiredAttribute ZeroOrMore ZeroOrOneZeroOrOneChoiceitemsr$populate_class_members)rMclsnamebases namespace dispatchablekeyvalues r__init__zMetaOxmlElement.__init__lsT        $//+ 7JC%.,,S#6 7r!N)rgr%rhzTuple[type, ...]rizDict[str, Any])rRrSrTrUrmrYr!rr\r\is ( 7r!r\cjeZdZdZdfd Zd dZdZedZed dZ e d dZ xZ S) BaseAttributezZBase class for OptionalAttribute and RequiredAttribute. Provides common methods. cFtt| ||_||_yr2)superrorm _attr_name _simple_type)r* attr_name simple_type __class__s rrmzBaseAttribute.__init__s mT+-#'r!c@||_||_|jyz-Add the appropriate methods to `element_cls`.N) _element_cls _prop_name_add_attr_propertyr* element_cls prop_names rrfz$BaseAttribute.populate_class_memberss'# !r!ct|j|jd}t|j|j |y)zAdd a read/write `.{prop_name}` property to the element class. The property returns the interpreted value of this attribute on access and changes the attribute value to its ST_* counterpart on assignment. N)property_getter_settersetattrryrzr* property_s rr{z BaseAttribute._add_attr_propertys0 T\\4<<> !!4??I>r!c`d|jvrt|jS|jS)N:)rrrr*s r _clark_namezBaseAttribute._clark_names' $// !doo& &r!cyr2rYrs rrzBaseAttribute._gettersBEr!cyr2rYrs rrzBaseAttribute._setters9 dfd }j|_|S)zJFunction suitable for `__get__()` method on attribute property descriptor.c|jj}| jSjj |Sr2)getrrrsfrom_xmlobjattr_str_valuer*s rget_attr_valuez1OptionalAttribute._getter..get_attr_values@!WWT%5%56N%}}$$$--n= =r!rBaseOxmlElementrP Any | NonerrUr*rs` rrzOptionalAttribute._getters,  >  >  >"&r!cdfd }|S)zJFunction suitable for `__set__()` method on attribute property descriptor.cZ||jk(r0j|jvr|jj=yjj |}|0j|jvr|jj=y|j j|yr2)rrattribrsto_xmlsetrrl str_valuer*s rset_attr_valuez1OptionalAttribute._setter..set_attr_values} 6##szz1 4#3#34))007I ##szz1 4#3#34 GGD$$i 0r!)rrrlrrYr*rs` rrzOptionalAttribute._setters 1r!r2)rtr%rurrz0BaseXmlEnum | BaseSimpleType | str | bool | NonerrPz&Callable[[BaseOxmlElement, Any], None]) rRrSrTrUrmrrrrrrs@rr`r`suEI   > B     0 r!r`cDeZdZdZedZeddZeddZy)raaDefines a required attribute on a custom element class. A required attribute is assumed to be present for reading, so does not have a default value; its actual value is always used. If missing on read, an |InvalidXmlError| is raised. It also does not remove the attribute if |None| is assigned. Assigning |None| raises |TypeError| or |ValueError|, depending on the simple type of the attribute. cN|jjd|jdS)zaReturn the string to use as the ``__doc__`` attribute of the property for this attribute.rz `` attribute.rrs rrzRequiredAttribute._docstrings$    & & OO  r!c6dfd }j|_|S)zDfunction object suitable for "get" side of attr property descriptor.c|jj}|%tdjd|jj j |S)Nz required 'z#' attribute not present on element )rrrrrtagrsrrs rrz1RequiredAttribute._getter..get_attr_valuesV WWT%5%56N%%KO??\_\c\cd$$--n= =r!rrrs` rrzRequiredAttribute._getters >"&r!cdfd }|S)zIfunction object suitable for "set" side of attribute property descriptor.cjj|}|td|d|jj|y)Nzcannot assign z to this required attribute)rsr ValueErrorrrrs rrz1RequiredAttribute._setter..set_attr_value sH))007I  >%8S!TUU GGD$$i 0r!)rrrlrrYrs` rrzRequiredAttribute._setters 1 r!N)rPz Callable[[BaseOxmlElement], Any]r)rRrSrTrUrrrrrYr!rrarasC      r!raceZdZdZddfd ZddZdZdZdZdZ dZ e d Z d Z dd Zedd Zed Ze dZedZe dZe dZe dZxZS)_BaseChildElementzBase class for the child-element classes. The child-element sub-classes correspond to varying cardinalities, such as ZeroOrOne and ZeroOrMore. cFtt| ||_||_yr2)rqrrm _nsptagname _successors)r* nsptagname successorsrvs rrmz_BaseChildElement.__init__s! /1%%r!c ||_||_y)zFBaseline behavior for adding the appropriate methods to `element_cls`.N)ryrzr|s rrfz(_BaseChildElement.populate_class_members s'#r!crdfd }djz|_jj|y)zGAdd an ``_add_x()`` method to the element class for this child element.ct|j}|}|jD]\}}t|||t|j}|||Sr2)getattr_new_method_namerer_insert_method_name)rr8 new_methodchildrkrl insert_methodr*s r _add_childz0_BaseChildElement._add_adder.._add_child(s` d&;&;`` child element unconditionally, inserted in the correct sequence.N)rrr8r)rrU _add_to_class_add_method_name)r*rs` r _add_adderz_BaseChildElement._add_adder%s;  #%)%5%5 6  400*=r!c||j}d|jz|_|j|j|y)zAdd a ``_new_{prop_name}()`` method to the element class that creates a new, empty element of the correct type, having no attributes.zYReturn a "loose", newly created ``<%s>`` element having no attributes, text, or children.N)_creatorrrUrr)r*creators r _add_creatorz_BaseChildElement._add_creator7s?-- (*.*:*: ;  400':r!ctt|jdd}t|j|j|y)z]Add a read-only ``{prop_name}`` property to the element class for this child element.N)rrrryrzrs r _add_getterz_BaseChildElement._add_getterAs,T\\46 !!4??I>r!crdfd }djz|_jj|y)zJAdd an ``_insert_x()`` method to the element class for this child element.cB|j|gj|Sr2)insert_element_beforerrrr*s r _insert_childz6_BaseChildElement._add_inserter.._insert_childKs# %C % %e ?d.>.> ?Lr!zYReturn the passed ``<%s>`` element after inserting it as a child in the correct sequence.N)rrrr)rrUrr)r*rs` r _add_inserterz_BaseChildElement._add_inserterHs;   )+/+;+; <  433]Cr!c~d|jz}t|jdd}t|j||y)zAdd a read-only ``{prop_name}_lst`` property to the element class to retrieve a list of child elements matching this type.z%s_lstN)rzr _list_getterrry)r*r~rs r_add_list_getterz"_BaseChildElement._add_list_getterUs8t. T..d; !!9i8r!c d|jzS)Nz_add_%srzrs rrz"_BaseChildElement._add_method_name\4??**r!crdfd }djz|_jj|y)z.add_childcs#!(d.C.C!D &(ELr!rNrr)rrUr_public_add_method_name)r*rs` r_add_public_adderz#_BaseChildElement._add_public_adder`s;   #%)%5%5 6  477Cr!c`t|j|ryt|j||y)zbAdd `method` to the target class as `name`, unless `name` is already defined on the class.N)hasattrryr)r*namemethods rrz_BaseChildElement._add_to_classns) 4$$d + !!40r!c$ddlmdfd }|S)zHCallable that creates an empty element of the right type, with no attrs.r) OxmlElementc(jSr2r)rrr*s rnew_child_elementz5_BaseChildElement._creator..new_child_elementzst//0 0r!r)docx.oxml.parserr)r*rrs` @rrz_BaseChildElement._creatorus 1 1! r!c<dfd }djz|_|S)zReturn a function object suitable for the "get" side of the property descriptor. This default getter returns the child element with matching tag name or |None| if not present. cL|jtjSr2)findrrrr*s rget_child_elementz4_BaseChildElement._getter..get_child_elements88Bt//01 1r!z0``<%s>`` child element or |None| if not present.rrrUr*rs` rrz_BaseChildElement._getters( 2 ?AQAQ Q !! r!c d|jzS)Nz _insert_%srrs rrz%_BaseChildElement._insert_method_namedoo--r!c<dfd }djz|_|S)z[Return a function object suitable for the "get" side of a list property descriptor.cL|jtjSr2)findallrrrs rget_child_element_listz>_BaseChildElement._list_getter..get_child_element_lists;;r$"2"234 4r!zPA list containing each of the ``<%s>`` child elements, in the order they appear.rr)r*rs` rrz_BaseChildElement._list_getters+  5 "&"2"2 3 &&%r!c d|jzS)a add_childElement() is public API for a repeating element, allowing new elements to be added to the sequence. May be overridden to provide a friendlier API to clients having domain appropriate parameter names for required attributes. zadd_%srrs rrz)_BaseChildElement._public_add_method_names$//))r!c d|jzSNz _remove_%srrs r_remove_method_namez%_BaseChildElement._remove_method_namerr!c d|jzS)Nz_new_%srrs rrz"_BaseChildElement._new_method_namerr!rY)rr%rTuple[str, ...]r)rr%rzCallable[..., Any])rPz,Callable[[BaseOxmlElement], BaseOxmlElement])rRrSrTrUrmrfrrrrrrrrrrrrrrrrrrrs@rrrs & $ >$;? D9++ D1!!!! .. & &**..++r!rcneZdZdZedZ d dZdZedZe dZ e dZ y) ChoicezZDefines a child element belonging to a group, only one of which may appear as a child.c|jSr2rrs rrzChoice.nsptagnamesr!c||_||_||_|j|j |j |j |jyrx)ry_group_prop_namerrrrr_add_get_or_change_to_method)r*r}group_prop_namers rrfzChoice.populate_class_memberssV( /%     ))+r!crdfd }djz|_jj|y)zZAdd a ``get_or_change_to_x()`` method to the element class for this child element.ct|j}||St|j}|t|j}|}|Sr2)rrz_remove_group_method_namer)rrremove_group_method add_methodr*s rget_or_change_to_childzCChoice._add_get_or_change_to_method..get_or_change_to_childsUC1E  ")#t/M/M"N   ! d&;&;`` child, replacing any other group element if found.Nr)rrUr_get_or_change_to_method_name)r*rs` rr z#Choice._add_get_or_change_to_methods;  X   *& 4==?UVr!c|d|jvr|jjddznd}|j|dS)zDProperty name computed from tag name, e.g. a:schemeClr -> schemeClr.rrGrN)rindex)r*starts rrzzChoice._prop_namesB47$:J:J3J  &&s+a/PQ''r!c d|jzS)Nzget_or_change_to_%srrs rrz$Choice._get_or_change_to_method_names$t66r!c d|jzSr)r rs rrz Choice._remove_group_method_namesd3333r!N)r}r\r r%rrrPr) rRrSrTrUrrrfr rzrrrrYr!rrrs  ,$,,$ ,  ,"W&(( 7744r!rc@eZdZdZdfd Zdfd ZedZxZS)r^z5Defines a required child element for MetaOxmlElement.c.tt| |dy)NrY)rqr^rm)r*rrvs rrmzOneAndOnlyOne.__init__s mT+J;r!cNtt| |||jyrx)rqr^rfrr*r}r~rvs rrfz$OneAndOnlyOne.populate_class_memberss  mT9+yQ r!c<dfd }djz|_|S)XReturn a function object suitable for the "get" side of the property descriptor.c|jtj}|tdjz|S)Nz+required ``<%s>`` child element not present)rrrrrs rrz0OneAndOnlyOne._getter..get_child_elementsCHHR 0 012E}%ADDTDTTLr!z Required ``<%s>`` child element.rrrs` rrzOneAndOnlyOne._getters%  %GIYIY$Y!  r!)rr%r) rRrSrTrUrmrfrrrrs@rr^r^s$?<  ! !r!r^c$eZdZdZdfd ZxZS)r_zYDefines a repeating child element for MetaOxmlElement that must appear at least once.ctt| |||j|j |j |j |jt||yrx) rqr_rfrrrrrdelattrrs rrfz OneOrMore.populate_class_memberssX i5k9M       Y'r!rrRrSrTrUrfrrs@rr_r_ s ((r!r_c$eZdZdZdfd ZxZS)rbz@Defines an optional repeating child element for MetaOxmlElement.ctt| |||j|j |j |j |jt||yrx) rqrbrfrrrrrr!rs rrfz!ZeroOrMore.populate_class_memberssX j$6{IN       Y'r!rr"rs@rrbrbsJ((r!rbc@eZdZdZdfd ZdZdZedZxZ S)rcz6Defines an optional child element for MetaOxmlElement.ctt| |||j|j |j |j |j|jyrx) rqrcrfrrrr_add_get_or_adder _add_removerrs rrfz ZeroOrOne.populate_class_members,sZ i5k9M       r!crdfd }djz|_jj|y)zTAdd a ``get_or_add_x()`` method to the element class for this child element.crt|j}|t|j}|}|Sr2)rrzr)rrrr*s rget_or_add_childz5ZeroOrOne._add_get_or_adder..get_or_add_child:s6C1E}$S$*?*?@ " Lr!z>Return the ``<%s>`` child element, newly added if not present.Nr)rrUr_get_or_add_method_name)r*r+s` rr'zZeroOrOne._add_get_or_adder6s;  M   $  4779IJr!crdfd }djz|_jj|y)zIAdd a ``_remove_x()`` method to the element class for this child element.c<|jjyr2) remove_allrrs r _remove_childz-ZeroOrOne._add_remover.._remove_childIs NN4++ ,r!z#Remove all ``<%s>`` child elements.Nr)rrUrr)r*r0s` rr(zZeroOrOne._add_removerFs4 -"G$JZJZ Z  433]Cr!c d|jzS)Nz get_or_add_%srrs rr,z!ZeroOrOne._get_or_add_method_nameOs00r!r) rRrSrTrUrfr'r(rr,rrs@rrcrc)s+@K D11r!rccjeZdZdZd d dZd fd ZdZdZedZ e dZ e dZ xZ S) rdzeCorrespondes to an ``EG_*`` element group where at most one of its members may appear as a child.c ||_||_yr2)_choicesr)r*choicesrs rrmzZeroOrOneChoice.__init__Xs %r!ctt| |||j|jD])}|j||j |j +|jyrx)rqrdrf_add_choice_getterr4rzr_add_group_remover)r*r}r~choicervs rrfz&ZeroOrOneChoice.populate_class_members\s] ot;KS !mm ZF  ) )+tHXHX Y Z !r!ctt|jdd}t|j|j|y)zAdd a read-only ``{prop_name}`` property to the element class that returns the present member of this group, or |None| if none are present.N)r_choice_getterrryrzrs rr7z"ZeroOrOneChoice._add_choice_getterds.T00$= !!4??I>r!cXdfd }d|_jj|y)zSAdd a ``_remove_eg_x()`` method to the element class for this choice group.cJjD]}|j|yr2)_member_nsptagnamesr/)rtagnamer*s r_remove_choice_groupz@ZeroOrOneChoice._add_group_remover.._remove_choice_groupos$33 (w' (r!z9Remove the current choice group child element if present.Nr)rUr _remove_choice_group_method_name)r*r@s` rr8z"ZeroOrOneChoice._add_group_removerks+ ((c$ 4@@BVWr!c"dfd }d|_|S)rc6|jjSr2)first_child_found_inr>rs rget_group_member_elementz@ZeroOrOneChoice._choice_getter..get_group_member_element{s+3++T-E-EF Fr!zbReturn the child element belonging to this element group, or |None| if no member child is present.r)rU)r*rEs` rr;zZeroOrOneChoice._choice_gettervs  G 4 !(('r!cT|jDcgc]}|jc}Scc}w)zjSequence of namespace-prefixed tagnames, one for each of the member elements of this choice group.)r4r)r*r9s rr>z#ZeroOrOneChoice._member_nsptagnamess"15 >f!!>>>s%c d|jzSrrrs rrAz0ZeroOrOneChoice._remove_choice_group_method_namerr!r)r5zSequence[Choice]rrr)rRrSrTrUrmrfr7r8rr;rr>rArrs@rrdrdTsY&"? X ( (?? ..r!rdcfeZdZdZdZd dZd dZd dZed dZ d fd Z ed dZ xZ S)rzvEffective base class for all custom element classes. Adds standardized behavior to all classes in one place. c`d|jj|jt|fzS)Nz<%s '<%s>' at 0x%0x>)rvrR_nsptagidrs r__repr__zBaseOxmlElement.__repr__s/% NN # # LL tH)   r!cR|D]"}|jt|}| |cSy)z9First child with tag in `tagnames`, or None if not found.N)rr)r*tagnamesr?rs rrDz$BaseOxmlElement.first_child_found_ins3 GIIbk*E   r!cp|j|}||j||S|j||Sr2)rD addpreviousappend)r*elmrN successors rrz%BaseOxmlElement.insert_element_beforesB-D--x8   ! !# &  KK  r!cv|D]4}|jt|}|D]}|j|6y)z>Remove child elements with tagname (e.g. "a:p") in `tagnames`.N)rrremove)r*rNr?matchingrs rr/zBaseOxmlElement.remove_alls> #G||BwK0H! # E" # #r!ct|S)zXML string for this element, suitable for testing purposes. Pretty printed for readability and without an XML declaration at the top. )r rs rrzBaseOxmlElement.xmls %T**r!c.t||tS)zOverride of `lxml` _Element.xpath() method. Provides standard Open XML namespace mapping (`nsmap`) in centralized location. ) namespaces)rqxpathr)r* xpath_strrvs rrZzBaseOxmlElement.xpaths w}Y5}99r!c@tj|jSr2)rfrom_clark_namerrs rrJzBaseOxmlElement._nsptags#33DHH==r!)rNr%rPz_Element | None)rRrrNr%)rNr%rPr)rPr%)r[r%rPr) rRrSrTrUrLrDrr/rrrZrJrrs@rrrsI  #++:>>r!r) metaclass)rr)0rU __future__rrVtypingrrrrrr r r r lxmlr lxml.etreerrdocx.oxml.exceptionsr docx.oxml.nsrrr docx.sharedrdocx.enum.baserdocx.oxml.simpletypesrr r%rrZtyper\ror`rarrr^r_rbrcrdrrYr!rrisF"    ,088$*4:):)z T]7d7$(<(e''?5>r!