o W_E`@s\dZddlmZddlmZddlZddlmZddlm Z ddl m Z ddl m Z mZmZdd lmZd d ZGd d d eZGdddeZGdddeZGdddeZGdddeZGdddeZGdddeZGdddeZGdddeZGdddeZGd d!d!eZGd"d#d#eZ Gd$d%d%ej!Z"ed&ej!fe#e"j$Z%dS)'z_ Provides a wrapper around lxml that enables declarative definition of custom element classes. )absolute_import)etreeN)Unicode) OxmlElement)InvalidXmlError)NamespacePrefixedTagnsmapqn) lazypropertycCstj|ddd}t|S)z_ Serialize *element* to human-readable XML suitable for tests. No XML declaration. unicodeT)encodingZ pretty_print)rtostring XmlString)elementxmlrBD:\Projects\ConvertPro\env\Lib\site-packages\docx\oxml\xmlchemy.pyserialize_for_readingsrc@sFeZdZdZedZddZddZddZ d d Z e d d Z d S)rzg Provides string comparison override suitable for serialized XML that is useful for tests. z)( *)([^<]*)?$cCsN|}|}t|t|krdSt||D] \}}|||s$dSqdS)NFT) splitlineslenzip _eq_elm_strs)selfotherlinesZ lines_otherlineZ line_otherrrr__eq__,s zXmlString.__eq__cCs || SN)r)rrrrr__ne__6 zXmlString.__ne__cCs|}|}t|S)z Return a sequence of attribute strings parsed from *attrs*. Each attribute string is stripped of whitespace on both ends. )stripsplitsorted)rattrsZattr_lstrrr _attr_seq9szXmlString._attr_seqc Csd||\}}}}||\}}} } ||krdS||||kr$dS|| kr*dS|| kr0dSdS)zl Return True if the element in *line_2* is XML equivalent to the element in *line*. FT) _parse_liner$) rrZline_2frontr#closetextZfront_2Zattrs_2Zclose_2Ztext_2rrrrBszXmlString._eq_elm_strscs8|j|fddtddD\}}}}||||fS)zo Return front, attrs, close, text 4-tuple result of parsing XML element string *line*. csg|]}|qSr)group).0nmatchrr Zsz)XmlString._parse_line..)_xml_elm_line_pattr-range)clsrr&r#r'r(rr,rr%Ss   zXmlString._parse_lineN) __name__ __module__ __qualname____doc__recompiler1rrr$r classmethodr%rrrrrs   rc@seZdZdZddZdS)MetaOxmlElementz' Metaclass for BaseOxmlElement cCs>tttttttf}|D]\}}t||r| ||q dSr) OneAndOnlyOne OneOrMoreOptionalAttributeRequiredAttribute ZeroOrMore ZeroOrOneZeroOrOneChoiceitems isinstancepopulate_class_members)r3ZclsnamebasesZclsdictZ dispatchablekeyvaluerrr__init__bs  zMetaOxmlElement.__init__N)r4r5r6r7rIrrrrr;^s r;c<eZdZdZfddZddZddZedd ZZ S) BaseAttributez_ Base class for OptionalAttribute and RequiredAttribute, providing common methods. ctt|||_||_dSr)superrKrI _attr_name _simple_type)r attr_name simple_type __class__rrrIq zBaseAttribute.__init__cCs||_||_|dSz? Add the appropriate methods to *element_cls*. N) _element_cls _prop_name_add_attr_propertyr element_cls prop_namerrrrEvs z$BaseAttribute.populate_class_memberscCs$t|j|jd}t|j|j|dS)z Add a read/write ``{prop_name}`` property to the element class that returns the interpreted value of this attribute on access and changes the attribute value to its ST_* counterpart on assignment. N)property_getter_settersetattrrVrWr property_rrrrXsz BaseAttribute._add_attr_propertycCsd|jvr t|jS|jS)N:)rNr rrrr _clark_names  zBaseAttribute._clark_name) r4r5r6r7rIrErXr\rd __classcell__rrrRrrKls   rKcsFeZdZdZd fdd ZeddZeddZed d ZZ S) r>z Defines 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. Ncstt|||||_dSr)rMr>rI_default)rrPrQdefaultrRrrrIs zOptionalAttribute.__init__cfdd}j|_|S)t Return a function object suitable for the "get" side of the attribute property descriptor. cs&|j}|dur jSj|Sr)getrdrfrOfrom_xmlobjZattr_str_valuercrrget_attr_values  z1OptionalAttribute._getter..get_attr_value _docstringr7rrnrrcrr]s zOptionalAttribute._gettercCd|jj|jfS)s Return the string to use as the ``__doc__`` attribute of the property for this attribute. z%s type-converted value of ``%s`` attribute, or |None| (or specified default value) if not present. Assigning the default value causes the attribute to be removed from the element.rOr4rNrcrrrrps zOptionalAttribute._docstringcfdd}|S)t Return a function object suitable for the "set" side of the attribute property descriptor. csJ|dus |jkrj|jvr|jj=dSj|}|j|dSr)rfrdZattribrOto_xmlsetrmrHZ str_valuercrrset_attr_values    z1OptionalAttribute._setter..set_attr_valuerrrzrrcrr^s zOptionalAttribute._setterr) r4r5r6r7rIr\r]rpr^rerrrRrr>s   r>c@s4eZdZdZeddZeddZeddZdS) r?a Defines 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. crh)rics4|j}|durtdj|jfj|S)Nz1required '%s' attribute not present on element %s)rjrdrrNtagrOrkrlrcrrrns   z1RequiredAttribute._getter..get_attr_valuerorqrrcrr]s zRequiredAttribute._gettercCrr)rsz,%s type-converted value of ``%s`` attribute.rtrcrrrrps zRequiredAttribute._docstringcru)rvcsj|}|j|dSr)rOrwrxrdryrcrrrzs z1RequiredAttribute._setter..set_attr_valuerr{rrcrr^s zRequiredAttribute._setterN)r4r5r6r7r\r]rpr^rrrrr?s   r?cseZdZdZd%fdd ZddZddZd d Zd d Zd dZ ddZ e ddZ ddZ ddZeddZeddZe ddZeddZe dd Ze d!d"Ze d#d$ZZS)&_BaseChildElementz Base class for the child element classes corresponding to varying cardinalities, such as ZeroOrOne and ZeroOrMore. rcrLr)rMr}rI _nsptagname _successors)r nsptagname successorsrRrrrIrTz_BaseChildElement.__init__cCs||_||_dS)z` Baseline behavior for adding the appropriate methods to *element_cls*. N)rVrWrYrrrrEs z(_BaseChildElement.populate_class_membersc*fdd}dj|_j|dS)za Add an ``_add_x()`` method to the element class for this child element. csHt|j}|}|D] \}}t|||q t|j}|||Sr)getattr_new_method_namerCr__insert_method_name)rmr#Z new_methodchildrGrHZ insert_methodrcrr _add_child s  z0_BaseChildElement._add_adder.._add_childSAdd a new ``<%s>`` child element unconditionally, inserted in the correct sequence.N)r~r7 _add_to_class_add_method_name)rrrrcr _add_adders  z_BaseChildElement._add_addercCs$|j}d|j|_||j|dS)z Add 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)_creatorr~r7rr)rZcreatorrrr _add_creators z_BaseChildElement._add_creatorcC"t|jdd}t|j|j|dS)zo Add a read-only ``{prop_name}`` property to the element class for this child element. N)r\r]r_rVrWr`rrr _add_getter(sz_BaseChildElement._add_gettercr)zd Add an ``_insert_x()`` method to the element class for this child element. cs|j|gjR|Sr)insert_element_beforerrmrrcrr _insert_child6sz6_BaseChildElement._add_inserter.._insert_childzYReturn the passed ``<%s>`` element after inserting it as a child in the correct sequence.N)r~r7rr)rrrrcr _add_inserter1s z_BaseChildElement._add_insertercCs*d|j}t|jdd}t|j||dS)z Add a read-only ``{prop_name}_lst`` property to the element class to retrieve a list of child elements matching this type. z%s_lstN)rWr\ _list_getterr_rV)rr[rarrr_add_list_getter@s z"_BaseChildElement._add_list_gettercC d|jS)Nz_add_%srWrcrrrrI z"_BaseChildElement._add_method_namecr)zN Add a public ``add_x()`` method to the parent element class. cst|j}|}|Sr)rr)rmZprivate_add_methodrrcrr add_childQs z6_BaseChildElement._add_public_adder..add_childrN)r~r7r_public_add_method_name)rrrrcr_add_public_adderMs z#_BaseChildElement._add_public_addercCs"t|j|rdSt|j||dS)zt Add *method* to the target class as *name*, unless *name* is already defined on the class. N)hasattrrVr_)rnamemethodrrrr\s z_BaseChildElement._add_to_classcru)z} Return a function object that creates a new, empty element of the right type, having no attributes. cs tjSr)rr~rmrcrrnew_child_elementks z5_BaseChildElement._creator..new_child_elementr)rrrrcrres z_BaseChildElement._creatorcfdd}dj|_|S)z Return 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. c|tjSr)findr r~rrcrrget_child_elementvz4_BaseChildElement._getter..get_child_elementz0``<%s>`` child element or |None| if not present.r~r7rrrrcrr]os z_BaseChildElement._gettercCr)Nz _insert_%srrcrrrr~rz%_BaseChildElement._insert_method_namecr)zm Return a function object suitable for the "get" side of a list property descriptor. crr)findallr r~rrcrrget_child_element_listrz>_BaseChildElement._list_getter..get_child_element_listzPA list containing each of the ``<%s>`` child elements, in the order they appear.r)rrrrcrrs 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_%srrcrrrrs z)_BaseChildElement._public_add_method_namecCrNz _remove_%srrcrrr_remove_method_namerz%_BaseChildElement._remove_method_namecCr)Nz_new_%srrcrrrrrz"_BaseChildElement._new_method_namer)r4r5r6r7rIrErrrrrr rrrr\rr]rrrrrrerrrRrr}s6         r}c@sPeZdZdZeddZddZddZedd Ze d d Z e d d Z dS)Choicezd Defines a child element belonging to a group, only one of which may appear as a child. cCs|jSr)r~rcrrrrszChoice.nsptagnamecCs>||_||_||_|||||dSrU)rV_group_prop_namerrrrr_add_get_or_change_to_method)rrZZgroup_prop_namerrrrrEs zChoice.populate_class_memberscr)zl Add a ``get_or_change_to_x()`` method to the element class for this child element. cs@t|j}|dur |St|j}|t|j}|}|Sr)rrW_remove_group_method_namer)rmrZremove_group_method add_methodrcrrget_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)r~r7r_get_or_change_to_method_name)rrrrcrrs  z#Choice._add_get_or_change_to_methodcCs.d|jvr|jdd}nd}|j|dS)zW Calculate property name from tag name, e.g. a:schemeClr -> schemeClr. rbr/rN)r~index)rstartrrrrWs zChoice._prop_namecCr)Nzget_or_change_to_%srrcrrrrrz$Choice._get_or_change_to_method_namecCrr)rrcrrrrrz Choice._remove_group_method_nameN) r4r5r6r7r\rrErrWr rrrrrrrs   rcs8eZdZdZfddZfddZeddZZS)r<z? Defines a required child element for MetaOxmlElement. cstt||ddSr)rMr<rI)rrrRrrrIszOneAndOnlyOne.__init__cstt||||dSrU)rMr<rErrYrRrrrEs  z$OneAndOnlyOne.populate_class_memberscr)j Return a function object suitable for the "get" side of the property descriptor. cs*|tj}|durtdj|S)Nz+required ``<%s>`` child element not present)rr r~rrrcrrrsz0OneAndOnlyOne._getter..get_child_elementz Required ``<%s>`` child element.rrrrcrr]s  zOneAndOnlyOne._getter) r4r5r6r7rIrEr\r]rerrrRrr<s    r<c eZdZdZfddZZS)r=zc Defines a repeating child element for MetaOxmlElement that must appear at least once. cHtt||||||||t||dSrU) rMr=rErrrrrdelattrrYrRrrrE z OneOrMore.populate_class_membersr4r5r6r7rErerrrRrr=sr=cr)r@zJ Defines an optional repeating child element for MetaOxmlElement. crrU) rMr@rErrrrrrrYrRrrrE&rz!ZeroOrMore.populate_class_membersrrrrRrr@"sr@crJ) rAz@ Defines an optional child element for MetaOxmlElement. csFtt|||||||||dSrU) rMrArErrrr_add_get_or_adder _add_removerrYrRrrrE9s z ZeroOrOne.populate_class_memberscr)zf Add a ``get_or_add_x()`` method to the element class for this child element. cs*t|j}|durt|j}|}|Sr)rrWr)rmrrrcrrget_or_add_childJs  z5ZeroOrOne._add_get_or_adder..get_or_add_childz>Return the ``<%s>`` child element, newly added if not present.N)r~r7r_get_or_add_method_name)rrrrcrrEs zZeroOrOne._add_get_or_addercr)zc Add a ``_remove_x()`` method to the element class for this child element. cs|jdSr) remove_allr~rrcrr _remove_childZrz-ZeroOrOne._add_remover.._remove_childz#Remove all ``<%s>`` child elements.N)r~r7rr)rrrrcrrUs zZeroOrOne._add_removercCr)Nz get_or_add_%srrcrrrrarz!ZeroOrOne._get_or_add_method_name) r4r5r6r7rErrr rrerrrRrrA5s   rAcs^eZdZdZdddZfddZddZd d Zed d Z e d dZ e ddZ Z S)rBzo Correspondes to an ``EG_*`` element group where at most one of its members may appear as a child. rcCs||_||_dSr)_choicesr)rchoicesrrrrrIks zZeroOrOneChoice.__init__csDtt|||||jD] }|||j|jq|dSrU)rMrBrE_add_choice_getterrrWr_add_group_remover)rrZr[choicerRrrrEos    z&ZeroOrOneChoice.populate_class_memberscCr)z Add 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_rVrWr`rrrr}sz"ZeroOrOneChoice._add_choice_gettercs$fdd}d|_j|dS)ze Add a ``_remove_eg_x()`` method to the element class for this choice group. csjD]}||qdSr)_member_nsptagnamesr)rmtagnamercrr_remove_choice_groups  z@ZeroOrOneChoice._add_group_remover.._remove_choice_groupz9Remove the current choice group child element if present.N)r7r _remove_choice_group_method_name)rrrrcrrs z"ZeroOrOneChoice._add_group_removercsfdd}d|_|S)rcs |jjSr)first_child_found_inrrrcrrget_group_member_elementrz@ZeroOrOneChoice._choice_getter..get_group_member_elementzbReturn the child element belonging to this element group, or |None| if no member child is present.)r7)rrrrcrrs zZeroOrOneChoice._choice_gettercCsdd|jDS)z| Sequence of namespace-prefixed tagnames, one for each of the member elements of this choice group. cSsg|]}|jqSr)r)r*rrrrr.sz7ZeroOrOneChoice._member_nsptagnames..)rrcrrrrsz#ZeroOrOneChoice._member_nsptagnamescCrrrrcrrrrrz0ZeroOrOneChoice._remove_choice_group_method_namer)r4r5r6r7rIrErrr\rr rrrerrrRrrBfs     rBcs\eZdZdZeZddZddZddZdd Z e d d Z fd d Z e ddZ ZS)_OxmlElementBasez Effective base class for all custom element classes, to add standardized behavior to all classes in one place. Actual inheritance is from BaseOxmlElement below, needed to manage Python 2-3 metaclass declaration compatibility. cCsd|jj|jt|fS)Nz<%s '<%s>' at 0x%0x>)rSr4_nsptagidrcrrr__repr__sz_OxmlElementBase.__repr__cGs,|D]}|t|}|dur|SqdS)zd Return the first child found with tag in *tagnames*, or None if not found. N)rr )rtagnamesrrrrrrs z%_OxmlElementBase.first_child_found_incGs.|j|}|dur|||S|||Sr)rZ addpreviousappend)relmr successorrrrrs   z&_OxmlElementBase.insert_element_beforecGs0|D]}|t|}|D]}||q qdS)ze Remove all child elements whose tagname (e.g. 'a:p') appears in *tagnames*. N)rr remove)rrrZmatchingrrrrrs  z_OxmlElementBase.remove_allcCst|S)z Return XML string for this element, suitable for testing purposes. Pretty printed for readability and without an XML declaration at the top. )rrcrrrrsz_OxmlElementBase.xmlcstt|j|tdS)z Override of ``lxml`` _Element.xpath() method to provide standard Open XML namespace mapping (``nsmap``) in centralized location. ) namespaces)rMBaseOxmlElementxpathr)rZ xpath_strrRrrrs z_OxmlElementBase.xpathcCs t|jSr)rZfrom_clark_namer|rcrrrrs z_OxmlElementBase._nsptag)r4r5r6r7r;Z __metaclass__rrrrr\rrrrerrrRrrs    rr)&r7Z __future__rZlxmlrr8Z docx.compatrZ docx.oxmlrZdocx.oxml.exceptionsrZ docx.oxml.nsrrr Z docx.sharedr rrtyper;objectrKr>r?r}rr<r=r@rArBZ ElementBaserdict__dict__rrrrrs6       @$51.E&1LC