U cqe e@sdZddlmZddlZddlmZmZmZmZm Z m Z m Z m Z m Z ddlmZddlmZmZddlmZddlmZmZmZdd lmZerdd lmZdd lmZd d 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)BaseSimpleTyper )elementcCstj|ddd}t|S)z[Serialize `element` to human-readable XML suitable for tests. No XML declaration. unicodeT)encodingZ pretty_print)r tostring XmlString)rxmlr6/tmp/pip-unpacked-wheel-gx5hpqp3/docx/oxml/xmlchemy.pyserialize_for_reading src@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<dSqbsz)XmlString._parse_line..)_xml_elm_line_pattr>range)clsr+r6r/r7r8rr=rr5\s   zXmlString._parse_lineN) __name__ __module__ __qualname____doc__recompilerBr,r.r3r( classmethodr5rrrrr)s   r_Tc@s"eZdZdZddddddZdS) MetaOxmlElementzMetaclass for BaseOxmlElement.r$zTuple[type, ...]zDict[str, Any])clsnamebases namespacecCs>tttttttf}|D]\}}t||r| ||qdSr-) OneAndOnlyOne OneOrMoreOptionalAttributeRequiredAttribute ZeroOrMore ZeroOrOneZeroOrOneChoiceitemsr#populate_class_members)rDrNrOrPZ dispatchablekeyvaluerrr__init__ls  zMetaOxmlElement.__init__N)rErFrGrHr\rrrrrMisrMcsreZdZdZdddfdd 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-)superr]r\ _attr_name _simple_type)r)r_r` __class__rrr\szBaseAttribute.__init__rMNone element_cls prop_namer"cCs||_||_|dSz-Add the appropriate methods to `element_cls`.N) _element_cls _prop_name_add_attr_propertyr)rhrirrrrYsz$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_settersetattrrkrlr) property_rrrrmsz BaseAttribute._add_attr_propertycCsd|jkrt|jS|jS)N:)rbrr)rrr _clark_names  zBaseAttribute._clark_name'Callable[[BaseOxmlElement], Any | None]r"cCsdSr-rrvrrrrpszBaseAttribute._getterz-Callable[[BaseOxmlElement, Any | None], None]cCsdSr-rrvrrrrqszBaseAttribute._setter) rErFrGrHr\rYrmrorwrprq __classcell__rrrdrr]{s   r]cs\eZdZdZdddddfdd Zed d Zed d d dZedd ddZZ S)rSaDefines 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^z#BaseXmlEnum | BaseSimpleType | None)r_r`defaultcstt|||||_dSr-)rarSr\_default)r)r_r`r{rdrrr\szOptionalAttribute.__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.rcrErbrvrrr _docstringszOptionalAttribute._docstringrxrycs dddfdd }j|_|S)zJFunction suitable for `__get__()` method on attribute property descriptor.BaseOxmlElement Any | Noneobjr"cs&|j}|dkrjSj|Sr-)getrwr|rcfrom_xmlrZattr_str_valuervrrget_attr_values z1OptionalAttribute._getter..get_attr_valuer~rHr)rrrvrrpszOptionalAttribute._getter&Callable[[BaseOxmlElement, Any], None]csdddfdd }|S)zJFunction suitable for `__set__()` method on attribute property descriptor.rrrr[csl|dks|jkr,j|jkr(|jj=dSj|}|dkrZj|jkrV|jj=dS|j|dSr-)r|rwattribrcto_xmlsetrr[Z str_valuervrrset_attr_values     z1OptionalAttribute._setter..set_attr_valuerr)rrrvrrqs zOptionalAttribute._setter)N) rErFrGrHr\ror~rprqrzrrrdrrSs   rSc@s@eZdZdZeddZeddddZeddd d Zd S) rTaDefines 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.r}rvrrrr~szRequiredAttribute._docstringz Callable[[BaseOxmlElement], Any]rycs dddfdd }j|_|S)zDfunction object suitable for "get" side of attr property descriptor.rrrcs4|j}|dkr(tdj|jfj|S)Nz1required '%s' attribute not present on element %s)rrwrrbtagrcrrrvrrrs  z1RequiredAttribute._getter..get_attr_valuerrrrvrrps zRequiredAttribute._getterrcsdddfdd }|S)zIfunction object suitable for "set" side of attribute property descriptor.rrrcs6j|}|dkr$td|d|j|dS)Nzcannot assign z to this required attribute)rcr ValueErrorrrwrrvrrrs z1RequiredAttribute._setter..set_attr_valuerrrrvrrqszRequiredAttribute._setterN)rErFrGrHror~rprqrrrrrTs  rTcseZdZdZd/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-)rarr\ _nsptagname _successors)r)rrrdrrr\"sz_BaseChildElement.__init__rMrfrgcCs||_||_dS)zFBaseline behavior for adding the appropriate methods to `element_cls`.N)rkrlrnrrrrY'sz(_BaseChildElement.populate_class_memberscs2dddfdd }dj|_j|dS)zGAdd an ``_add_x()`` method to the element class for this child element.rr)rr/csHt|j}|}|D]\}}t|||qt|j}|||Sr-)getattr_new_method_namerXrr_insert_method_name)rr/Z new_methodchildrZr[Z insert_methodrvrr _add_child1s  z0_BaseChildElement._add_adder.._add_childSAdd a new ``<%s>`` child element unconditionally, inserted in the correct sequence.N)rrH _add_to_class_add_method_name)r)rrrvr _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)_creatorrrHrr)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)rorprrrkrlrsrrr _add_getterJsz_BaseChildElement._add_gettercs2dddfdd }dj|_j|dS)zJAdd an ``_insert_x()`` method to the element class for this child element.rrrcs|j|fj|Sr-)insert_element_beforerrrvrr _insert_childTsz6_BaseChildElement._add_inserter.._insert_childzYReturn the passed ``<%s>`` element after inserting it as a child in the correct sequence.N)rrHrr)r)rrrvr _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)rlro _list_getterrrrk)r)rirtrrr_add_list_getter^s z"_BaseChildElement._add_list_gettercCs d|jS)Nz_add_%srlrvrrrresz"_BaseChildElement._add_method_namecs0ddfdd }dj|_j|dS)z.add_childrN)rrHr_public_add_method_name)r)rrrvr_add_public_adderis 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)hasattrrkrr)r)rrrrrrws z_BaseChildElement._add_to_classz,Callable[[BaseOxmlElement], BaseOxmlElement]rycs$ddlmddfdd }|S)zHCallable that creates an empty element of the right type, with no attrs.r) OxmlElementrrcs jSr-rrrr)rrnew_child_elementsz5_BaseChildElement._creator..new_child_element)Zdocx.oxml.parserr)r)rrrrr~s 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. rrcs|tjSr-)findrrrrvrrget_child_elementsz4_BaseChildElement._getter..get_child_elementz0``<%s>`` child element or |None| if not present.rrHr)rrrvrrps z_BaseChildElement._gettercCs d|jS)Nz _insert_%srrvrrrrsz%_BaseChildElement._insert_method_namecs"ddfdd }dj|_|S)z[Return a function object suitable for the "get" side of a list property descriptor.rrcs|tjSr-)findallrrrrvrrget_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)rrrvrrs 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_%srrvrrrrsz)_BaseChildElement._public_add_method_namecCs d|jSNz _remove_%srrvrrr_remove_method_namesz%_BaseChildElement._remove_method_namecCs d|jS)Nz_new_%srrvrrrrsz"_BaseChildElement._new_method_name)r)rErFrGrHr\rYrrrrrrrrrrorrprrrrrrzrrrdrrs4         rc@s\eZdZdZeddZdddddd d Zd d Zed dZe ddZ e ddZ dS)ChoicezZDefines a child element belonging to a group, only one of which may appear as a child.cCs|jSr-rrvrrrrszChoice.nsptagnamerMr$rrf)rhgroup_prop_namerr"cCs>||_||_||_|||||dSrj)rk_group_prop_namerrrrr_add_get_or_change_to_method)r)rhrrrrrrYszChoice.populate_class_memberscs0ddfdd }dj|_j|dS)zZAdd a ``get_or_change_to_x()`` method to the element class for this child element.rrcs@t|j}|dk r|St|j}|t|j}|}|Sr-)rrl_remove_group_method_namer)rrZremove_group_method add_methodrvrrget_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)rrHr_get_or_change_to_method_name)r)rrrvrrs  z#Choice._add_get_or_change_to_methodcCs,d|jkr|jddnd}|j|dS)zDProperty name computed from tag name, e.g. a:schemeClr -> schemeClr.rur@rN)rindex)r)startrrrrlszChoice._prop_namecCs d|jS)Nzget_or_change_to_%srrvrrrrsz$Choice._get_or_change_to_method_namecCs d|jSr)rrvrrrrsz Choice._remove_group_method_nameN) rErFrGrHrorrYrrlrrrrrrrrs   rcsHeZdZdZddfdd Zddddfd d Zed d ZZS) rQz5Defines a required child element for MetaOxmlElement.r$rcstt||ddS)Nr)rarQr\)r)rrdrrr\szOneAndOnlyOne.__init__rMrfrgcstt||||dSrj)rarQrYrrnrdrrrYsz$OneAndOnlyOne.populate_class_memberscs"ddfdd }dj|_|S)XReturn a function object suitable for the "get" side of the property descriptor.rrcs*|tj}|dkr&tdj|S)Nz+required ``<%s>`` child element not present)rrrrrrvrrr s z0OneAndOnlyOne._getter..get_child_elementz Required ``<%s>`` child element.rrrrvrrps zOneAndOnlyOne._getter) rErFrGrHr\rYrorprzrrrdrrQs rQcs*eZdZdZddddfdd ZZS)rRzYDefines a repeating child element for MetaOxmlElement that must appear at least once.rMr$rfrgcsHtt||||||||t||dSrj) rarRrYrrrrrdelattrrnrdrrrYsz OneOrMore.populate_class_membersrErFrGrHrYrzrrrdrrRsrRcs*eZdZdZddddfdd ZZS)rUz@Defines an optional repeating child element for MetaOxmlElement.rMr$rfrgcsHtt||||||||t||dSrj) rarUrYrrrrrrrnrdrrrY-sz!ZeroOrMore.populate_class_membersrrrrdrrU*srUcsFeZdZdZddddfdd Zdd Zd d Zed d ZZ S)rVz6Defines an optional child element for MetaOxmlElement.rMr$rfrgcsFtt|||||||||dSrj) rarVrYrrrr_add_get_or_adder _add_removerrnrdrrrY=sz ZeroOrOne.populate_class_memberscs0ddfdd }dj|_j|dS)zTAdd a ``get_or_add_x()`` method to the element class for this child element.rrcs*t|j}|dkr&t|j}|}|Sr-)rrlr)rrrrvrrget_or_add_childMs   z5ZeroOrOne._add_get_or_adder..get_or_add_childz>Return the ``<%s>`` child element, newly added if not present.N)rrHr_get_or_add_method_name)r)rrrvrrIs zZeroOrOne._add_get_or_addercs0ddfdd }dj|_j|dS)zIAdd a ``_remove_x()`` method to the element class for this child element.rrcs|jdSr-) remove_allrrrvrr _remove_child\sz-ZeroOrOne._add_remover.._remove_childz#Remove all ``<%s>`` child elements.N)rrHrr)r)rrrvrrYs zZeroOrOne._add_removercCs d|jS)Nz get_or_add_%srrvrrrrdsz!ZeroOrOne._get_or_add_method_name) rErFrGrHrYrrrrrzrrrdrrV:s   rVcspeZdZdZddddddZdd d d fd d ZddZddZeddZ e ddZ e ddZ Z S)rWzeCorrespondes to an ``EG_*`` element group where at most one of its members may appear as a child.rzSequence[Choice]r)choicesrcCs||_||_dSr-)_choicesr)r)rrrrrr\mszZeroOrOneChoice.__init__rMr$rfrgcsDtt|||||jD]}|||j|jq |dSrj)rarWrY_add_choice_getterrrlr_add_group_remover)r)rhrichoicerdrrrYqs 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)ro_choice_getterrrrkrlrsrrrr}sz"ZeroOrOneChoice._add_choice_gettercs*ddfdd }d|_j|dS)zSAdd a ``_remove_eg_x()`` method to the element class for this choice group.rrcsjD]}||qdSr-)_member_nsptagnamesr)rtagnamervrr_remove_choice_groups z@ZeroOrOneChoice._add_group_remover.._remove_choice_groupz9Remove the current choice group child element if present.N)rHr _remove_choice_group_method_name)r)rrrvrrsz"ZeroOrOneChoice._add_group_removercsddfdd }d|_|S)rrrcs |jjSr-)first_child_found_inrrrvrrget_group_member_elementsz@ZeroOrOneChoice._choice_getter..get_group_member_elementzbReturn the child element belonging to this element group, or |None| if no member child is present.)rH)r)rrrvrrszZeroOrOneChoice._choice_gettercCsdd|jDS)zjSequence of namespace-prefixed tagnames, one for each of the member elements of this choice group.cSsg|] }|jqSrr)r;rrrrr?sz7ZeroOrOneChoice._member_nsptagnames..)rrvrrrrsz#ZeroOrOneChoice._member_nsptagnamescCs d|jSrrrvrrrrsz0ZeroOrOneChoice._remove_choice_group_method_name)r)rErFrGrHr\rYrrrorrrrrzrrrdrrWis    rWcseZdZdZddZdddddZd dd d d Zdd dddZeddddZ dddfdd Z eddddZ 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>)rerE_nsptagidrvrrr__repr__s zBaseOxmlElement.__repr__r$z_Element | None)tagnamesr"cGs,|D]"}|t|}|dk r|SqdS)z9First child with tag in `tagnames`, or None if not found.N)rr)r)rrrrrrrs  z$BaseOxmlElement.first_child_found_inr )elmrcGs,|j|}|dk r||n |||Sr-)rZ addpreviousappend)r)rr successorrrrrs    z%BaseOxmlElement.insert_element_beforerfcGs0|D]&}|t|}|D]}||qqdS)z>Remove child elements with tagname (e.g. "a:p") in `tagnames`.N)rrremove)r)rrZmatchingrrrrrszBaseOxmlElement.remove_allrycCst|S)zXML string for this element, suitable for testing purposes. Pretty printed for readability and without an XML declaration at the top. )rrvrrrrszBaseOxmlElement.xmlr) xpath_strr"cstj|tdS)zOverride of `lxml` _Element.xpath() method. Provides standard Open XML namespace mapping (`nsmap`) in centralized location. ) namespaces)raxpathr)r)rrdrrrszBaseOxmlElement.xpathcCs t|jSr-)rZfrom_clark_namerrvrrrrszBaseOxmlElement._nsptag) rErFrGrHrrrrrorrrrzrrrdrrs r) metaclass)0rH __future__rrItypingrrrrrrr r r lxmlr Z lxml.etreer rZdocx.oxml.exceptionsrZ docx.oxml.nsrrrZ docx.sharedrZdocx.enum.baserZdocx.oxml.simpletypesrrr$rrLtyperMr]rSrTrrrQrRrUrVrWrrrrrs< ,      =1?0$; /B