j eBdZddlmZddlZddlmZmZmZmZm Z m Z m Z m Z m Z ddlmZddlmZmZddlmZddlmZmZmZdd lmZer dd lmZdd lmZd+dZGdde Z!e dZ"Gdde#Z$GddZ%Gdde%Z&Gdde%Z'GddZ(Gdde(Z)Gdde(Z*Gd d!e(Z+Gd"d#e(Z,Gd$d%e(Z-Gd&d'e(Z.Gd(d)eje$*Z/dS),z?Enabling declarative definition of lxml custom element classes.) annotationsN) TYPE_CHECKINGAnyCallableDictListSequenceTupleTypeTypeVar)etree) ElementBase_Element)InvalidXmlError)NamespacePrefixedTagnsmapqn) lazyproperty) BaseXmlEnum)BaseSimpleTypeelementrcNtj|dd}t|S)z[Serialize `element` to human-readable XML suitable for tests. No XML declaration. unicodeT)encoding pretty_print)r tostring XmlString)rxmls \/lsinfo/ai/hellotax_ai/base_platform/venv/lib/python3.11/site-packages/docx/oxml/xmlchemy.pyserialize_for_readingr s& .94 H H HC S>>cjeZdZdZejdZddZddZdd Z ddZ e ddZ dS)rz]Provides string comparison override suitable for serialized XML that is useful for tests.z)( *)([^<]*)?$otherobjectreturnboolc&t|tsdS|}|}t|t|krdSt ||D]\}}|||sdSdS)NFT) isinstancestr splitlineslenzip _eq_elm_strs)selfr#lines lines_otherline line_others r__eq__zXmlString.__eq__5s%%% 5!!&&(( u::[)) ) )5 #E; 7 7   D*$$T:66 uu tr!c.|| SN)r3)r.r#s r__ne__zXmlString.__ne__As;;u%%%%r!attrsr) List[str]cp|}|}t|S)zReturn a sequence of attribute strings parsed from `attrs`. Each attribute string is stripped of whitespace on both ends. )stripsplitsorted)r.r7attr_lsts r _attr_seqzXmlString._attr_seqDs,  ;;==hr!r1line_2c||\}}}}||\}}} } ||krdS||||krdS|| krdS|| krdSdS)zZReturn True if the element in `line_2` is XML equivalent to the element in `line`.FT) _parse_liner>) r.r1r?frontr7closetextfront_2attrs_2close_2text_2s rr-zXmlString._eq_elm_strsMs%)$4$4T$:$:!ueT,0,<,>% DNN7$;$; ; ;5 G  5 6>>5tr!Tuple[str, str, str, str]c|j|dSfdtddD\}}}}||||fS)zI(front, attrs, close, text) 4-tuple result of parsing XML element `line`.N)rKrKrKc:g|]}|S)group).0nmatchs r z)XmlString._parse_line..bs#$I$I$IU[[^^$I$I$Ir!)_xml_elm_line_pattrQrange)clsr1rBr7rCrDrQs @rrAzXmlString._parse_line\s^&,,T22 =!>$I$I$I$IU1a[[$I$I$I!ueTeUD((r!N)r#r$r%r&)r7r)r%r8)r1r)r?r))r1r)r%rI) __name__ __module__ __qualname____doc__recompilerUr3r6r>r- classmethodrArMr!rrr)s$$PQQ    &&&&        )))[)))r!r_TceZdZdZd dZd S) MetaOxmlElementzMetaclass for BaseOxmlElement.clsnamer)basesTuple[type, ...] namespaceDict[str, Any]ctttttt t f}|D]+\}}t||r| ||,dSr5) OneAndOnlyOne OneOrMoreOptionalAttributeRequiredAttribute ZeroOrMore ZeroOrOneZeroOrOneChoiceitemsr(populate_class_members)rWrbrcre dispatchablekeyvalues r__init__zMetaOxmlElement.__init__lsp        $//++ 7 7JC%.. 7,,S#666 7 7r!N)rbr)rcrdrerf)rXrYrZr[rtrMr!rrarais.(( 7 7 7 7 7 7r!racxeZdZdZdfd Zdd Zd ZedZeddZ eddZ xZ S) BaseAttributezZBase class for OptionalAttribute and RequiredAttribute. Provides common methods. attr_namer) simple_type(Type[BaseXmlEnum] | Type[BaseSimpleType]crtt|||_||_dSr5)superrvrt _attr_name _simple_type)r.rwrx __class__s rrtzBaseAttribute.__init__s6 mT""++---#'r! element_clsra prop_namer%NonecJ||_||_|dSz-Add the appropriate methods to `element_cls`.N) _element_cls _prop_name_add_attr_propertyr.rrs rrpz$BaseAttribute.populate_class_memberss+(# !!!!!r!crt|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_settersetattrrrr. property_s rrz BaseAttribute._add_attr_propertys6 T\4<>> !4?I>>>>>r!cJd|jvrt|jS|jS)N:)r|rr.s r _clark_namezBaseAttribute._clark_names' $/ ! !do&& &r!'Callable[[BaseOxmlElement], Any | None]cdSr5rMrs rrzBaseAttribute._getters r!-Callable[[BaseOxmlElement, Any | None], None]cdSr5rMrs rrzBaseAttribute._setters  r!)rwr)rxryrrarr)r%rr%r)r%r) rXrYrZr[rtrprrrrr __classcell__r~s@rrvrv{s ((((((""""???X    X    X     r!rvcneZdZdZ ddfd Zed Zedd ZeddZxZ S)rjaDefines 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. Nrwr)rxrydefault#BaseXmlEnum | BaseSimpleType | Nonechtt|||||_dSr5)r{rjrt_default)r.rwrxrr~s rrtzOptionalAttribute.__init__s1 &&// ;GGG r!c0|jjd|jdS)z;String to use as `__doc__` attribute of attribute property. 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}rXr|rs r _docstringzOptionalAttribute._docstrings0 ) : :/ : : : r!r%rc,dfd }j|_|S)zJFunction suitable for `__get__()` method on attribute property descriptor.objBaseOxmlElementr% Any | Nonec~|j}|jSj|Sr5)getrrr}from_xmlrattr_str_valuer.s rget_attr_valuez1OptionalAttribute._getter..get_attr_values>!WWT%566N%}$$--n== =r!rrr%rrr[r.rs` rrzOptionalAttribute._getters3  > > > > > >"&r!&Callable[[BaseOxmlElement, Any], None]cdfd }|S)zJFunction suitable for `__set__()` method on attribute property descriptor.rrrsrc| |jkrj|jvr |jj=dSj|}|j|jvr |jj=dS|j|dSr5)rrattribr}to_xmlsetrrs str_valuer.s rset_attr_valuez1OptionalAttribute._setter..set_attr_values} 6 6#sz11 4#34)0077I #sz11 4#34 GGD$i 0 0 0 0 0r!)rrrsrrMr.rs` rrzOptionalAttribute._setters) 1 1 1 1 1 1r!r5)rwr)rxryrrrr%r) rXrYrZr[rtrrrrrrs@rrjrjs8<          X X Xr!rjcXeZdZdZedZed dZed dZdS) rkaDefines 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. c0|jjd|jdS)zaReturn the string to use as the ``__doc__`` attribute of the property for this attribute.rz `` attribute.rrs rrzRequiredAttribute._docstrings&   & & & OOO  r!r% Callable[[BaseOxmlElement], Any]c,dfd }j|_|S)zDfunction object suitable for "get" side of attr property descriptor.rrr%rc|j}|tdjd|jj|S)Nz required 'z#' attribute not present on element )rrrr|tagr}rrs rrz1RequiredAttribute._getter..get_attr_values^ WWT%566N%%o1$--n== =r!rrrs` rrzRequiredAttribute._getters3 > > > > > >"&r!rcdfd }|S)zIfunction object suitable for "set" side of attribute property descriptor.rrrsrcj|}|td|d|j|dS)Nzcannot assign z to this required attribute)r}r ValueErrorrrrs rrz1RequiredAttribute._setter..set_attr_valuesV)0077I  !T%!T!T!TUUU GGD$i 0 0 0 0 0r!)rrrsrrMrs` rrzRequiredAttribute._setters) 1 1 1 1 1 1 r!N)r%rr)rXrYrZr[rrrrrMr!rrkrksy  X    X    X   r!rkc eZdZdZd!d"fd Zd#d ZdZdZdZdZ dZ e dZ dZ d$dZed%dZedZe dZedZe dZe dZe d ZxZS)&_BaseChildElementzBase class for the child-element classes. The child-element sub-classes correspond to varying cardinalities, such as ZeroOrOne and ZeroOrMore. rM nsptagnamer) successorsTuple[str, ...]crtt|||_||_dSr5)r{rrt _nsptagname _successors)r.rrr~s rrtz_BaseChildElement.__init__"s6 &&//111%%r!rrarr%rc"||_||_dS)zFBaseline behavior for adding the appropriate methods to `element_cls`.N)rrrs rrpz(_BaseChildElement.populate_class_members's(#r!chdfd }djz|_j|dS) zGAdd an ``_add_x()`` method to the element class for this child element.rrr7rct|j}|}|D]\}}t|||t|j}|||Sr5)getattr_new_method_nameror_insert_method_name)rr7 new_methodchildrrrs insert_methodr.s r _add_childz0_BaseChildElement._add_adder.._add_child1sw d&;<`` child element unconditionally, inserted in the correct sequence.N)rrr7r)rr[ _add_to_class_add_method_name)r.rs` r _add_adderz_BaseChildElement._add_adder.sZ       #%)%5 6  40*=====r!ch|j}d|jz|_||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)_creatorrr[rr)r.creators r _add_creatorz_BaseChildElement._add_creator@sC- (*.*: ;  40':::::r!cht|jdd}t|j|j|dS)z]Add a read-only ``{prop_name}`` property to the element class for this child element.N)rrrrrrs r _add_getterz_BaseChildElement._add_getterJs4T\466 !4?I>>>>>r!chdfd }djz|_j|dS)zJAdd an ``_insert_x()`` method to the element class for this child element.rrrc.|j|gjR|Sr5)insert_element_beforerrrr.s r _insert_childz6_BaseChildElement._add_inserter.._insert_childTs& %C %e ?d.> ? ? ? ?Lr!zYReturn the passed ``<%s>`` element after inserting it as a child in the correct sequence.N)rrrr)rr[rr)r.rs` r _add_inserterz_BaseChildElement._add_inserterQsZ        )+/+; <  43]CCCCCr!crd|jz}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)rr _list_getterrr)r.rrs r_add_list_getterz"_BaseChildElement._add_list_getter^s?t. T.d;; !9i88888r!cd|jzS)Nz_add_%srrs rrz"_BaseChildElement._add_method_namee4?**r!chdfd }djz|_j|dS)z.add_childls)!(d.C!D!D &&((ELr!rNrr)rr[r_public_add_method_name)r.rs` r_add_public_adderz#_BaseChildElement._add_public_adderisZ        #%)%5 6  47CCCCCr!namemethodCallable[..., Any]c`t|j|rdSt|j||dS)zbAdd `method` to the target class as `name`, unless `name` is already defined on the class.N)hasattrrr)r.rrs rrz_BaseChildElement._add_to_classws9 4$d + +  F!400000r!,Callable[[BaseOxmlElement], BaseOxmlElement]c$ddlmdfd }|S)zHCallable that creates an empty element of the right type, with no attrs.r) OxmlElementrrc$jSr5r)rrr.s rnew_child_elementz5_BaseChildElement._creator..new_child_elements;t/00 0r!r)docx.oxml.parserr)r.rrs` @rrz_BaseChildElement._creator~sC 100000 1 1 1 1 1 1 1! r!c2dfd }djz|_|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. rrcR|tjSr5)findrrrr.s rget_child_elementz4_BaseChildElement._getter..get_child_elements 88Bt/0011 1r!z0``<%s>`` child element or |None| if not present.rrr[r.rs` rrz_BaseChildElement._getters> 2 2 2 2 2 2 ?AQ Q !! r!cd|jzS)Nz _insert_%srrs rrz%_BaseChildElement._insert_method_namedo--r!c2dfd }djz|_|S)z[Return a function object suitable for the "get" side of a list property descriptor.rrcR|tjSr5)findallrrrs rget_child_element_listz>_BaseChildElement._list_getter..get_child_element_lists ;;r$"23344 4r!zPA list containing each of the ``<%s>`` child elements, in the order they appear.rr)r.r s` rrz_BaseChildElement._list_gettersA  5 5 5 5 5 5 "&"2 3 &&%r!cd|jzS)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_%srrs rrz)_BaseChildElement._public_add_method_names$/))r!cd|jzSNz _remove_%srrs r_remove_method_namez%_BaseChildElement._remove_method_namerr!cd|jzS)Nz_new_%srrs rrz"_BaseChildElement._new_method_namerr!rM)rr)rrr)rr)rr)r%r)rXrYrZr[rtrprrrrrrrrrrrrrrrrrrrs@rrrs &&&&&&& $$$$>>>$;;;??? D D D999++\+ D D D1111!!!X!!!X! ..\. & &X &**\*..\.++\+++++r!rcxeZdZdZedZdd Zd Zed Ze dZ e dZ dS)ChoicezZDefines a child element belonging to a group, only one of which may appear as a child.c|jSr5rrs rrzChoice.nsptagnames r!rragroup_prop_namer)rrr%rc||_||_||_|||||dSr)r_group_prop_namerrrrr_add_get_or_change_to_method)r.rrrs rrpzChoice.populate_class_memberssz( /%     ))+++++r!chdfd }djz|_j|dS)zZAdd a ``get_or_change_to_x()`` method to the element class for this child element.rrct|j}||St|j}|t|j}|}|Sr5)rr_remove_group_method_namer)rrremove_group_method add_methodr.s rget_or_change_to_childzCChoice._add_get_or_change_to_method..get_or_change_to_childscC11E  ")#t/M"N"N    ! ! ! d&;<`` child, replacing any other group element if found.Nr)rr[r_get_or_change_to_method_name)r.rs` rrz#Choice._add_get_or_change_to_methodsZ       X  *& 4=?UVVVVVr!cpd|jvr|jddznd}|j|dS)zDProperty name computed from tag name, e.g. a:schemeClr -> schemeClr.rrSrN)rindex)r.starts rrzChoice._prop_namesD47$:J3J3J &&s++a//PQ''r!cd|jzS)Nzget_or_change_to_%srrs rr z$Choice._get_or_change_to_method_names$t66r!cd|jzSr)rrs rrz Choice._remove_group_method_namesd333r!N)rrarr)rrr%r) rXrYrZr[rrrprrrr rrMr!rrrs  X ,,,,"WWW&((X( 77\744\444r!rcFeZdZdZd fd Zd fd Zed ZxZS)rhz5Defines a required child element for MetaOxmlElement.rr)cZtt||ddS)NrM)r{rhrt)r.rr~s rrtzOneAndOnlyOne.__init__s) mT""++J;;;;;r!rrarr%rctt||||dSr)r{rhrprr.rrr~s rrpz$OneAndOnlyOne.populate_class_memberss= mT""99+yQQQ r!c2dfd }djz|_|S)XReturn a function object suitable for the "get" side of the property descriptor.rrc|tj}|tdjz|S)Nz+required ``<%s>`` child element not present)rrrrrs rrz0OneAndOnlyOne._getter..get_child_element sHHHR 01122E}%ADDTTLr!z Required ``<%s>`` child element.rrrs` rrzOneAndOnlyOne._getters>        /1A A !! r!)rr)r) rXrYrZr[rtrprrrrs@rrhrhs|??<<<<<<!!X!!!!!r!rhc$eZdZdZd fd ZxZS) rizYDefines a repeating child element for MetaOxmlElement that must appear at least once.rrarr)r%rcBtt||||||||t||dSr) r{rirprrrrrdelattrr)s rrpz OneOrMore.populate_class_memberss i55k9MMM         Y'''''r!rrXrYrZr[rprrs@rririsG   ( ( ( ( ( ( ( ( ( (r!ric$eZdZdZd fd ZxZS) rlz@Defines an optional repeating child element for MetaOxmlElement.rrarr)r%rcBtt||||||||t||dSr) r{rlrprrrrrr/r)s rrpz!ZeroOrMore.populate_class_members-s j$66{INNN         Y'''''r!rr0rs@rrlrl*sCJJ ( ( ( ( ( ( ( ( ( (r!rlcFeZdZdZd fd Zd Zd Zed ZxZ S) rmz6Defines an optional child element for MetaOxmlElement.rrarr)r%rcJtt|||||||||dSr) r{rmrprrrr_add_get_or_adder _add_removerr)s rrpz ZeroOrOne.populate_class_members=s i55k9MMM         r!chdfd }djz|_j|dS)zTAdd a ``get_or_add_x()`` method to the element class for this child element.rrctt|j}|t|j}|}|Sr5)rrr)rrrr.s rget_or_add_childz5ZeroOrOne._add_get_or_adder..get_or_add_childMs;C11E}$S$*?@@ " Lr!z>Return the ``<%s>`` child element, newly added if not present.Nr)rr[r_get_or_add_method_name)r.r9s` rr5zZeroOrOne._add_get_or_adderIsZ       M  $  479IJJJJJr!chdfd }djz|_j|dS)zIAdd a ``_remove_x()`` method to the element class for this child element.rrc<|jdSr5) remove_allrrs r _remove_childz-ZeroOrOne._add_remover.._remove_child\s NN4+ , , , , ,r!z#Remove all ``<%s>`` child elements.Nr)rr[rr)r.r>s` rr6zZeroOrOne._add_removerYsW - - - - - - 2  !  43]CCCCCr!cd|jzS)Nz get_or_add_%srrs rr:z!ZeroOrOne._get_or_add_method_nameds00r!r) rXrYrZr[rpr5r6rr:rrs@rrmrm:s@@      KKK D D D11\11111r!rmc|eZdZdZdddZdfd ZdZdZedZ e dZ e dZ xZ S)rnzeCorrespondes to an ``EG_*`` element group where at most one of its members may appear as a child.rMchoicesSequence[Choice]rrc"||_||_dSr5)_choicesr)r.rArs rrtzZeroOrOneChoice.__init__ms %r!rrarr)r%rctt|||||jD]#}|||j|j$|dSr)r{rnrp_add_choice_getterrDrr_add_group_remover)r.rrchoicer~s rrpz&ZeroOrOneChoice.populate_class_membersqs ot$$;;KSSS !!!m  F  ) )T_d.>     !!!!!r!cht|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)r_choice_getterrrrrs rrFz"ZeroOrOneChoice._add_choice_getter}s5T0$== !4?I>>>>>r!cXdfd }d|_j|dS)zSAdd a ``_remove_eg_x()`` method to the element class for this choice group.rrcFjD]}||dSr5)_member_nsptagnamesr=)rtagnamer.s r_remove_choice_groupz@ZeroOrOneChoice._add_group_remover.._remove_choice_groups43 ( (w'''' ( (r!z9Remove the current choice group child element if present.Nr)r[r _remove_choice_group_method_name)r.rOs` rrGz"ZeroOrOneChoice._add_group_removersQ ( ( ( ( ( ( H $ 4@BVWWWWWr!c"dfd }d|_|S)r+rrc"|jjSr5)first_child_found_inrMrs rget_group_member_elementz@ZeroOrOneChoice._choice_getter..get_group_member_elements+3+T-EF Fr!zbReturn the child element belonging to this element group, or |None| if no member child is present.r)r[)r.rTs` rrJzZeroOrOneChoice._choice_getters<  G G G G G G 4 !(('r!c$d|jDS)zjSequence of namespace-prefixed tagnames, one for each of the member elements of this choice group.cg|] }|j SrM)r)rOrHs rrRz7ZeroOrOneChoice._member_nsptagnames..s>>>f!>>>r!)rDrs rrMz#ZeroOrOneChoice._member_nsptagnamess?> >>>>r!cd|jzSrrrs rrPz0ZeroOrOneChoice._remove_choice_group_method_namerr!r)rArBrrr)rXrYrZr[rtrprFrGrrJrrMrPrrs@rrnrnis&&&&& " " " " " "??? X X X ( (X (??\? ..\.....r!rncreZdZdZdZddZdd Zdd Zedd Z dfd Z eddZ xZ S)rzvEffective base class for all custom element classes. Adds standardized behavior to all classes in one place. cJd|jj|jt|fzS)Nz<%s '<%s>' at 0x%0x>)r~rX_nsptagidrs r__repr__zBaseOxmlElement.__repr__s*% N # L tHH)   r!tagnamesr)r%_Element | Nonec`|D]*}|t|}||cS+dS)z9First child with tag in `tagnames`, or None if not found.N)rr)r.r]rNrs rrSz$BaseOxmlElement.first_child_found_insA  GIIbkk**E  !tr!elmrct|j|}|||n|||Sr5)rS addpreviousappend)r.r`r] successors rrz%BaseOxmlElement.insert_element_beforesE-D-x8   ! !# & & & & KK    r!rc|D]>}|t|}|D]}||?dS)z>Remove child elements with tagname (e.g. "a:p") in `tagnames`.N)r rremove)r.r]rNmatchingrs rr=zBaseOxmlElement.remove_alls[ # #G||BwKK00H! # # E"""" # # #r!c t|S)zXML string for this element, suitable for testing purposes. Pretty printed for readability and without an XML declaration at the top. )r rs rrzBaseOxmlElement.xmls %T***r! xpath_strrcTt|tS)zOverride of `lxml` _Element.xpath() method. Provides standard Open XML namespace mapping (`nsmap`) in centralized location. ) namespaces)r{xpathr)r.rir~s rrlzBaseOxmlElement.xpathsww}}Y5}999r!c4tj|jSr5)rfrom_clark_namerrs rrZzBaseOxmlElement._nsptags#3DH===r!)r]r)r%r^)r`rr]r))r]r)r%r)r%r))rir)r%r) rXrYrZr[r\rSrr=rrrlrZrrs@rrrs    ####+++X+::::::>>>X>>>>>r!r) metaclass)rr)0r[ __future__rr\typingrrrrrr r r r lxmlr lxml.etreerrdocx.oxml.exceptionsr docx.oxml.nsrrr docx.sharedrdocx.enum.baserdocx.oxml.simpletypesrr r)rr_typerarvrjrkrrrhrirlrmrnrrMr!rrzsFE""""""                       ,,,,,,,,0000008888888888$$$$$$5******444444:):):):):):):):)z WT]]77777d777$. . . . . . . . b<<<<< <<<~----- ---``+`+`+`+`+`+`+`+F8484848484 848484v!!!!!%!!!@(((((!(((" ( ( ( ( (" ( ( ( ,1,1,1,1,1!,1,1,1^>.>.>.>.>.'>.>.>.D9>9>9>9>9> 9>9>9>9>9>9>r!