o hrc@sdZddlmZddlZddlmZmZmZmZm Z m Z ddl m Z ddl mZmZddlmZddlmZmZmZdd lmZerNdd lmZdd lmZd,ddZGdddeZe dZGddde 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*e je!d+Z,dS)-z?Enabling declarative definition of lxml custom element classes.) annotationsN) TYPE_CHECKINGAnyCallableSequenceTypeTypeVar)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)rxmlrR/var/www/html/premium_crap/venv/lib/python3.10/site-packages/docx/oxml/xmlchemy.pyserialize_for_readingsrc@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)selfrlines lines_otherline line_otherrrr__eq__+s  zXmlString.__eq__cCs || SN)r,)r'rrrr__ne__7 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'r0attr_lstrrr _attr_seq:szXmlString._attr_seqr*line_2c Cs\||\}}}}||\}}} } ||krdS||||kr$dS|| kr*dS|| kS)zZReturn True if the element in `line_2` is XML equivalent to the element in `line`.F) _parse_liner6) r'r*r7frontr0closetextfront_2attrs_2close_2text_2rrrr&CszXmlString._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)rArArAcsg|]}|qSr)group).0nmatchrr Vsz)XmlString._parse_line..)_xml_elm_line_pattrFrange)clsr*r9r0r:r;rrErr8Ps   zXmlString._parse_lineN)rrrr )r0r"rr1)r*r"r7r")r*r"rr@) __name__ __module__ __qualname____doc__recompilerJr,r.r6r& classmethodr8rrrrrs    r_Tc@seZdZdZd dd Zd S) MetaOxmlElementzMetaclass for BaseOxmlElement.clsnamer"basestuple[type, ...] namespacedict[str, Any]cCs>tttttttf}|D]\}}t||r| ||q dSr-) OneAndOnlyOne OneOrMoreOptionalAttributeRequiredAttribute ZeroOrMore ZeroOrOneZeroOrOneChoiceitemsr!populate_class_members)rLrVrWrY dispatchablekeyvaluerrr__init__`s  zMetaOxmlElement.__init__N)rVr"rWrXrYrZ)rMrNrOrPrgrrrrrU]srUcs\eZdZdZdfdd Zdd dZddZeddZedddZ edddZ Z S) BaseAttributezZBase class for OptionalAttribute and RequiredAttribute. Provides common methods. attr_namer" simple_type(Type[BaseXmlEnum] | Type[BaseSimpleType]ctt|||_||_dSr-)superrhrg _attr_name _simple_type)r'rirj __class__rrrgu zBaseAttribute.__init__ element_clsrU prop_namerNonecCs||_||_|dSz-Add the appropriate methods to `element_cls`.N) _element_cls _prop_name_add_attr_propertyr'rsrtrrrrczs 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_settersetattrrwrxr' property_rrrrysz BaseAttribute._add_attr_propertycCsd|jvr t|jS|jS)N:)rnrr'rrr _clark_names  zBaseAttribute._clark_name'Callable[[BaseOxmlElement], Any | None]cCdSr-rrrrrr|szBaseAttribute._getter-Callable[[BaseOxmlElement, Any | None], None]cCrr-rrrrrr}szBaseAttribute._setter)rir"rjrkrsrUrtr"rrurr)rr) rMrNrOrPrgrcryr{rr|r} __classcell__rrrprrhos   rhcsNeZdZdZ 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. Nrir"rjrkdefault0BaseXmlEnum | BaseSimpleType | str | bool | Nonecstt|||||_dSr-)rmr]rg_default)r'rirjrrprrrgs 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.rorMrnrrrr _docstrings zOptionalAttribute._docstringrrcdfdd }j|_|S) zJFunction suitable for `__get__()` method on attribute property descriptor.objBaseOxmlElementr Any | Nonecs&|j}|dur jSj|Sr-)getrrrofrom_xmlrattr_str_valuerrrget_attr_values  z1OptionalAttribute._getter..get_attr_valueNrrrrrrPr'rrrrr|szOptionalAttribute._getter&Callable[[BaseOxmlElement, Any], None]cdfdd }|S) zJFunction suitable for `__set__()` method on attribute property descriptor.rrrfrcsl|dus |jkrj|jvr|jj=dSj|}|dur-j|jvr+|jj=dS|j|dSr-)rrattribroto_xmlsetrrf str_valuerrrset_attr_values     z1OptionalAttribute._setter..set_attr_valueN)rrrfrrr'rrrrr}s zOptionalAttribute._setterr-)rir"rjrkrrrrr) rMrNrOrPrgr{rr|r}rrrrprr]s   r]c@s8eZdZdZeddZed ddZed d d Zd S)r^aDefines 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.rrrrcs4|j}|durtdj|jfj|S)Nz1required '%s' attribute not present on element %s)rrr rntagrorrrrrrs  z1RequiredAttribute._getter..get_attr_valueNrrrrrrr|szRequiredAttribute._getterrcr) zIfunction object suitable for "set" side of attribute property descriptor.rrrfrcs6j|}|durtd|d|j|dS)Nzcannot assign z to this required attribute)ror ValueErrorrrrrrrrs z1RequiredAttribute._setter..set_attr_valueN)rrrfrrrrrrr}szRequiredAttribute._setterN)rrr)rMrNrOrPr{rr|r}rrrrr^s  r^cseZdZdZd2d3fdd 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, ...]crlr-)rmrrg _nsptagname _successors)r'rrrprrrgrrz_BaseChildElement.__init__rsrUrtrrucCs||_||_dS)zFBaseline behavior for adding the appropriate methods to `element_cls`.N)rwrxrzrrrrcs z(_BaseChildElement.populate_class_memberscs,d fdd }dj|_j|dS) zGAdd an ``_add_x()`` method to the element class for this child element.rrr0rcsHt|j}|}|D] \}}t|||q t|j}|||Sr-)getattr_new_method_namerbr~_insert_method_name)rr0 new_methodchildrerf insert_methodrrr _add_childs  z0_BaseChildElement._add_adder.._add_childSAdd a new ``<%s>`` child element unconditionally, inserted in the correct sequence.N)rrr0r)rrP _add_to_class_add_method_name)r'rrrr _add_adders  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)_creatorrrPrr)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|r~rwrxrrrr _add_getter5z_BaseChildElement._add_gettercs,dfdd }dj|_j|dS) zJAdd an ``_insert_x()`` method to the element class for this child element.rrrcs|j|gjR|Sr-)insert_element_beforerrrrrr _insert_child?sz6_BaseChildElement._add_inserter.._insert_childzYReturn the passed ``<%s>`` element after inserting it as a child in the correct sequence.N)rrrr)rrPrr)r'rrrr _add_inserter<s 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)rxr{ _list_getterr~rw)r'rtrrrr_add_list_getterIs z"_BaseChildElement._add_list_gettercC d|jS)Nz_add_%srxrrrrrP z"_BaseChildElement._add_method_namec,dfdd }dj|_j|dS)z.add_childrNrr)rrPr_public_add_method_name)r'rrrr_add_public_adderTs 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)hasattrrwr~)r'rrrrrrbs 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 jSr-rrrr'rrnew_child_elementns z5_BaseChildElement._creator..new_child_elementNr)docx.oxml.parserr)r'rrrrris 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|tjSr-)findrrrrrrget_child_element|z4_BaseChildElement._getter..get_child_elementz0``<%s>`` child element or |None| if not present.NrrrPr'rrrrr|ss 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.rrcrr-)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)rr)rMrNrOrPrgrcrrrrrrrrrr{rr|rrrrrrrrrprrs6           rc@sReZdZdZeddZdd d ZddZeddZe ddZ e ddZ dS)ChoicezVDefines a child element belonging to a group, only one of which may appear as a child.cCs|jSr-rrrrrrszChoice.nsptagnamersrUgroup_prop_namer"rrrrucCs>||_||_||_|||||dSrv)rw_group_prop_namerrrrr_add_get_or_change_to_method)r'rsrrrrrrcs 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}|}|Sr-)rrx_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)rrPr_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.rrHrN)rindex)r'startrrrrxszChoice._prop_namecCr)Nzget_or_change_to_%srrrrrrrz$Choice._get_or_change_to_method_namecCrr)rrrrrrrz Choice._remove_group_method_nameN)rsrUrr"rrrru) rMrNrOrPr{rrcrrxrrrrrrrrs    rcs<eZdZdZdfdd Zdfd d Zed dZZS)r[z5Defines a required child element for MetaOxmlElement.rr"cstt||ddS)Nr)rmr[rg)r'rrprrrgszOneAndOnlyOne.__init__rsrUrtrrucstt||||dSrv)rmr[rcrrzrprrrcs 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)rrrr rrrrrs z0OneAndOnlyOne._getter..get_child_elementz Required ``<%s>`` child element.Nrrrrrrr|s zOneAndOnlyOne._getter)rr"r) rMrNrOrPrgrcr{r|rrrrprr[s r[c"eZdZdZd fdd ZZS) r\zYDefines a repeating child element for MetaOxmlElement that must appear at least once.rsrUrtr"rrucHtt||||||||t||dSrv) rmr\rcrrrrrdelattrrzrprrrcz OneOrMore.populate_class_membersrrMrNrOrPrcrrrrprr\sr\cr) r_z@Defines an optional repeating child element for MetaOxmlElement.rsrUrtr"rrucrrv) rmr_rcrrrrrrrzrprrrcrz!ZeroOrMore.populate_class_membersrrrrrprr_sr_cs>eZdZdZdfdd Zd d Zd d ZeddZZ S)r`z6Defines an optional child element for MetaOxmlElement.rsrUrtr"rrucsFtt|||||||||dSrv) rmr`rcrrrr_add_get_or_adder _add_removerrzrprrrcs 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}|}|Sr-)rrxr)rrrrrrget_or_add_child-s  z5ZeroOrOne._add_get_or_adder..get_or_add_childz>Return the ``<%s>`` child element, newly added if not present.Nr)rrPr_get_or_add_method_name)r'rrrrr)s zZeroOrOne._add_get_or_addercr)zIAdd a ``_remove_x()`` method to the element class for this child element.rrcs|jdSr-) remove_allrrrrr _remove_child<rz-ZeroOrOne._add_remover.._remove_childz#Remove all ``<%s>`` child elements.Nr)rrPrr)r'rrrrr9s zZeroOrOne._add_removercCr)Nz get_or_add_%srrrrrrBrz!ZeroOrOne._get_or_add_method_namer) rMrNrOrPrcrrrrrrrrprr`s  r`csbeZdZdZddddZdfdd ZddZddZeddZ e ddZ e ddZ Z S)razeCorrespondes to an ``EG_*`` element group where at most one of its members may appear as a child.rchoicesSequence[Choice]rrcCs||_||_dSr-)_choicesr)r'rrrrrrgKs zZeroOrOneChoice.__init__rsrUrtr"rrucsDtt|||||jD] }|||j|jq|dSrv)rmrarc_add_choice_getterrrxr_add_group_remover)r'rsrtchoicerprrrcOs   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_getterr~rwrxrrrrrWrz"ZeroOrOneChoice._add_choice_gettercs&dfdd }d|_j|dS)zSAdd a ``_remove_eg_x()`` method to the element class for this choice group.rrcsjD]}||qdSr-)_member_nsptagnamesr)rtagnamerrr_remove_choice_groupbs  z@ZeroOrOneChoice._add_group_remover.._remove_choice_groupz9Remove the current choice group child element if present.Nr)rPr _remove_choice_group_method_name)r'rrrrr^sz"ZeroOrOneChoice._add_group_removercsdfdd }d|_|S)rrrcs |jjSr-)first_child_found_inrrrrrget_group_member_elementnr/z@ZeroOrOneChoice._choice_getter..get_group_member_elementzbReturn the child element belonging to this element group, or |None| if no member child is present.Nr)rP)r'rrrrriszZeroOrOneChoice._choice_gettercCsdd|jDS)zjSequence of namespace-prefixed tagnames, one for each of the member elements of this choice group.cSsg|]}|jqSr)r)rCrrrrrG{sz7ZeroOrOneChoice._member_nsptagnames..)rrrrrrwsz#ZeroOrOneChoice._member_nsptagnamescCrrrrrrrr}rz0ZeroOrOneChoice._remove_choice_group_method_namer)rrrrr)rMrNrOrPrgrcrrr{rrrrrrrrprraGs   racsdeZdZdZddZddd 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>)rqrM_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'r rrrrrrs z$BaseOxmlElement.first_child_found_inelmr cGs.|j|}|dur|||S|||Sr-)r addpreviousappend)r'rr  successorrrrrs   z%BaseOxmlElement.insert_element_beforerucGs0|D]}|t|}|D]}||q qdS)z>Remove child elements with tagname (e.g. "a:p") in `tagnames`.N)rrremove)r'r rmatchingrrrrrs  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)rmxpathr)r'rrprrrszBaseOxmlElement.xpathcCs t|jSr-)r from_clark_namerrrrrr s zBaseOxmlElement._nsptag)r r"rr )rr r r")r r"rru)rr")rr"rr) rMrNrOrPr rrrr{rrr rrrrprrs    r) metaclass)rr )-rP __future__rrQtypingrrrrrrlxmlr lxml.etreer r docx.oxml.exceptionsr docx.oxml.nsr rr docx.sharedrdocx.enum.baserdocx.oxml.simpletypesrrr"rrTtyperUrhr]r^rrr[r\r_r`rarrrrrs8         ;+?/":+<