o )Tiu@sUdZddlZddlZddlZddlZddlmZddlmZddl m Z ddl m Z ddl mZddlmZmZmZmZmZmZmZd d lmZmZd d lmZd d lmZd d lmZm Z gdZ!e"Z#eee$d<Gddde%Z&dddZ'ddZ(ddZ)e(dGdddZ*e(dGdddZ+e(dGdd d Z,e(d!Gd"d#d#eZ-e(d$d%e.fd&d'Z/e(d( ) )dd*e.d+e.fd,d-Z0e(d.d/e1fd0d1Z2e(d2dd3ee.fd4d5Z3d6Z4d7d8Z5d9Z6d:Z7d;Z8dd=d>Z9d?Z:d@Z;GdAdBdBZe(dEdFedGe1d/dfdHdIZ?dJZ@dKdLZAdMZBGdNdOdOZCdPeDdQe.d/e.fdRdSZEdPeDdTe.d/e.fdUdVZFeZGddWdXZHeHdYeHdZeHd[eHdeHd\eHd]eHd^eHd_eHd`eHdaeHdbeHdceHddeHdeeHdfdgdhie(diGdjdkdkZIe(dlGdmdndneZe(dodaed/ee1effdpdqZJe(drdseDe1efd/efdtduZKeddxdyZLedvee1efd/ee1effdzdyZLe(d{d|dyZLGd}d~d~ZMe(dddZNdS)zDeprecated code.N) ArgumentError)Enum) import_module)Path) ModuleType)AnyCallableDictOptionalSetUnionoverload)Action null_logger)LoggerProperty) Namespace)ArgumentParserruamelCommentedMap) ActionEnumActionJsonnetExtVarsActionOperators ActionPathActionPathListHelpFormatterDeprecationsrPathDeprecationsParserDeprecations ParserErrorcompose_dataclassesget_config_read_modedict_to_namespacenamespace_to_dictrset_docstring_parse_optionsset_config_read_modeset_url_support strip_metausage_and_exit_error_handlershown_deprecation_warningsc@ eZdZdS)JsonargparseDeprecationWarningN__name__ __module__ __qualname__r.r.L/home/ubuntu/.local/lib/python3.10/site-packages/jsonargparse/_deprecated.pyr).r)cCstjdd}|dk}|dk}|r@|tvs|rBddlm}ttdkr0|s0|dt|d d ||t|d d t |dSdSdS) N!JSONARGPARSE_DEPRECATION_WARNINGSoffallr)warningra! By default only one JsonargparseDeprecationWarning per type is shown. To see all warnings set environment variable JSONARGPARSE_DEPRECATION_WARNINGS=all and to disable the warnings set JSONARGPARSE_DEPRECATION_WARNINGS=off.  stacklevel) osenvirongetlowerr'_utilr5lenr)add) componentmessager8env_var show_warnings all_warningsr5r.r.r/deprecation_warning2s  rEcsfdd}|S)Ncs|dd}jdur dnj|_tr0tjfdd}j_|_}|Stfdd}|S)Nz .. warning::  r2cst|j|i|dSN)rE_original_initselfargskwargsr@rAr.r/ init_wrapNs z;deprecated..deprecated_decorator..init_wrapcst|i|SrG)rE)rKrLrMr.r/ decoratedYs z;deprecated..deprecated_decorator..decorated)__doc__inspectisclass functoolswraps__init__rH)r@r5rNrOrA)r@r/deprecated_decoratorHs    z(deprecated..deprecated_decoratorr.)rArWr.rVr/ deprecatedGs rXcs&ddlmtdr Jdddddtffd d j__fd d }|d |d|d|ddtttt t ffdtttt t fffdd}j _ |_ dtttt t ffdt fdd}j _|_ dddtttt t ffdtddfdd}j_|_dS)zAdds parse_as_dict support to ArgumentParser as a patch. This is a temporal backward compatible support for parse_as_dict to have cleaner code in v4.0.0 and warn users about the deprecation and future removal. r)r_unpatched_initab ``parse_as_dict`` parameter was deprecated in v4.0.0 and will be removed in v5.0.0. After removal, the parse_*, dump, save and instantiate_classes methods will only return Namespace and/or accept Namespace objects. If needed for some use case, config objects can be converted to a nested dict using the Namespace.as_dict method. z ``with_meta`` parameter was deprecated in v4.44.0 and will be removed in v5.0.0. After removal, config objects will always include metadata. To remove metadata from a config object, do ``.clone(with_meta=False)``. F) parse_as_dictrZcs(||_|r t|j|i|dSrG)_parse_as_dictrErY)rJrZrKrL)message_parse_as_dict patched_initr.r/r]|s z)parse_as_dict_patch..patched_initc sdd|ddddttdtdtttttffffddtt|t|dS) N _unpatched_F) with_meta_skip_validationr_r`returncsdt|}||d|i|}t|trt|s'|dur!|js'|jdd}|jr0|s0|S|S)Nr`F)r_)getattr isinstanceboolrE _default_metacloner[as_dict)rJr_r`rKrL parse_methodcfg)message_with_meta patched_parseunpatched_method_namer.r/rks    zFparse_as_dict_patch..patch_parse_method..patched_parse) r rdr rr strrsetattrrb) method_name)rrj)rkrlr/patch_parse_methodsz/parse_as_dict_patch..patch_parse_method parse_args parse_object parse_env parse_stringrirac[s8t|tr ||}|j|fi|}|jr|S|SrG)rcdict_apply_actions_unpatched_instantiate_classesr[rg)rJrirLr.r.r/patched_instantiate_classess  z8parse_as_dict_patch..patched_instantiate_classesc_s0t|tr |j|dd}|j|g|Ri|S)NTr`)rcrurr_unpatched_dump)rJrirKrLr.r.r/ patched_dumps z)parse_as_dict_patch..patched_dumpT) multifiler|Nc_s8|rt|tr|j|dd}|j|g|Rd|i|S)NTryr|)rcrurr_unpatched_save)rJrir|rKrLr.r.r/ patched_savesz)parse_as_dict_patch..patched_save)_corerhasattrrdrUrYr rr rmrinstantiate_classesrwdumprzsaver})rprxr{r~r.)rr\rjr]r/parse_as_dict_patchcs2  ", rz ActionEnum was deprecated in v3.9.0 and will be removed in v5.0.0. Enums now should be given directly as a type as explained in :ref:`enums`. c@ eZdZdZddZddZdS)rzEAn action based on an Enum that maps to-from strings and enum values.cKs@d|vrddlm}||dtstd|d|_dStd)Nenumr) is_subclassz(Expected enum to be an subclass of Enum.zExpected enum keyword argument.)_commonrr ValueError_type)rJrLrr.r.r/rUs  zActionEnum.__init__cO4|dr tdddlm}||jddi|S)Ntypez ActionEnum doesn't allow a type.rActionTypeHinttypehintr.r;r _typehintsrrrJrKrLrr.r.r/__call__  zActionEnum.__call__Nr+r,r-rPrUrr.r.r.r/rs rz ActionOperators was deprecated in v3.0.0 and will be removed in v5.0.0. Now types should be used as explained in :ref:`restricted-numbers`. c@r)rz5Action to restrict a value with comparison operators.cKsd|vrLt|dtr|dgn|d}tt||dt|ddf}ddlm}m}||vr8|||_dS|d|dt|d|dd|_dSt d)Nexprrjoinandr)registered_typesrestricted_number_typezExpected expr keyword argument.) rctuplesortedr;inttypingrrrr)rJrL restrictions register_keyrrr.r.r/rUs " zActionOperators.__init__cOr)Nrz%ActionOperators doesn't allow a type.rrrr.rrr.r.r/rrzActionOperators.__call__Nrr.r.r.r/rs rz ActionPath was deprecated in v3.11.0 and will be removed in v5.0.0. Paths now should be given directly as a type as explained in :ref:`parsing-paths`. c@s.eZdZdZ d dedefddZddZd S) rz!Action to check and store a path.Fmode skip_checkcCsddlm}|||d|_dS)Nr path_typer)rrr)rJrrrr.r.r/rUs zActionPath.__init__cOr)Nrz ActionPath doesn't allow a type.rrrr.rrr.r.r/r rzActionPath.__call__N)F)r+r,r-rPrmrdrUrr.r.r.r/rs rz ActionPathList was deprecated in v4.20.0 and will be removed in v5.0.0. Instead use as type ``List[]`` with ``enable_path=True``. cs@eZdZdZd deedeffdd Zdd Zd d ZZ S) rzUAction to check and store a list of file paths read from a plain text file or stream.Ncwdrrelc s|dur"ddlm}|||_||_|jdvr td|jddSd|vr*td|d|_|d |_tjd i|dS) aInitializer for ActionPathList instance. Args: mode: The required type and access permissions among [fdrwxcuFDRWX] as a keyword argument (uppercase means not), e.g. ActionPathList(mode='fr'). rel: Whether relative paths are with respect to current working directory 'cwd' or the list's parent directory 'list'. Raises: ValueError: If any of the parameters (mode or rel) are invalid. Nrr>rlistz(rel must be either "cwd" or "list", got .rzExpected mode keyword argument._relr.)rrrrrpopsuperrU)rJrrrLr __class__r.r/rUs     zActionPathList.__init__cOsjt|dkr%d|vr|ddvrtd|j|d<|j|d<td i|St|d|j||dd S) zParses an argument as a PathList and if valid sets the parsed value to the corresponding key. Raises: TypeError: If the argument is not a valid PathList. rnargs>r+z/ActionPathList only supports nargs of 1 or "+".rrrr6Nr.)r>rrrrrndest _check_typerIr.r.r/r4s   zActionPathList.__call__c s|gkr|Sddlm}|}|st|ts|g}t|trtfdd|Dr|}g}|D]}z&|dkr:tjnt|}dd|D}Wdn1sRwYWnt yo}z t d|d ||d}~wwt } j d kr|dkrt t jt j|t jz5t|D])\} } z | || <Wqt y}zt d | dd |d ||d}~wwWt | nt | w||7}q0|S)Nr)_is_action_value_listc3s|] }t|j VqdSrG)rcr).0vrJr.r/ Ksz-ActionPathList._check_type..-cSsg|]}|qSr.)strip)rxr.r.r/ Qsz.ActionPathList._check_type..zProblems reading path list: z :: rz Path number z in list z, )_actionsrrcrr4sysstdinopen readlinesFileNotFoundError TypeErrorr9getcwdrchdirpathabspathrpardir enumerater) rJvaluerislistpath_list_filespath_list_filef path_listexrnumvalr.rr/rCsD    zActionPathList._check_type)Nr) r+r,r-rPr rmrUrr __classcell__r.r.rr/rs rz set_url_support was deprecated in v3.12.0 and will be removed in v5.0.0. Optional config read modes should now be set using function set_parsing_settings. enabledcCs.ddlm}m}||d|vrdndddS)z2Enables/disables URL support for config read mode.r)_get_config_read_mode_set_config_read_modesTF urls_enabledfsspec_enabledN) _optionalsrr)rrrr.r.r/r$cs  r$z set_config_read_mode was deprecated in v4.39.0 and will be removed in v5.0.0. Optional config read modes should now be set using function set_parsing_settings. FrrcCddlm}|||ddS)z,Enables/disables optional config read modes.r)rrN)rr)rrrr.r.r/r#rs  r#z get_config_read_mode was deprecated in v4.39.0 and will be removed in v5.0.0. The config read mode is internal and thus shouldn't be used. racCsddlm}|S)z(Returns the current config reading mode.rr)rrrr.r.r/rs rz set_docstring_parse_options was deprecated in v4.39.0 and will be removed in v5.0.0. Docstring parse options should now be set using function set_parsing_settings. attribute_docstringscCr)z#Sets options for docstring parsing.r)_set_docstring_parse_options)stylerN)rr)rrrr.r.r/r"s  r"z The return_parser parameter was deprecated in v4.5.0 and will be removed in v5.0.0. Instead of this use function capture_parser. cCtdt|ddS)NzCLI.__init__.return_parserr7)rEcli_return_parser_messager7r.r.r/%deprecation_warning_cli_return_parserrz Setting the logger property to None was deprecated in v4.10.0 and will raise an exception in v5.0.0. Use False instead. z Setting the env_prefix property to None was deprecated in v4.11.0 and will raise an exception in v5.0.0. Use True instead. z The skip_check parameter of Path was deprecated in v4.20.0 and will be removed in v5.0.0. There is no reason to use a Path type if its checks are disabled. Instead use a type such as str or os.PathLike. r6cCr)Nz Path.__init__r7)rEpath_skip_check_messager7r.r.r/path_skip_check_deprecationrra Path objects are not meant to be mutable. To make this more explicit, attributes have been renamed and changed into properties without setters. Please update your code to use the new property names and don't modify path attributes. The changes are: ``rel_path`` -> ``relative`` and ``abs_path`` -> ``absolute``, ``cwd`` no name change, ``skip_check`` will be removed. z Calling Path objects is deprecated and will be removed in v5.0.0. Use the ``absolute`` or ``relative`` properties instead. c@seZdZdZeddZejddZeddZejddZedd Zejd d Zd d Z d dZ eddZ e jddZ e e ddedefddZdS)rzDeprecated methods for Path.cCtdt|jSNz Path attr getrEpath_immutable_attrs_message _relativerr.r.r/rel_path zPathDeprecations.rel_pathcCtdt||_dSNz Path attr setr)rJrr.r.r/r  cCrrrEr _absoluterr.r.r/abs_pathrzPathDeprecations.abs_pathcCrrr)rJrr.r.r/rrcC|jSrG)_cwdrr.r.r/rzPathDeprecations.cwdcCrr)rErr)rJrr.r.r/rrcCs.ddlm}||dd|_|jrtdSdS)Nr)get_private_kwargsFr)r=r _skip_checkr)rJrLrr.r.r/_deprecated_kwargss  z#PathDeprecations._deprecated_kwargscCs|jr|d7}|S)Nrr)rJnamer.r.r/_repr_skip_checksz!PathDeprecations._repr_skip_checkcCrrGrrr.r.r/rrzPathDeprecations.skip_checkcCrr)rErr)rJrr.r.r/rrTabsoluteracCs|r|jS|jSrG)rr)rJrr.r.r/rszPathDeprecations.__call__N)T)r+r,r-rPpropertyrsetterrrrrrrXpath_call_messagerdrmrr.r.r.r/rs,        rc@r()DebugExceptionNr*r.r.r.r/rr0rz usage_and_exit_error_handler was deprecated in v4.20.0 and will be removed in v5.0.0. With the removal of error_handler, there is no longer a need for this function. parserrAcCs6|tj|j|d}tjd||ddS)zPrints the usage and exits with error code 2 (same behavior as argparse). Args: parser: The parser object. message: The message describing the error being handled. )progrAz%(prog)s: error: %(message)s r6N) print_usagerstderrrwriteexit)rrArKr.r.r/r& s r&z ArgumentParser's error_handler was deprecated in v4.20.0 and will be removed in v5.0.0. Instead use the new exit_on_error parameter from argparse. cCr)NzArgumentParser.error_handlerr7)rEerror_handler_messager7r.r.r/!deprecation_warning_error_handler"rr z ``default_meta`` property was deprecated in v4.44.0 and will be removed in v5.0.0. After removal, config objects will always include metadata. To remove metadata from a config object, do ``.clone(with_meta=False)``. cseZdZdZdddfdd Zeeddeee e gdffd d Z e j d d Z eee defd d Zej defdd ZeddedefddZedddZedddZZS)rzHHelper class for ArgumentParser deprecations. Will be removed in v5.0.0.FN) error_handler default_metacs4tj|i|||_|durd|_dS||_dS)NT)rrUr rer )rJr r rKrLrr.r/rU0s   zParserDeprecations.__init__zCerror_handler property is deprecated and will be removed in v5.0.0.racCr)a=Property for the error_handler function that is called when there are parsing errors. :getter: Returns the current error_handler function. :setter: Sets a new error_handler function (Callable[self, message:str] or None). Raises: ValueError: If an invalid value is given. )_error_handlerrr.r.r/r 8 z ParserDeprecations.error_handlercCs^|durd}td}|jttddrd}t|t|s&|dvr+||_ dSt d) NFr6r jsonargparsez_deprecated.py>FNz/error_handler can be either a Callable or None.) rQstackfilenameendswithr9fspathrr callabler r)rJr r8rr.r.r/r Es  cCr)zWhether by default metadata is included in config objects. :getter: Returns the current default metadata setting. :setter: Sets the default metadata setting. Raises: ValueError: If an invalid value is given. )rerr.r.r/r Rr zParserDeprecations.default_metar cCs&t|trtdt||_dStd)NzArgumentParser.default_metazdefault_meta expects a boolean.)rcrdrEdefault_meta_messagerer)rJr r.r.r/r _s   z instantiate_subclasses was deprecated in v4.0.0 and will be removed in v5.0.0. Instead use instantiate_classes. ricCs|j|ddS)NF)instantiate_groups)rrJrir.r.r/instantiate_subclassesgsz)ParserDeprecations.instantiate_subclassesz add_dataclass_arguments was deprecated in v4.35.0 and will be removed in v5.0.0. Instead use add_class_arguments. cOs&d|vr |d|d<|j|i|S)Ntitlehelp)radd_class_argumentsrIr.r.r/add_dataclass_argumentsnsz*ParserDeprecations.add_dataclass_argumentsz ArgumentParser.check_config was deprecated in v4.35.0 and will be removed in v5.0.0. Instead use validate. cOs|j|i|SrG)validaterIr.r.r/ check_configwszParserDeprecations.check_config)r+r,r-rPrUrrXr rrrmr rrrdr rrrrrr.r.rr/r-s&"    rrLskip_validationcCs@|dd}|rtdt||dur|}t|ddd|S)NrzUnexpected keyword parameters: zjskip_check parameter was deprecated in v4.35.0 and will be removed in v5.0.0. Instead use skip_validation.r7)rrsetrE)r@rLrrr.r.r/deprecated_skip_checks r" with_commentscCs*|dd}|durttddd|S|S)N yaml_commentszkyaml_comments parameter was deprecated in v4.44.0 and will be removed in v5.0.0. Instead use with_comments.r r7)rrEdeprecated_yaml_comments)rLr#r$r.r.r/r%s r%cstd}t|d|}|tj|<td|dfdd}||_tttjd|j d<||j d <dS) N jsonargparse.z deprecated z Only use the public API as described in https://jsonargparse.readthedocs.io/en/stable/#api-reference. Importing from z is kept only to avoid breaking code that does not correctly use the public API. It will no longer be available from v5.0.0. cs6d}r|vr|\}}ttd||S)N_r&)rbr)r new_modulemappings module_namer.r/ __getattr__s   z&deprecated_module..__getattr__z.py__file____path__) rrmodulesrXr,rmrr-parent__dict__)r+r* module_pathmoduler,r.r)r/deprecated_modules  r4actionsclicore formattersjsonnet jsonschemalink_argumentsloaders_dumpers namespaceparameter_resolvers signatures typehintsutil optionalsimport_docstring_parse)rimport_docstring_parserzr ActionJsonnetExtVars was deprecated in v4.24.0 and will be removed in v5.0.0. Instead use ``type=dict``. c@seZdZdZddZdS)rz?Action to add argument to provide ext_vars for jsonnet parsing.cOs*ddlm}|tddi|}d|_|S)NrrrTr.)rrrujsonnet_ext_vars)rJrKrLractionr.r.r/rs zActionJsonnetExtVars.__call__N)r+r,r-rPrr.r.r.r/rs rz LoggerProperty was deprecated in v4.40.0 and will be removed from the public API in v5.0.0. There is no replacement since jsonargparse is not a logging library. A similar class can be found in reconplogger package. c@seZdZdZdS)rz2Adds a logger property, intended for internal use.N)r+r,r-rPr.r.r.r/rsrz namespace_to_dict was deprecated in v4.40.0 and will be removed in v5.0.0. Instead you can use ``.clone().as_dict()`` or ``.as_dict()``. cCs |S)zHReturns a copy of a nested namespace converted into a nested dictionary.)rfrg)r=r.r.r/r!s r!z dict_to_namespace was deprecated in v4.43.0 and will be removed in v5.0.0. No replacement is provided because blindly converting a dictionary to a namespace may not yield the same results as using a parser, which could lead to confusion. cfg_dictcCddlm}||S)z5Converts a nested dictionary into a nested namespace.r)r ) _namespacer )rG_dict_to_namespacer.r.r/r s r rircCdSrGr.rir.r.r/r%r%cCrKrGr.rLr.r.r/r%rMzv strip_meta was deprecated in v4.43.0 and will be removed in v5.0.0. Instead use ``.clone(with_meta=False)``. cCrH)z6Removes all metadata keys from a configuration object.r) remove_meta)rIrN)rirNr.r.r/r%s c seZdZdZfddZeddedefddZed d edefd d Z ed d ededede fddZ edd ededede fddZ Z S)rzNHelper class for DefaultHelpFormatter deprecations. Will be removed in v5.0.0.cs,ddlm}tj|i||||_dS)Nr)YAMLCommentFormatter)jsonargparse._formattersrOrrU_yaml_formatter)rJrKrLrOrr.r/rUs z"HelpFormatterDeprecations.__init__zIThe add_yaml_comments method is deprecated and will be removed in v5.0.0.riracCs |j|S)z Adds help text as yaml comments.)rQadd_yaml_commentsrr.r.r/rRs z+HelpFormatterDeprecations.add_yaml_commentszNThe set_yaml_start_comment method is deprecated and will be removed in v5.0.0.textcCs|j||dS)zSets the start comment to a ruamel.yaml object. Args: text: The content to use for the comment. cfg: The ruamel.yaml object. N)rQset_yaml_start_comment)rJrSrir.r.r/rTsz0HelpFormatterDeprecations.set_yaml_start_commentzNThe set_yaml_group_comment method is deprecated and will be removed in v5.0.0.keydepthcC|j||||dS)a Sets the comment for a group to a ruamel.yaml object. Args: text: The content to use for the comment. cfg: The parent ruamel.yaml object. key: The key of the group. depth: The nested level of the group. N)rQset_yaml_group_commentrJrSrirUrVr.r.r/rX' z0HelpFormatterDeprecations.set_yaml_group_commentzQThe set_yaml_argument_comment method is deprecated and will be removed in v5.0.0.cCrW)aSets the comment for an argument to a ruamel.yaml object. Args: text: The content to use for the comment. cfg: The parent ruamel.yaml object. key: The key of the argument. depth: The nested level of the argument. N)rQset_yaml_argument_commentrYr.r.r/r[3rZz3HelpFormatterDeprecations.set_yaml_argument_comment)r+r,r-rPrUrXrmrRrrTrrXr[rr.r.rr/rs   $rz compose_dataclasses is deprecated and will be removed in v5.0.0. There is no direct replacement, whoever is interested can copy the code from an old release. cs,ddl}|jGfdddgR}|S)zYReturns a dataclass inheriting all given dataclasses and properly handling __post_init__.rNcseZdZfddZdS)z.compose_dataclasses..ComposedDataclasscs"D] }t|dr||qdS)N __post_init__)rr\)rJargrKr.r/r\Ls   z.ComposedDataclass.__post_init__N)r+r,r-r\r.r^r.r/ComposedDataclassJsr_) dataclasses dataclass)rKr`r_r.r^r/r@sr)r)FF)NN)r6rG)rirrar)OrPrSrQr9rargparserrr importlibrpathlibrtypesrrrrr r r r r rrrrInternalLoggerPropertyrIr_type_checkingrr__all__r!r'__annotations__DeprecationWarningr)rErXrrrrrrdr$r#rmrr"rrlogger_property_none_message env_prefix_property_none_messagerrrrr Exceptionrr&rr rrrur"r%rr4rr!r r%rrr.r.r.r/s     $   ^L     : R   $ 1