B 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}xD] }|||<qW|S)N)sys _getframe f_globals)clscallerZ globals_dictalias)aliases@/var/www/html/venv/lib/python3.7/site-packages/docx/enum/base.py decorators    zalias..decoratorr)r rr)r 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||_||_dS)N)_clsname_clsdict)selfclsnameclsdictrrr__init__&sz_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_strcCsBy|jd}Wntk r&d}YnX|dkr4dSt|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|]}|jdk r|qS)N)r+r-).0r,)rrr Xsz3_DocsPageFormatter._member_defs.. )rjoin)rmembersZ member_defsr)rrrPs z_DocsPageFormatter._member_defscCs |jdS)z= The Microsoft API name for this enumeration __ms_name__)r)rrrrr]sz_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__rrpropertyrrr-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||||S)N)_add_enum_members_collect_valid_settings_generate_docs_pagetype__new__)metarbasesrrrrrAts   zMetaEnumeration.__new__cCs$|d}x|D]}||qWdS)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. r.N) add_to_enum)rBr enum_membersr,rrrr=zs z!MetaEnumeration._add_enum_memberscCs2|d}g}x|D]}||jqW||d<dS)z Return a sequence containing the enumeration values that are valid assignment values. Return-only values are excluded. r._valid_settingsN)extendvalid_settings)rBrrErHr,rrrr>s  z'MetaEnumeration._collect_valid_settingscCst||j|d<dS)zH Return the RST documentation page for the enumeration. Z __docs_rst__N)rr)rBrrrrrr?sz#MetaEnumeration._generate_docs_pageN) r8r9r:rrA classmethodr=r>r?rrrrr<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 ||jkrtd||jfdS)zK Raise |ValueError| if *value* is not an assignable value. z!%s not a member of %s enumerationN)rF ValueErrorr8)r valuerrrvalidates zEnumerationBase.validateN)r8r9r:rr.r4rIrMrrrrrJsrJ Enumerationc@s0eZdZdZdZdZeddZeddZdS) XmlEnumerationzg Provides ``to_xml()`` and ``from_xml()`` methods in addition to base enumeration features rr cCs ||jkrtd||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&||jkrtd||jf|j|S)zK Return the XML value of the enumeration value *enum_val*. z value '%s' not in enumeration %s)_member_to_xmlrKr8)r Zenum_valrrrto_xmls zXmlEnumeration.to_xmlN) r8r9r:rr.r4rIrQrSrrrrrOs  rOc@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|||}||_||_dS)N)_name isinstanceint EnumValue_value _docstring)rr+rLr)rrrrs   zEnumMember.__init__cCs||dS)z: Add a name to *clsdict* for this member. N) register_name)rrrrrrDszEnumMember.add_to_enumcCs|jS)z0 The description of this member )rZ)rrrrr)szEnumMember.docstringcCs|jS)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|. )rU)rrrrr+szEnumMember.namecCs|jdkrdS|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+rL)rrrrrr[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. )rY)rrrrrHszEnumMember.valid_settingscCs|jS)z The enumeration value for this member, often an instance of EnumValue, but may be a primitive value such as |None|. )rY)rrrrrL szEnumMember.valueN) r8r9r:rrrDr;r)r+r[rHrLrrrrrTs   rTcs@eZdZdZfddZfddZeddZdd ZZS) rXz 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|||S)N)superrXrA)r member_name int_valuer)) __class__rrrAszEnumValue.__new__cstt|||_||_dS)N)r\rXr _member_namerZ)rr]r^r))r_rrrszEnumValue.__init__cCs |jS)z< The description of this enumeration member )rZr$)rrrrr!szEnumValue.__doc__cCsd|jt|fS)zV The symbolic name and string value of this member, e.g. 'MIDDLE (3)' z%s (%d))r`rW)rrrr__str__(szEnumValue.__str__) r8r9r:rrArr;ra __classcell__rr)r_rrXs    rXc@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. rr)rrrrrH4sz(ReturnValueOnlyEnumMember.valid_settingsN)r8r9r:rr;rHrrrrrc/srccsXeZdZdZfddZfddZddZedd 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||||||_dS)N)r\rdr _xml_value)rr+rL xml_valuer))r_rrr@szXmlMappedEnumMember.__init__cstt||||dS)zH Compile XML mappings in addition to base add behavior. N)r\rdrDregister_xml_mapping)rr)r_rrrDDszXmlMappedEnumMember.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_xmlrfrL_get_or_add_xml_to_member)rrZ member_to_xmlZ xml_to_memberrrrrgKs   z(XmlMappedEnumMember.register_xml_mappingcCs|jS)zT The XML attribute value that corresponds to this enumeration value )re)rrrrrfTszXmlMappedEnumMember.xml_valuecCsd|krt|d<|dS)zR Add the enum -> xml value mapping to the enumeration class state rR)dict)rrrrrh[s z-XmlMappedEnumMember._get_or_add_member_to_xmlcCsd|krt|d<|dS)zR Add the xml -> enum value mapping to the enumeration class state rP)rj)rrrrrids z-XmlMappedEnumMember._get_or_add_xml_to_member) r8r9r:rrrDrgr;rf staticmethodrhrirbrr)r_rrd<s    rd)r __future__rrrr" exceptionsrr objectrr@r<rJrj__dict__rNrOrTrWrXrcrdrrrrs P- ?