Update dependency jsonargparse to v4.47.0

[renovate]

This PR contains the following updates:

Package	Change	Age	Confidence
jsonargparse (changelog)	==4.36.0 → ==4.47.0

---

Release Notes

omni-us/jsonargparse (jsonargparse)

v4.47.0

Compare Source

Added
^^^^^

• Improved shtab bash typehint completions for Union and Literal:
  choices for unions that also accept open values now require a prefix to be
  completed, and literal booleans/None now complete as false/true
  and null (#&#8203;851 <https://github.com/omni-us/jsonargparse/pull/851>__).
• auto_cli now supports a return_instance parameter to instantiate class
  components directly instead of exposing methods as subcommands (#&#8203;855 <https://github.com/omni-us/jsonargparse/pull/855>__).
• New ArgumentParser.get_completion_script(completion_type) public method
  to generate completion scripts programmatically, and new
  set_parsing_settings(add_print_completion_argument=...) setting and
  JSONARGPARSE_ADD_PRINT_COMPLETION_ARGUMENT environment variable to opt-in
  automatic addition of --print_completion when shtab is installed
  (#&#8203;859 <https://github.com/omni-us/jsonargparse/pull/859>__).

Fixed
^^^^^

• Positional arguments with nargs="*" or nargs="?" now correctly allow
  default values, matching standard argparse behavior (#&#8203;846 <https://github.com/omni-us/jsonargparse/pull/846>__).
• Parsing of floats with implicit leading zero (e.g. -.5) not working (#&#8203;847 <https://github.com/omni-us/jsonargparse/pull/847>__).
• Subcommand names now correctly take precedence over top-level option strings
  with the same name, fixing a failure during typed sub-default processing
  (#&#8203;853 <https://github.com/omni-us/jsonargparse/pull/853>__).
• --help no longer fails with IndexError for options without explicit
  help text while keeping argparse compatibility for help=None (#&#8203;854 <https://github.com/omni-us/jsonargparse/pull/854>__).
• store_true and store_false arguments now parse boolean environment
  variable values as true/false and raise a clear error for invalid
  values (#&#8203;858 <https://github.com/omni-us/jsonargparse/pull/858>__).
• Environment variable overrides now correctly take precedence over
  default_config_files values for subcommands and nested subsubcommands
  (#&#8203;862 <https://github.com/omni-us/jsonargparse/pull/862>__).
• omegaconf+ incorrectly applied for default_config_files (#&#8203;865 <https://github.com/omni-us/jsonargparse/pull/865>__).
• ActionSubCommands.add_subcommand() missing from API reference
  (#&#8203;863 <https://github.com/omni-us/jsonargparse/pull/863>__).

Changed
^^^^^^^

• Tests are no longer installed by default, there is a separate
  jsonargparse_tests wheel file for that (#&#8203;843 <https://github.com/omni-us/jsonargparse/pull/843>__).
• Adding argument giving both type and action is now allowed
  (#&#8203;845 <https://github.com/omni-us/jsonargparse/pull/845>__).
• Parsers no longer auto-add --print_shtab by default. Completion script
  generation now uses shtab-* completion types, and when
  get_completion_script is used the parser instance is invalidated for
  further use. A hidden --print_shtab argument remains to guide users to
  the new opt-in completion setting (#&#8203;859 <https://github.com/omni-us/jsonargparse/pull/859>__).
• JSONARGPARSE_DEBUG can only be enabled with true (case-insensitive)
  (867 <https://github.com/omni-us/jsonargparse/pull/867>__).

v4.46.0

Compare Source

Added
^^^^^

• Public interface for enabling/disabling support of type subclasses (#&#8203;817 <https://github.com/omni-us/jsonargparse/pull/817>__).

Fixed
^^^^^

• Choices with an int type not working correctly (#&#8203;827 <https://github.com/omni-us/jsonargparse/pull/827>__).
• Union of dataclasses not discarding parameters on class change (#&#8203;833 <https://github.com/omni-us/jsonargparse/pull/833>__).
• Targets of links applied on parse not being instantiated (#&#8203;834 <https://github.com/omni-us/jsonargparse/pull/834>__).
• Validation of defaults getting stuck for path with - (stdin) default
  (#&#8203;837 <https://github.com/omni-us/jsonargparse/pull/837>__).
• Failure when parsing deeply nested dataclass with a union parent (#&#8203;839 <https://github.com/omni-us/jsonargparse/pull/839>__).

v4.45.0

Compare Source

Added
^^^^^

• Signature methods now when given sub_configs=True, list of paths types can
  now receive a file containing a list of paths (#&#8203;816 <https://github.com/omni-us/jsonargparse/pull/816>__).
• FromConfigMixin.from_config now supports subclasses (#&#8203;822 <https://github.com/omni-us/jsonargparse/pull/822>__).

Fixed
^^^^^

• Dict override syntax to allow standard form: --cfg.dict.key val (#&#8203;824 <https://github.com/omni-us/jsonargparse/pull/824>__).
• Evaluation of postponed annotations for dataclass inheritance across modules
  not working correctly (#&#8203;814 <https://github.com/omni-us/jsonargparse/pull/814>__).
• Getting parameter descriptions from docstrings not working for dataclass
  inheritance (#&#8203;815 <https://github.com/omni-us/jsonargparse/pull/815>__).
• default_env=True conflicting with default_config_files (#&#8203;818 <https://github.com/omni-us/jsonargparse/pull/818>__).
• default_config_files with settings for multiple subcommands not working
  correctly (#&#8203;819 <https://github.com/omni-us/jsonargparse/pull/819>__).
• register_type not checking that the given type is a class (#&#8203;820 <https://github.com/omni-us/jsonargparse/pull/820>__).

Changed
^^^^^^^

• List of paths types now show in the help the supported options for providing
  paths like '["PATH1",...]' | LIST_OF_PATHS_FILE | - (#&#8203;816 <https://github.com/omni-us/jsonargparse/pull/816>__).
• Providing a choice of subcommand in default_config_files is now an error
  (#&#8203;819 <https://github.com/omni-us/jsonargparse/pull/819>__).

v4.44.0

Compare Source

Fixed
^^^^^

• Union types with str and default comment-like string incorrectly parsed as a
  stringified exception of an other subtype (#&#8203;812 <https://github.com/omni-us/jsonargparse/pull/812>__).
• FromConfigMixin not handling correctly required parameters (#&#8203;813 <https://github.com/omni-us/jsonargparse/pull/813>__).

Changed
^^^^^^^

• Improved error messages when not accepted options are given, referencing which
  parser/subcommand the option was given to. Also suggests running --help
  for the corresponding parser/subcommand (#&#8203;809 <https://github.com/omni-us/jsonargparse/pull/809>__).
• The yaml_comments parameter of ArgumentParser.dump has been renamed to
  with_comments to allow future comments support of other formats (#&#8203;811 <https://github.com/omni-us/jsonargparse/pull/811>__).

Deprecated
^^^^^^^^^^

• ArgumentParser.default_meta property and with_meta parameter of
  ArgumentParser.parse_* are deprecated and will be removed in v5.0.0.
  Instead use .clone(with_meta=...) (#&#8203;810 <https://github.com/omni-us/jsonargparse/pull/810>__).
• The yaml_comments parameter of ArgumentParser.dump is deprecated and
  will be removed in v5.0.0. Use with_comments instead (#&#8203;811 <https://github.com/omni-us/jsonargparse/pull/811>__).

v4.43.0

Compare Source

Added
^^^^^

• Non-public experimental mixin class to override init defaults and instantiate
  from config (#&#8203;800 <https://github.com/omni-us/jsonargparse/pull/800>__).

Fixed
^^^^^

• Prevent extra environment variables in helptext when default_env=True, for
  version actions and subcommands (#&#8203;787 <https://github.com/omni-us/jsonargparse/pull/787>__).
• Union with path type and non-path value incorrectly dumped as string
  (#&#8203;789 <https://github.com/omni-us/jsonargparse/pull/789>__).
• Misleading error message for invalid value for Literal strings (#&#8203;790 <https://github.com/omni-us/jsonargparse/pull/790>__).
• Changing omegaconf_absolute_to_relative_paths not taking effect after
  parsing once (#&#8203;805 <https://github.com/omni-us/jsonargparse/pull/805>__).

Changed
^^^^^^^

• parse_optionals_as_positionals and applied_instantiation_links no
  longer marked as experimental (#&#8203;788 <https://github.com/omni-us/jsonargparse/pull/788>__).
• Moved location of Path class from jsonargparse to
  jsonargparse.typing (#&#8203;792 <https://github.com/omni-us/jsonargparse/pull/792>__).
• Non-parsing actions now have a common base class to ease identification
  (#&#8203;793 <https://github.com/omni-us/jsonargparse/pull/793>__).
• jsonargparse.* modules now use Python 3.9+ syntax (#&#8203;798 <https://github.com/omni-us/jsonargparse/pull/798>__).

Deprecated
^^^^^^^^^^

• Path.__call__ is deprecated and will be removed in v5.0.0. Use the
  absolute or relative properties instead (#&#8203;794 <https://github.com/omni-us/jsonargparse/pull/794>__).
• strip_meta is deprecated and will be removed in v5.0.0. Instead use
  .clone(with_meta=False) (#&#8203;795 <https://github.com/omni-us/jsonargparse/pull/795>__).
• compose_dataclasses is deprecated and will be removed in v5.0.0. There is
  no direct replacement, whoever is interested can copy the code (#&#8203;796 <https://github.com/omni-us/jsonargparse/pull/796>__).
• dict_to_namespace is deprecated 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 (#&#8203;797 <https://github.com/omni-us/jsonargparse/pull/797>__).

v4.42.0

Compare Source

Added
^^^^^

• set_parsing_settings now supports setting allow_py_files to enable
  stubs resolver searching in .py files in addition to .pyi (#&#8203;770 <https://github.com/omni-us/jsonargparse/pull/770>__).
• Experimental support for dataclass inheritance (#&#8203;775 <https://github.com/omni-us/jsonargparse/pull/775>__).
• Experimental support for pydantic BaseModel subclasses (#&#8203;781 <https://github.com/omni-us/jsonargparse/pull/781>__).
• Argument to print help for dataclasses nested in types, e.g.
  Optional[Data], Union[Data1, Data2] (#&#8203;783 <https://github.com/omni-us/jsonargparse/pull/783>__).
• set_parsing_settings now supports omegaconf_absolute_to_relative_paths
  to enable backward compatibility of omegaconf+ parser mode by converting
  absolute paths to relative in interpolations (#&#8203;774 <https://github.com/omni-us/jsonargparse/pull/774>__).

Fixed
^^^^^

• Stubs resolver in some cases failing with maximum recursion error (#&#8203;770 <https://github.com/omni-us/jsonargparse/pull/770>__).
• dataclass with default failing when validate_defaults=True (#&#8203;771 <https://github.com/omni-us/jsonargparse/pull/771>__).
• Misleading error message when a namespace is used in a list comprehension
  (#&#8203;772 <https://github.com/omni-us/jsonargparse/pull/772>__).
• omegaconf+ parser mode failing when there are inf, -inf or nan
  values (#&#8203;773 <https://github.com/omni-us/jsonargparse/pull/773>__).
• save with multifile=True not saving separate subconfigs for items in a
  list (#&#8203;779 <https://github.com/omni-us/jsonargparse/pull/779>__).
• omegaconf parser mode failing on spawned processes (#&#8203;784 <https://github.com/omni-us/jsonargparse/pull/784>__).

v4.41.0

Compare Source

Added
^^^^^

• Support for Python 3.14 (#&#8203;753 <https://github.com/omni-us/jsonargparse/pull/753>__).
• Support callable protocols for instance factory dependency injection (#&#8203;758 <https://github.com/omni-us/jsonargparse/pull/758>__).
• New ActionFail for arguments that should fail parsing with a given error
  message (#&#8203;759 <https://github.com/omni-us/jsonargparse/pull/759>__).
• Experimental omegaconf+ parser mode that supports variable interpolation
  and resolving across configs and command line arguments. Depending on
  community feedback, in v5.0.0 this new mode could replace the current
  omegaconf mode, introducing a breaking change (#&#8203;765 <https://github.com/omni-us/jsonargparse/pull/765>__).

Fixed
^^^^^

• Improved parameter kind handling for argument requirement determination.
  KEYWORD_ONLY parameters now correctly use --flag style (#&#8203;756 <https://github.com/omni-us/jsonargparse/pull/756>__).
• Some deprecations not shown in the API documentation (#&#8203;760 <https://github.com/omni-us/jsonargparse/pull/760>__).
• Environment variable names not shown in help for positional arguments when
  default_env is true (#&#8203;763 <https://github.com/omni-us/jsonargparse/pull/763>__).
• parse_object not parsing correctly configs (#&#8203;765 <https://github.com/omni-us/jsonargparse/pull/765>__).

Changed
^^^^^^^

• Removed support for python 3.8 (#&#8203;752 <https://github.com/omni-us/jsonargparse/pull/752>__).
• YAML comments feature is now implemented in a separate class to allow
  better support for custom help formatters without breaking the comments (#&#8203;754 <https://github.com/omni-us/jsonargparse/pull/754>__).
• Replaced unmaintained optional dependency ruyaml with ruamel.yaml
  (#&#8203;768 <https://github.com/omni-us/jsonargparse/pull/768>__).

Deprecated
^^^^^^^^^^

• DefaultHelpFormatter.*_yaml*_comment* methods are deprecated and will be
  removed in v5.0.0. This logic has been moved to a new private class
  YAMLCommentFormatter. If deemed necessary, this class might be made public
  in the future (#&#8203;754 <https://github.com/omni-us/jsonargparse/pull/754>__).
• The ruyaml optional dependency is deprecated and will be removed in
  v5.0.0. Instead use the ruamel optional dependency (#&#8203;768 <https://github.com/omni-us/jsonargparse/pull/768>__).

v4.40.2

Compare Source

Fixed
^^^^^

• Subclass defaults incorrectly taken from base class (#&#8203;743 <https://github.com/omni-us/jsonargparse/pull/743>__).
• Linking entire dataclasses on instantiation not working (#&#8203;746 <https://github.com/omni-us/jsonargparse/pull/746>__).
• Introspection of postponed annotations from jax not working (#&#8203;749 <https://github.com/omni-us/jsonargparse/pull/749>__).
• without-future-annotations test not included in local coverage (#&#8203;751 <https://github.com/omni-us/jsonargparse/pull/751>__).

v4.40.1

Compare Source

Fixed
^^^^^

• print_shtab incorrectly parsed from environment variable (#&#8203;726 <https://github.com/omni-us/jsonargparse/pull/726>__).
• adapt_class_type used a locally defined partial_instance wrapper
  function that is not pickleable (#&#8203;728 <https://github.com/omni-us/jsonargparse/pull/728>__).
• ArgumentParser with dashes incorrectly resolves paths to default values (#&#8203;736 <https://github.com/omni-us/jsonargparse/pull/736>__).
• Fix failing tests due to new version of typeshed-client (#&#8203;740 <https://github.com/omni-us/jsonargparse/pull/740>__).
• Require new version of docstring-parser to avoid deprecation warnings
  (#&#8203;741 <https://github.com/omni-us/jsonargparse/pull/741>__).

v4.40.0

Compare Source

Added
^^^^^

• New auto_parser function for convenience and more visibility of the
  capture_parser feature (#&#8203;721 <https://github.com/omni-us/jsonargparse/pull/721>__).

Fixed
^^^^^

• set_parsing_settings(validate_defaults=True) fails when the parser has a
  config action (#&#8203;718 <https://github.com/omni-us/jsonargparse/pull/718>__).
• Regression causing dump/save to fail when skip_link_targets=True and
  target being an entire required dataclass (#&#8203;717 <https://github.com/omni-us/jsonargparse/pull/717>__).
• TypedDict values not validated when types are forward references (#&#8203;722 <https://github.com/omni-us/jsonargparse/pull/722>__).
• Stubs-only resolver incorrectly triggered when inspect.signature available
  leading to missing parameter defaults (#&#8203;724 <https://github.com/omni-us/jsonargparse/pull/724>__).

Changed
^^^^^^^

• Use latest jsonnet release that works on all platforms and python versions
  (#&#8203;682 <https://github.com/omni-us/jsonargparse/pull/682>__).

Deprecated
^^^^^^^^^^

• LoggerProperty is deprecated and will be removed in v5.0.0. There is no
  replacement since jsonargparse is not a logging library. A similar class can
  be found in reconplogger (#&#8203;719 <https://github.com/omni-us/jsonargparse/pull/719>__).
• namespace_to_dict is deprecated and will be removed in v5.0.0. Instead use
  .clone().as_dict() or .as_dict() (#&#8203;720 <https://github.com/omni-us/jsonargparse/pull/720>__).

v4.39.0

Compare Source

Added
^^^^^

• shtab hint for positionals in bash now includes the argument name (#&#8203;699 <https://github.com/omni-us/jsonargparse/pull/699>__).
• shtab support for optionals parsed as positionals (#&#8203;700 <https://github.com/omni-us/jsonargparse/pull/700>__).
• auto_cli now supports class @property (#&#8203;701 <https://github.com/omni-us/jsonargparse/pull/701>__).
• Resolve parameters completely from stubs when inspect.signature fails
  (#&#8203;698 <https://github.com/omni-us/jsonargparse/pull/698>__).
• Option to enable validation of default values (#&#8203;711 <https://github.com/omni-us/jsonargparse/pull/711>__).
• Experimental support for custom instantiators receiving values applied by
  instantiation links (#&#8203;716 <https://github.com/omni-us/jsonargparse/pull/716>__).

Changed
^^^^^^^

• Untyped parameters with None default no longer skipped when
  fail_untyped=True (#&#8203;697 <https://github.com/omni-us/jsonargparse/pull/697>__).
• config_read_mode and docstring_parse options can now be set using
  set_parsing_settings (#&#8203;712 <https://github.com/omni-us/jsonargparse/pull/712>__).

Fixed
^^^^^

• ActionParser not updating dest of groups for instantiation (#&#8203;707 <https://github.com/omni-us/jsonargparse/pull/707>__).
• Nested generic dataclasses not working correctly (#&#8203;709 <https://github.com/omni-us/jsonargparse/pull/709>__).
• List append nested in subclass not working (#&#8203;710 <https://github.com/omni-us/jsonargparse/pull/710>__).

Deprecated
^^^^^^^^^^

• get_config_read_mode, set_config_read_mode and
  set_docstring_parse_options are deprecated and will be removed in v5.0.0.
  Instead of set_config_read_mode and set_docstring_parse_options use
  set_parsing_settings. There will be no replacement for
  get_config_read_mode since this is considered internal (#&#8203;712 <https://github.com/omni-us/jsonargparse/pull/712>__).

v4.38.0

Compare Source

Added
^^^^^

• Support shtab completion of Literal types (#&#8203;693 <https://github.com/omni-us/jsonargparse/pull/693>__).
• Support for parsing optionals as positionals (#&#8203;692 <https://github.com/omni-us/jsonargparse/pull/692>__).

Changed
^^^^^^^

• validate now checks values before required so that errors related to wrong
  level in a config are easier to understand (#&#8203;681 <https://github.com/omni-us/jsonargparse/pull/681>__).
• add_argument of a positional and providing default now raises an error
  (#&#8203;694 <https://github.com/omni-us/jsonargparse/pull/694>__).

Fixed
^^^^^

• add_class_arguments with dashes in the nested_key fail to instantiate
  (#&#8203;679 <https://github.com/omni-us/jsonargparse/pull/679>__).
• Regression parsing strings with omegaconf as the parser mode (#&#8203;686 <https://github.com/omni-us/jsonargparse/pull/686>__).
• Help incorrectly showing environment variable name for --print_shtab.
• add_argument raises error when type is assigned with action=None
  (#&#8203;687 <https://github.com/omni-us/jsonargparse/pull/687>__).
• shtab failing when parser has positional arguments (#&#8203;693 <https://github.com/omni-us/jsonargparse/pull/693>__).

v4.37.0

Compare Source

Added
^^^^^

• Experimental support for sub-classing ArgumentParser to customize
  add_argument (#&#8203;661 <https://github.com/omni-us/jsonargparse/pull/661>__).

Fixed
^^^^^

• Incorrect instantiation order when instantiation targets share a parent (#&#8203;662 <https://github.com/omni-us/jsonargparse/pull/662>__).
• Pydantic discriminated unions handled incorrectly (#&#8203;667 <https://github.com/omni-us/jsonargparse/pull/667>__).
• Failure when a link target has an undefined parent (#&#8203;668 <https://github.com/omni-us/jsonargparse/pull/668>__).
• Functions that create types now have TypeAlias return type to avoid mypy
  errors (#&#8203;671 <https://github.com/omni-us/jsonargparse/pull/671>__).
• String parsing regressions (#&#8203;673 <https://github.com/omni-us/jsonargparse/pull/673>, #&#8203;674 <https://github.com/omni-us/jsonargparse/pull/674>).
• Regression when using old CLI and inferring components from the local
  context (#&#8203;676 <https://github.com/omni-us/jsonargparse/pull/676>__).

---

Configuration

📅 Schedule: Branch creation - At any time (no schedule defined), Automerge - At any time (no schedule defined).

🚦 Automerge: Disabled by config. Please merge this manually once you are satisfied.

♻ Rebasing: Whenever PR becomes conflicted, or you tick the rebase/retry checkbox.

🔕 Ignore: Close this PR and you won't be reminded about these updates again.

---

• If you want to rebase/retry this PR, check this box

---

This PR was generated by Mend Renovate. View the repository job log.