o )Ti@sdZddlZddlZddlZddlZddlZddlZddlmZddl m Z ddl m Z m Z mZmZmZddlmZmZmZmZmZmZmZddlmZmZmZmZmZmZm Z m!Z!m"Z"m#Z#m$Z$dd l%m&Z&m'Z'dd l%m(Z)dd l*m+Z+m,Z,m-Z-dd l.m/Z/m0Z0dd l1m2Z2ddl3m4Z4ddl5m6Z6m7Z7ddl8m9Z9m:Z:m;Z;mm?Z?m@Z@mAZAmBZBmCZCmDZDmEZEmFZFmGZGddlHmIZImJZJmKZKmLZLmMZMmNZNddlOmPZPddlQmRZRddlSmTZTddlUmVZVmWZWmXZXmYZYmZZZm[Z[m\Z\m]Z]ddl^m_Z_m`Z`ddlambZbmcZcmdZdmeZemfZfmgZgmhZhddgZidejejkjljmvZnGdddeTejoZpGdddepejqZrGddde+epe7eejkZkdd l*msZsd!ejtvrHesdSdS)"z$Extensions of core argparse classes.N)Sequence)suppress)AnyCallableNoReturnOptionalUnion)ActionConfigFile ActionParser_ActionConfigLoad_ActionPrintConfig_is_action_value_listfilter_non_parsing_actionsprevious_config) InstantiatorCallableInstantiatorsDictTypeLoggerPropertyclass_instantiatorsdebug_mode_active$get_optionals_as_positionals_actionsis_subclasses_disabled lenient_checkparser_context!supports_optionals_as_positionalsvalidate_default)argcomplete_namespacehandle_completions)get_completion_script)ParserDeprecationsdeprecated_skip_checkdeprecated_yaml_comments)DefaultHelpFormatter get_env_var) ActionJsonnet)ActionJsonSchema) ActionLinkArgumentLinking)check_valid_dump_formatdump_using_formatget_loader_exceptions load_valueloaders) Namespace NSKeyError is_meta_keypatch_namespacerecreate_branches remove_meta split_keysplit_key_leafsplit_key_root)_get_config_read_modefsspec_support import_fsspecimport_jsonnetomegaconf_applypyyaml_available)UnknownDefault)change_to_path_dir)SignatureArguments)ActionSubCommands find_actionfind_action_and_subcommand!find_parent_action_and_subcommandget_subcommandhandle_subcommands is_branch_keyparse_kwargs_context)ActionTypeHintis_subclass_spec) ClassTypePathargument_errorget_argument_group_classget_private_kwargsidentityreturn_parser_if_capturedActionsContainerArgumentParser intermixedcseZdZUdZeded<dfdd Zdd d effd d Zdd de e ddfddZ de e e fde ddfddZZS)rPzRExtension of ``argparse._ActionsContainer`` to support additional functionalities. ArgumentGroup_action_groupsreturnNcs@tj|i||ddt|ddt|ddtdS)z*Initializer for ActionsContainer instance.typeNactionparsersconfig)super__init__registerrNr?r selfargskwargs __class__F/home/ubuntu/.local/lib/python3.10/site-packages/jsonargparse/_core.pyr[rszActionsContainer.__init__F) enable_pathrecst|dr|jn|}|ddur(t||dr t|||St||dd|vr^t|drK|d d}|j | d|fi|t ||St |dr^t j|||t|jd}d|vrst|dttfsst|d|d<tj|i|}|j|_t||t||t|jrtd |jd |jgkrd |vr|d tjur|j d vrtd t!|||j"r|j#$|jd|_%d|_"|S)aAdds an argument to the parser or argument group. All the arguments from `argparse.ArgumentParser.add_argument `_ are supported. Additionally it accepts: Args: enable_path: Whether to try parsing path/subconfig when argument is a complex type. parserrWNrVr-)r_r`re containerloggerchoicesz Argument with destination name "z" not allowed.default)*?z9Positional arguments not allowed to have a default value.TF)&hasattrrfgetr _is_valid_action_parser_move_parser_actionsr _ensure_single_config_argumentrlstripadd_class_argumentspopr@rGis_supported_typehintprepare_add_argumentrZ_logger isinstancelisttuple add_argumentri_add_print_config_argumentr$_check_ext_vars_actionr/dest ValueErroroption_stringsargparseSUPPRESSnargsrrequired required_argsadd _required)r^rer_r`rf nested_keyrWrarcrdr|ysJ         zActionsContainer.add_argument)namercOst|dr|jn|}|dur||jvrtd|dt|dt}||g|Rd|ji|}||_|j||durA||j|<|S)a Adds a group to the parser. All the arguments from `argparse.ArgumentParser.add_argument_group `_ are supported. Additionally it accepts: Args: name: Name of the group. If set, the group object will be included in the ``parser.groups`` dict. Returns: The group object. Raises: ValueError: If a group with the same name already exists. rfNzGroup with name z already exists. _group_classri) rnrfgroupsrgetattrrSrxrTappend)r^rr_r`rf group_classgrouprcrcrdadd_argument_groups   z#ActionsContainer.add_argument_groupr_r`cs|D]T}|D]M\}ddt|}|dur#tddt|tr-tnt|trCfdd|D}||qt|t rM| |}||j <|_ qq|r`||dSdS)a"Sets default values from dictionary or keyword arguments. Args: *args: Dictionary defining the default values to set. **kwargs: Sets default values based on keyword arguments. Raises: KeyError: If key not defined in the parser. rg_NNo action for key "z" to set its default.cs i|] \}}d||qS.rc.0kvrrcrd s z1ActionsContainer.set_defaults..) itemsreplacer@r.ryr set_default_errorr set_defaultsrGnormalize_default _defaultsrk)r^r_r`argrkrWrcrrdrs&         zActionsContainer.set_defaultsrUN)__name__ __module__ __qualname____doc__r__annotations__r[boolr|rstrrdictrr __classcell__rcrcrardrPms  2&c@s:eZdZUdZdZeeed<dZee de fed<dS)rSzKExtension of argparse._ArgumentGroup to support additional functionalities.NrrQrf) rrrrrrrrrfrrPrcrcrcrdrSs rScsveZdZUdZeejed<dZe e e e fed<ee ed<dZ e eed<dZe eed<dedd dd er:d nd ddd d deee fdeejdedeejee e fde e de e de de ee de eee ejfdeddffddZdddZddZfddZ dd ed!e ed"ed#ed$ed%ed&edefd'd(Z   dd"ed!e ed)e ee e e fej ffd*d+Z!    dd,e e"e d-e ed!e ed"edef d.d/Z#   dd0eee e e$ffd1e ed!e ed"edef d2d3Z%d!ee e e fej fd"edefd4d5Z&  dd!e e e e fd"edefd6d7Z'   dd8ee ejfd9e e d!e ed"edef d:d;Z( <   dd=e d8ee ejfd9e e d!e ed"edef d>d?Z) <  dd=e d8ee ejfd9e e d@e edef dAdBZ*de+fdCdDZ,ddFedGe deffdHdI Z-   dd edJe dKedLed#edMedNede fdOdPZ.ddQdRZ/dSdTZ0    dd edUee ejfdJe dKed#edVedWedXe e ddfdYdZZ1dee2fd[d\Z3dGe de$fd]d^Z4dd#edefd_d`Z5de+fdadbZ6ddcddZ7dee de fdfdgZ8ddhe die e9de+fdjdkZ:  dd edKed$edXe e ddf dldmZ;  ddnedtduZ? dd edvedefdwdxZ@d edefdydzZAd edee fd{d|ZBde ffd}d~ ZCdfdd ZD <  dd eee e e$ffde d@e ede eEe$gefdef ddZFdededefddZG ddejHde$de d e edede$f ddZIeJdee fddZKeKjLde e"ee ejffddZKeJdefddZMeMjLdefddZMeJdeee ffddZNeNjLdeee ffddZNeJde fddZOeOjLde fddZOeJde ee fddZPePjLde ee fddZPZQS)rQzGParser for command line, configuration files and environment variables.formatter_classNrr_subcommands_action_instantiatorsTFz--print_configyamljson) env_prefixr exit_on_errorriversion print_config parser_mode dump_headerdefault_config_files default_envrrrirrrrrrrUc stj| ||d| t||_|jduri|_||_t|_t|_| |_ | |_ ||_ ||_ ||_ ||_|durG|jddd|dddSdS)aBInitializer for ArgumentParser instance. All the arguments from the initializer of `argparse.ArgumentParser `_ are supported. Additionally it accepts: Args: env_prefix: Prefix for environment variables. ``True`` to derive from ``prog``. formatter_class: Class for printing help messages. logger: Logger to use or configuration for logger. version: Program version which will be printed by the ``--version`` argument. print_config: Name for print config argument, ``%s`` is replaced by config dest, set ``None`` to disable. parser_mode: Mode for parsing values: ``yaml``, ``json``, ``jsonnet`` or added via :func:`.set_loader`. dump_header: Header to include as comment when dumping a config object. default_config_files: Default config file locations, e.g. ``['~/.config/myapp/*.yaml']``. default_env: Set the default value on whether to parse environment variables. )rriNz --versionrz %(prog)s zPrint version and exit.)rWrhelp)rZr[rLrrrsetrsave_path_contentrrrrr _print_configr|) r^rrrrirrrrrrr_r`rarcrdr[s$    zArgumentParser.__init__c Cs:ttdd}|durdn|j}|dvrtdt|||}z\tGt|dd1t |i}t r argcomplete jsonargparsezKparse_known_args not supported because typos in configs would go unnoticed.T parent_parserrFrR)inspect getmodulestack __package__NotImplementedErrorrr0rrGsubclass_arg_context_parse_known_has_intermixed_parse_known_argsr ArgumentErrorerrorr)r^r_ namespace caller_modcallerr`exrcrcrdparse_known_args's:    zArgumentParser.parse_known_argscCst|dks t|s||fSt|ddD]:}|jgkr4||jdur3|jd|jd||fSq||| d|j|||j<t|dkrN||fSq||fS)NrT)include_positionalszPositional argument z( missing, aborting _positional_optionals) lenrrrrorrxdebug_check_value_keyru)r^cfgunkrWrcrcrd_positional_optionals?s  z$ArgumentParser._positional_optionalscs0t|}|r |S||jkr|d7}t|S)N=)rGparse_argv_itemrrZ_parse_optional)r^ arg_string subclass_argrarcrdrPs   zArgumentParser._parse_optionalrenvdefaultsskip_validation skip_requiredskip_subcommandsfail_no_subcommandc Cs"|dur |jr d}|st|||||d|r1tddt||Wdn1s,wYt|dQtsE|jdkrEt||}t ||zt ||Wnt ym}z|t||WYd}~nd}~ww|s|j||dWd|SWd|S1swY|S)aCommon parsing code used by other parse methods. Args: cfg: The configuration object. env: Whether to merge with the parsed environment, ``None`` to use the parser's default. defaults: Whether to merge with the parser's defaults. skip_validation: Whether to skip validation of configuration. skip_required: Whether to skip check of required arguments. skip_subcommands: Whether to skip subcommand processing. fail_no_subcommand: Whether to fail if no subcommand given. Returns: A config object with all parsed values. NT)rrrrr omegaconf+)r) _default_envrDrrGadd_sub_defaultsrrorr:r print_config_if_requestedr&apply_parsing_links Exceptionrrvalidate) r^rrrrrrrrrcrcrd _parse_commonXs6      zArgumentParser._parse_commonenvironcCst}|r tdd|jdd}Wdn1swY|s)|durS|jrS|dur0tj}t|jd|j||d}Wdn1sHwY|||}|S)NTrrload_value_moderr) r-r get_defaultsrosrr_load_env_vars merge_config)r^rrrrcfg_envrcrcrd_parse_defaults_and_environs  z*ArgumentParser._parse_defaults_and_environr_rc Kst|ddd\}}t|t||durtjdd}nt|}tdd|Ds2|d|||_z| ||}|r|r{|j |dd}| ||}|sV|durz|j rzt |j d |jtj|d } Wdn1sowY| | |}n| ||}t||d |j||d \}} ||| \}} Wdn1swY| r|d d | |j||||d} Wntttjfy} z|t| | WYd} ~ nd} ~ ww|jd|| S)aParses command line argument strings. All the arguments from `argparse.ArgumentParser.parse_args `_ are supported. Additionally it accepts: Args: args: List of arguments to parse or ``None`` to use ``sys.argv``. env: Whether to merge with the parsed environment, ``None`` to use the parser's default. defaults: Whether to merge with the parser's defaults. Returns: A config object with all parsed values. Raises: ArgumentError: If the parsing fails and ``exit_on_error=True``. F)_skip_validation_namespace_as_configNr cs|]}t|tVqdSNryrrarcrcrd z,ArgumentParser.parse_args..z*All arguments are expected to be strings: )rrr)r_rzUnrecognized arguments:  )rrrrz!Parsed command line arguments: %s)rMrOrsysargvrzallrr_rrrrrrrrrFrrjoinr TypeErrorKeyErrorrrrrxr) r^r_rrrr`rnamespace_as_configrrr parsed_cfgrrcrcrd parse_argssT      zArgumentParser.parse_argscfg_objcfg_basec Kst|ddd\}}z,|||}|r|||}||}|j||d} || |}|j|||||d} WnttfyQ} z|t| | WYd} ~ nd} ~ ww|j d|| S)aParses configuration given as an object. Args: cfg_obj: The configuration object. env: Whether to merge with the parsed environment, ``None`` to use the parser's default. defaults: Whether to merge with the parser's defaults. Returns: A config object with all parsed values. Raises: ArgumentError: If the parsing fails and ``exit_on_error=True``. F)r_skip_requiredprev_cfg)rrrrrNzParsed object: %s) rMrr_apply_actionsrrrrrrxr) r^r r rrr`rrr cfg_applyr rrcrcrd parse_objects*     zArgumentParser.parse_objectc Cst}t|j}|D]}t||}||vr%t|tr%t|||j||q |D]E}t||}||vrmt|trm||}||j vrm| |||j|||j<}|j |j ||dd} t | D] \} } | ||d| <q`q(|D]k}t||}||vrt|ttfs||}t|tjtjfr|} | dkrd}n5| dkrd}n.t|d|d|t|rzt|} t| tr| n|g}Wn ty|g}Ynw| |||j|||j<qp|||S) NT)rrrrtruefalseFz/Invalid boolean value for environment variable z: )r-r_actionsr#ryr apply_configrr?rjr_name_parser_map parse_envvarsrr_StoreTrueAction_StoreFalseActionlowerrrr+rzr*r)r^rrractionsrWenv_varenv_val subcommandpcfgrr env_val_lower list_env_valrcrcrdrsR       zArgumentParser._load_env_varsc Kst|ddd\}}z!|j|d|d}d|||d}|rd|d<|jd d|i|}WnttfyF}z|t||WYd}~nd}~ww|jd |S) atParses environment variables. Args: env: The environment object to use, if ``None`` then ``os.environ`` is used. defaults: Whether to merge with the parser's defaults. Returns: A config object with all parsed values. Raises: ArgumentError: If the parsing fails and ``exit_on_error=True``. F)r_skip_subcommandsT)rr)rrrrrrNzParsed environment variablesrc) rMrrrrrrrxr) r^rrr`rrrr rrcrcrdr;s" zArgumentParser.parse_envcfg_pathext_varsc Kstt|td}t||}|jd|tj||||d|}Wdn1s,wY|j d||S)aParses a configuration file given its path. Args: cfg_path: Path to the configuration file to parse. ext_vars: Optional external variables used for parsing jsonnet. env: Whether to merge with the parsed environment, ``None`` to use the parser's default. defaults: Whether to merge with the parser's defaults. Returns: A config object with all parsed values. Raises: ArgumentError: If the parsing fails and ``exit_on_error=True``. mode)cfg_strr%r&rrNz"Parsed configuration from path: %src) rJr6r= get_content parse_stringrpathbasenamerxr) r^r%r&rrr`fpathr)r rcrcrd parse_pathcs   zArgumentParser.parse_pathr)c Kst|ddd\}}z`_ the difference being that dest by default is ``subcommand`` and the parsed values of the subcommand are stored in a nested namespace using the subcommand's name as base key. Args: required: Whether the subcommand must be provided. dest: Destination key where the chosen subcommand name is stored. **kwargs: All options that `argparse.ArgumentParser.add_subparsers `_ accepts. descriptionzNFor more details of each subcommand, add it as an argument followed by --help.rFNrc) rrZr5rrrrrr#rr)r^rrr`r subcommandsrarcrdadd_subcommandss  zArgumentParser.add_subcommandsformat skip_none skip_default with_commentsskip_link_targetsc Kst||}ttj||}t||jdd}t|jdI|s$|||r,t ||||d} | ||j | | } |r^|jdd} t || | | |j d|d|| | Wdn1shwYt|dt|| ||d WdS1swYdS) asGenerates a serialized string for the given configuration object. Args: cfg: The configuration object to dump. format: The output format: ``yaml``, ``json``, ``json_indented``, ``toml``, ``parser_mode`` or ones added via :func:`.set_dumper`. skip_none: Whether to exclude entries whose value is ``None``. skip_default: Whether to exclude entries whose value is the same as the default. skip_validation: Whether to skip parser checking. with_comments: Whether to add help content as comments. Currently only supported for ``format="yaml"``. skip_link_targets: Whether to exclude link targets. Returns: The configuration in the chosen format. Raises: TypeError: If any of the values of cfg is invalid according to the parser. F with_metar)rr:TrNr) dump_formatr<)r!r rQdumpr(clonerrrr&strip_link_target_keys_dump_cleanup_actionsras_dictr_dump_delete_default_entriesr)) r^rr9r:r;rr<r=r` dump_kwargsr3rrcrcrdrAs,        $zArgumentParser.dumpc Csj|d}t|D]}||j}|jtjkrt|tr+t|ts+|r2||vr2||dur2||dn.t|t rV||d|j D]\}} |j || j |||ddqBn t|tr`|jd}t|tr||} | durt|dd0|drtt|j| |d} Wdn1swYn|j| |d} Wdn1swY|| |qdS) Nr:r)prefixr Trr)rG)rrrrrryr r rur?rjrrDrr&targetrGrorrr serializeupdate) r^rrrGrHr:rW action_destkey subparservaluercrcrdrD2s@           z$ArgumentParser._dump_cleanup_actionsc Cst|D]q}||vrw||}||}d}t|rS|d|dkrGt|dt|d}Wdn1s:wYd|i}|}|d}|d}||kr[||=qt |t rwt |t rw| |||rw|dikrw|d=qdS)N class_pathr init_args) rzkeysrHrorrGget_class_parserrrEryrrF)r^subcfg subdefaultsrMvalrkclass_object_valrfrcrcrdrFMs,    z+ArgumentParser._dump_delete_default_entriesr, overwrite multifilebranchc  sXttj| |}tfdd||d} tr`zt|dd} Wn ty*Yn6w| jr`|r7td|t d} | |d} | j |fi| Wd d S1sYwYd St|d d}||st |j d} | j |fi| Wd d S1swYd S|}|stjd j|jd d |dWd n1swYt|fddfddfdd}t|!td ||Wd n1swYWd n1swYd| d<t |j d} | j |fi| Wd d S1s%wYd S)aWrites to file(s) the given configuration object using the chosen format. Args: cfg: The configuration object to save. path: Path to the location where to save config. format: The output format: ``yaml``, ``json``, ``json_indented``, ``parser_mode`` or ones added via :func:`.set_dumper`. skip_none: Whether to exclude entries whose value is ``None``. skip_validation: Whether to skip parser checking. overwrite: Whether to overwrite existing files. multifile: Whether to save multiple config files by using the ``__path__`` metas. Raises: TypeError: If any of the values of cfg is invalid according to the parser. cs*stj|jrtd|jdSdS)Nz%Refusing to overwrite existing file: )rr,isfileabsoluter)r,)rXrcrdcheck_overwritesz,ArgumentParser.save..check_overwrite)r9r:rswr'z/multifile=True not supported for fsspec paths: ArgumentParser.savewNfcrFr>)rZcst|}t|ttttfSr)r@ryr%r$rGr )rMrWr^rcrdis_path_actions z+ArgumentParser.save..is_path_actioncsttj|djdd}|t|}t|tr|}d|vr'|d}nt | d}t ||r7dn}t |jd }||Wdn1sPwYtj|S)N__path__rar'__orig__z.json json_indentedr`)rJrr,r-r\r2ryr-rErrendswithr)openwrite)rVval_pathval_outval_stris_jsonf)r]r9r^rcrd save_paths    z&ArgumentParser.save..save_pathc s|D]}||}t|ttfr d|vr |r|||<qt|trD|rCt|D]\}}t|ttfrBd|vrB|||<q-qt|tr|jvrd|jvrtt j |j dd}|t |j d}||Wdn1szwYt|t|||<qdS)Nrdrrar'r`)get_sorted_keysryr-rrz enumeraterJrr(rr,r-r\rhrir*rVr)rrMrVnumitemrjrn)r]rcror^rcrd save_pathss*    z'ArgumentParser.save..save_pathsrTr)r rQsaver(r7rJr is_fsspecrr8rhrirAr\rBrrrr&rCr=)r^rr,r9r:rrXrYrZr`rGpath_swfsspecrnpath_fcrurc)r]r9rcrXror^rdrvbsX     "   $r_cCst|ddrgSg}|jD]}|tttj|7}q t|dkr>tt dd|DWdS1s9wYgS)N _inner_parserFrcSsg|] }t|tdqS)r')rJr6)rrrcrcrd z.) rrsortedglobrr, expanduserrrr)r^rpatternrcrcrd_get_default_config_filess      z(ArgumentParser._get_default_config_filescsvt|\}dusjkrtddfdd}|s)|jS|}j|vr5||jS)zGets a single default value for the given destination key. Args: dest: Destination key from which to get the default. Raises: KeyError: If key or its default not defined in the parser. Nrz" to get its default.cs jtjkrtdddS)NzAction for key "z" does not specify a default.)rkrrr.rcrWrrcrdcheck_suppressed_defaults z.check_suppressed_default)rBrr.rrkrro)r^rrrrrcrrd get_defaults   zArgumentParser.get_defaultc Ks ttj||}t}t|jD]}|jtjkr+|j tjkr+t |jt s+t |j||j <q|j d||}|D]}|}|sDq9t|ot|ddY|j||d}|||}z!t|j|dd|ddd}Wdn1sxwYWn"tttjfy} ztd|d | jd t|d | d} ~ wwWdn1swYWdn1swY|d } t | t r| !|nt | t"r| |g|d <n||d <|j d |q9tddt#$||Wd|S1swY|S)zReturns a namespace with all default values. Args: skip_validation: Whether to skip validation of defaults. Returns: An object with all default values as attributes. zLoaded parser defaults: %sT)rparsing_defaultsrF)rrrrrrNz Problem in default config file 'z': r)default_config_file__default_config__z*Parsed default configuration from path: %s)validating_defaults)%r rQrr-rrrkrrrryr<r1rxrrr*stripr=rr2rr skip_print_configrrrrrKr_rrorzrrJrGr) r^rr`rrWrrdefault_config_file_contentcfg_filermetarcrcrdrsp             zArgumentParser.get_defaultscOr4)NznParser instance was invalidated by get_completion_script() and cannot be reused. Create a new parser instance.)rr]rcrcrd'_raise_invalidated_by_completion_script5sz6ArgumentParser._raise_invalidated_by_completion_scriptcCsZt|D]&}|dr qt||d}t|r*t||d}t|r*t|||jqdS)Nr) dir startswithrgetattr_static isroutinerismethodsetattrr)r^r static_attrattrrcrcrd _invalidate_by_completion_script;s     z/ArgumentParser._invalidate_by_completion_scriptcompletion_typecKst||fi|}||S)z6Returns shell completion script for a completion type.)get_completion_script_internalr)r^rr`completion_scriptrcrcrdrEsz$ArgumentParser.get_completion_scriptmessagercCs|j|t|jr||||jst||tr'|jdt||t|ddp.|}t|ddr8g|_ | t j t dd|jDd}|rb|jdd}t j d |d |jd d t j d |d |ddS)zTLogs error message if a logger is set and exits or raises an :class:`ArgumentError`.z6Debug enabled, thus raising exception instead of exit.subcommand_parserNrcss |] }t|tjr|VqdSr)ryr _HelpActionrrcrcrdr]sz'ArgumentParser.error..z [options]r0z*tip: For details of accepted options run: r zerror: )rxrcallable_error_handlerrrKrrrr print_usagerstderrnextrprogrrirexit)r^rrrf help_actionrrcrcrdrMs$         zArgumentParser.errorc  st|dd}|}t|tr|}t}|||<fddfdd}tjd ||Wdn1s=wY|sPtsR||dSdSdS) a Checks that the content of a given configuration object conforms with the parser. Args: cfg: The configuration object to check. skip_none: Whether to skip checking of values that are ``None``. skip_required: Whether to skip checking required arguments. branch: Base key in case cfg corresponds only to a branch. Raises: TypeError: If any of the values are not valid. KeyError: If a key in cfg is not defined in the parser. r0_prefixc s|jD]'}z ||}|durtWqttfy*}z td||d|d}~wwt||dd\}}|durK|durM|||||ddSdSdS)NOption 'z4' is required but not provided or its value is None.Frr)rrrrCro)rrfrHreqkeyrVrr rN)check_requiredrcrdrs$ z/ArgumentParser.validate..check_requiredc sfdd|D}|D]\}d}|durEtrqttd\}}|rE|r3|d|jn|j}|drE|||urEq|}|dur|durSsWtrXqz  ||Wqt y}z|ikrxt |rxj vsz|WYd}~qd}~wwt|trdvrt\}}td|d|d}|j||_|tfdd jDd} | rˈt| d d}td | d|djr|jjrd|jjd}n d tjjd d}tdd|tdddS)Ncsi|]}|t|qSrc)r@rrrbrcrdrzAArgumentParser.validate..check_values..excluderz Subcommand 'z' does not accept option ''c3s"|] }|dr|VqdS)rN)rrgrMrcrdrs z@ArgumentParser.validate..check_values..r zGroup '{rz,...}rz$' is not accepted before subcommand z' is not accepted)rqrrErBr rrrorrrrGis_subclass_typehintrryr?r5r.rrrrrrrzrj) r sorted_keysrW parent_actionr  parent_keyrVrsubkey group_key)ccfgr^r:rrd check_valuessN    z-ArgumentParser.validate..check_valuesrN) rMrBryrr-rrrro) r^rr:rrZr`rH branch_cfgrrc)rrr^r:rdres    *  zArgumentParser.validate instantiator class_type subclassesprependcsX|jduri|_||ffdd|jD}|r#|i||_dS||<||_dS)aAdds a custom instantiator for a class type. Used by ``instantiate_classes``. Instantiator functions are expected to have as signature ``(class_type: Type[ClassType], *args, **kwargs) -> ClassType``. For reference, the default instantiator is ``return class_type(*args, **kwargs)``. In some use cases, the instantiator function might need access to values applied by instantiation links. For this, the instantiator function can have an additional keyword parameter ``applied_instantiation_links: dict``. This parameter will be populated with a dictionary having as keys the targets of the instantiation links and corresponding values that were applied. Args: instantiator: Function that instantiates a class. class_type: The class type to instantiate. subclasses: Whether to instantiate subclasses of ``class_type``. prepend: Whether to prepend the instantiator to the existing instantiators. Ncsi|] \}}|kr||qSrcrcrrrcrdrz3ArgumentParser.add_instantiator..)rr)r^rrrr instantiatorsrcrrdadd_instantiators  zArgumentParser.add_instantiatorcsv|jpit|dr!|j}fdd|Dt}|r9fdd|DS)Nrci|] \}}|vr||qSrcrcrrrcrdrrz5ArgumentParser._get_instantiators..crrcrcrrrcrdrr) rrnr_get_instantiatorscopyrKrrro)r^parent_instantiatorscontext_instantiatorsrcrrdrs   z!ArgumentParser._get_instantiatorsinstantiate_groupsc sg}t|jD]"}t|tr||qt|tr)t|jdtr)||jdq|rBdd|Dfdd|jD}|||j dddt |}t ||}|j d d }|D]w}tj |||jd t|trz ||j\}} } Wn ttfyYq]w|d urt|t||||d d||| | <Wd n1swYq]t|j||d d|||Wd n1swYq]tj |||dt||d d\} } | d ur| d ur| j|| |d|| <|S)a`Recursively instantiates all subclasses defined by ``class_path``+``init_args`` and class groups. Args: cfg: The configuration object to use. instantiate_groups: Whether class groups should be instantiated. Returns: A configuration object with all subclasses and class groups instantiated. r cSsh|]}|jqSrcr)rcrcrcrd sz5ArgumentParser.instantiate_classes..cs$g|]}t|dr|jvr|qS)instantiate_class)rnrrskiprcrdr|s$z6ArgumentParser.instantiate_classes..cSstt|j Sr)rr3r)xrcrcrd sz4ArgumentParser.instantiate_classes..rFr>)rIN__applied_instantiation_links__)r nested_linksrapplied_instantiation_links)rrr)orderr)r)rrryrGrr&rIrTextendsortinstantiation_orderreorderrBapply_instantiation_linksrget_value_and_parentrAttributeErrorrget_nested_linksrroinstantiate_classesrrrC) r^rr componentsrWrr componentrOparentrMr rNrcrrdrs\        z"ArgumentParser.instantiate_classescCsN|}g}|D]}t||durt|s||q |D]}||=q|S)zRemoves all unknown keys from a configuration object. Args: cfg: The configuration object to strip. Returns: The stripped configuration object. N)rBrRr@r/r)r^rdel_keysrMrcrcrd strip_unknown.s   zArgumentParser.strip_unknowncCsjg}d|vr ||dt|jD] }t|tr2|j|vr2||jdur2|dd||jDq|S)zReturns a list of loaded config file paths. Args: cfg: The configuration object. Returns: Paths to loaded config files. rNcss|] }|dur|VqdSrrc)rprcrcrdrQsz2ArgumentParser.get_config_files..)rrrryr rr)r^r cfg_filesrWrcrcrdget_config_filesCs "zArgumentParser.get_config_filesc sd}t|jdkrOd}z|}d|vr)|d}t|tr$dd|D}d|}WntjyB}z d|}WYd}~nd}~ww|j}|jd||_t ||d t }Wd|S1sfwY|S) Nrz&no existing default config file found.rcSsg|]}t|qSrc)rrrrcrcrdr|]sz.ArgumentParser.format_help..zAdefault values below are the ones overridden by the contents of: zKtried getting defaults considering default_config_files but failed due to: z, Note: )rdefaults_cache) r_default_config_filesrryrzrr_default_config_files_groupr6rrZ format_help)r^rnote config_filesrrhelp_strrarcrdrTs.    zArgumentParser.format_helpcs@t|dtj|i|WdS1swYdS)Nr)rrZrr]rarcrdrgs $zArgumentParser.print_usagerskip_fncsttr tr#}t|<fdd|jdddDn tjddd|r3|}nt}t}d}|tkrY||vrLtnd}t ||d\} } t| t r| j rd|vrd|gfd d|dDq;|d 7}| dust| t r} t| trt| } t| tr| jddd} fd d| D7| <q;| dur| j n| d | j } d}| vrوd rd}| <| } |r|| rq;t|dd|j| | | ||d} Wdn1swYt| tr|| | n:t| trDt| trC| tfdd|dD}t|| | |q;n t| ddrO| || <| | <|tksBr`SS)z3Runs _check_value_key on actions present in config.csg|]}d|qSrrcr)rrcrdr|yrz1ArgumentParser._apply_actions..TF)branchesnestedrNrcsg|]}|kr|qSrcrcr) ext_vars_keyrcrdr|rr cs(g|]}d|vrd|qSrrcr)rMrRrcrdr|s(r+r)rcsi|]}||qSrcrcr)rrcrdrz1ArgumentParser._apply_actions..jsonnet_ext_vars)ryrr-rRrzrBrrr rAr$ _ext_varsr?rrgrurrrrr rrrKr)r^rrrr cfg_branch config_keysrsrrWr rOnew_keysrLrpreserverc)rrrMrRrrdrksv   ,           .zArgumentParser._apply_actionscfg_fromcfg_tocCsV|}|}t|dt|||Wdn1swY|||S)aMerges the first configuration into the second configuration. Args: cfg_from: The configuration from which to merge. cfg_to: The configuration into which to merge. Returns: A new object with the merged configuration. rN)rBrrG&discard_init_args_on_class_path_changerK)r^rrrcrcrdrs   zArgumentParser.merge_configrWrOrMrc Cs|dur tr |St|t}|r0|jr0t|d}||jkr!|S|j|}|j||ddn{t|t rAt|t r@| ||}njt |drft |d|j||||jd}Wdn1s`wYnE|jdurz&|jdvsv|jd kr|||}n|durt|D] \} } || || <qWnttfy} z td |d | | d} ~ ww|s|jrt|r|n|g} t| tsJ| D]} | |jvrtd |d | d |jq|S) zChecks the value for a given action. Args: action: The action used for parsing. value: The value to parse. key: The configuration key. Raises: TypeError: If the value is not valid. Nrrr _check_typer)rrr(>Nrmrz Parser key "z": z not among choices )rroryr?rjr4rrrr r check_typernr _check_type_rrVrrrrrrrz)r^rWrOrMrr is_subcommandleaf_keyrNrrrvalsrVrcrcrdrsL               zArgumentParser._check_value_keycC|jS)aDefault config file locations. :getter: Returns the current default config file locations. :setter: Sets new default config file locations, e.g. ``['~/.config/myapp/*.yaml']``. Raises: ValueError: If an invalid value is given. )rrbrcrcrdr z#ArgumentParser.default_config_filescs|durg_nt|trtdd|Drdd|D_ntdtjdkrKtdsId}td t}||d }|gj _ |_ dSdStdrbfd dj D_ t ddSdS) Ncss |] }t|ttjfVqdSr)ryrrPathLikerrcrcrdrs z6ArgumentParser.default_config_files..cSsg|]}t|qSrc)rfspath)rdrcrcrdr|rz7ArgumentParser.default_config_files..z=default_config_files expects None or List[str | os.PathLike].rrzdefault config file locationsr)titlecsg|] }|jkr|qSrc)rrrbrcrdr|r}) rryrzrrrrnrrSrTrdelattr)r^r group_titlerrrcrbrdrs&     cCr )aWhether by default environment variables parsing is enabled. If the ``JSONARGPARSE_DEFAULT_ENV`` environment variable is set to true or false, that value will take precedence. :getter: Returns the current default environment variables parsing setting. :setter: Sets the default environment variables parsing setting. Raises: ValueError: If an invalid value is given. )rrbrcrcrdrs zArgumentParser.default_envcCsftdd}|dvr|dk|_n t|tr||_ntd|jr/|jj D]}|j|_ q(dSdS)NJSONARGPARSE_DEFAULT_ENVr0>rrrzdefault_env expects a boolean.) rgetenvrrryrrrrvaluesr)r^ros_default_envrNrcrcrdr%s   cCr )zThe environment variables prefix property. :getter: Returns the current environment variables prefix. :setter: Sets the environment variables prefix. Raises: ValueError: If an invalid value is given. ) _env_prefixrbrcrcrdr2r zArgumentParser.env_prefixcCsh|durddlm}m}|t|ddd}n|dur$tj|jd}n t|t t fs/t d||_ dS) Nr )deprecation_warning env_prefix_property_none_message) stacklevelFTrz)env_prefix expects a string or a boolean.) _deprecatedrrrQrr,splitextrryrrrr)r^rrrrcrcrdr>s cCr )aMode for parsing configuration files: ``yaml``, ``json``, ``jsonnet`` or ones added via :func:`.set_loader`. :getter: Returns the current parser mode. :setter: Sets the parser mode. Raises: ValueError: If an invalid value is given. ) _parser_moderbrcrcrdrNs zArgumentParser.parser_modecCsfttddh}||vrtd|d|dkrtd||_|jr/|jjD]}||_ q)dSdS)N omegaconfrz-The only accepted values for parser_mode are rjsonnetzparser_mode=jsonnet) rr,unionrr9rrrrr)r^racceptedrNrcrcrdr[scCr )zHeader to include as comment when dumping a config object. :getter: Returns the current dump header. :setter: Sets the dump header. Raises: ValueError: If an invalid value is given. ) _dump_headerrbrcrcrdrgr zArgumentParser.dump_headercCs6|dust|trtdd|Dstd||_dS)Ncsrrrrrcrcrdrvrz-ArgumentParser.dump_header..z5Expected dump_header to be None or a list of strings.)ryrzrrr!)r^rrcrcrdrss$ )NN)FFT)TNN)NNNT)NNT)NT)r0NNT)r0NN)Tr )rTFFFT)r0)rTFFTN)Frr)TFN)TF)T)RrrrrrVr HelpFormatterrrrrrrSrr?rrr"r;rrloggingLoggerrzrr r[rrrr-r_Environrrr rrrrr/r+r2rr5r8rArDrFrvrJrrrrrrrrrrrIrrrrrrrrrrActionrpropertyrsetterrrrrrrcrcrardrQsb         4  4   J (.* +  (  5  # 9   o<   \ & ? I / "     )parse_as_dict_patch SPHINX_BUILD)urrrrr#rrcollections.abcr contextlibrtypingrrrrrrr r r r rrr_commonrrrrrrrrrrr _completionsrrrrrrr r! _formattersr"r#_jsonnetr$ _jsonschemar%_link_argumentsr&r'_loaders_dumpersr(r)r*r+r, _namespacer-r.r/r0r1r2r3r4r5 _optionalsr6r7r8r9r:r;_parameter_resolversr<_pathsr= _signaturesr> _subcommandsr?r@rArBrCrDrErF _typehintsrGrH_utilrIrJrKrLrMrNrO__all__ signaturerQr parametersr_ActionsContainerrP_ArgumentGrouprSr)rrcrcrcrds`  $4    ,   ( $ v