o SiM@sdZddlmZddlZddlZddlZddlmZmZm Z ddl m Z ddl m Z ddl mZddl mZe d Ze d ejd ZejGd d d eeZGdddeeZGdddeeZGdddeeZGdddeeeeeZGdddeeZdS)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. )IterableN)AnyGenericTypeVar)minidom)_argument_parser) _exceptions)_helpers_T_ET)boundc@s:eZdZUdZedBed<edBed<edBeBed<ejeed<       dFdejed ej edBd ededBeBd edBd edBd e de de de de de ddfddZ e dedBfddZ e jdedBfddZ ddZddZddZd d!Zd"d#Zd$d%Zd&eeefdd'fd(d)ZdedBdedBfd*d+Zd,eeBddfd-d.Zd,eeBdedBfd/d0ZdGd1d2Zdefd3d4ZdedBdefd5d6ZdedBeBddfd7d8ZdeeBdedBfd9d:Z defd;d<Z! dHd=e"j#d>ed?e de"j$fd@dAZ%dedBdefdBdCZ&d=e"j#de'e"j$fdDdEZ(dS)IFlaga 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. Ndefaultdefault_as_strdefault_unparsedparserFT serializername help_string short_namebooleanallow_overrideallow_override_cppallow_hide_cppallow_overwriteallow_using_method_namesreturnc Cs||_|sd}||_||_||_d|_||_||_||_| |_| |_ | |_ | |_ d|_ d|_ g|_|j r<|jr%s does not support shallow copies. Use copy.deepcopy instead.)r:type__name__r+r&r&r'__copy__sz Flag.__copy__memozFlag[_T]cCs"tt|}t|j||_|Sr))object__new__r=copydeepcopy__dict__)r%r@resultr&r&r' __deepcopy__szFlag.__deepcopy__cCsH|durdS|jrt|j|S|jr|rtdStdStt|S)z$Returns parsed flag value as string.Ntruefalse)rrepr serializerstrr-r&r&r'_get_parsed_value_as_strings z Flag._get_parsed_value_as_stringargumentcCsB|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)rrrIllegalFlagValueErrorrr,_parse)r%rNr&r&r'parses   z Flag.parsec CsDz|j|WStttfy!}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)rrRr: ValueError OverflowErrorrrPr)r%rNer&r&r'rQs z Flag._parsecCs|j|_d|_d|_dS)NTr)rr,r rr+r&r&r'unparses z Flag.unparsecCs ||jS)zSerializes the flag.) _serializer,r+r&r&r'rKs 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)rrrrr#rKr-r&r&r'rWs  zFlag._serializecCsF||_|dur d|_n|||_||j|_|jr!|j|_dSdS)z@Changes the default value (and current value too) for this Flag.N)rr_parse_from_defaultrMrr r,r-r&r&r'r$s  zFlag._set_defaultcCs ||Sr))rQr-r&r&r'rZs 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+r&r&r'r\s zFlag.flag_typedoc module_nameis_keycCs&|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. flagkeyyesfilerrmeaningNrXrcurrentr=) createElement appendChildr create_xml_dom_elementrrrrr5rrLrK_serialize_value_for_xmlr,r\_extra_xml_dom_elements)r%r]r^r_elementdefault_serializedvalue_serializedrUr&r&r'_create_xml_dom_elementsB     zFlag._create_xml_dom_elementcCs|S)z:Returns the serialized value, for use in an XML help text.r&r-r&r&r'ri<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_custom_xml_dom_elements)r%r]r&r&r'rj@s zFlag._extra_xml_dom_elements)NFFFFTF)rNF))r> __module__ __qualname____doc__r __annotations__rLrArgumentParserArgumentSerializerboolr(propertyr,setterr0r3r7r;r<r?dictintrrGrMrRrQrVrKrWr$rZr\rDocumentElementrnrilistrjr&r&r&r'r $s  0          *     6r c sJeZdZdZ d dededBeBdedBdedBddf fdd 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``. Nrrrrrc s,t}tj|d||||dfi|dSNT)r BooleanParsersuperr()r%rrrrargsp __class__r&r'r(_s$zBooleanFlag.__init__r))r>rqrrrsrLrwr( __classcell__r&r&rr'rRs rc sveZdZUdZejed<  ddededBdedBdeed edBd e f fd d Z d e j de e jfddZZS)EnumFlagzFBasic enum flag; its value can be any string from list of enum_values.rNTrrr enum_valuesrcase_sensitivec  sTt||}t} tj|| ||||fi|||_dd|j|jf|_dS)N<%s>: %s|) r EnumParserrvrr(rjoinrr) r%rrrrrrrrgrr&r'r(ps zEnumFlag.__init__r]rcCs*g}|jjD] }|t|d|q|SN enum_value)rrappendr rhr%r]elementsrr&r&r'rjs  z EnumFlag._extra_xml_dom_elementsr)r>rqrrrsrrrtrLrrwr(rr|r~r}rjrr&r&rr'rks.  rc szeZdZUdZejed<  ddededBeBdedBde ed edBd e f fd d Z d e j dee jfddZZS) EnumClassFlagz5Basic enum flag; its value is an enum class's member.rNFrrr enum_classrrc  s\tj||d}tj| d} tj|| ||||fi|||_dd|j|jf|_dS)Nr) lowercaserr) rEnumClassParserEnumClassSerializerrr(rr member_namesr) r%rrrrrrrrrrr&r'r(s zEnumClassFlag.__init__r]rcC0g}|jjjD] }|t|d|q |Srrr __members__keysrr rhrr&r&r'rj z%EnumClassFlag._extra_xml_dom_elements)NF)r>rqrrrsrrrtrLr r=rwr(rr|r~r}rjrr&r&rr'rs.   rcseZdZdZfddZdeeBeeBfddZdeeBeeBde effdd Z d e ed Bdeffd d Z ddZ de jde e jfddZZS) 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$tj|i||jd7_dS)Nz4; repeat this option to specify a list of values)rr(r)r%rkwargsrr&r'r(szMultiFlag.__init__ argumentscCsH||}|jr|jdusJ|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)rQrr,extendlen)r%r new_valuesr&r&r'rRs zMultiFlag.parsercs@t|tr |g}n t|trt|}n|g}fdd|DS)Ncg|] }tt|qSr&)rrrQ).0itemrr%r&r' sz$MultiFlag._parse..)r5rLrr~)r%rarguments_listrr+r'rQs   zMultiFlag._parser,Ncs@js tdj|durdSfdd|D}d|S)See base class.rYNrXcrr&)rrrW)r value_itemrr&r'rsz(MultiFlag._serialize.. )rrr#rr)r%r,serialized_itemsrr+r'rWs  zMultiFlag._serializecCsd|jS)rzmulti r[r+r&r&r'r\szMultiFlag.flag_typer]cCs6g}t|jdr|jjD] }|t|d|q |S)Nrr)hasattrrrrr rhrr&r&r'rjs  z!MultiFlag._extra_xml_dom_elements)r>rqrrrsr(rLr rrRr~rQrWr\rr|r}rjrr&r&rr'rs &rc seZdZUdZejeed< ddedde eBeBe eBeBdede ed e f fd d Z d e jd ee jfddZddZZS)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. rFrrNrrrc  sdtj||d}tjd| d}tj|||||fi|||_||_dd|j|p,df|_ dS)Nr,)list_seprz<<%s>: %s; repeat this option to specify a list of valuesrr) rrEnumClassListSerializerrr(rrrrr) r%rrrrrrrrrr&r'r( s zMultiEnumClassFlag.__init__r]rcCrrrrr&r&r'rj#rz*MultiEnumClassFlag._extra_xml_dom_elementscCs6|dur|jstd|j|j|}|Sd}|S)rNrYrX)rrr#rrK)r%r,rmr&r&r'ri,s z+MultiEnumClassFlag._serialize_value_for_xmlrp)r>rqrrrsrrr rtrLrr=rwr(rr|r~r}rjrirr&r&rr'rs*   r)rscollections.abcrrCenum functoolstypingrrrxml.domr absl.flagsrrr r Enumr total_orderingr rwrrLrrr~rrr&r&r&r's*     / "T