o 7h!i@sdZddlmZddlZddlmZmZmZmZm Z m Z m Z ddl m Z ddlmZmZddlmZddlmZdd lmZmZmZdd lmZGd d d eZd3d4ddZd5ddZGdddeZGddde Z!GdddZ"Gdd d e"Z#Gd!d"d"e"Z$Gd#d$d$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%Z*Gd/d0d0e%Z+Gd1dde je!d2Z,dS)6zPBase and meta classes enabling declarative definition of custom element classes.) annotationsN)AnyCallableIterableProtocolSequenceTypecast)etree) ElementBase_Element)InvalidXmlError) oxml_parser)NamespacePrefixedTag_nsmapqn) lazypropertyc@s,eZdZdZed ddZed d d Zd S) AttributeTypezInterface for an object that can act as an attribute type. An attribute-type specifies how values are transformed to and from the XML "string" value of the attribute. xml_valuestrreturnrcCdS)z/Transform an attribute value to a Python value.N)clsrrrZ/var/www/html/figdemos/bartoux_crm/venv/lib/python3.10/site-packages/pptx/oxml/xmlchemy.pyfrom_xmlzAttributeType.from_xmlvaluecCr)zGTransform a Python value to a str value suitable to this XML attribute.Nr)rrrrrto_xmlrzAttributeType.to_xmlN)rrrr)rrrr)__name__ __module__ __qualname____doc__ classmethodrrrrrrrs  r nsptag_strrnsmapdict[str, str] | NonerBaseOxmlElementcCs*t|}|dur |n|j}tj|j|dS)aReturn a "loose" lxml element having the tag specified by `nsptag_str`. `nsptag_str` must contain the standard namespace prefix, e.g. 'a:tbl'. The resulting element is an instance of the custom element class for this tag name if one is defined. N)r%)rr%r makeelement clark_name)r$r%nsptagrrr OxmlElement#sr+elementr cCstj|ddd}t|S)z_ Serialize *element* to human-readable XML suitable for tests. No XML declaration. unicodeT)encoding pretty_print)r tostring XmlString)r,xmlrrrserialize_for_reading.sr3c@sLeZdZdZedZdddZdd d ZdddZ dddZ dddZ dS)r1zRProvides string comparison override suitable for serialized XML; useful for tests.z(( *)([^<]*)?otherobjectrboolcCs\t|tsdS|}|}t|t|krdSt||D] \}}|||s+dSqdS)NFT) isinstancer splitlineslenzip _eq_elm_strs)selfr4linesZ lines_otherlineZ line_otherrrr__eq__Bs  zXmlString.__eq__cCs || SN)r?)r<r4rrr__ne__Ns 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<rBZattr_lstrrr _attr_seqQszXmlString._attr_seqr>line_2c Csd||\}}}}||\}}} } ||krdS||||kr$dS|| kr*dS|| kr0dSdS)zTrue if the element in `line_2` is XML-equivalent to the element in `line`. In particular, the order of attributes in XML is not significant. FT) _parse_linerG) r<r>rHfrontrBclosetextZfront_2Zattrs_2Zclose_2Ztext_2rrrr;ZszXmlString._eq_elm_strscsH|j|durtdfddtddD\}}}}||||fS)zUReturn front, attrs, close, text 4-tuple result of parsing XML element string `line`.Nz0`line` does not match pattern for an XML elementcsg|]}|qSr)group).0nmatchrr psz)XmlString._parse_line..)_xml_elm_line_pattrQ ValueErrorrange)r<r>rJrBrKrLrrPrrIks   zXmlString._parse_lineN)r4r5rr6)rBrrrC)r>rrHrrr6)r>r) rr r!r"recompilerUr?rArGr;rIrrrrr17s    r1c@seZdZdZd dd Zd S) MetaOxmlElementzMetaclass for BaseOxmlElement.clsnamerbasestuple[type, ...]clsdictdict[str, Any]cCs>tttttttf}|D]\}}t||r| ||q dSr@) OneAndOnlyOne OneOrMoreOptionalAttributeRequiredAttribute ZeroOrMore ZeroOrOneZeroOrOneChoiceitemsr7populate_class_members)rr[r\r^Z dispatchablekeyrrrr__init__ws  zMetaOxmlElement.__init__N)r[rr\r]r^r_)rr r!r"rjrrrrrZtsrZc@sTeZdZdZdddZdd d Zd dZeddZedddZ edddZ dS) BaseAttributezQBase class for OptionalAttribute and RequiredAttribute, providing common methods. attr_namer simple_typetype[AttributeType]cCs||_||_dSr@) _attr_name _simple_type)r<rlrmrrrrjs zBaseAttribute.__init__ element_clsType[BaseOxmlElement] prop_namecCs||_||_|dSz? Add the appropriate methods to *element_cls*. N) _element_cls _prop_name_add_attr_propertyr<rqrsrrrrhs 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_settersetattrrurvr< property_rrrrwsz BaseAttribute._add_attr_propertycCsd|jvr t|jS|jS)N:)rorr<rrr _clark_names  zBaseAttribute._clark_namer Callable[[BaseOxmlElement], Any]cCtd)JCallable suitable for the "get" side of the attribute property descriptor.$must be implemented by each subclassNotImplementedErrorrrrrrzzBaseAttribute._getter&Callable[[BaseOxmlElement, Any], None]cCr)JCallable suitable for the "set" side of the attribute property descriptor.rrrrrrr{rzBaseAttribute._setterN)rlrrmrnrqrrrsrrrrr) rr r!r"rjrhrwryrrzr{rrrrrks     rkcsLeZdZdZddfd d Zed d ZedddZedddZZ S)rbzDefines 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. Nrlrrmrndefaultrcstt|||||_dSr@)superrbrj_default)r<rlrmr __class__rrrjs zOptionalAttribute.__init__cCd|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.rprrorrrr _docstrings zOptionalAttribute._docstringrrcdfdd }j|_|S) robjr'rrcs&|j}|dur jSj|Sr@)getrrrprrZattr_str_valuerrrget_attr_values  z1OptionalAttribute._getter..get_attr_valueNrr'rrrr"r<rrrrrzszOptionalAttribute._getterrcd fdd }|S) rrr'rrrNonecsB|jkrj|jvr|jj=dSj|}|j|dSr@)rrattribrprsetrr str_valuerrrset_attr_values    z1OptionalAttribute._setter..set_attr_valueNrr'rrrrrr<rrrrr{s zOptionalAttribute._setterr@)rlrrmrnrrrr) rr r!r"rjryrrzr{ __classcell__rrrrrbs   rbc@s8eZdZdZed ddZeddZed d d Zd S)rcaDefines 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. rrcr) rrr'rrcs4|j}|durtdj|jfj|S)Nz1required '%s' attribute not present on element %s)rrr rotagrprrrrrrs  z1RequiredAttribute._getter..get_attr_valueNrrrrrrrzszRequiredAttribute._gettercCr)rz,%s type-converted value of ``%s`` attribute.rrrrrrszRequiredAttribute._docstringrcr) rrr'rrrrcsj|}|j|dSr@)rprrrrrrrrs z1RequiredAttribute._setter..set_attr_valueNrrrrrrr{ szRequiredAttribute._setterNrr)rr r!r"ryrzrr{rrrrrcs   rccseZdZdZd/d0fdd Zd1d d ZddZddZddZddZ ddZ e ddZ d2ddZ ed3d!d"Zed4d$d%Ze d&d'Zed5d)d*Ze d+d,Ze d-d.ZZS)6_BaseChildElementzBase class for the child element classes corresponding to varying cardinalities. Subclasses include ZeroOrOne and ZeroOrMore. r nsptagnamer successors Sequence[str]cstt|||_||_dSr@)rrrj _nsptagname _successors)r<rrrrrrjs z_BaseChildElement.__init__rqrrrscCs||_||_dS)zFBaseline behavior for adding the appropriate methods to `element_cls`.N)rurvrxrrrrh s z(_BaseChildElement.populate_class_memberscs,d fdd }dj|_j|dS) zGAdd an ``_add_x()`` method to the element class for this child element.rr'rBrcsHt|j}|}|D] \}}t|||q t|j}|||Sr@)getattr_new_method_namergr|_insert_method_name)rrBZ new_methodchildrirZ insert_methodrrr _add_child(s  z0_BaseChildElement._add_adder.._add_childSAdd a new ``<%s>`` child element unconditionally, inserted in the correct sequence.N)rr'rBr)rr" _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. This method 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)_creatorrr"rr)r<creatorrrr _add_creator7s z_BaseChildElement._add_creatorcC"t|jdd}t|j|j|dS)zAdd a read-only `{prop_name}` property to the parent element class. The property locates and returns this child element or `None` if not present. N)ryrzr|rurvr}rrr _add_getterCz_BaseChildElement._add_getterc,dfdd }dj|_j|dS) zJAdd an ``_insert_x()`` method to the element class for this child element.rr'rcs|j|gjR|Sr@)insert_element_beforerrrrrr _insert_childOsz6_BaseChildElement._add_inserter.._insert_childzYReturn the passed ``<%s>`` element after inserting it as a child in the correct sequence.N)rr'rr')rr"rr)r<rrrr _add_inserterLs z_BaseChildElement._add_insertercCs,|jd}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_lstN)rvry _list_getterr|ru)r<rsr~rrr_add_list_getterYs z"_BaseChildElement._add_list_gettercC d|jS)Nz_add_%srvrrrrrb z"_BaseChildElement._add_method_namenamemethodCallable[..., Any]cCs"t|j|rdSt|j||dS)zSAdd `method` to the target class as `name`, unless `name` is already defined there.N)hasattrrur|)r<rrrrrrfs z_BaseChildElement._add_to_classr,Callable[[BaseOxmlElement], BaseOxmlElement]csdfdd }|S)zSCallable that creates a new, empty element of the child type, having no attributes.rr'cs tjSr@)r+rrrrrnew_child_elementps z5_BaseChildElement._creator..new_child_elementNrr'r)r<rrrrrlsz_BaseChildElement._creator3Callable[[BaseOxmlElement], BaseOxmlElement | None]cd fdd }dj|_|S) zCallable 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. rr'rBaseOxmlElement | Nonecs|tjSr@)findrrrrrrget_child_element}z4_BaseChildElement._getter..get_child_elementz0``<%s>`` child element or |None| if not present.Nrr'rrrr"r<rrrrrzusz_BaseChildElement._gettercCr)Nz _insert_%srrrrrrrz%_BaseChildElement._insert_method_name2Callable[[BaseOxmlElement], list[BaseOxmlElement]]cr) zCCallable suitable for the "get" side of a list property descriptor.rr'rlist[BaseOxmlElement]cstd|tjS)Nr)r findallrrrrrrget_child_element_listz>_BaseChildElement._list_getter..get_child_element_listzPA list containing each of the ``<%s>`` child elements, in the order they appear.N)rr'rrr)r<rrrrrs z_BaseChildElement._list_gettercCrNz _remove_%srrrrr_remove_method_namerz%_BaseChildElement._remove_method_namecCr)Nz_new_%srrrrrrrz"_BaseChildElement._new_method_namer)rrrrr)rrrrrr)rr)rr)rr r!r"rjrhrrrrrrrrryrrzrrrrrrrrrrs0           rc@sTeZdZdZeddZdd d ZdddZeddZe ddZ e ddZ dS)ChoicezVDefines a child element belonging to a group, only one of which may appear as a child.cCs|jSr@)rrrrrrszChoice.nsptagnamerqrrgroup_prop_namerrrcCs>||_||_||_|||||dSz-Add the appropriate methods to `element_cls`.N)ru_group_prop_namerrrrr_add_get_or_change_to_method)r<rqrrrrrrhs zChoice.populate_class_membersrrcs,dfdd }dj|_j|dS)zPAdd a `get_or_change_to_x()` method to the element class for this child element.rr'cs@t|j}|dur |St|j}|t|j}|}|Sr@)rrv_remove_group_method_namer)rrZremove_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)rr"r_get_or_change_to_method_name)r<rrrrrs  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. rrSrN)rindex)r<startrrrrvs zChoice._prop_namecCr)Nzget_or_change_to_%srrrrrrrz$Choice._get_or_change_to_method_namecCrr)rrrrrrrz Choice._remove_group_method_nameN)rqrrrrrrrr) rr r!r"ryrrhrrvrrrrrrrrs     rcs>eZdZdZdfdd Zdfd d Zedd dZZS)r`z5Defines a required child element for MetaOxmlElement.rrcstt||ddS)Nr)rr`rj)r<rrrrrjrzOneAndOnlyOne.__init__rqrrrscstt||||dSrt)rr`rhrrxrrrrhs z$OneAndOnlyOne.populate_class_membersrrcsdfdd }dj|_|S) z@Callable suitable for the "get" side of the property descriptor.rr'rcs*|tj}|durtdj|S)Nz+required ``<%s>`` child element not present)rrrr rrrrrs z0OneAndOnlyOne._getter..get_child_elementz Required ``<%s>`` child element.Nrr'rr'rrrrrrzs zOneAndOnlyOne._getter)rrrr) rr r!r"rjrhryrzrrrrrr`s r`cs8eZdZdZdfdd Zdd d Zed d ZZS)razUDefines a repeating child element for MetaOxmlElement that must appear at least once.rqrrrsrcsHtt||||||||t||dS)z-Add the appropriate methods to *element_cls*.N) rrarhrrrr_add_public_adderdelattrrxrrrrhsz OneOrMore.populate_class_membersrrcr) z;Add a public `.add_x()` method to the parent element class.rr'rcst|j}|}|Sr@)rr)rZprivate_add_methodrrrr add_childs z.OneOrMore._add_public_adder..add_childrNr)rr"r_public_add_method_name)r<rrrrrs zOneOrMore._add_public_addercCr)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!OneOrMore._public_add_method_namerr) rr r!r"rhrrrrrrrrras  racs"eZdZdZdfdd ZZS) rdzJ Defines an optional repeating child element for MetaOxmlElement. rqrrrsrcs@tt|||||||t||dSrt)rrdrhrrrrrrxrrrrh"s z!ZeroOrMore.populate_class_membersr)rr r!r"rhrrrrrrdsrdcs>eZdZdZdfdd Zdd Zd d Zed d ZZ S)rez6Defines an optional child element for MetaOxmlElement.rqrrrsrcsFtt|||||||||dSr) rrerhrrrr_add_get_or_adder _add_removerrxrrrrh1s z ZeroOrOne.populate_class_memberscr) zKAdd a `.get_or_add_x()` method to the element class for this child element.rr'rcs*t|j}|durt|j}|}|Sr@)rrvr)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)rr"r_get_or_add_method_name)r<rrrrr;s zZeroOrOne._add_get_or_addercs0d fdd }djd|_j|d S) zHAdd a `._remove_x()` method to the element class for this child element.rr'rrcs|jdSr@) remove_allrrrrr _remove_childMrz-ZeroOrOne._add_remover.._remove_childz Remove all `z` child elements.Nrr'rr)rr"rr)r<rrrrrJszZeroOrOne._add_removercCr)Nz get_or_add_%srrrrrrSrz!ZeroOrOne._get_or_add_method_namer) rr r!r"rhrrrrrrrrrre.s  recsdeZdZdZddddZdfd d ZddZddZeddZ e dddZ e ddZ Z S)rfzOAn `EG_*` element group where at most one of its members may appear as a child.rchoicesIterable[Choice]r Iterable[str]cCst||_t||_dSr@)tuple_choicesr)r<rrrrrrj[s zZeroOrOneChoice.__init__rqrrrsrcsDtt|||||jD] }|||j|jq|dSr)rrfrh_add_choice_getterrrvr_add_group_remover)r<rqrschoicerrrrh_s   z&ZeroOrOneChoice.populate_class_memberscCr)zAdd a read-only `.{prop_name}` property to the element class. The property returns the present member of this group, or |None| if none are present. N)ry_choice_getterr|rurvr}rrrrgrz"ZeroOrOneChoice._add_choice_gettercs&d fdd }d|_j|dS) zJAdd a `._remove_eg_x()` method to the element class for this choice group.rr'rrcsjD]}||qdSr@)_member_nsptagnamesr)rtagnamerrr_remove_choice_groupss  z@ZeroOrOneChoice._add_group_remover.._remove_choice_groupz9Remove the current choice group child element if present.Nr)r"r _remove_choice_group_method_name)r<rrrrrpsz"ZeroOrOneChoice._add_group_removercsd fdd }d|_|S) zj Return a function object suitable for the "get" side of the property descriptor. rr'rrcstd|jjS)Nr)r first_child_found_inrrrrrget_group_member_elements 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)r")r<r rrrrzszZeroOrOneChoice._choice_getterrrCcCsdd|jDS)zUSequence of namespace-prefixed tagnames, one for each member element of choice group.cSsg|]}|jqSr)r)rNrrrrrRsz7ZeroOrOneChoice._member_nsptagnames..)rrrrrrsz#ZeroOrOneChoice._member_nsptagnamescCs d|jS)z!Function-name for choice remover.Z_remove_rrrrrrs z0ZeroOrOneChoice._remove_choice_group_method_namer)rrrrr)rrC)rr r!r"rjrhrrryrrrrrrrrrrfXs    rfcsdeZdZdZddZddd Zdd d ZdddZedddZ dfdd Z edddZ 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>)rr_nsptagidrrrr__repr__s zBaseOxmlElement.__repr__tagnamesrr_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_beforercGs0|D]}|t|}|D]}||q qdS)z>Remove child elements with tagname (e.g. "a:p") in `tagnames`.N)rrremove)r<r rZmatchingrrrrrs  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. )r3rrrrr2szBaseOxmlElement.xml xpath_strrcstj|tdS)zOverride of `lxml` _Element.xpath() method. Provides standard Open XML namespace mapping (`nsmap`) in centralized location. ) namespaces)rxpathr)r<rrrrrszBaseOxmlElement.xpathcCs t|jSr@)rfrom_clark_namerrrrrr s zBaseOxmlElement._nsptag)r rrr)rr r r)r rrr)rr)rrrr) rr r!r"r rrrryr2rr rrrrrr's    ) metaclassr@)r$rr%r&rr')r,r )-r" __future__rrXtypingrrrrrrr lxmlr lxml.etreer r pptx.excr pptx.oxmlr pptx.oxml.nsrrr pptx.utilrrr+r3rr1typerZrkrbrcrrr`rardrerfr'rrrrs6 $       =+6. ;&*@