o ewC@sdZddlmZddlZddlZddlmZddlmZddlmZej Gddde Z Gd d d e Z Gd d d e Z Gd dde ZGddde ZGdddeZdS)zContains Flag class - information about single command-line flag. Do NOT import this module directly. Import the flags package and use the aliases defined at the package level instead. )abcN)_argument_parser) _exceptions)_helpersc@seZdZdZ   d0ddZeddZejd dZd d Zd d Z ddZ ddZ ddZ ddZ ddZddZddZddZddZd d!Zd"d#Zd$d%Zd&d'Zd(d)Zd1d*d+Zd,d-Zd.d/ZdS)2Flaga Information about a command-line flag. Attributes: name: the name for this flag default: the default value for this flag default_unparsed: the unparsed default value for this flag. default_as_str: default value as repr'd string, e.g., "'true'" (or None) value: the most recent parsed value of this flag set by :meth:`parse` help: a help string or None if no help is available short_name: the single letter alias for this flag (or None) boolean: if 'true', this flag does not accept arguments present: true if this flag was parsed from command line flags parser: an :class:`~absl.flags.ArgumentParser` object serializer: an ArgumentSerializer object allow_override: the flag may be redefined without raising an error, and newly defined flag overrides the old one. allow_override_cpp: use the flag from C++ if available the flag definition is replaced by the C++ flag after init allow_hide_cpp: use the Python flag despite having a C++ flag with the same name (ignore the C++ flag) using_default_value: the flag value has not been set by user allow_overwrite: the flag may be parsed more than once without raising an error, the last set value will be used allow_using_method_names: whether this flag can be defined even if it has a name that conflicts with a FlagValues method. validators: list of the flag validators. The only public method of a ``Flag`` object is :meth:`parse`, but it is typically only called by a :class:`~absl.flags.FlagValues` object. The :meth:`parse` method is a thin wrapper around the :meth:`ArgumentParser.parse()` method. The parsed value is saved in ``.value``, and the ``.present`` attribute is updated. If this flag was already present, an Error is raised. :meth:`parse` is also called during ``__init__`` to parse the default value and initialize the ``.value`` attribute. This enables other python modules to safely use flags even if the ``__main__`` module neglects to parse the command line arguments. The ``.present`` attribute is cleared after ``__init__`` parsing. If the default value is set to ``None``, then the ``__init__`` parsing step is skipped and the ``.value`` attribute is initialized to None. Note: The default value is also presented to the user in the help string, so it is important that it be a legal value for this flag. NFTc Cs||_|sd}||_||_||_d|_||_||_||_| |_| |_ | |_ | |_ d|_ d|_ g|_|j r<|jr%s does not support shallow copies. Use copy.deepcopy instead.)r/type__name__r rrr__copy__sz Flag.__copy__cCs"tt|}t|j||_|Sr)object__new__r2copydeepcopy__dict__)rmemoresultrrr __deepcopy__szFlag.__deepcopy__cCsH|durdS|jrt|j|S|jr|rtdStdStt|S)z$Returns parsed flag value as string.Ntruefalse)rrepr serializer strr"rrr_get_parsed_value_as_strings z Flag._get_parsed_value_as_stringcCsB|jr|jstd|j||jf|||_|jd7_dS)z}Parses string and sets flag value. Args: argument: str or the correct flag value type, argument to be parsed. z#flag --%s=%s: already defined as %sN)r rrIllegalFlagValueErrorrr!_parse)rargumentrrrparses   z Flag.parsec CsBz|j|WSttfy }z td|j||fd}~ww)zInternal parse function. It returns the parsed value, and does not modify class states. Args: argument: str or the correct flag value type, argument to be parsed. Returns: The parsed value. zflag --%s=%s: %sN)r rGr/ ValueErrorrrDr)rrFerrrrEs z Flag._parsecCs|j|_d|_d|_dS)NTr)rr!rr r rrrunparses z Flag.unparsecCs ||jS)zSerializes the flag.) _serializer!r rrrr@s zFlag.serializecCsV|durdS|jr|rd|jSd|jS|js td|jd|j|j|fS)zInternal serialize function.Nz--%sz--no%s"Serializer not present for flag %sz--%s=%s)r rrrrr@r"rrrrKs  zFlag._serializecCsF||_|dur d|_n|||_||j|_|jr!|j|_dSdS)z@Changes the default value (and current value too) for this Flag.N)Zdefault_unparsedr_parse_from_defaultrBZdefault_as_strrr!r"rrrrs  zFlag._set_defaultcCs ||Sr)rEr"rrrrNs zFlag._parse_from_defaultcCs |jS)aReturns a str that describes the type of the flag. NOTE: we use strings, and not the types.*Type constants because our flags can have more exotic types, e.g., 'comma separated list of strings', 'whitespace separated list of strings', etc. r flag_typer rrrrPs zFlag.flag_typecCs&|d}|r|t|dd|t|d||t|d|j|jr4|t|d|j|jrB|t|d|j|jr[t|j t s[|j durX|j |j }nd }n|j }|t|d || |j }|t|d ||t|d |||D]}||q|S) a6Returns an XML element that contains this flag's information. This is information that is relevant to all flags (e.g., name, meaning, etc.). If you defined a flag that has some other pieces of info, then please override _ExtraXMLInfo. Please do NOT override this method. Args: doc: minidom.Document, the DOM document it should create nodes from. module_name: str,, the name of the module that defines this flag. is_key: boolean, True iff this flag is key for main module. Returns: A minidom.Element instance. flagkeyyesfilerr ZmeaningNrLrcurrentr2)Z createElementZ appendChildrcreate_xml_dom_elementrr r rr*rrAr@_serialize_value_for_xmlr!rP_extra_xml_dom_elements)rdoc module_nameZis_keyelementZdefault_serializedvalue_serializedrIrrr_create_xml_dom_elementsB     zFlag._create_xml_dom_elementcCs|S)z:Returns the serialized value, for use in an XML help text.rr"rrrrW!szFlag._serialize_value_for_xmlcCs |j|S)aReturns extra info about this flag in XML. "Extra" means "not already included by _create_xml_dom_element above." Args: doc: minidom.Document, the DOM document it should create nodes from. Returns: A list of minidom.Element. )r Z_custom_xml_dom_elements)rrYrrrrX%s zFlag._extra_xml_dom_elements)NFFFFTFF)r3 __module__ __qualname____doc__rpropertyr!setterr%r(r,r0r1r4r<rBrGrErJr@rKrrNrPr]rWrXrrrrrs:0       4 rcs"eZdZdZdfdd ZZS) BooleanFlagaBasic boolean flag. Boolean flags do not take any arguments, and their value is either ``True`` (1) or ``False`` (0). The false value is specified on the command line by prepending the word ``'no'`` to either the long or the short flag name. For example, if a Boolean flag was created whose long name was ``'update'`` and whose short name was ``'x'``, then this flag could be explicitly unset through either ``--noupdate`` or ``--nox``. Nc s0t}tt|j|d||||dfi|dS)NrC)rZ BooleanParsersuperrdr)rrrr r argsp __class__rrrBs   zBooleanFlag.__init__r)r3r_r`rar __classcell__rrrhrrd5s rdcs,eZdZdZ dfdd ZddZZS) EnumFlagzFBasic enum flag; its value can be any string from list of enum_values.NTc  sPt||}t} tt|j|| ||||fi|dd||jf|_dS)N<%s>: %s|)rZ EnumParserZArgumentSerializerrerkrjoinr ) rrrr enum_valuesr case_sensitiverfrggrhrrrKs   zEnumFlag.__init__cCs*g}|jjD] }|t|d|q|SN enum_value)r roappendrrVrrYelementsrsrrrrXSs  z EnumFlag._extra_xml_dom_elements)NTr3r_r`rarrXrjrrrhrrkHs rkcs.eZdZdZ  dfdd ZddZZS) EnumClassFlagz5Basic enum flag; its value is an enum class's member.NFc  sZtj||d}tj| d} tt|j|| ||||fi|dd|j|jf|_dS)Nrp) lowercaserlrm) rEnumClassParserZEnumClassSerializerrerxrrn member_namesr ) rrrr enum_classr rprfrgrqrhrrr^s   zEnumClassFlag.__init__cC0g}|jjjD] }|t|d|q |Srrr r} __members__keysrtrrVrurrrrXn z%EnumClassFlag._extra_xml_dom_elements)NFrwrrrhrrx[s rxcsPeZdZdZfddZddZfddZfdd Zd d Zd d Z Z S) MultiFlagaeA flag that can appear multiple time on the command-line. The value of such a flag is a list that contains the individual values from all the appearances of that flag on the command-line. See the __doc__ for Flag for most behavior of this class. Only differences in behavior are described here: * The default value may be either a single value or an iterable of values. A single value is transformed into a single-item list of that value. * The value of the flag is always a list, even if the option was only supplied once, and even if the default value is a single value cs(tt|j|i||jd7_dS)Nz4; repeat this option to specify a list of values)rerrr )rrfkwargsrhrrrszMultiFlag.__init__cCs:||}|jr|j|n||_|jt|7_dS)aParses one or more arguments with the installed parser. Args: arguments: a single argument or a list of arguments (typically a list of default values); a single argument is converted internally into a list containing one item. N)rEr r!extendlen)r arguments new_valuesrrrrGs zMultiFlag.parsecsBt|tjrt|tst|}t|ts|g}fdd|DS)Ncg|] }tt|qSr)rerrE).0itemrirrr sz$MultiFlag._parse..)r*rIterablerAlist)rrrhr rrEs  zMultiFlag._parsecs@js tdj|durdSfdd|D}d|S)See base class.rMNrLcrr)rerrK)rZ value_itemrrrrsz(MultiFlag._serialize.. )rrrrrn)rr!Zserialized_itemsrhr rrKs  zMultiFlag._serializecCsd|jS)rzmulti rOr rrrrPszMultiFlag.flag_typecCs6g}t|jdr|jjD] }|t|d|q |S)Nrors)hasattrr rortrrVrurrrrXs  z!MultiFlag._extra_xml_dom_elements) r3r_r`rarrGrErKrPrXrjrrrhrrvs   rcs4eZdZdZ d fdd ZddZddZZS) MultiEnumClassFlagzA multi_enum_class flag. See the __doc__ for MultiFlag for most behaviors of this class. In addition, this class knows how to handle enum.Enum instances as values for this flag type. Fc  s\tj||d}tjd| d}tt|j|||||fi|dd|j|p(df|_dS)Nry,)Zlist_seprzz<<%s>: %s; repeat this option to specify a list of valuesrmr) rr{ZEnumClassListSerializerrerrrnr|r ) rrrrr}rprfrgrqrhrrrs  zMultiEnumClassFlag.__init__cCr~rrrrurrrrXrz*MultiEnumClassFlag._extra_xml_dom_elementscCs |dur |j|}|Sd}|S)rNrL)rr@)rr!r\rrrrWs  z+MultiEnumClassFlag._serialize_value_for_xmlr^)r3r_r`rarrXrWrjrrrhrrs  r)ra collectionsrr7 functoolsZ absl.flagsrrrtotal_orderingr5rrdrkrxrrrrrrs     L