a IDg^@sdZddlZddlZddlZddlZddlZddlZddlZddlZddl Z ddl Z ddl m Z ddl Z e jdkrddlmZn ddlmZejejejejejgZe jdkreejddZnd dZeeZiZd8d d Zd9d d ZGdddejejej Z!Gddde"Z#Gddde$Z%Gddde#Z&Gddde#Z'Gddde#Z(e)dZ*ej)dej+dZ,ej-dddd:d d!Z.d;d"d#Z/d$d%Z0d&d'Z1Gd(d)d)e#Z2Gd*d+d+e#Z3Gd,d-d-e#Z4d.Z5d/Z6d0Z7d1Z8Gd2d3d3ej9Z9d4d5Z:d6d7Z;ejZ>ejZej?Z?ej@Z@ejAZAejBZBejCZCejDZDej Z ejZejEZEejFZFejGZGejHZHejIZIejJZJeZKeZLeZMeZNeZOeZPe9ZQe9ZRejrcCsdS)NFr r r r r r!rcKsX|dur d}|tvr(td|t|f|dtj|ddtfi|t|<dS)zCreates a global ArgumentParser instance with the given name, passing any args other than "name" to the ArgumentParser constructor. This instance can then be retrieved using get_argument_parser(..) Ndefaultzbkwargs besides 'name' can only be passed in the first time. '%s' ArgumentParser already exists: %sformatter_classconflict_handlerresolve)_parsers ValueError setdefaultrArgumentDefaultsHelpFormatterArgumentParsernamekwargsr r r init_argument_parser)s rcKs8|dur d}t|dks |tvr0t|fi|t|S)a Returns the global ArgumentParser instance with the given name. The 1st time this function is called, a new ArgumentParser instance will be created for the given name, and any args other than "name" will be passed on to the ArgumentParser constructor. Nrr)lenrrrr r r get_argument_parser<s rc@seZdZdZdS) ArgumentDefaultsRawHelpFormatterzCHelpFormatter that adds default values AND doesn't do line-wrappingN__name__ __module__ __qualname____doc__r r r r rKsrc@s(eZdZdZddZddZddZdS) ConfigFileParserzRThis abstract class can be extended to add support for new config file formatscCs tddS)z3Returns a string describing the config file syntax.z*get_syntax_description(..) not implementedNNotImplementedErrorselfr r r get_syntax_descriptionWsz'ConfigFileParser.get_syntax_descriptioncCs tddS)aUParses the keys and values from a config file. NOTE: For keys that were specified to configargparse as action="store_true" or "store_false", the config file value must be one of: "yes", "no", "on", "off", "true", "false". Otherwise an error will be raised. Args: stream (IO): A config file input stream (such as an open file object). Returns: OrderedDict: Items where the keys are strings and the values are either strings or lists (eg. to support config file formats like YAML which allow lists). zparse(..) not implementedNr&)r)streamr r r parse[szConfigFileParser.parsecCs tddS)aDoes the inverse of config parsing by taking parsed values and converting them back to a string representing config file contents. Args: items: an OrderedDict of items to be converted to the config file format. Keys should be strings, and values should be either strings or lists. Returns: Contents of config file as a string zserialize(..) not implementedNr&)r)itemsr r r serializels zConfigFileParser.serializeNr!r"r#r$r*r,r.r r r r r%Ssr%c@seZdZdZdS)ConfigFileParserExceptionz'Raised when config file parsing failed.Nr r r r r r0{sr0c@s(eZdZdZddZddZddZdS) DefaultConfigFileParsera Based on a simplified subset of INI and YAML formats. Here is the supported syntax .. code:: # this is a comment ; this is also a comment (.ini style) --- # lines that start with --- are ignored (yaml style) ------------------- [section] # .ini-style section names are treated as comments # how to specify a key-value pair (all of these are equivalent): name value # key is case sensitive: "Name" isn't "name" name = value # (.ini style) (white space is ignored, so name = value same as name=value) name: value # (yaml style) --name value # (argparse style) # how to set a flag arg (eg. arg which has action="store_true") --name name name = True # "True" and "true" are the same # how to specify a list arg (eg. arg which has action="append") fruit = [apple, orange, lemon] indexes = [1, 12, 35 , 40] cCsd}|S)NzrConfig file syntax allows: key=value, flag=true, stuff=[a,b,c] (for details, see syntax at https://goo.gl/R74nmi).r r)msgr r r r*sz.DefaultConfigFileParser.get_syntax_descriptionc CsNt}t|D]8\}}|}|r|ddvs|dr[^:=;#\s]+)\s*(?:(?P[:=\s])\s*([\'"]?)(?P.+?)?\3)?\s*(?:\s[;#]\s*(?P.*?)\s*)?$keyequalvaluecomment truer6]cSsg|] }|qSr strip.0elemr r r rz1DefaultConfigFileParser.parse..,zUnexpected line {} in {}: {}rr+)r enumerater@ startswithrematchgroupendswithjsonloads Exceptionsplitr0formatgetattr) r)r+r-ilinerKr7r8r9r:er r r r,s:    2  zDefaultConfigFileParser.parsecCsTt}|D]<\}}t|tr8ddtt|d}|d||q| S)Nr6, r>z{} = {} ) rr-rlistjoinmapstrwriterRgetvalue)r)r-rr7r9r r r r.s  z!DefaultConfigFileParser.serializeNr/r r r r r1s$r1c@s(eZdZdZddZddZddZdS) ConfigparserConfigFileParserz,parses INI files using pythons configparser.cCsd}|S)NaUses configparser module to parse an INI file which allows multi-line values. Allowed syntax is that for a ConfigParser with the following options: allow_no_value = False, inline_comment_prefixes = ("#",) strict = True empty_lines_in_values = False See https://docs.python.org/3/library/configparser.html for details. Note: INI file sections names are still treated as comments. r r2r r r r*sz3ConfigparserConfigFileParser.get_syntax_descriptionc Csddl}ddlm}|jddddddd}z||Wn0tyl}ztd|WYd}~n d}~00t}| D]t}|| D]b\}} | d d  d d } d | vrd | vr| d d} d| vr|| ||<q| ||<q| ||<qq||S)Nr) literal_eval)=:F)r4r5T) delimitersallow_no_valuecomment_prefixesinline_comment_prefixesstrictempty_lines_in_valuesCouldn't parse config file: %s r; r6r>{) configparserastr` ConfigParser read_stringreadrPr0rsectionsr-replacerQ) r)r+rmr`configrVresultsectionkvZmultiLine2SingleLineZprelist_stringr r r r,s2 "   z"ConfigparserConfigFileParser.parsecCsXddl}ddl}|jddddd}d|i}|||}|||d|S)NrF)r4T)rdrfrgrhDEFAULT)rmioro read_dictrr\seekrq)r)r-rmrzrtr+r r r r.s   z&ConfigparserConfigFileParser.serializeNr/r r r r r_s#r_c@s2eZdZdZddZddZddZd d d Zd S) YAMLConfigFileParserzdParses YAML config files. Depends on the PyYAML module. https://pypi.python.org/pypi/PyYAML cCsd}|S)NzThe config file uses YAML syntax and must represent a YAML 'mapping' (for details, see http://learn.getgrav.org/advanced/yaml).r r2r r r r*sz+YAMLConfigFileParser.get_syntax_descriptioncCszz ddl}Wnty&tdYn0zddlm}ddlm}Wn*tynddlm}ddlm}Yn0|||fS)zjlazy-import PyYAML so that configargparse doesn't have to depend on it unless this parser is used.rNzJCould not import yaml. It can be installed by running 'pip install PyYAML') CSafeLoader)CDumper) SafeLoader)Dumper)yaml ImportErrorr0r~rrr)r)rrrr r r _load_yaml$s     zYAMLConfigFileParser._load_yamlc Cs|\}}}z|j||d}Wn0tyP}ztd|WYd}~n d}~00t|tsztdt|ddt|jft }| D]2\}} t| t r| ||<q| durqt | ||<q|S)N)LoaderrizThe config file doesn't appear to contain 'key: value' pairs (aka. a YAML mapping). yaml.load('%s') returned type '%s' instead of 'dict'.rr+) rloadrPr0rdictrStyper!rr-rXr[) r)r+rr_Z parsed_objrVrur7r9r r r r,6s$"   zYAMLConfigFileParser.parseFcCs&|\}}}t|}|j|||dS)N)default_flow_styler)rrdump)r)r-rrrrr r r r.PszYAMLConfigFileParser.serializeN)F)r!r"r#r$r*rr,r.r r r r r}s r}z1(^\"(?:\\.|[^\"\\])*\"$)|(^\'(?:\\.|[^\'\\])*\'$)z(^\"\"\"(\s+)?(([^\"]|\"([^\"]|\"[^\"]))*(\"\"?)?)?(\s+)?(?:\\.|[^\"\\])?\"\"\"$)|(^\'\'\'(\s+)?(([^\']|\'([^\']|\'[^\']))*(\'\'?)?)?(\s+)?(?:\\.|[^\'\\])?\'\'\'$))flagsT)maxsizetypedcCs tt|p|ott|S)zu Detect whether a string is a quoted representation. :param triple: Also match tripple quoted strings. )bool_QUOTED_STR_REGEXrK_TRIPLE_QUOTED_STR_REGEX)texttripler r r is_quoted}src Cslt||drhzt|}t|ts&JWn:tyb}z"td|d||WYd}~n d}~00|S|S)a Unquote a maybe quoted string representation. If the string is not detected as being a quoted representation, it returns the same string as passed. It supports all kinds of python quotes: ``"""``, ``'''``, ``"`` and ``'``. :param triple: Also unquote tripple quoted strings. @raises ValueError: If the string is detected as beeing quoted but literal_eval() fails to evaluate it as string. This would be a bug in the regex. rz+Error trying to unquote the quoted string: : N)rrnr`rr[rPr)rrsrVr r r unquote_strs  ,rcCsBg}tj|gddD]$}|D]}|t|ddqqt|S)u Parse a TOML section name to a sequence of strings. The following names are all valid: .. python:: "a.b.c" # this is best practice -> returns ("a", "b", "c") " d.e.f " # same as [d.e.f] -> returns ("d", "e", "f") " g . h . i " # same as [g.h.i] -> returns ("g", "h", "i") ' j . "ʞ" . "l" ' # same as [j."ʞ"."l"], double or simple quotes here are supported. -> returns ("j", "ʞ", "l") .) delimiterFr)csvreaderappendrr@tuple) section_namervrowar r r parse_toml_section_names rcCs\t|trt|n|}||d}|s,dS|dd}|rFt||St|tsTdS|SdS)z Given some TOML data (as loaded with `toml.load()`), returns the requested section of the data. Returns ``None`` if the section is not found. rNrE)rr[rgetget_toml_sectionr)datarvrrZitemdatar r r rs   rcs8eZdZdZfddZddZddZdd ZZS) TomlConfigParsera( Create a TOML parser bounded to the list of provided sections. Example:: # this is a comment [tool.my-software] # TOML section table. # how to specify a key-value pair format-string = "restructuredtext" # strings must be quoted # how to set an arg which has action="store_true" warnings-as-errors = true # how to set an arg which has action="count" or type=int verbosity = 1 # how to specify a list arg (eg. arg which has action="append") repeatable-option = ["https://docs.python.org/3/objects.inv", "https://twistedmatrix.com/documents/current/api/objects.inv"] # how to specify a multiline text: multi-line-text = ''' Lorem ipsum dolor sit amet, consectetur adipiscing elit. Vivamus tortor odio, dignissim non ornare non, laoreet quis nunc. Maecenas quis dapibus leo, a pellentesque leo. ''' Note that the config file fragment above is also valid for the `IniConfigParser` class and would be parsed the same manner. Thought, any valid TOML config file will not be necessarly parsable with `IniConfigParser` (INI files must be rigorously indented whereas TOML files). See the `TOML specification <>`_ for details. cst||_dS)zO :param sections: The section names bounded to the new parser. N)super__init__rr)r)rr __class__r r rs zTomlConfigParser.__init__cCs|Srr r(r r r __call__szTomlConfigParser.__call__c Csddl}z||}Wn0tyF}ztd|WYd}~n d}~00t}|jD]R}t||}|rT|D]2\}} t| t r| ||<qn| durqnt | ||<qnqqT|S)z3Parses the keys and values from a TOML config file.rNzCouldn't parse TOML file: %s) tomlrrPr0rrrrr-rrXr[) r)r+rrtrVrurvrr7r9r r r r,s""    zTomlConfigParser.parsecCsdS)NzConfig file syntax is Tom's Obvious, Minimal Language. See https://github.com/toml-lang/toml/blob/v0.5.0/README.md for details.r r(r r r r*sz'TomlConfigParser.get_syntax_description r!r"r#r$rrr,r* __classcell__r r rr rs  rcs8eZdZdZfddZddZddZdd ZZS) IniConfigParsera Create a INI parser bounded to the list of provided sections. Optionaly convert multiline strings to list. Example (if split_ml_text_to_list=False):: # this is a comment ; also a comment [my-software] # how to specify a key-value pair format-string: restructuredtext # white space are ignored, so name = value same as name=value # this is why you can quote strings quoted-string = ' hello mom... ' # how to set an arg which has action="store_true" warnings-as-errors = true # how to set an arg which has action="count" or type=int verbosity = 1 # how to specify a list arg (eg. arg which has action="append") repeatable-option = ["https://docs.python.org/3/objects.inv", "https://twistedmatrix.com/documents/current/api/objects.inv"] # how to specify a multiline text: multi-line-text = Lorem ipsum dolor sit amet, consectetur adipiscing elit. Vivamus tortor odio, dignissim non ornare non, laoreet quis nunc. Maecenas quis dapibus leo, a pellentesque leo. Example (if split_ml_text_to_list=True):: # the same rules are applicable with the following changes: [my-software] # how to specify a list arg (eg. arg which has action="append") repeatable-option = # Just enter one value per line (the list literal format can also be used) https://docs.python.org/3/objects.inv https://twistedmatrix.com/documents/current/api/objects.inv # how to specify a multiline text (you have to quote it): multi-line-text = ''' Lorem ipsum dolor sit amet, consectetur adipiscing elit. Vivamus tortor odio, dignissim non ornare non, laoreet quis nunc. Maecenas quis dapibus leo, a pellentesque leo. ''' cst||_||_dS)z :param sections: The section names bounded to the new parser. :split_ml_text_to_list: Wether to convert multiline strings to list N)rrrrsplit_ml_text_to_list)r)rrrrr r r2s zIniConfigParser.__init__cCs|Srr r(r r r r;szIniConfigParser.__call__c Csddl}|}z||Wn0tyR}ztd|WYd}~n d}~00t}||jgD]f}||jvr|qj|| D]F\}}| } | sq| dr | dr zt | ||<Wn<ty}z"tdt|d|WYd}~n d}~00qt| r\zt| ||<Wn4tyX}ztt||WYd}~n d}~00q|jrd|dvrzd d | dD||<Wn4ty}ztt||WYd}~n d}~00q|||<qqj|S) z3Parses the keys and values from an INI config file.rNzCouldn't parse INI file: %sr6r>zError evaluating list: z;. Put quotes around your text if it's meant to be a string.rjcSsg|]}|rt|qSr )r)rBrTr r r rDdrz)IniConfigParser.parse..)rmrorprqrPr0rrr DEFAULTSECTr-r@rIrMrnr`rr[rrrrstriprQ) r)r+rmrtrVrurvrwrxZstrip_vr r r r,>s>" . && zIniConfigParser.parsecCsd}|jr|d7}|S)NzUses configparser module to parse an INI file which allows multi-line values. See https://docs.python.org/3/library/configparser.html for details. This parser includes support for quoting strings literal as well as python list syntax evaluation. z{Alternatively lists can be constructed with a plain multiline string, each non-empty line will be converted to a list item.)rr2r r r r*lsz&IniConfigParser.get_syntax_descriptionrr r rr rs + .rcs8eZdZdZfddZddZddZdd ZZS) CompositeConfigParserz Createa a config parser composed by others `ConfigFileParser`s. The composite parser will successively try to parse the file with each parser, until it succeeds, else raise execption with all encountered errors. cstdd|D|_dS)NcSsg|] }|qSr r )rBpr r r rDrz2CompositeConfigParser.__init__..)rrparsers)r)Zconfig_parser_typesrr r r}s zCompositeConfigParser.__init__cCs|Srr r(r r r rszCompositeConfigParser.__call__c Cs|g}|jD]N}z||WStyV}z |d||WYd}~q d}~00q tdddd|DdS)NrzError parsing config: rWcss|]}tt|VqdSr)reprr[)rBrVr r r rz.CompositeConfigParser.parse..)rr,rPr|rr0rY)r)r+errorsrrVr r r r,s  "zCompositeConfigParser.parsec CsPdd}d}t|jD]4\}}|d|dd||jjd|d7}q|S) NcSs6|ddddddd}|r2|SdS)Nrparserr<rtfilez??)lowerr@rsupper) classnamer@r r r guess_format_nameszGCompositeConfigParser.get_syntax_description..guess_format_namez2Uses multiple config parser settings (in order): r6rEz] rz )rHrrr!r*)r)rr3rTrr r r r*s .z,CompositeConfigParser.get_syntax_descriptionrr r rr rus   rZ command_lineZenvironment_variables config_filedefaultsc@seZdZdZddZdddejfddZdddejdfdd Zd d Z dd d Z ddZ ddZ ddZ ddZddZddZejfddZddZdS)rzDrop-in replacement for `argparse.ArgumentParser` that adds support for environment variables and ``.ini`` or ``.yaml-style`` config files. cOs|dd}|dd}|dd}|dg}|dd}|d t}|d g} |d d} |d d } |dg} |dd} |dt|_||_||_||_tjj |g|Ri||durt|_ n||_ ||_ ||_ | r|j | d| | dd| r|j | dd| dddS)aR Supports args of the `argparse.ArgumentParser` constructor as \*\*kwargs, as well as the following additional args. Arguments: add_config_file_help: Whether to add a description of config file syntax to the help message. add_env_var_help: Whether to add something to the help message for args that can be set through environment variables. auto_env_var_prefix: If set to a string instead of None, all config- file-settable options will become also settable via environment variables whose names are this prefix followed by the config file key, all in upper case. (eg. setting this to ``foo_`` will allow an arg like ``--my-arg`` to also be set via the FOO_MY_ARG environment variable) default_config_files: When specified, this list of config files will be parsed in order, with the values from each config file taking precedence over previous ones. This allows an application to look for config files in multiple standard locations such as the install directory, home directory, and current directory. Also, shell \* syntax can be used to specify all conf files in a directory. For example:: ["/etc/conf/app_config.ini", "/etc/conf/conf-enabled/*.ini", "~/.my_app_config.ini", "./app_config.txt"] ignore_unknown_config_file_keys: If true, settings that are found in a config file but don't correspond to any defined configargparse args will be ignored. If false, they will be processed and appended to the commandline like other args, and can be retrieved using parse_known_args() instead of parse_args() config_file_open_func: function used to open a config file for reading or writing. Needs to return a file-like object. config_file_parser_class: configargparse.ConfigFileParser subclass which determines the config file format. configargparse comes with DefaultConfigFileParser and YAMLConfigFileParser. args_for_setting_config_path: A list of one or more command line args to be used for specifying the config file path (eg. ["-c", "--config-file"]). Default: [] config_arg_is_required: When args_for_setting_config_path is set, set this to True to always require users to provide a config path. config_arg_help_message: the help message to use for the args listed in args_for_setting_config_path. args_for_writing_out_config_file: A list of one or more command line args to use for specifying a config file output path. If provided, these args cause configargparse to write out a config file with settings based on the other provided commandline args, environment variants and defaults, and then to exit. (eg. ["-w", "--write-out-config-file"]). Default: [] write_out_config_file_arg_help_message: The help message to use for the args in args_for_writing_out_config_file. add_config_file_helpTadd_env_var_helpauto_env_var_prefixNdefault_config_filesignore_unknown_config_file_keysFconfig_file_parser_classargs_for_setting_config_pathconfig_arg_is_requiredconfig_arg_help_messagezconfig file path args_for_writing_out_config_file&write_out_config_file_arg_help_messagezftakes the current command line args and writes them out to a config file at the given path, then exitsZconfig_file_open_funcr)destrequiredhelpis_config_file_argZ"write_out_config_file_to_this_pathZCONFIG_OUTPUT_PATH)rmetavarris_write_out_config_file_arg)popr1open_config_file_open_func_add_config_file_help_add_env_var_help_auto_env_var_prefixrrr_config_file_parser_default_config_files _ignore_unknown_config_file_keys add_argument)r)argsrrrrrrrrrrrrr r r rsZ:      zArgumentParser.__init__NcCs4|j||||dd\}}|r0|dd||S)aSupports all the same args as the `argparse.ArgumentParser.parse_args()`, as well as the following additional args. Arguments: args: a list of args as in argparse, or a string (eg. "-x -y bla") config_file_contents: String. Used for testing. env_vars: Dictionary. Used for testing. Returns: argparse.Namespace: namespace F)r namespaceconfig_file_contentsenv_varsignore_help_argszunrecognized arguments: %sr;)parse_known_argserrorrY)r)rrrrargvr r r parse_argss  zArgumentParser.parse_argsFc sdurtjddnttr,ntjD]}|j |_q:|r\ddDt _ rdtf}d|ij t <j durjD]j} |}|r|js|js|js|jst|tjst|tjs|dj} j | dd|_qg} d } fd djD} | D]} | j}|}| jsJt| tjrd } |d r|d rzt|}Wn0tydd|dddD}Yn0| | ||7} q"| r̈| n| | rt fdd| Dj t <t!ddjD}|o dvp dv}fddjD}g}|durZt"|}d|_#|g}n|sj$}t%|D]f}z^zj&'|}Wn4t(y}z)t|WYd}~n d}~00Wt*|dr|+nt*|dr|+0g}d } |,D]\}}||vr*||} t-| jj}n"d} j.pJt-/|gj}|s|| ||7}dt0|j#f}|j vrt j |<| |fj ||<| r| jst| tjrd } q| rЈ|n|qrt }jD]} | j p| jt1t2fv}t-| jjs|r| j3dus| j3t4kst| t5rFqn,| jrZ| jd}n| j6}| t| j3f||<q|r|j t7<tj8j9d\}fddjD}dd|D}j:|d d|fS)aSupports all the same args as the `argparse.ArgumentParser.parse_args()`, as well as the following additional args. Arguments: args: a list of args as in argparse, or a string (eg. "-x -y bla") config_file_contents (str). Used for testing. env_vars (dict). Used for testing. ignore_help_args (bool): This flag determines behavior when user specifies ``--help`` or ``-h``. If False, it will have the default behavior - printing help and exiting. If True, it won't do either. Returns: tuple[argparse.Namespace, list[str]]: tuple namescpace, unknown_args NrEcSsg|]}|dvr|qS))-h--helpr )rBargr r r rDHrz3ArgumentParser.parse_known_args..r<r-rFcs6g|].}|js|jr|jvrt|jjs|qSr )is_positional_argenv_varalready_on_command_lineoption_strings prefix_charsrBr)rrr)r r rDcsTr6r>cSsg|] }|qSr r?rAr r r rDrrrFrGcs g|]}|j||jffqSr )rr)rr r rD}scss|]}t|tjr|VqdSr)rr _HelpActionrr r r rsz2ArgumentParser.parse_known_args..rrcs"i|]}|D] }||qqSr )get_possible_config_keys)rBr Z config_keyr(r r sz3ArgumentParser.parse_known_args..z method argclosez%s|%s)rrcs&g|]}t|ddrt|jdqS)rFN)rSrr)rr r rDs cSsg|]}|dur|qSrr rr r r rDr) exit_after);sysrrr[rQrX_actionsrrr_source_to_settings_COMMAND_LINE_SOURCE_KEYrrrrrr_VersionActionrr@rrsrnargs _AppendActionrIrMrNrOrP convert_item_to_command_line_arg_ENV_VAR_SOURCE_KEYanyrr_open_config_filesreversedrr,r0rhasattrrr-rr4get_command_line_key_for_unknown_config_file_setting_CONFIG_FILE_SOURCE_KEYOPTIONAL ZERO_OR_MORErSUPPRESS#ACTION_TYPES_THAT_DONT_NEED_A_VALUEr_DEFAULTS_SOURCE_KEYrrwrite_config_file)r)rrrrrrZa_v_pairconfig_file_keysZstripped_config_file_keyZ env_var_argsrZactions_with_env_var_valuesr r7r9Zsupports_help_argZskip_config_file_parsingZknown_config_keysZconfig_streamsr+ config_itemsrVZ config_argsZdiscard_this_keyZ source_keyZdefault_settingsZcares_about_default_valueZ unknown_argsoutput_file_pathsr )rrrr)r r(s           "      &                 zArgumentParser.parse_known_argscCs|jS)ar If called after `parse_args()` or `parse_known_args()`, returns a dict that contains up to 4 keys corresponding to where a given option's value is coming from: - "command_line" - "environment_variables" - "config_file" - "defaults" Each such key, will be mapped to another dictionary containing the options set via that method. Here the key will be the option name, and the value will be a 2-tuple of the form (`argparse.Action` obj, `str` value). Returns: dict[str, dict[str, tuple[argparse.Action, str]]]: source to settings dict )rr(r r r get_source_to_settings_dictsz*ArgumentParser.get_source_to_settings_dictc Cs|D]j}z0||d}Wdn1s,0YWqtyl}ztd||WYd}~qd}~00q|r||j|}|j|}|D]:}||d}||Wdq1s0Yqt dd ||r| ddS)a4Write the given settings to output files. Args: parsed_namespace: namespace object created within parse_known_args() output_file_paths: any number of file paths to write the config to exit_after: whether to exit the program after writing the config files wNz Couldn't open {} for writing: {}zWrote config file to rWr) rIOErrorrrR get_items_for_config_file_outputrrr.r\printrYexit) r)parsed_namespacer rZoutput_file_pathZ output_filerVr  file_contentsr r r r s&" *z ArgumentParser.write_config_filecCs"||j}|jdd|}|S)aMCompute a commandline arg key to be used for a config file setting that doesn't correspond to any defined configargparse arg (and so doesn't have a user-specified commandline arg key). Args: key: The config file key that was being set. Returns: str: command line key r)r@r)r)r7Zkey_without_prefix_charscommand_line_keyr r r r s zCArgumentParser.get_command_line_key_for_unknown_config_file_settingc Cslt}|D]V\}}|tkr|d\}}|jD]`}||} | r2|js2t||j|jr2t ||j d} | dur2t | t rt | } | || d<q2q|tkr|D]<\} \}} ||} | rt ||j d} | dur| || d<qq|tr|D]\} \}} | || <qq|tkr|D]B\} \}} ||} | r"t ||j d} | dur"| || d<q"q|S)aConverts the given settings back to a dictionary that can be passed to ConfigFormatParser.serialize(..). Args: source_to_settings: the dictionary described in parse_known_args() parsed_namespace: namespace object created within parse_known_args() Returns: OrderedDict: where keys are strings and values are either strings or lists r<Nr)rr-rrrrrrrrSrrrr[rrrIrr) r)Zsource_to_settingsrZconfig_file_itemssourcesettingsrZexisting_command_line_argsr r r9r7r r r rsF            z/ArgumentParser.get_items_for_config_file_outputc s\g}|dur||}nt|s*|jd}|durt|trt|tsRJd|dvrt|sr||n||jdn|dvrt|sn||jdn^t|tj r|D] t fdd |jDrd}q||jdgt |7}n| d ||fnJt|t r$|duon|jduont|tjsLt|tjon|jd vpnt|jt on|jdk}|dust|tjr|D]T}|rt|t r|||D]}|t|qn|d |t|fqn>|r|||D]}|t|qn| d ||fn4t|trD|d ||fntdt|||S)aConverts a config file or env var key + value to a list of commandline args to append to the commandline. Args: action: The argparse Action object for this setting, or None if this config file setting doesn't correspond to any defined configargparse arg. key: string (config file key or env var name) value: parsed value of type string or list Returns: list[str]: args NrFzCconfig parser should convert anything that is not a list to string.)r=yeson1r)falsenooff0rEcsg|]}|qSr rI)rBrrr r rDtrzCArgumentParser.convert_item_to_command_line_arg..z^Unexpected value for %s: '%s'. Expecting 'true', 'false', 'yes', 'no', 'on', 'off', '1' or '0')+*z%s=%szp%s can't be set to a list '%s' unless its action type is changed to 'append' or nargs is set to '*', '+', or > 1z&Unexpected value type {} for value: {})ris_boolean_optional_actionrrrr[rrr _CountActionrintrrXr _StoreActionrrrRr) r)r r7r9rrZaccepts_list_and_has_nargsZ list_elemZsub_elemr r!r rKsd       "   z/ArgumentParser.convert_item_to_command_line_argcsPg}t|ddr|S|jD]0tfdd|jDr|ddg7}q|S)aThis method decides which actions can be set in a config file and what their keys will be. It returns a list of 0 or more config keys that can be used to set the given action's value in a config file. Returns: list[str]: keys rNc3s|]}d|VqdS)rNr )rBcr!r r rrz:ArgumentParser.get_possible_config_keys..r)rSrrr)r)r keysr r!r rs  z'ArgumentParser.get_possible_config_keysc Csrg}ttjttjj|jD]}|D]}|||q$qdd|jD}|sT|S|D]}t j |j dd}| |dd}t |||_|j|d} | sqX| \} } t| |jd} | sqXtj| } z|| } Wnty`}zpt|jd kr|j\}}nt|}|D](}z |Wnty4Yn0q|d | |fWYd}~n d}~00|| g7}qX|S) aTries to parse config file path(s) from within command_line_args. Returns a list of opened config files, including files specified on the commandline as well as any default_config_files specified in the constructor that are present on disk. Args: command_line_args: List of all args Returns: list[IO]: open config files cSsg|]}t|ddr|qSrFrSrr r r rDsz5ArgumentParser._open_config_files..F)radd_helpcSsdSrr )r)messager r r error_methodsz7ArgumentParser._open_config_files..error_method)rNrz)Unable to open config file: %s. Error: %s)rZglobospath expanduserrrrrrrr _add_actiontypes MethodTyperrrSrrPrrr[r)r)Zcommand_line_args config_filesfilesfZuser_config_file_arg_actionsr Z arg_parserr.Z parsed_argrrZuser_config_filer+rVerrnor3rr r r rsR         z!ArgumentParser._open_config_filescCstdtdtdtdi}t}|jD]\}}|d}||dt|dd}| ||D]`\}\}}|r| d |d |qdt |t r| d |qdt |t rd| d d |qdq$|S) zReturns a string with all args and settings and where they came from (eg. commandline, config file, environment variable or default) Returns: str: source to settings string zCommand Line Args: zEnvironment Variables: zConfig File (%s): z Defaults: |rrENz {:<19}{} rbz %s r;)rrrrrrr-rQrr\rRrr[rXrYr])r)Zsource_key_to_display_value_mapr^rrr7r r9r r r format_valuess$    zArgumentParser.format_valuescCs||dS)zBPrints the format_values() string (to sys.stdout or another file).N)r\r;)r)rr r r print_valuesszArgumentParser.print_valuesc sd}d}d}jr̈j}djd}fddjD}ddjD}|r|sV|rd_d}|d |7}d d d |D}|rd |}|s|r|dd t|ttd|g7}|dj7}j r6ddjD} | D]L\} } | j t krqd| } | j sd| _ | | j vr| j | 7_ d}d_ q|sB|rzdg} |rXdg| } |rhdg| } |dd| 7}t jd}t||}tj|dkrd|ndS)Nr<Frrcs@g|]8}|jD],}|r|jdks|js|js||fqqS)r)rrrrr)rBrrr(r r rD s  z.ArgumentParser.format_help..cSsg|]}t|ddr|qSr*r+rr r r rD$s Tz:Args that start with '%s' can also be set in a config filez or css|]}|jr|jdVqdS)rN)rrr r r r.sz-ArgumentParser.format_help..zspecified via z (%s).r;cSs"g|]}t|ddr|j|fqS)rN)rSrrr r r rD8s z [env var: %s]rzconfig file valueszenvironment variablesz- In general, command-line values override %s.z which override z {} )rrrrrYrfilterrr*rrrmax_get_formatter_widthtextwrapfillrr format_helprR)r)r3Zadded_config_file_helpZadded_env_var_helprccZconfig_settable_argsZconfig_path_actionsZconfig_arg_stringZenv_var_actionsrrZenv_var_help_stringZ value_sources text_widthr r(r rDsl          zArgumentParser.format_help)F)r!r"r#r$rr0environrrr r rrrrrr;rstdoutr<rDr r r r rs,j  6 /MKrcOs|dd}|ddp"|dd}|dd}|j|i|}|j |_||_||_||_|jrn|rntd|jrt|t j std|jrd}t|t j st|d |rt|d |S) aH This method supports the same args as ArgumentParser.add_argument(..) as well as the additional args below. Arguments: env_var: If set, the value of this environment variable will override any config file or default values for this arg (but can itself be overridden on the commandline). Also, if auto_env_var_prefix is set in the constructor, this env var name will be used instead of the automatic name. is_config_file_arg: If True, this arg is treated as a config file path This provides an alternative way to specify config files in place of the ArgumentParser(fromfile_prefix_chars=..) mechanism. Default: False is_write_out_config_file_arg: If True, this arg will be treated as a config file path, and, when it is specified, will cause configargparse to write all current commandline args to this file as config options and then exit. Default: False Returns: argparse.Action: the new argparse action rNrZis_config_filerz*env_var can't be set for a positional arg.z9arg with is_config_file_arg=True must have action='store'z+arg with is_write_out_config_file_arg=True zmust have action='store'z'can't also have is_config_file_arg=True) roriginal_add_argument_methodrrrrrrrrr')r)rrrrrr Z error_prefixr r r rUs6      rcsbg|D]B}|r@|d|vr@d|vr@|dd\}}|q|qtfdd|DS)zUtility method for checking if any of the potential_command_line_args is already present in existing_args. Returns: bool: already on command line? rrarEc3s|]}|vVqdSrr )rBZ potential_arg arg_namesr r rsz*already_on_command_line..)rQrr)Zexisting_args_listZpotential_command_line_argsr arg_string option_string explicit_argr rJr rs   r)N)N)T)T)\r$rrnr functoolsrNr/r0rJrr4 collectionsrrB version_inforzr_StoreTrueAction_StoreFalseActionr%_StoreConstAction_AppendConstActionrrr r$rrrrrRawTextHelpFormatterRawDescriptionHelpFormatterrobjectr%rPr0r1r_r}compilerDOTALLr lru_cacherrrrrrrrrrrrrr_ActionsContainerrIAction ArgumentErrorArgumentTypeErrorFileType HelpFormatterMetavarTypeHelpFormatter Namespace ONE_OR_MORErPARSER REMAINDERrrZinitArgumentParserZgetArgumentParserZ getArgParserZ getParserZget_arg_parserZ get_parserZ ArgParserParserZadd_argaddrr,rZ parse_knownZ RawFormatterZDefaultsFormatterZDefaultsRawFormatterr r r r s         (RIZ   Ho&99