a ]jrc@sdZddlmZddlZddlmZmZmZmZm Z m Z ddl m Z ddl mZmZddlmZddlmZmZmZdd lmZerdd lmZdd lmZd d 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)BaseSimpleTyper )elementcCstj|ddd}t|S)z[Serialize `element` to human-readable XML suitable for tests. No XML declaration. unicodeT)encodingZ pretty_print)r Ztostring XmlString)rxmlrN/var/www/html/assistant/venv/lib/python3.9/site-packages/docx/oxml/xmlchemy.pyserialize_for_readingsrc@sneZdZdZedZdddddZddddd Zd d d d dZ d d dddZ e d ddddZ dS)rz]Provides string comparison override suitable for serialized XML that is useful for tests.z)( *)([^<]*)?$objectbool)otherreturncCs\t|tsdS|}|}t|t|kr2dSt||D]\}}|||s<dSqVz)XmlString._parse_line..)_xml_elm_line_pattr:range)clsr'r2r+r3r4rr9rr1Ps   zXmlString._parse_lineN) __name__ __module__ __qualname____doc__recompiler?r(r*r/r$ classmethodr1rrrrrs    r_Tc@s"eZdZdZddddddZdS) MetaOxmlElementzMetaclass for BaseOxmlElement.r ztuple[type, ...]zdict[str, Any])clsnamebases namespacecCs>tttttttf}|D]\}}t||r| ||qdSr)) OneAndOnlyOne OneOrMoreOptionalAttributeRequiredAttribute ZeroOrMore ZeroOrOneZeroOrOneChoiceitemsrpopulate_class_members)rArKrLrMZ dispatchablekeyvaluerrr__init__`s  zMetaOxmlElement.__init__N)rBrCrDrErYrrrrrJ]srJcsreZdZdZdddfdd Zdddd d d Zd d ZeddZeddddZ eddddZ Z S) BaseAttributezZBase class for OptionalAttribute and RequiredAttribute. Provides common methods. r (Type[BaseXmlEnum] | Type[BaseSimpleType]) attr_name simple_typecstt|||_||_dSr))superrZrY _attr_name _simple_type)r%r\r] __class__rrrYuszBaseAttribute.__init__rJNone element_cls prop_namercCs||_||_|dSz-Add the appropriate methods to `element_cls`.N) _element_cls _prop_name_add_attr_propertyr%rerfrrrrVzsz$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_settersetattrrhrir% property_rrrrjsz BaseAttribute._add_attr_propertycCsd|jvrt|jS|jS)N:)r_rr%rrr _clark_names  zBaseAttribute._clark_name'Callable[[BaseOxmlElement], Any | None]rcCsdSr)rrsrrrrmszBaseAttribute._getterz-Callable[[BaseOxmlElement, Any | None], None]cCsdSr)rrsrrrrnszBaseAttribute._setter) rBrCrDrErYrVrjrlrtrmrn __classcell__rrrarrZos  rZcs\eZdZdZdddddfdd Zed d Zed d d dZedd ddZZ S)rPaDefines 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. Nr r[z0BaseXmlEnum | BaseSimpleType | str | bool | None)r\r]defaultcstt|||||_dSr))r^rPrY_default)r%r\r]rxrarrrYszOptionalAttribute.__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.r`rBr_rsrrr _docstrings zOptionalAttribute._docstringrurvcs dddfdd }j|_|S)zJFunction suitable for `__get__()` method on attribute property descriptor.BaseOxmlElement Any | Noneobjrcs&|j}|durjSj|Sr))getrtryr`from_xmlrZattr_str_valuersrrget_attr_values z1OptionalAttribute._getter..get_attr_valuer{rEr%rrrsrrmszOptionalAttribute._getter&Callable[[BaseOxmlElement, Any], None]csdddfdd }|S)zJFunction suitable for `__set__()` method on attribute property descriptor.r|r}rrXcsl|dus|jkr,j|jvr(|jj=dSj|}|durZj|jvrV|jj=dS|j|dSr))ryrtZattribr`to_xmlsetrrXZ str_valuersrrset_attr_values     z1OptionalAttribute._setter..set_attr_valuerr%rrrsrrns zOptionalAttribute._setter)N) rBrCrDrErYrlr{rmrnrwrrrarrPs   rPc@s@eZdZdZeddZeddddZeddd d Zd S) rQaDefines 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.rzrsrrrr{szRequiredAttribute._docstringz Callable[[BaseOxmlElement], Any]rvcs dddfdd }j|_|S)zDfunction object suitable for "get" side of attr property descriptor.r|r}r~cs4|j}|dur(tdj|jfj|S)Nz1required '%s' attribute not present on element %s)rrtr r_tagr`rrrsrrrs  z1RequiredAttribute._getter..get_attr_valuerrrrsrrmszRequiredAttribute._getterrcsdddfdd }|S)zIfunction object suitable for "set" side of attribute property descriptor.r|rrcs6j|}|dur$td|d|j|dS)Nzcannot assign z to this required attribute)r`r ValueErrorrrtrrsrrrs z1RequiredAttribute._setter..set_attr_valuerrrrsrrnszRequiredAttribute._setterN)rBrCrDrErlr{rmrnrrrrrQs  rQcseZdZdZd/dddfdd Zddd d d d Zd dZddZddZddZ ddZ e ddZ ddZ dddddZedd d!d"Zed#d$Ze d%d&Zed'd(Ze d)d*Ze d+d,Ze d-d.ZZS)0_BaseChildElementzBase class for the child-element classes. The child-element sub-classes correspond to varying cardinalities, such as ZeroOrOne and ZeroOrMore. rr tuple[str, ...]) nsptagname successorscstt|||_||_dSr))r^rrY _nsptagname _successors)r%rrrarrrYsz_BaseChildElement.__init__rJrcrdcCs||_||_dS)zFBaseline behavior for adding the appropriate methods to `element_cls`.N)rhrirkrrrrVsz(_BaseChildElement.populate_class_memberscs2dddfdd }dj|_j|dS)zGAdd an ``_add_x()`` method to the element class for this child element.r|r)rr+csHt|j}|}|D]\}}t|||qt|j}|||Sr))getattr_new_method_namerUro_insert_method_name)rr+Z new_methodchildrWrXZ insert_methodrsrr _add_childs  z0_BaseChildElement._add_adder.._add_childSAdd a new ``<%s>`` child element unconditionally, inserted in the correct sequence.N)rrE _add_to_class_add_method_name)r%rrrsr _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)_creatorrrErr)r%Zcreatorrrr _add_creator+s z_BaseChildElement._add_creatorcCs"t|jdd}t|j|j|dS)z]Add a read-only ``{prop_name}`` property to the element class for this child element.N)rlrmrorhrirprrr _add_getter5sz_BaseChildElement._add_gettercs2dddfdd }dj|_j|dS)zJAdd an ``_insert_x()`` method to the element class for this child element.r|rrcs|j|gjR|Sr))insert_element_beforerrrsrr _insert_child?sz6_BaseChildElement._add_inserter.._insert_childzYReturn the passed ``<%s>`` element after inserting it as a child in the correct sequence.N)rrErr)r%rrrsr _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)rirl _list_getterrorh)r%rfrqrrr_add_list_getterIs z"_BaseChildElement._add_list_gettercCs d|jS)Nz_add_%srirsrrrrPsz"_BaseChildElement._add_method_namecs0ddfdd }dj|_j|dS)z.add_childrN)rrEr_public_add_method_name)r%rrrsr_add_public_adderTs z#_BaseChildElement._add_public_adderzCallable[..., Any])namemethodcCs"t|j|rdSt|j||dS)zbAdd `method` to the target class as `name`, unless `name` is already defined on the class.N)hasattrrhro)r%rrrrrrbs z_BaseChildElement._add_to_classz,Callable[[BaseOxmlElement], BaseOxmlElement]rvcs$ddlmddfdd }|S)zHCallable that creates an empty element of the right type, with no attrs.r) OxmlElementr|rcs jSr)rrrr%rrnew_child_elementnsz5_BaseChildElement._creator..new_child_element)Zdocx.oxml.parserr)r%rrrrris z_BaseChildElement._creatorcs"ddfdd }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. r|rcs|tjSr))findrrrrsrrget_child_element|sz4_BaseChildElement._getter..get_child_elementz0``<%s>`` child element or |None| if not present.rrEr%rrrsrrmss z_BaseChildElement._gettercCs d|jS)Nz _insert_%srrsrrrrsz%_BaseChildElement._insert_method_namecs"ddfdd }dj|_|S)z[Return a function object suitable for the "get" side of a list property descriptor.r|rcs|tjSr))findallrrrrsrrget_child_element_listsz>_BaseChildElement._list_getter..get_child_element_listzPA list containing each of the ``<%s>`` child elements, in the order they appear.r)r%rrrsrrs z_BaseChildElement._list_gettercCs d|jS)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_%srrsrrrrsz)_BaseChildElement._public_add_method_namecCs d|jSNz _remove_%srrsrrr_remove_method_namesz%_BaseChildElement._remove_method_namecCs d|jS)Nz_new_%srrsrrrrsz"_BaseChildElement._new_method_name)r)rBrCrDrErYrVrrrrrrrrrrlrrmrrrrrrwrrrarrs4         rc@s\eZdZdZeddZdddddd d Zd d Zed dZe ddZ e ddZ dS)ChoicezVDefines a child element belonging to a group, only one of which may appear as a child.cCs|jSr)rrsrrrrszChoice.nsptagnamerJr rrc)regroup_prop_namerrcCs>||_||_||_|||||dSrg)rh_group_prop_namerrrrr_add_get_or_change_to_method)r%rerrrrrrVszChoice.populate_class_memberscs0ddfdd }dj|_j|dS)zZAdd a ``get_or_change_to_x()`` method to the element class for this child element.r|rcs@t|j}|dur|St|j}|t|j}|}|Sr))rri_remove_group_method_namer)rrZremove_group_method add_methodrsrrget_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.N)rrEr_get_or_change_to_method_name)r%rrrsrrs  z#Choice._add_get_or_change_to_methodcCs,d|jvr|jddnd}|j|dS)zDProperty name computed from tag name, e.g. a:schemeClr -> schemeClr.rrr=rN)rindex)r%startrrrriszChoice._prop_namecCs d|jS)Nzget_or_change_to_%srrsrrrrsz$Choice._get_or_change_to_method_namecCs d|jSr)rrsrrrrsz Choice._remove_group_method_nameN) rBrCrDrErlrrVrrirrrrrrrrs   rcsHeZdZdZddfdd Zddddfd d Zed d ZZS) rNz5Defines a required child element for MetaOxmlElement.r rcstt||ddS)Nr)r^rNrY)r%rrarrrYszOneAndOnlyOne.__init__rJrcrdcstt||||dSrg)r^rNrVrrkrarrrVsz$OneAndOnlyOne.populate_class_memberscs"ddfdd }dj|_|S)XReturn a function object suitable for the "get" side of the property descriptor.r|rcs*|tj}|dur&tdj|S)Nz+required ``<%s>`` child element not present)rrrr rrsrrrs z0OneAndOnlyOne._getter..get_child_elementz Required ``<%s>`` child element.rrrrsrrms zOneAndOnlyOne._getter) rBrCrDrErYrVrlrmrwrrrarrNs rNcs*eZdZdZddddfdd ZZS)rOzYDefines a repeating child element for MetaOxmlElement that must appear at least once.rJr rcrdcsHtt||||||||t||dSrg) r^rOrVrrrrrdelattrrkrarrrVsz OneOrMore.populate_class_membersrBrCrDrErVrwrrrarrOsrOcs*eZdZdZddddfdd ZZS)rRz@Defines an optional repeating child element for MetaOxmlElement.rJr rcrdcsHtt||||||||t||dSrg) r^rRrVrrrrrrrkrarrrVsz!ZeroOrMore.populate_class_membersrrrrarrRsrRcsFeZdZdZddddfdd Zdd Zd d Zed d ZZ S)rSz6Defines an optional child element for MetaOxmlElement.rJr rcrdcsFtt|||||||||dSrg) r^rSrVrrrr_add_get_or_adder _add_removerrkrarrrVsz ZeroOrOne.populate_class_memberscs0ddfdd }dj|_j|dS)zTAdd a ``get_or_add_x()`` method to the element class for this child element.r|rcs*t|j}|dur&t|j}|}|Sr))rrir)rrrrsrrget_or_add_child-s   z5ZeroOrOne._add_get_or_adder..get_or_add_childz>Return the ``<%s>`` child element, newly added if not present.N)rrEr_get_or_add_method_name)r%rrrsrr)s zZeroOrOne._add_get_or_addercs0ddfdd }dj|_j|dS)zIAdd a ``_remove_x()`` method to the element class for this child element.r|rcs|jdSr)) remove_allrrrsrr _remove_child<sz-ZeroOrOne._add_remover.._remove_childz#Remove all ``<%s>`` child elements.N)rrErr)r%rrrsrr9s zZeroOrOne._add_removercCs d|jS)Nz get_or_add_%srrsrrrrBsz!ZeroOrOne._get_or_add_method_name) rBrCrDrErVrrrrrwrrrarrSs   rScspeZdZdZddddddZdd d d fd d ZddZddZeddZ e ddZ e ddZ Z S)rTzeCorrespondes to an ``EG_*`` element group where at most one of its members may appear as a child.rzSequence[Choice]r)choicesrcCs||_||_dSr))_choicesr)r%rrrrrrYKszZeroOrOneChoice.__init__rJr rcrdcsDtt|||||jD]}|||j|jq |dSrg)r^rTrV_add_choice_getterrrir_add_group_remover)r%rerfchoicerarrrVOs  z&ZeroOrOneChoice.populate_class_memberscCs"t|jdd}t|j|j|dS)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)rl_choice_getterrorhrirprrrrWsz"ZeroOrOneChoice._add_choice_gettercs*ddfdd }d|_j|dS)zSAdd a ``_remove_eg_x()`` method to the element class for this choice group.r|rcsjD]}||qdSr))_member_nsptagnamesr)rtagnamersrr_remove_choice_groupbs z@ZeroOrOneChoice._add_group_remover.._remove_choice_groupz9Remove the current choice group child element if present.N)rEr _remove_choice_group_method_name)r%rrrsrr^sz"ZeroOrOneChoice._add_group_removercsddfdd }d|_|S)rr|rcs |jjSr))first_child_found_inrrrsrrget_group_member_elementnsz@ZeroOrOneChoice._choice_getter..get_group_member_elementzbReturn the child element belonging to this element group, or |None| if no member child is present.)rE)r%rrrsrriszZeroOrOneChoice._choice_gettercCsdd|jDS)zjSequence of namespace-prefixed tagnames, one for each of the member elements of this choice group.cSsg|] }|jqSrr)r7rrrrr;{r<z7ZeroOrOneChoice._member_nsptagnames..)rrsrrrrwsz#ZeroOrOneChoice._member_nsptagnamescCs d|jSrrrsrrrr}sz0ZeroOrOneChoice._remove_choice_group_method_name)r)rBrCrDrErYrVrrrlrrrrrwrrrarrTGs   rTcseZdZdZddZdddddZd dd d d Zdd dddZeddddZ dddfdd Z eddddZ Z S)r|zvEffective 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>)rbrB_nsptagidrsrrr__repr__s zBaseOxmlElement.__repr__r z_Element | None)tagnamesrcGs,|D]"}|t|}|dur|SqdS)z9First child with tag in `tagnames`, or None if not found.N)rr)r%rrrrrrrs  z$BaseOxmlElement.first_child_found_inr )elmrcGs,|j|}|dur||n |||Sr))rZ addpreviousappend)r%rr successorrrrrs    z%BaseOxmlElement.insert_element_beforerccGs0|D]&}|t|}|D]}||qqdS)z>Remove child elements with tagname (e.g. "a:p") in `tagnames`.N)rrremove)r%rrZmatchingrrrrrszBaseOxmlElement.remove_allrvcCst|S)zXML string for this element, suitable for testing purposes. Pretty printed for readability and without an XML declaration at the top. )rrsrrrrszBaseOxmlElement.xmlr) xpath_strrcstj|tdS)zOverride of `lxml` _Element.xpath() method. Provides standard Open XML namespace mapping (`nsmap`) in centralized location. ) namespaces)r^xpathr)r%rrarrrszBaseOxmlElement.xpathcCs t|jSr))r Zfrom_clark_namerrsrrrrszBaseOxmlElement._nsptag) rBrCrDrErrrrrlrrrrwrrrarr|sr|) metaclass)-rE __future__rrFtypingrrrrrrZlxmlr Z lxml.etreer r Zdocx.oxml.exceptionsr Z docx.oxml.nsr rrZ docx.sharedrZdocx.enum.baserZdocx.oxml.simpletypesrrr rrItyperJrZrPrQrrrNrOrRrSrTr|rrrrs6        ;+?/":+<