o W_+@sdZddlmZmZddlZddlZddlmZddZGdd d e Z Gd d d e Z Gd d d e Z e de fee jZGdddeZGddde ZGdddeZGdddeZGdddeZdS)z5 Base classes and other objects used by enumerations )absolute_importprint_functionN)InvalidXmlErrorcsfdd}|S)z Decorating a class with @alias('FOO', 'BAR', ..) allows the class to be referenced by each of the names provided as arguments. cs&td}|j}D]}|||<q |S)N)sys _getframe f_globals)clscallerZ globals_dictaliasaliases>D:\Projects\ConvertPro\env\Lib\site-packages\docx\enum\base.py decorators  zalias..decoratorr)rrrr rr s r c@s\eZdZdZddZeddZeddZdd Zed d Z ed d Z eddZ dS)_DocsPageFormatterzGenerate an .rst doc page for an enumeration. Formats a RestructuredText documention page (string) for the enumeration class parts passed to the constructor. An immutable one-shot service object. cCs||_||_dSN)_clsname_clsdict)selfclsnameclsdictrrr__init__&s z_DocsPageFormatter.__init__cCs d}|j|j|j|jf}||S)z The RestructuredText documentation page for the enumeration. This is the only API member for the class. z.. _%s: %s %s ---- %s)_ms_name _page_title _intro_text _member_defs)rtmpl componentsrrrpage_str*s  z_DocsPageFormatter.page_strcCs@z|jd}Wn tyd}Ynw|durdSt|S)z?Docstring of the enumeration, formatted for documentation page.__doc__N)rKeyErrortextwrapdedentstrip)rZ cls_docstringrrrr7s z_DocsPageFormatter._intro_textcCs0t|j}tj|dddd}d|j|fS)z Return an individual member definition formatted as an RST glossary entry, wrapped to fit within 78 columns. Nz )widthinitial_indentsubsequent_indentz%s %s )r$r% docstringr&fillname)rmemberZmember_docstringrrr _member_defDs z_DocsPageFormatter._member_defcs&jd}fdd|D}d|S)zx A single string containing the aggregated member definitions section of the documentation page __members__cs g|] }|jdur|qSr)r-r/).0r.rrr Ws  z3_DocsPageFormatter._member_defs.. )rjoin)rmembersZ member_defsrr2rrPs   z_DocsPageFormatter._member_defscCs |jdS)z= The Microsoft API name for this enumeration __ms_name__)rr2rrrr] z_DocsPageFormatter._ms_namecCs dt|jd}d|j|fS)z The title for the documentation page, formatted as code (surrounded in double-backtics) and underlined with '=' characters =z ``%s`` %s)lenr)rZtitle_underscorerrrrdsz_DocsPageFormatter._page_titleN) __name__ __module__ __qualname__r!rpropertyr rr/rrrrrrrrs     rc@s<eZdZdZddZeddZeddZedd Zd S) MetaEnumerationz The metaclass for Enumeration and its subclasses. Adds a name for each named member and compiles state needed by the enumeration class to respond to other attribute gets cCs0|||||||t||||Sr)_add_enum_members_collect_valid_settings_generate_docs_pagetype__new__)metarbasesrrrrrEts   zMetaEnumeration.__new__cCs |d}|D]}||qdS)z Dispatch ``.add_to_enum()`` call to each member so it can do its thing to properly add itself to the enumeration class. This delegation allows member sub-classes to add specialized behaviors. r0N) add_to_enum)rFr enum_membersr.rrrrAzs z!MetaEnumeration._add_enum_memberscCs.|d}g}|D]}||jq||d<dS)z Return a sequence containing the enumeration values that are valid assignment values. Return-only values are excluded. r0_valid_settingsN)extendvalid_settings)rFrrIrLr.rrrrBs  z'MetaEnumeration._collect_valid_settingscCst||j|d<dS)zH Return the RST documentation page for the enumeration. Z __docs_rst__N)rr )rFrrrrrrCs  z#MetaEnumeration._generate_docs_pageN) r<r=r>r!rE classmethodrArBrCrrrrr@ns   r@c@s$eZdZdZdZdZeddZdS)EnumerationBasez Base class for all enumerations, used directly for enumerations requiring only basic behavior. It's __dict__ is used below in the Python 2+3 compatible metaclass definition. rr"cCs ||jvrtd||jfdS)zK Raise |ValueError| if *value* is not an assignable value. z!%s not a member of %s enumerationN)rJ ValueErrorr<)r valuerrrvalidates  zEnumerationBase.validateN)r<r=r>r!r0r7rMrQrrrrrNs rN Enumerationc@s0eZdZdZdZdZeddZeddZdS) XmlEnumerationzg Provides ``to_xml()`` and ``from_xml()`` methods in addition to base enumeration features rr"cCs ||jvr td||j|S)za Return the enumeration member corresponding to the XML value *xml_val*. z,attribute value '%s' not valid for this type)_xml_to_memberr)r Zxml_valrrrfrom_xmls  zXmlEnumeration.from_xmlcCs&||jvrtd||jf|j|S)zK Return the XML value of the enumeration value *enum_val*. z value '%s' not in enumeration %s)_member_to_xmlrOr<)r Zenum_valrrrto_xmls   zXmlEnumeration.to_xmlN) r<r=r>r!r0r7rMrUrWrrrrrSs  rSc@sXeZdZdZddZddZeddZedd Zd d Z ed d Z eddZ dS) EnumMemberz` Used in the enumeration class definition to define a member value and its mappings cCs,||_t|trt|||}||_||_dSr)_name isinstanceint EnumValue_value _docstring)rr-rPr+rrrrs    zEnumMember.__init__cCs||dS)z: Add a name to *clsdict* for this member. N) register_namerrrrrrHszEnumMember.add_to_enumcC|jS)z0 The description of this member )r^r2rrrr+zEnumMember.docstringcCra)z The distinguishing name of this member within the enumeration class, e.g. 'MIDDLE' for MSO_VERTICAL_ANCHOR.MIDDLE, if this is a named member. Otherwise the primitive value such as |None|, |True| or |False|. )rYr2rrrr-szEnumMember.namecCs|jdurdS|j||j<dS)a  Add a member name to the class dict *clsdict* containing the value of this member object. Where the name of this object is None, do nothing; this allows out-of-band values to be defined without adding a name to the class dict. N)r-rPr`rrrr_s zEnumMember.register_namecCs|jfS)z A sequence containing the values valid for assignment for this member. May be zero, one, or more in number. r]r2rrrrLszEnumMember.valid_settingscCra)z The enumeration value for this member, often an instance of EnumValue, but may be a primitive value such as |None|. rcr2rrrrP szEnumMember.valueN) r<r=r>r!rrHr?r+r-r_rLrPrrrrrXs    rXcs@eZdZdZfddZfddZeddZdd ZZS) r\z A named enumeration value, providing __str__ and __doc__ string values for its symbolic name and description, respectively. Subclasses int, so behaves as a regular int unless the strings are asked for. cstt|||Sr)superr\rE)r member_name int_valuer+ __class__rrrEszEnumValue.__new__cstt|||_||_dSr)rdr\r _member_namer^)rrerfr+rgrrrs zEnumValue.__init__cCs |jS)z< The description of this enumeration member )r^r&r2rrrr!!r8zEnumValue.__doc__cCsd|jt|fS)zV The symbolic name and string value of this member, e.g. 'MIDDLE (3)' z%s (%d))rir[r2rrr__str__(szEnumValue.__str__) r<r=r>r!rErr?rj __classcell__rrrgrr\s   r\c@seZdZdZeddZdS)ReturnValueOnlyEnumMemberz Used to define a member of an enumeration that is only valid as a query result and is not valid as a setting, e.g. MSO_VERTICAL_ANCHOR.MIXED (-2) cCsdS)z@ No settings are valid for a return-only value. rrr2rrrrL4sz(ReturnValueOnlyEnumMember.valid_settingsN)r<r=r>r!r?rLrrrrrl/srlcsXeZdZdZfddZfddZddZedd Ze d d Z e d d Z Z S)XmlMappedEnumMemberzM Used to define a member whose value maps to an XML attribute value. cstt||||||_dSr)rdrmr _xml_value)rr-rP xml_valuer+rgrrr@s zXmlMappedEnumMember.__init__cstt||||dS)zH Compile XML mappings in addition to base add behavior. N)rdrmrHregister_xml_mappingr`rgrrrHDszXmlMappedEnumMember.add_to_enumcCs0||}|j||j<||}|j||j<dS)zR Add XML mappings to the enumeration class state for this member. N)_get_or_add_member_to_xmlrorP_get_or_add_xml_to_member)rrZ member_to_xmlZ xml_to_memberrrrrpKs   z(XmlMappedEnumMember.register_xml_mappingcCra)zT The XML attribute value that corresponds to this enumeration value )rnr2rrrroTrbzXmlMappedEnumMember.xml_valuecCd|vr t|d<|dS)zR Add the enum -> xml value mapping to the enumeration class state rVdictrrrrrq[ z-XmlMappedEnumMember._get_or_add_member_to_xmlcCrs)zR Add the xml -> enum value mapping to the enumeration class state rTrtrvrrrrrdrwz-XmlMappedEnumMember._get_or_add_xml_to_member) r<r=r>r!rrHrpr?ro staticmethodrqrrrkrrrgrrm<s    rm)r!Z __future__rrrr$ exceptionsrr objectrrDr@rNru__dict__rRrSrXr[r\rlrmrrrrs" P- ?