h4SrSSKJr SSKrSSKJrJrJrJrJ r J r J r J r J r \(aSSKJr SSKJr SSKJr SSKJr "SS \5r"S S \5r"S S \5r"SS\5r"SS\5r"SS\5r"SS\5r"SS\ \\\45r\ "S5r "SS\\ 5r!S$Sjr""SS5r#"SS5r$"S S!5r%"S"S#5r&g)%zObjects shared by docx modules.) annotationsN) TYPE_CHECKINGAnyCallableGenericIteratorListTupleTypeVarcast)XmlPart)BaseOxmlElement) StoryPartc\rSrSrSrSrSrSrSrSr SSjr \ S 5r \ S 5r \ S 5r\ S 5r\ S 5r\ S5rSrg)LengthzBase class for length constructor classes Inches, Cm, Mm, Px, and Emu. Behaves as an int count of English Metric Units, 914,400 to the inch, 36,000 to the mm. Provides convenience unit conversion methods in the form of read-only properties. Immutable. i i@~ii1i{c,[RX5$N)int__new__clsemus =/var/www/html/env/lib/python3.13/site-packages/docx/shared.pyrLength.__new__'s{{3$$c2U[UR5- $)z7The equivalent length expressed in centimeters (float).)float _EMUS_PER_CMselfs rcm Length.cm*eD--...rcU$)z>The equivalent length expressed in English Metric Units (int).r s rr Length.emu/s  rc2U[UR5- $)z2The equivalent length expressed in inches (float).)r_EMUS_PER_INCHr s rinches Length.inches4seD//000rc2U[UR5- $)z7The equivalent length expressed in millimeters (float).)r _EMUS_PER_MMr s rmm Length.mm9r$rc2U[UR5- $)z Floating point length in points.)r _EMUS_PER_PTr s rpt Length.pt>r$rcV[[U[UR5- 55$)z/The equivalent length expressed in twips (int).)rroundr_EMUS_PER_TWIPr s rtwips Length.twipsCs$5d&9&9 ::;<rr@r&rrrBrBIs U(rrBc"\rSrSrSrSSjrSrg)CmQzLConvenience constructor for length in centimeters, e.g. ``height = Cm(12)``.cd[U[R-5n[RX5$r)rrrr)rr"rs rr Cm.__new__T&"v***+~~c''rr&N)r"rrFr&rrrHrHQs V(rrHc"\rSrSrSrSSjrSrg)EmuYzYConvenience constructor for length in English Metric Units, e.g. ``width = Emu(457200)``.c@[RU[U55$r)rrrrs rr Emu.__new__]s~~c3s8,,rr&Nr9rFr&rrrNrNYs -rrNc"\rSrSrSrSSjrSrg)MmazNConvenience constructor for length in millimeters, e.g. ``width = Mm(240.5)``.cd[U[R-5n[RX5$r)rrr-r)rr.rs rr Mm.__new__drLrr&N)r.rrFr&rrrSrSas X(rrSc"\rSrSrSrSSjrSrg)Ptiz:Convenience value class for specifying a length in points.cd[U[R-5n[RX5$r)rrr1r)rpointsrs rr Pt.__new__ls&&6.../~~c''rr&N)r[rrFr&rrrXrXis D(rrXc"\rSrSrSrSSjrSrg)TwipsqzuConvenience constructor for length in twips, e.g. ``width = Twips(42)``. A twip is a twentieth of a point, 635 EMU. cd[U[R-5n[RX5$r)rrr6r)rr7rs rr Twips.__new__ws&%&///0~~c''rr&N)r7rrFr&rrr^r^qs  (rr^cP^\rSrSrSrSU4SjjrSrSr\S Sj5r Sr U=r $) RGBColor|z7Immutable value object defining a particular RGB color.c>SnXU4H/n[U[5(aUS:dUS:dM&[U5e [[U]XX#45$)Nz+RGBColor() takes three integer values 0-255r) isinstancer ValueErrorsuperrcr)rrgbmsgval __class__s rrRGBColor.__new__sS;!9CsC((79 o% Xs+CQ;;rc SU-$)Nz RGBColor(0x%02x, 0x%02x, 0x%02x)r&r s r__repr__RGBColor.__repr__s 1D88rc SU-$)z-Return a hex string rgb value, like '3C2F80'.z %02X%02X%02Xr&r s r__str__RGBColor.__str__s $$rcn[USSS5n[USSS5n[USSS5nU"X#U5$)zEReturn a new instance from an RGB color hex string like ``'3C2F80'``.N)r)r rgb_hex_strrjrkrls r from_stringRGBColor.from_stringsG  BQ $  Aa " %  AB $1|rr&)rjrrkrrlr)r{strreturnrc) r:r;r<r=r>rrrru classmethodr|r@ __classcell__)ros@rrcrc|s)A <9%rrcTc:\rSrSrSrSSjrS S SjjrS SjrSrg) lazypropertyaDecorator like @property, but evaluated only on first access. Like @property, this can only be used to decorate methods having only a `self` parameter, and is accessed like an attribute on an instance, i.e. trailing parentheses are not used. Unlike @property, the decorated method is only evaluated on first access; the resulting value is cached and that same value returned on second and later access without re-evaluation of the method. Like @property, this class produces a *data descriptor* object, which is stored in the __dict__ of the *class* under the name of the decorated method ('fget' nominally). The cached value is stored in the __dict__ of the *instance* under that same name. Because it is a data descriptor (as opposed to a *non-data descriptor*), its `__get__()` method is executed on each access of the decorated attribute; the __dict__ item of the same name is "shadowed" by the descriptor. While this may represent a performance improvement over a property, its greater benefit may be its other characteristics. One common use is to construct collaborator objects, removing that "real work" from the constructor, while still only executing once. It also de-couples client code from any sequencing considerations; if it's accessed from more than one location, it's assured it will be ready whenever needed. Loosely based on: https://stackoverflow.com/a/6849299/1902513. A lazyproperty is read-only. There is no counterpart to the optional "setter" (or deleter) behavior of an @property. This is critically important to maintaining its immutability and idempotence guarantees. Attempting to assign to a lazyproperty raises AttributeError unconditionally. The parameter names in the methods below correspond to this usage example:: class Obj(object) @lazyproperty def fget(self): return 'some result' obj = Obj() Not suitable for wrapping a function (as opposed to a method) because it is not callable.c^XlURUl[R"X5 g)a1*fget* is the decorated method (a "getter" function). A lazyproperty is read-only, so there is only an *fget* function (a regular @property can also have an fset and fdel function). This name was chosen for consistency with Python's `property` class which uses this name for the corresponding parameter. N)_fgetr:_name functoolsupdate_wrapper)r!fgets r__init__lazyproperty.__init__s" ]]   ,rNcUcU$URRUR5nUc)URU5nX1RUR'[ [ U5$)aCalled on each access of 'fget' attribute on class or instance. *self* is this instance of a lazyproperty descriptor "wrapping" the property method it decorates (`fget`, nominally). *obj* is the "host" object instance when the attribute is accessed from an object instance, e.g. `obj = Obj(); obj.fget`. *obj* is None when accessed on the class, e.g. `Obj.fget`. *type* is the class hosting the decorated getter method (`fget`) on both class and instance attribute access. )__dict__getrrr r)r!objtypevalues r__get__lazyproperty.__get__sX ;K   , =JJsOE',LL $Au~rc[S5e)ayRaises unconditionally, to preserve read-only behavior. This decorator is intended to implement immutable (and idempotent) object attributes. For that reason, assignment to this property must be explicitly prevented. If this __set__ method was not present, this descriptor would become a *non-data descriptor*. That would be nice because the cached value would be accessed directly once set (__dict__ attrs have precedence over non-data descriptors on instance attribute lookup). The problem is, there would be nothing to stop assignment to the cached value, which would overwrite the result of `fget()` and break both the immutability and idempotence guarantees of this decorator. The performance with this __set__() method in place was roughly 0.4 usec per access when measured on a 2.8GHz development machine; so quite snappy and probably not a rich target for optimization efforts. zcan't set attribute)AttributeError)r!rrs r__set__lazyproperty.__set__s&233r)rr)rzCallable[..., T]rNoner)rrrrrr)rrrrrr) r:r;r<r=r>rrrr@r&rrrrs*X -:4rrc,URn[XS9$)z@write_only_property decorator. Creates a property (descriptor attribute) that accepts assignment, but not getattr (use in an expression). )fsetdoc)r>r?)f docstrings rwrite_only_propertyr s  I  **rc^\rSrSrSrS S SjjrS SjrS Sjr\S5r \S Sj5r S r g) ElementProxyiaBase class for lxml element proxy classes. An element proxy class is one whose primary responsibilities are fulfilled by manipulating the attributes and child elements of an XML element. They are the most common type of class in python-docx other than custom element (oxml) classes. NcXlX lgr_element_parent)r!elementparents rrElementProxy.__init__s   rc^[U[5(dgURURL$)a,Return |True| if this proxy object refers to the same oxml element as does `other`. ElementProxy objects are value objects and should maintain no mutable local state. Equality for proxy objects is defined as referring to the same XML element, whether or not they are the same proxy object instance. Frgrrr!others r__eq__ElementProxy.__eq__#s'%..}}..rc^[U[5(dgURURL$)NTrrs r__ne__ElementProxy.__ne__/s%%..}}ENN22rcUR$)z(The lxml element proxied by this object.)rr s rrElementProxy.element4s}}rc^URc [S5eURR$)(The package part containing this object.z(part is not accessible from this element)rrhpartr s rrElementProxy.part9s* << GH H||   rrr)rrrzt.ProvidesXmlPart | None)robject)rr ) r:r;r<r=r>rrrr?rrr@r&rrrrs> /3 !!rrc2\rSrSrSrSSjr\S5rSrg)ParentediAzProvides common services for document elements that occur below a part but may occasionally require an ancestor object to provide a service, such as add or drop a relationship. Provides ``self._parent`` attribute to subclasses. cXlgrrr!rs rrParented.__init__I rc.URR$rrrr s rr Parented.partL||   rrN)rzt.ProvidesXmlPart r:r;r<r=r>rr?rr@r&rrrrAs !!rrc6\rSrSrSrSSjr\SSj5rSrg) StoryChildiRaA document element within a story part. Story parts include DocumentPart and Header/FooterPart and can contain block items (paragraphs and tables). Items from the block-item subtree occasionally require an ancestor object to provide access to part-level or package-level items like styles or images or to add or drop a relationship. Provides `self._parent` attribute to subclasses. cXlgrrrs rrStoryChild.__init__]rrc.URR$rrr s rrStoryChild.part`rrrN)rzt.ProvidesStoryPart)rrrr&rrrrRs !!rrc:\rSrSrSrSS SjjrS SjrS SjrSrg) TextAccumulatorifa.Accepts `str` fragments and joins them together, in order, on `.pop(). Handy when text in a stream is broken up arbitrarily and you want to join it back together within certain bounds. The optional `separator` argument determines how the text fragments are punctuated, defaulting to the empty string. cXl/Ulgr _separator_texts)r! separators rrTextAccumulator.__init__ns#!# rc:URRU5 g)z'Add a text fragment to the accumulator.N)rappendr!texts rpushTextAccumulator.pushrs 4 rc## UR(dgURRUR5nURR5 Uv g7f)zGenerate sero-or-one str from those accumulated. Using `yield from accum.pop()` in a generator setting avoids producing an empty string when no text is in the accumulator. N)rrjoinclearrs rpopTextAccumulator.popvs> {{ ##DKK0  sAArN))rr~)rr~rr)rz Iterator[str]) r:r;r<r=r>rrrr@r&rrrrfs$! rr)rzCallable[[Any, Any], None])'r> __future__rrtypingrrrrrr r r r docx.typestypest docx.opc.partr docx.oxml.xmlchemyrdocx.parts.storyrrrrBrHrNrSrXr^rcrrrrrrrr&rrrs%"   %2*-=S-=`(V(((-&-(((((F(uS#s]#< CLl471:l4^+'!'!T!!"!!(r