o 'f e@sdZddlmZddlZddlmZmZmZmZm Z m Z m Z m Z m Z ddlmZddlmZmZddlmZddlmZmZmZdd lmZerTdd lmZdd lmZd,ddZGddde Z!e dZ"Gddde#Z$GdddZ%Gddde%Z&Gddde%Z'GdddZ(Gddde(Z)Gdd d e(Z*Gd!d"d"e(Z+Gd#d$d$e(Z,Gd%d&d&e(Z-Gd'd(d(e(Z.Gd)d*d*eje$d+Z/dS)-z?Enabling declarative definition of lxml custom element classes.) annotationsN) TYPE_CHECKINGAnyCallableDictListSequenceTupleTypeTypeVar)etree) ElementBase_Element)InvalidXmlError)NamespacePrefixedTagnsmapqn) lazyproperty) BaseXmlEnum)BaseSimpleTypeelementr cCstj|ddd}t|S)z[Serialize `element` to human-readable XML suitable for tests. No XML declaration. unicodeT)encoding pretty_print)r tostring XmlString)rxmlrJ/home/ubuntu/flask/venv/lib/python3.10/site-packages/docx/oxml/xmlchemy.pyserialize_for_reading src@sPeZdZdZedZdddZdd d ZdddZ dddZ e dddZ dS)rz]Provides string comparison override suitable for serialized XML that is useful for tests.z)( *)([^<]*)?$otherobjectreturnboolcCs\t|tsdS|}|}t|t|krdSt||D] \}}|||s+dSqdS)NFT) isinstancestr splitlineslenzip _eq_elm_strs)selfr lines lines_otherline line_otherrrr__eq__5s  zXmlString.__eq__cCs || SN)r/)r*r rrr__ne__A zXmlString.__ne__attrsr% List[str]cCs|}|}t|S)zReturn a sequence of attribute strings parsed from `attrs`. Each attribute string is stripped of whitespace on both ends. )stripsplitsorted)r*r3attr_lstrrr _attr_seqDszXmlString._attr_seqr-line_2c Csd||\}}}}||\}}} } ||krdS||||kr$dS|| kr*dS|| kr0dSdS)zZReturn True if the element in `line_2` is XML equivalent to the element in `line`.FT) _parse_liner9) r*r-r:frontr3closetextfront_2attrs_2close_2text_2rrrr)MszXmlString._eq_elm_strsTuple[str, str, str, str]csD|j|dur dSfddtddD\}}}}||||fS)zI(front, attrs, close, text) 4-tuple result of parsing XML element `line`.N)rDrDrDcsg|]}|qSr)group).0nmatchrr bsz)XmlString._parse_line..)_xml_elm_line_pattrIrange)clsr-r<r3r=r>rrHrr;\s   zXmlString._parse_lineN)r r!r"r#)r3r%r"r4)r-r%r:r%)r-r%r"rC) __name__ __module__ __qualname____doc__recompilerMr/r1r9r) classmethodr;rrrrr)s   r_Tc@seZdZdZd dd Zd S) MetaOxmlElementzMetaclass for BaseOxmlElement.clsnamer%basesTuple[type, ...] namespaceDict[str, Any]cCs>tttttttf}|D]\}}t||r| ||q dSr0) OneAndOnlyOne OneOrMoreOptionalAttributeRequiredAttribute ZeroOrMore ZeroOrOneZeroOrOneChoiceitemsr$populate_class_members)rOrYrZr\ dispatchablekeyvaluerrr__init__ls  zMetaOxmlElement.__init__N)rYr%rZr[r\r])rPrQrRrSrjrrrrrXisrXcs\eZdZdZdfdd Zdd dZddZeddZedddZ edddZ Z S) BaseAttributezZBase class for OptionalAttribute and RequiredAttribute. Provides common methods. attr_namer% simple_type(Type[BaseXmlEnum] | Type[BaseSimpleType]ctt|||_||_dSr0)superrkrj _attr_name _simple_type)r*rlrm __class__rrrjs zBaseAttribute.__init__ element_clsrX prop_namer"NonecCs||_||_|dSz-Add the appropriate methods to `element_cls`.N) _element_cls _prop_name_add_attr_propertyr*rurvrrrrfs z$BaseAttribute.populate_class_memberscCs$t|j|jd}t|j|j|dS)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_rrrr{sz BaseAttribute._add_attr_propertycCsd|jvr t|jS|jS)N:)rqrr*rrr _clark_names  zBaseAttribute._clark_name'Callable[[BaseOxmlElement], Any | None]cCdSr0rrrrrr~szBaseAttribute._getter-Callable[[BaseOxmlElement, Any | None], None]cCrr0rrrrrrszBaseAttribute._setter)rlr%rmrnrurXrvr%r"rwr"r)r"r) rPrQrRrSrjrfr{r}rr~r __classcell__rrrsrrk{s    rkcsNeZdZdZ ddfd d Zed d ZedddZedddZZ S)r`aDefines an optional attribute on a custom element class. An optional attribute returns a default value when not present for reading. When assigned |None|, the attribute is removed, but still returns the default value when one is specified. Nrlr%rmrndefault#BaseXmlEnum | BaseSimpleType | Nonecstt|||||_dSr0)rpr`rj_default)r*rlrmrrsrrrjs zOptionalAttribute.__init__cCs|jjd|jdS)z;String to use as `__doc__` attribute of attribute property.z type-converted value of ``z`` attribute, or |None| (or specified default value) if not present. Assigning the default value causes the attribute to be removed from the element.rrrPrqrrrr _docstrings zOptionalAttribute._docstringr"rcdfdd }j|_|S) zJFunction suitable for `__get__()` method on attribute property descriptor.objBaseOxmlElementr" Any | Nonecs&|j}|dur jSj|Sr0)getrrrrfrom_xmlrattr_str_valuerrrget_attr_values  z1OptionalAttribute._getter..get_attr_valueNrrr"rrrSr*rrrrr~szOptionalAttribute._getter&Callable[[BaseOxmlElement, Any], None]cdfdd }|S) zJFunction suitable for `__set__()` method on attribute property descriptor.rrrircsl|dus |jkrj|jvr|jj=dSj|}|dur-j|jvr+|jj=dS|j|dSr0)rrattribrrto_xmlsetrri str_valuerrrset_attr_values     z1OptionalAttribute._setter..set_attr_valueN)rrrirrr*rrrrrs zOptionalAttribute._setterr0)rlr%rmrnrrrr"r) rPrQrRrSrjr}rr~rrrrrsrr`s   r`c@s8eZdZdZeddZed ddZed d d Zd S)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. cCsd|jj|jfS)zaReturn the string to use as the ``__doc__`` attribute of the property for this attribute.z,%s type-converted value of ``%s`` attribute.rrrrrrszRequiredAttribute._docstringr" Callable[[BaseOxmlElement], Any]cr) zDfunction object suitable for "get" side of attr property descriptor.rrr"rcs4|j}|durtdj|jfj|S)Nz1required '%s' attribute not present on element %s)rrrrqtagrrrrrrrrs   z1RequiredAttribute._getter..get_attr_valueNrrrrrrr~s zRequiredAttribute._getterrcr) zIfunction object suitable for "set" side of attribute property descriptor.rrrircs6j|}|durtd|d|j|dS)Nzcannot assign z to this required attribute)rrr ValueErrorrrrrrrrs z1RequiredAttribute._setter..set_attr_valueN)rrrirrrrrrrszRequiredAttribute._setterN)r"rr)rPrQrRrSr}rr~rrrrrras  racseZdZdZd2d3fdd Zd4ddZddZddZddZddZ ddZ e ddZ ddZ d5d!d"Zed6d$d%Zed&d'Ze d(d)Zed*d+Ze d,d-Ze d.d/Ze d0d1ZZS)7_BaseChildElementzBase class for the child-element classes. The child-element sub-classes correspond to varying cardinalities, such as ZeroOrOne and ZeroOrMore. r nsptagnamer% successorsTuple[str, ...]cror0)rprrj _nsptagname _successors)r*rrrsrrrj"s z_BaseChildElement.__init__rurXrvr"rwcCs||_||_dS)zFBaseline behavior for adding the appropriate methods to `element_cls`.N)ryrzr|rrrrf's z(_BaseChildElement.populate_class_memberscs,d fdd }dj|_j|dS) zGAdd an ``_add_x()`` method to the element class for this child element.rrr3rcsHt|j}|}|D] \}}t|||q t|j}|||Sr0)getattr_new_method_namerer_insert_method_name)rr3 new_methodchildrhri insert_methodrrr _add_child1s  z0_BaseChildElement._add_adder.._add_childSAdd a new ``<%s>`` child element unconditionally, inserted in the correct sequence.N)rrr3r)rrS _add_to_class_add_method_name)r*rrrr _add_adder.s  z_BaseChildElement._add_addercCs$|j}d|j|_||j|dS)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)_creatorrrSrr)r*creatorrrr _add_creator@s z_BaseChildElement._add_creatorcC"t|jdd}t|j|j|dS)z]Add a read-only ``{prop_name}`` property to the element class for this child element.N)r}r~rryrzrrrr _add_getterJz_BaseChildElement._add_gettercs,dfdd }dj|_j|dS) zJAdd an ``_insert_x()`` method to the element class for this child element.rrrcs|j|gjR|Sr0)insert_element_beforerrrrrr _insert_childTsz6_BaseChildElement._add_inserter.._insert_childzYReturn the passed ``<%s>`` element after inserting it as a child in the correct sequence.N)rrrr)rrSrr)r*rrrr _add_inserterQs z_BaseChildElement._add_insertercCs*d|j}t|jdd}t|j||dS)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*rvrrrr_add_list_getter^s z"_BaseChildElement._add_list_gettercC d|jS)Nz_add_%srzrrrrre z"_BaseChildElement._add_method_namec,dfdd }dj|_j|dS)z.add_childrNrr)rrSr_public_add_method_name)r*rrrr_add_public_adderis z#_BaseChildElement._add_public_addernamemethodCallable[..., Any]cCs"t|j|rdSt|j||dS)zbAdd `method` to the target class as `name`, unless `name` is already defined on the class.N)hasattrryr)r*rrrrrrws z_BaseChildElement._add_to_class,Callable[[BaseOxmlElement], BaseOxmlElement]cs ddlmdfdd }|S) zHCallable that creates an empty element of the right type, with no attrs.r) OxmlElementrrcs jSr0rrrr*rrnew_child_elements z5_BaseChildElement._creator..new_child_elementNr)docx.oxml.parserr)r*rrrrr~s z_BaseChildElement._creatorcdfdd }dj|_|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. rrc|tjSr0)findrrrrrrget_child_elementz4_BaseChildElement._getter..get_child_elementz0``<%s>`` child element or |None| if not present.NrrrSr*rrrrr~s z_BaseChildElement._gettercCr)Nz _insert_%srrrrrrrz%_BaseChildElement._insert_method_namecr)z[Return a function object suitable for the "get" side of a list property descriptor.rrcrr0)findallrrrrrrget_child_element_listrz>_BaseChildElement._list_getter..get_child_element_listzPA list containing each of the ``<%s>`` child elements, in the order they appear.Nrr)r*rrrrrs z_BaseChildElement._list_gettercCr)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_%srrrrrrs z)_BaseChildElement._public_add_method_namecCrNz _remove_%srrrrr_remove_method_namerz%_BaseChildElement._remove_method_namecCr)Nz_new_%srrrrrrrz"_BaseChildElement._new_method_namer)rr%rrr)rr%rr)r"r)rPrQrRrSrjrfrrrrrrrrrr}rr~rrrrrrrrrsrrs6           rc@sReZdZdZeddZdd d ZddZeddZe ddZ e ddZ dS)ChoicezZDefines a child element belonging to a group, only one of which may appear as a child.cCs|jSr0rrrrrrszChoice.nsptagnamerurXgroup_prop_namer%rrr"rwcCs>||_||_||_|||||dSrx)ry_group_prop_namerrrrr_add_get_or_change_to_method)r*rurrrrrrfs zChoice.populate_class_memberscr)zZAdd a ``get_or_change_to_x()`` method to the element class for this child element.rrcs@t|j}|dur |St|j}|t|j}|}|Sr0)rrz_remove_group_method_namer)rrremove_group_method add_methodrrrget_or_change_to_childs   zCChoice._add_get_or_change_to_method..get_or_change_to_childzFReturn the ``<%s>`` child, replacing any other group element if found.Nr)rrSr_get_or_change_to_method_name)r*rrrrrs  z#Choice._add_get_or_change_to_methodcCs,d|jvr |jddnd}|j|dS)zDProperty name computed from tag name, e.g. a:schemeClr -> schemeClr.rrKrN)rindex)r*startrrrrzszChoice._prop_namecCr)Nzget_or_change_to_%srrrrrrrz$Choice._get_or_change_to_method_namecCrr)rrrrrrrz Choice._remove_group_method_nameN)rurXrr%rrr"rw) rPrQrRrSr}rrfrrzrrrrrrrrs    rcs<eZdZdZdfdd Zdfd d Zed dZZS)r^z5Defines a required child element for MetaOxmlElement.rr%cstt||ddS)Nr)rpr^rj)r*rrsrrrjszOneAndOnlyOne.__init__rurXrvr"rwcstt||||dSrx)rpr^rfrr|rsrrrfs z$OneAndOnlyOne.populate_class_memberscr)XReturn a function object suitable for the "get" side of the property descriptor.rrcs*|tj}|durtdj|S)Nz+required ``<%s>`` child element not present)rrrrrrrrr s z0OneAndOnlyOne._getter..get_child_elementz Required ``<%s>`` child element.Nrrrrrrr~s zOneAndOnlyOne._getter)rr%r) rPrQrRrSrjrfr}r~rrrrsrr^s r^c"eZdZdZd fdd ZZS) r_zYDefines a repeating child element for MetaOxmlElement that must appear at least once.rurXrvr%r"rwcHtt||||||||t||dSrx) rpr_rfrrrrrdelattrr|rsrrrfz OneOrMore.populate_class_membersrrPrQrRrSrfrrrrsrr_sr_cr) rbz@Defines an optional repeating child element for MetaOxmlElement.rurXrvr%r"rwcrrx) rprbrfrrrrrrr|rsrrrf-rz!ZeroOrMore.populate_class_membersrrrrrsrrb*srbcs>eZdZdZdfdd Zd d Zd d ZeddZZ S)rcz6Defines an optional child element for MetaOxmlElement.rurXrvr%r"rwcsFtt|||||||||dSrx) rprcrfrrrr_add_get_or_adder _add_removerr|rsrrrf=s z ZeroOrOne.populate_class_memberscr)zTAdd a ``get_or_add_x()`` method to the element class for this child element.rrcs*t|j}|durt|j}|}|Sr0)rrzr)rrrrrrget_or_add_childMs  z5ZeroOrOne._add_get_or_adder..get_or_add_childz>Return the ``<%s>`` child element, newly added if not present.Nr)rrSr_get_or_add_method_name)r*rrrrrIs zZeroOrOne._add_get_or_addercr)zIAdd a ``_remove_x()`` method to the element class for this child element.rrcs|jdSr0) remove_allrrrrr _remove_child\rz-ZeroOrOne._add_remover.._remove_childz#Remove all ``<%s>`` child elements.Nr)rrSrr)r*rrrrrYs zZeroOrOne._add_removercCr)Nz get_or_add_%srrrrrrdrz!ZeroOrOne._get_or_add_method_namer) rPrQrRrSrfrrrrrrrrsrrc:s  rccsbeZdZdZddddZdfdd ZddZddZeddZ e ddZ e ddZ Z S)rdzeCorrespondes to an ``EG_*`` element group where at most one of its members may appear as a child.rchoicesSequence[Choice]rrcCs||_||_dSr0)_choicesr)r*rrrrrrjms zZeroOrOneChoice.__init__rurXrvr%r"rwcsDtt|||||jD] }|||j|jq|dSrx)rprdrf_add_choice_getterrrzr_add_group_remover)r*rurvchoicersrrrfqs   z&ZeroOrOneChoice.populate_class_memberscCr)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_getterrryrzrrrrr}rz"ZeroOrOneChoice._add_choice_gettercs&dfdd }d|_j|dS)zSAdd a ``_remove_eg_x()`` method to the element class for this choice group.rrcsjD]}||qdSr0)_member_nsptagnamesr)rtagnamerrr_remove_choice_groups  z@ZeroOrOneChoice._add_group_remover.._remove_choice_groupz9Remove the current choice group child element if present.Nr)rSr _remove_choice_group_method_name)r*rrrrrsz"ZeroOrOneChoice._add_group_removercsdfdd }d|_|S)rrrcs |jjSr0)first_child_found_inrrrrrget_group_member_elementr2z@ZeroOrOneChoice._choice_getter..get_group_member_elementzbReturn the child element belonging to this element group, or |None| if no member child is present.Nr)rS)r*r rrrrszZeroOrOneChoice._choice_gettercCsdd|jDS)zjSequence of namespace-prefixed tagnames, one for each of the member elements of this choice group.cSsg|]}|jqSr)r)rFrrrrrJsz7ZeroOrOneChoice._member_nsptagnames..)rrrrrrsz#ZeroOrOneChoice._member_nsptagnamescCrrrrrrrrrz0ZeroOrOneChoice._remove_choice_group_method_namer)rrrrr)rPrQrRrSrjrfrrr}rrrrrrrrsrrdis    rdcsdeZdZdZddZddd Zdd d ZdddZedddZ dfdd Z edddZ Z S)rzvEffective base class for all custom element classes. Adds standardized behavior to all classes in one place. cCsd|jj|jt|fS)Nz<%s '<%s>' at 0x%0x>)rtrP_nsptagidrrrr__repr__s zBaseOxmlElement.__repr__tagnamesr%r"_Element | NonecGs,|D]}|t|}|dur|SqdS)z9First child with tag in `tagnames`, or None if not found.N)rr)r*rrrrrrr s z$BaseOxmlElement.first_child_found_inelmr cGs.|j|}|dur|||S|||Sr0)r  addpreviousappend)r*rr successorrrrrs   z%BaseOxmlElement.insert_element_beforerwcGs0|D]}|t|}|D]}||q qdS)z>Remove child elements with tagname (e.g. "a:p") in `tagnames`.N)rrremove)r*rrmatchingrrrrrs  zBaseOxmlElement.remove_allcCst|S)zXML string for this element, suitable for testing purposes. Pretty printed for readability and without an XML declaration at the top. )rrrrrrszBaseOxmlElement.xml xpath_strrcstj|tdS)zOverride of `lxml` _Element.xpath() method. Provides standard Open XML namespace mapping (`nsmap`) in centralized location. ) namespaces)rpxpathr)r*rrsrrrszBaseOxmlElement.xpathcCs t|jSr0)rfrom_clark_namerrrrrr s zBaseOxmlElement._nsptag)rr%r"r)rr rr%)rr%r"rw)r"r%)rr%r"r) rPrQrRrSr r rrr}rrr rrrrsrrs     r) metaclass)rr )0rS __future__rrTtypingrrrrrrr r r lxmlr lxml.etreer rdocx.oxml.exceptionsr docx.oxml.nsrrr docx.sharedrdocx.enum.baserdocx.oxml.simpletypesrrr%rrWtyperXrkr`rarrr^r_rbrcrdrrrrrs< ,       =1?0$; / B