Update dependency jsonargparse to v4.51.0 by renovate[bot] · Pull Request #368 · Solvik/netbox-agent

renovate · 2025-02-14T11:29:52Z

This PR contains the following updates:

Package	Change	Age	Confidence
jsonargparse (changelog)	`==4.36.0` → `==4.51.0`

Release Notes

mauvilsa/jsonargparse (jsonargparse)

`v4.51.0`

Compare Source

Added
^^^^^

validate_subclass_spec_in_any setting in set_parsing_settings so that
when a value looks like a subclass spec but is not a valid one, the parsing
fails instead of silently ignoring it. Applies to types that accept any value,
i.e. Any, object, Unvalidated<...> and dicts that don't validate
their values, e.g. dict[str, Any]. For dicts the spec is only validated,
since the value is kept as a dict. When disabled (the default), a debug log
now informs about the ignored invalid subclass spec (#938 <https://github.com/mauvilsa/jsonargparse/pull/938>, #953 <https://github.com/mauvilsa/jsonargparse/pull/953>, #958 <https://github.com/mauvilsa/jsonargparse/pull/958>__).
Items of a list of classes and values of a dict of classes can now be given as
paths to sub-config files, instead of this only being supported for the value
of an entire argument (#940 <https://github.com/mauvilsa/jsonargparse/pull/940>__).
shtab completion scripts now include file and directory completions for
arguments typed as pydantic's FilePath and DirectoryPath (#943 <https://github.com/mauvilsa/jsonargparse/pull/943>__).
Support type[SomeTypedDict] such that the given class is accepted when it
is structurally compatible, i.e. it has all the keys of the expected
TypedDict, with the same types and requiredness (#945 <https://github.com/mauvilsa/jsonargparse/pull/945>__).
Support types.ModuleType as a type. The value is the import path of a
module, which on parse is validated to be importable, and on instantiate
is replaced by the imported module object (#945 <https://github.com/mauvilsa/jsonargparse/pull/945>__).
Support types.UnionType and types.GenericAlias as types, often seen in
third party libraries in unions such as type | UnionType | dict. The value
is a string with a type expression, e.g. "int | str" and "list[int]"
(#945 <https://github.com/mauvilsa/jsonargparse/pull/945>__).
Support Collection, Container and Reversible, validated as a list,
and AbstractSet, validated as a set (#950 <https://github.com/mauvilsa/jsonargparse/pull/950>__).
shtab completion scripts now include the fields of a dataclass-like type
that is not added as a group, e.g. Optional[SomeDataclass] (#952 <https://github.com/mauvilsa/jsonargparse/pull/952>__).
A TypeVar used as the type itself, i.e. not only as the subtype of a
type[...], is now replaced by what it stands for: its PEP 696 default,
its constraints or its bound, also when given as a forward reference.
Previously the value was accepted without any validation, see
:ref:generic-types (#953 <https://github.com/mauvilsa/jsonargparse/pull/953>, #958 <https://github.com/mauvilsa/jsonargparse/pull/958>).
Arguments typed as a TypedDict now have a --*.help option that shows
the keys that are accepted, their types and their descriptions. It receives no
value, unless the TypedDict is in a union with other types that have a
help, in which case the value is the name of the typed dict (#956 <https://github.com/mauvilsa/jsonargparse/pull/956>__).
add_class_arguments now accepts a TypedDict, adding one argument per
key, analogous to a dataclass. instantiate gives the corresponding dict
(#956 <https://github.com/mauvilsa/jsonargparse/pull/956>__).
Descriptions of TypedDict keys taken from its docstring are now shown in
the help of **kwargs: Unpack[SomeTypedDict] parameters (#956 <https://github.com/mauvilsa/jsonargparse/pull/956>__).
shtab completion scripts now include the keys of a TypedDict
argument, e.g. --data.key, and the values that these keys accept (#956 <https://github.com/mauvilsa/jsonargparse/pull/956>__).
Pydantic's alias and validation_alias and attrs' alias are now
accepted as option and config keys, so that a parser accepts the same names as
the class itself. The parsed namespace and dumps use the name that the class
accepts, see :ref:parameter-aliases (#956 <https://github.com/mauvilsa/jsonargparse/pull/956>__).
Support a subscripted generic TypedDict, e.g. SomeDict[int], and a
TypedDict that inherits from one, e.g. class SubDict(SomeDict[int]),
previously unsupported types. The type arguments are substituted into the keys
annotated with a TypeVar, see :ref:type-hints (#958 <https://github.com/mauvilsa/jsonargparse/pull/958>__).

Fixed
^^^^^

TypeError when adding arguments for a class that has a parameter that has
a default and is annotated with a non-@runtime_checkable Protocol type
(#935 <https://github.com/mauvilsa/jsonargparse/pull/935>__).
TypedDict keys inherited from a base defined in a different module not
resolving the types only imported in the TYPE_CHECKING block of that
module (#936 <https://github.com/mauvilsa/jsonargparse/pull/936>__).
dump with with_comments=True, i.e. --print_config=comments, not
adding any comment for the init_args of subclasses and for the fields of
dataclass-like types that are not added as a group, including when nested in
lists and dicts (#939 <https://github.com/mauvilsa/jsonargparse/pull/939>__).
shtab bash completion scripts not escaping choices and type messages, such
that a value containing a single quote, e.g. a Literal type, produced a
script with invalid syntax (#947 <https://github.com/mauvilsa/jsonargparse/pull/947>__).
Tests for shtab completions failing with shtab>=1.9.1 due to a change
in how it quotes the elements of the generated bash arrays. The completion
scripts themselves were not affected (#947 <https://github.com/mauvilsa/jsonargparse/pull/947>__).
fail_untyped=True failing for mandatory parameters that do have a type,
with an error that says the parameter "does not specify a type". Now it only
fails for parameters that have no type at all (#948 <https://github.com/mauvilsa/jsonargparse/pull/948>__).
Signature parameters with a pydantic type nested in a container, e.g.
list[HttpUrl], being skipped (#948 <https://github.com/mauvilsa/jsonargparse/pull/948>__).
dump, and thus --print_config, failing when the value of an Any or
Unvalidated<...> typed argument is of a type that the config format does
not represent, e.g. a class instance, or a set when the format is json.
Now a type is derived from the value and used to serialize it, class instances
are serialized as an import path or as a message that says that it was not
serializable, and a warning is raised when the dumped value does not
round-trip, see :ref:unvalidated-types (#948 <https://github.com/mauvilsa/jsonargparse/pull/948>, #956 <https://github.com/mauvilsa/jsonargparse/pull/956>).
AssertionError without a message when adding an argument typed as a
subscripted user defined generic class, e.g. Optional[Strategy[T]] (#950 <https://github.com/mauvilsa/jsonargparse/pull/950>__).
A Callable type accepting values that are neither callable nor an import
path, e.g. a list, which in a union such as Union[Callable, list[Callable]] prevented the list items from being resolved (#950 <https://github.com/mauvilsa/jsonargparse/pull/950>__).
type[T] never validating. Now the TypeVar is replaced by its bound,
its constraints, or object when it has neither, so that the help shows
what is accepted, e.g. type[object] (#950 <https://github.com/mauvilsa/jsonargparse/pull/950>__).
Parameters of a subscripted generic class being dropped when their type is a
PEP 604 union, e.g. p: int | None in a Generic[T] class added as
MyClass[int] (#950 <https://github.com/mauvilsa/jsonargparse/pull/950>__).
Docstrings of base classes not being used to document inherited parameters and
attributes, e.g. the attribute docstrings of a pydantic model declared in a
base model not being shown in the help. Now the entire method resolution order
is searched (#951 <https://github.com/mauvilsa/jsonargparse/pull/951>__).
The description of a group being taken from an inherited __init__
docstring of a base class from another package, most notably pydantic models
without a docstring getting Create a new model by parsing and validating input data from keyword arguments. Now the nearest class docstring in the
method resolution order is used, skipping base classes that only provide
machinery (#951 <https://github.com/mauvilsa/jsonargparse/pull/951>__).
A dataclass-like type accepting the class_path of a subclass when it is
not added as a group, e.g. Optional[SomeDataclass], even though subclasses
are disabled for these types by default. The error now says how to enable
subclass support for the type, see :ref:subclasses-disabled (#952 <https://github.com/mauvilsa/jsonargparse/pull/952>__).
Signature parameters typed as a dataclass-like type that is not added as a
group, e.g. Optional[SomeDataclass], list[SomeDataclass] and
dict[str, SomeDataclass], not accepting a path to a sub-config file even
when added with sub_configs=True, failing with e.g. No module named 'data'. Also, the path of a loaded sub-config was not kept, so save with
multifile=True did not write it back to its own file. See
:ref:sub-config-files (#952 <https://github.com/mauvilsa/jsonargparse/pull/952>__).
The value of an environment variable not validating for a dataclass-like typed
argument of a subcommand, e.g. APP_SUB__DATA='{"p1": 2}' failing with
Not a valid subclass of ... (#952 <https://github.com/mauvilsa/jsonargparse/pull/952>__).
dump, and thus --print_config, not being able to serialize a value
that was given as an import path to an instance, unless the instance happened
to be defined in the module of its class. Instead of the import path it wrote
a message saying that the instance was not serializable, making the dump not
round-trippable. Now the import path that a value was resolved from is
remembered and dumped back (#953 <https://github.com/mauvilsa/jsonargparse/pull/953>__).
Secrets round-tripping through --print_config as the mask **********,
silently making the mask the actual secret. Now parsing the mask as a
SecretStr, both jsonargparse's and pydantic's, fails (#953 <https://github.com/mauvilsa/jsonargparse/pull/953>__).
A generic Protocol never being implementable, both unsubscripted and
subscripted, e.g. Proto and Proto[int]. Now the type arguments are
substituted and a TypeVar that remains matches any type, as static type
checkers do, see :ref:type-hints (#953 <https://github.com/mauvilsa/jsonargparse/pull/953>, #958 <https://github.com/mauvilsa/jsonargparse/pull/958>).
Classes having no parameters at all when a decorator wraps __new__, e.g.
decorators that mark a class as deprecated or experimental. The parameters
were resolved from the wrapper instead of from __init__ (#953 <https://github.com/mauvilsa/jsonargparse/pull/953>__).
Types shown in the help being mangled when they contain a dot, since the
stripping of module names was done with a regex over the entire type string.
Affected floats, literals and ellipsis (#954 <https://github.com/mauvilsa/jsonargparse/pull/954>__).
None in a PEP 604 union shown as is in the help, e.g. date | None,
instead of as date | null, which is what parsing requires (#954 <https://github.com/mauvilsa/jsonargparse/pull/954>__).
dump with skip_default=True, i.e. --print_config=skip_default,
failing with AttributeError: 'NoneType' object has no attribute 'get' when
a subclass spec is given for an argument whose default is None, e.g. an
Optional[SomeClass] parameter. Now the class_path is kept in the dump
and only the init_args that are defaults are removed (#954 <https://github.com/mauvilsa/jsonargparse/pull/954>__).
Parameters popped or gotten from **kwargs disappearing when the value is
then forwarded explicitly as a keyword, e.g. x = kwargs.pop("x", None)
followed by super().__init__(x=x, **kwargs) (#954 <https://github.com/mauvilsa/jsonargparse/pull/954>__).
shtab bash completion not redrawing the prompt after printing the type
guidance message when there are zero completions, leaving the cursor on an
empty line, observed since bash 5.3 (#954 <https://github.com/mauvilsa/jsonargparse/pull/954>__).
Missing deprecation warning for the --print_config to --print_%s
change (#955 <https://github.com/mauvilsa/jsonargparse/pull/955>__).
shtab completions of **kwargs: Unpack[SomeTypedDict] parameters
showing NotRequired[...] as the expected type and not completing the
values of the keys that are not required (#956 <https://github.com/mauvilsa/jsonargparse/pull/956>__).
Postponed annotations of a method not resolving names that are defined in the
body of its class. Now the namespace of the class that defines the method is
used as locals (#956 <https://github.com/mauvilsa/jsonargparse/pull/956>__).
The class_path of an abstract class being accepted for a class typed
argument, only to fail on instantiate with TypeError: Can't instantiate abstract class. Now the parsing fails with Expected an instantiatable class, but ... is abstract, also when the class_path is implicit, i.e.
only init args given, and when the class is given by name (#956 <https://github.com/mauvilsa/jsonargparse/pull/956>__).
Values silently discarded on instantiation for pydantic fields that have an
alias and don't accept the attribute name, i.e. models and dataclasses without
populate_by_name. Now the alias is the accepted name, see
:ref:parameter-aliases (#956 <https://github.com/mauvilsa/jsonargparse/pull/956>__).
attrs fields whose __init__ parameter name differs from the attribute
name, i.e. an explicit alias or a private attribute, failing to
instantiate with TypeError: got an unexpected keyword argument or not
being configurable at all (#956 <https://github.com/mauvilsa/jsonargparse/pull/956>__).
Internal RuntimeError when giving a value for a TypedDict key
annotated with a TypeVar, e.g. a generic TypedDict, see
:ref:generic-types (#958 <https://github.com/mauvilsa/jsonargparse/pull/958>__).
type[Any] rejecting every value, instead of accepting any class as
type without an argument does (#958 <https://github.com/mauvilsa/jsonargparse/pull/958>__).
The docstring of a subscripted generic class not being used, so the group
description and the parameter descriptions were missing in the help (#958 <https://github.com/mauvilsa/jsonargparse/pull/958>__).

Changed
^^^^^^^

Signature parameters with a type that jsonargparse can't validate are now
accepted, instead of the parameter being skipped and the key failing to parse.
Only the parts of the type that can't be validated accept any value, e.g. a
list[SomeType] still requires a list. These parts are shown in the help as
Unvalidated<...> and a debug log states the reason. See the new
documentation section :ref:unvalidated-types (#936 <https://github.com/mauvilsa/jsonargparse/pull/936>, #944 <https://github.com/mauvilsa/jsonargparse/pull/944>, #948 <https://github.com/mauvilsa/jsonargparse/pull/948>, #958 <https://github.com/mauvilsa/jsonargparse/pull/958>).
Required and NotRequired given as the type of an argument are no
longer shown in the help. Now they must agree with whether the argument is
required, otherwise adding the argument fails (#937 <https://github.com/mauvilsa/jsonargparse/pull/937>__).
Whether a class implements a Protocol is now decided by checking that its
methods can be called in all the ways that the protocol methods can be called,
similar to what static type checkers do, instead of requiring the parameter
lists to be identical. This accepts more implementations than before.
Parameter and return types must still match exactly, except when the protocol
has no annotation or Any (#941 <https://github.com/mauvilsa/jsonargparse/pull/941>__).
A signature parameter typed as jsonargparse.Namespace now raises a
ValueError when adding the arguments, instead of the parameter being
silently skipped. Namespace is only intended for parsing results (#948 <https://github.com/mauvilsa/jsonargparse/pull/948>__).
The subtypes of a Union are now sorted when the argument is added, instead
of only while parsing, so the type shown in the help tells the order in which
the subtypes are attempted. The subtypes that accept any value, i.e. Any,
object and the ones that can't be validated, are now moved to the end, so
that they no longer prevent the remaining subtypes from being attempted. See
the new documentation section :ref:union-types (#949 <https://github.com/mauvilsa/jsonargparse/pull/949>__).
A dataclass-like type added as a group now accepts a subclass spec that has
the class_path of the type itself, e.g. {"class_path": "Data", "init_args": {...}}, instead of failing with Group 'data' does not accept option 'init_args....'. Dataclass-like types now accept the same values
whether or not they are added as a group, see :ref:subclasses-disabled
(#952 <https://github.com/mauvilsa/jsonargparse/pull/952>__).
Dataclass-like types that are abstract, i.e. that have abstract methods or
inherit from abc.ABC, now have subclass support enabled by default.
Previously such a type was unusable, since the class_path of an
implementation was rejected and giving its fields directly failed on
instantiate. See :ref:subclasses-disabled (#956 <https://github.com/mauvilsa/jsonargparse/pull/956>__).
object as a type is now handled exactly like Any, since in standard
typing every value is an instance of it (#958 <https://github.com/mauvilsa/jsonargparse/pull/958>__).

Deprecated
^^^^^^^^^^

Instantiating a subclass spec given as value for a type that accepts any
value, i.e. Any, object or Unvalidated<...>, is deprecated. From
v5.0.0 the subclass spec will be kept as is, so that the code that receives it
decides whether to instantiate it. The new
instantiate_subclass_spec_in_any setting in set_parsing_settings
allows getting the future behavior now, False, or keeping the current one,
True. Enabling it is discouraged since it means that a config is able to
instantiate any class, which can be a security risk (#955 <https://github.com/mauvilsa/jsonargparse/pull/955>__).

`v4.50.0`

Compare Source

Added
^^^^^

FromConfigMixin.from_config with config_read_mode_fsspec_enabled=True
now supports fsspec config loading including the resolving of relative paths
(#918 <https://github.com/mauvilsa/jsonargparse/pull/918>__).
Add .Unset sentinel and unset_sentinel setting in
set_parsing_settings to distinguish between arguments not provided and
those explicitly set to null (#909 <https://github.com/mauvilsa/jsonargparse/pull/909>__).

Fixed
^^^^^

While parsing, internally preserve class_path for subclass disabled types
to correctly support defaults from union of dataclasses (#921 <https://github.com/mauvilsa/jsonargparse/pull/921>__).
Misleading error message for parse_optionals_as_positionals=True and
unrecognized non-positional arguments (#922 <https://github.com/mauvilsa/jsonargparse/pull/922>__).
Fix subclass instance defaults not being converted to dict format when the
parameter is keyword-only (declared after *) (#933 <https://github.com/mauvilsa/jsonargparse/pull/933>__).
Signature **kwargs: Unpack[TypedDict] where the TypedDict has
total=False incorrectly made the non-Required keys required (#934 <https://github.com/mauvilsa/jsonargparse/pull/934>__).
TypedDict requiredness of keys not correctly resolved when using
postponed annotations (from __future__ import annotations) together with
Required/NotRequired or totality-flipping inheritance, affecting both
Unpack and type= cases (#934 <https://github.com/mauvilsa/jsonargparse/pull/934>__).
TypedDict keys annotated with types only imported in TYPE_CHECKING
blocks not being resolved (#934 <https://github.com/mauvilsa/jsonargparse/pull/934>__).

Changed
^^^^^^^

Drop support for Python 3.9. The minimum supported Python version is now
3.10 (#916 <https://github.com/mauvilsa/jsonargparse/pull/916>__).
Renamed some parameters in the public API to improve consistency and clarity
(#926 <https://github.com/mauvilsa/jsonargparse/pull/926>__).

Deprecated
^^^^^^^^^^

skip_none parameter of ArgumentParser's dump, save, and
validate was deprecated and will be removed in v5.0.0. Use skip_unset
instead (#909 <https://github.com/mauvilsa/jsonargparse/pull/909>__).
skip_null flag for --print_config was deprecated and will be removed
in v5.0.0. Use skip_unset instead (#909 <https://github.com/mauvilsa/jsonargparse/pull/909>__).
Implicit selection of subcommand when multiple subcommand settings available
is deprecated and will be removed in v5.0.0. Provide an explicit subcommand
instead (#923 <https://github.com/mauvilsa/jsonargparse/pull/923>__).
ArgumentParser.merge_config is deprecated and will be removed in v5.0.0.
There is no replacement since it is considered internal (#925 <https://github.com/mauvilsa/jsonargparse/pull/925>__).
Optional type parameters without a default and required parameters
without a type annotation when using fail_untyped=False are currently set
to optional with default None. In v5.0.0 they will be required. Warnings
visible with JSONARGPARSE_DEPRECATION_WARNINGS=all (#930 <https://github.com/mauvilsa/jsonargparse/pull/930>__).

`v4.49.0`

Compare Source

Added
^^^^^

Support Deque and FrozenSet in type hints (#905 <https://github.com/mauvilsa/jsonargparse/pull/905>__).

Fixed
^^^^^

Detect loops in config files that recursively load subconfig files and raise
an error showing the config chain instead of recursing indefinitely (#910 <https://github.com/mauvilsa/jsonargparse/pull/910>__).

Changed
^^^^^^^

Docs now reference methods via the public ArgumentParser class instead of
internal mixin classes (#901 <https://github.com/mauvilsa/jsonargparse/pull/901>__).
Cache class parsers to improve performance and reduce test suite runtime
(#903 <https://github.com/mauvilsa/jsonargparse/pull/903>__).

Deprecated
^^^^^^^^^^

Implicit component discovery in auto_cli (calling without a components
argument) was deprecated and will be removed in v5.0.0. Pass components
explicitly; explicit is better than implicit (#895 <https://github.com/mauvilsa/jsonargparse/pull/895>__).
instantiate_classes is deprecated and will be removed in v5.0.0. Instead
use instantiate (#896 <https://github.com/mauvilsa/jsonargparse/pull/896>__).
ArgumentParser.add_instantiator is deprecated and will be removed in
v5.0.0. Use the global function jsonargparse.add_instantiator instead
(#899 <https://github.com/mauvilsa/jsonargparse/pull/899>__).
Namespace.get_sorted_keys and Namespace.get_value_and_parent are
deprecated and will be removed in v5.0.0. Instead run .keys() and then
sort or get the parent and leaf separately. (#900 <https://github.com/mauvilsa/jsonargparse/pull/900>__).
Path.get_content is deprecated and will be removed in v5.0.0. Instead use
Path.read_text for text and Path.open for binary content (#906 <https://github.com/mauvilsa/jsonargparse/pull/906>__).
enable_path parameter of ArgumentParser.add_argument was deprecated
and will be removed in v5.0.0. Use sub_configs instead, which is
consistent with the sub_configs parameter of the signature methods,
ArgumentParser.add_class_arguments etc. (#907 <https://github.com/mauvilsa/jsonargparse/pull/907>__).
enable_path parameter of ActionJsonSchema was deprecated and will be
removed in v5.0.0. Use sub_config instead (#907 <https://github.com/mauvilsa/jsonargparse/pull/907>__).

`v4.48.0`

Compare Source

Added
^^^^^

AST resolver now supports nested attribute calls like
module.submodule.function(**kwargs) (#878 <https://github.com/mauvilsa/jsonargparse/pull/878>__).
register_type now supports TypeAliasType (python 3.12+) in addition
to classes, and registered aliases no longer add subclass help actions
(#875 <https://github.com/mauvilsa/jsonargparse/pull/875>__).
add_class_arguments skip support for callable return class parameters
(#882 <https://github.com/mauvilsa/jsonargparse/pull/882>__).
FromConfigMixin is now an official public API feature
(#884 <https://github.com/mauvilsa/jsonargparse/pull/884>__).

Fixed
^^^^^

Fix resolving forward references in generic aliases (e.g.
list["ForwardReferenced"]) when the forward-referenced type is not
imported in the using module (#871 <https://github.com/mauvilsa/jsonargparse/pull/871>__).
auto_cli no longer fails when a single function, a class __init__, or
a function/class in a list/dict of components has a parameter named
config (#873 <https://github.com/mauvilsa/jsonargparse/pull/873>__).

Changed
^^^^^^^

Now all missing required options are listed in the error message (#876 <https://github.com/mauvilsa/jsonargparse/pull/876>__).
class_from_function and lazy_instance are now located in
jsonargparse.typing while the previous import locations are kept for
compatibility (#877 <https://github.com/mauvilsa/jsonargparse/pull/877>__).
Most argparse tests from the Python standard library are run against
jsonargparse. Also the explicit deviations from argparse are documented (#881 <https://github.com/mauvilsa/jsonargparse/pull/881>__).
Replace black and yesqa with ruff in pre-commit (#883 <https://github.com/mauvilsa/jsonargparse/pull/883>__).
Removed reconplogger integration (#886 <https://github.com/mauvilsa/jsonargparse/pull/886>__).
Avoid expensive inspect.stack in parse_args path and other optimizations to
speed up test suite (#887 <https://github.com/mauvilsa/jsonargparse/pull/887>__).
Rely on required attributes to improve compatibility with third-party
argparse extensions (#890 <https://github.com/mauvilsa/jsonargparse/pull/890>, #893 <https://github.com/mauvilsa/jsonargparse/pull/893>).

`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 (#851 <https://github.com/mauvilsa/jsonargparse/pull/851>__).
auto_cli now supports a return_instance parameter to instantiate class
components directly instead of exposing methods as subcommands (#855 <https://github.com/mauvilsa/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
(#859 <https://github.com/mauvilsa/jsonargparse/pull/859>__).

Fixed
^^^^^

Positional arguments with nargs="*" or nargs="?" now correctly allow
default values, matching standard argparse behavior (#846 <https://github.com/mauvilsa/jsonargparse/pull/846>__).
Parsing of floats with implicit leading zero (e.g. -.5) not working (#847 <https://github.com/mauvilsa/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
(#853 <https://github.com/mauvilsa/jsonargparse/pull/853>__).
--help no longer fails with IndexError for options without explicit
help text while keeping argparse compatibility for help=None (#854 <https://github.com/mauvilsa/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 (#858 <https://github.com/mauvilsa/jsonargparse/pull/858>__).
Environment variable overrides now correctly take precedence over
default_config_files values for subcommands and nested subsubcommands
(#862 <https://github.com/mauvilsa/jsonargparse/pull/862>__).
omegaconf+ incorrectly applied for default_config_files (#865 <https://github.com/mauvilsa/jsonargparse/pull/865>__).
ActionSubCommands.add_subcommand() missing from API reference
(#863 <https://github.com/mauvilsa/jsonargparse/pull/863>__).

Changed
^^^^^^^

Tests are no longer installed by default, there is a separate
jsonargparse_tests wheel file for that (#843 <https://github.com/mauvilsa/jsonargparse/pull/843>__).
Adding argument giving both type and action is now allowed
(#845 <https://github.com/mauvilsa/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 (#859 <https://github.com/mauvilsa/jsonargparse/pull/859>__).
JSONARGPARSE_DEBUG can only be enabled with true (case-insensitive)
(867 <https://github.com/mauvilsa/jsonargparse/pull/867>__).

`v4.46.0`

Compare Source

Added
^^^^^

Public interface for enabling/disabling support of type subclasses (#817 <https://github.com/mauvilsa/jsonargparse/pull/817>__).

Fixed
^^^^^

Choices with an int type not working correctly (#827 <https://github.com/mauvilsa/jsonargparse/pull/827>__).
Union of dataclasses not discarding parameters on class change (#833 <https://github.com/mauvilsa/jsonargparse/pull/833>__).
Targets of links applied on parse not being instantiated (#834 <https://github.com/mauvilsa/jsonargparse/pull/834>__).
Validation of defaults getting stuck for path with - (stdin) default
(#837 <https://github.com/mauvilsa/jsonargparse/pull/837>__).
Failure when parsing deeply nested dataclass with a union parent (#839 <https://github.com/mauvilsa/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 (#816 <https://github.com/mauvilsa/jsonargparse/pull/816>__).
FromConfigMixin.from_config now supports subclasses (#822 <https://github.com/mauvilsa/jsonargparse/pull/822>__).

Fixed
^^^^^

Dict override syntax to allow standard form: --cfg.dict.key val (#824 <https://github.com/mauvilsa/jsonargparse/pull/824>__).
Evaluation of postponed annotations for dataclass inheritance across modules
not working correctly (#814 <https://github.com/mauvilsa/jsonargparse/pull/814>__).
Getting parameter descriptions from docstrings not working for dataclass
inheritance (#815 <https://github.com/mauvilsa/jsonargparse/pull/815>__).
default_env=True conflicting with default_config_files (#818 <https://github.com/mauvilsa/jsonargparse/pull/818>__).
default_config_files with settings for multiple subcommands not working
correctly (#819 <https://github.com/mauvilsa/jsonargparse/pull/819>__).
register_type not checking that the given type is a class (#820 <https://github.com/mauvilsa/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 | - (#816 <https://github.com/mauvilsa/jsonargparse/pull/816>__).
Providing a choice of subcommand in default_config_files is now an error
(#819 <https://github.com/mauvilsa/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 (#812 <https://github.com/mauvilsa/jsonargparse/pull/812>__).
FromConfigMixin not handling correctly required parameters (#813 <https://github.com/mauvilsa/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 (#809 <https://github.com/mauvilsa/jsonargparse/pull/809>__).
The yaml_comments parameter of ArgumentParser.dump has been renamed to
with_comments to allow future comments support of other formats (#811 <https://github.com/mauvilsa/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=...) (#810 <https://github.com/mauvilsa/jsonargparse/pull/810>__).
The yaml_comments parameter of ArgumentParser.dump is deprecated and
will be removed in v5.0.0. Use with_comments instead (#811 <https://github.com/mauvilsa/jsonargparse/pull/811>__).

`v4.43.0`

Compare Source

Added
^^^^^

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

Fixed
^^^^^

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

Changed
^^^^^^^

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

Deprecated
^^^^^^^^^^

Path.__call__ is deprecated and will be removed in v5.0.0. Use the
absolute or relative properties instead (#794 <https://github.com/mauvilsa/jsonargparse/pull/794>__).
strip_meta is deprecated and will be removed in v5.0.0. Instead use
.clone(with_meta=False) (#795 <https://github.com/mauvilsa/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 (#796 <https://github.com/mauvilsa/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 (#797 <https://github.com/mauvilsa/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 (#770 <https://github.com/mauvilsa/jsonargparse/pull/770>__).
Experimental support for dataclass inheritance (#775 <https://github.com/mauvilsa/jsonargparse/pull/775>__).
Experimental support for pydantic BaseModel subclasses (#781 <https://github.com/mauvilsa/jsonargparse/pull/781>__).
Argument to print help for dataclasses nested in types, e.g.
Optional[Data], Union[Data1, Data2] (#783 <https://github.com/mauvilsa/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 (#774 <https://github.com/mauvilsa/jsonargparse/pull/774>__).

Fixed
^^^^^

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

`v4.41.0`

Compare Source

Added
^^^^^

Support for Python 3.14 (#753 <https://github.com/mauvilsa/jsonargparse/pull/753>__).
Support callable protocols for instance factory dependency injection (#758 <https://github.com/mauvilsa/jsonargparse/pull/758>__).
New ActionFail for arguments that should fail parsing with a given error
message (#759 <https://github.com/mauvilsa/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 (#765 <https://github.com/mauvilsa/jsonargparse/pull/765>__).

Fixed
^^^^^

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

Changed
^^^^^^^

Removed support for python 3.8 (#752 <https://github.com/mauvilsa/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 (#754 <https://github.com/mauvilsa/jsonargparse/pull/754>__).
Replaced unmaintained optional dependency ruyaml with ruamel.yaml
(#768 <https://github.com/mauvilsa/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 (#754 <https://github.com/mauvilsa/jsonargparse/pull/754>__).
The ruyaml optional dependency is deprecated and will be removed in
v5.0.0. Instead use the ruamel optional dependency (#768 <https://github.com/mauvilsa/jsonargparse/pull/768>__).

`v4.40.2`

Compare Source

Fixed
^^^^^

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

`v4.40.1`

Compare Source

Fixed
^^^^^

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

`v4.40.0`

Compare Source

Added
^^^^^

New auto_parser function for convenience and more visibility of the
capture_parser feature (#721 <https://github.com/mauvilsa/jsonargparse/pull/721>__).

Fixed
^^^^^

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

Changed
^^^^^^^

Use latest jsonnet release that works on all platforms and python versions
(#682 <https://github.com/mauvilsa/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 (#719 <https://github.com/mauvilsa/jsonargparse/pull/719>__).
namespace_to_dict is deprecated and will be removed in v5.0.0. Instead use
.clone().as_dict() or .as_dict() (#720 <https://github.com/mauvilsa/jsonargparse/pull/720>__).

`v4.39.0`

Compare Source

Added
^^^^^

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

Changed
^^^^^^^

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

Fixed
^^^^^

ActionParser not updating dest of groups for instantiation (#707 <https://github.com/mauvilsa/jsonargparse/pull/707>__).
Nested generic dataclasses not working correctly (#709 <https://github.com/mauvilsa/jsonargparse/pull/709>__).
List append nested in subclass not working (#710 <https://github.com/mauvilsa/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 (#712 <https://github.com/mauvilsa/jsonargparse/pull/712>__).

`v4.38.0`

Compare Source

Added
^^^^^

Support shtab completion of Literal types (#693 <https://github.com/mauvilsa/jsonargparse/pull/693>__).
Support for parsing optionals as positionals (#692 <https://github.com/mauvilsa/jsonargparse/pull/692>__).

Changed
^^^^^^^

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

Fixed
^^^^^

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

`v4.37.0`

Compare Source

Added
^^^^^

Experimental support for sub-classing ArgumentParser to customize
add_argument (#661 <https://github.com/mauvilsa/jsonargparse/pull/661>__).

Fixed
^^^^^

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

Configuration

📅 Schedule: (UTC)

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.

renovate Bot force-pushed the renovate/jsonargparse-4.x branch from a058b87 to 5be4bf2 Compare March 26, 2025 12:32

renovate Bot changed the title ~~Update dependency jsonargparse to v4.37.0~~ Update dependency jsonargparse to v4.38.0 Mar 26, 2025

renovate Bot force-pushed the renovate/jsonargparse-4.x branch from 5be4bf2 to 77f6cea Compare April 29, 2025 06:49

renovate Bot changed the title ~~Update dependency jsonargparse to v4.38.0~~ Update dependency jsonargparse to v4.39.0 Apr 29, 2025

renovate Bot force-pushed the renovate/jsonargparse-4.x branch from 77f6cea to 6a8d425 Compare May 16, 2025 07:03

renovate Bot changed the title ~~Update dependency jsonargparse to v4.39.0~~ Update dependency jsonargparse to v4.40.0 May 16, 2025

renovate Bot force-pushed the renovate/jsonargparse-4.x branch 2 times, most recently from 85dba8c to 869c2bb Compare July 24, 2025 08:41

renovate Bot changed the title ~~Update dependency jsonargparse to v4.40.0~~ Update dependency jsonargparse to v4.40.1 Jul 24, 2025

renovate Bot force-pushed the renovate/jsonargparse-4.x branch from 869c2bb to f6d6484 Compare August 6, 2025 05:22

renovate Bot changed the title ~~Update dependency jsonargparse to v4.40.1~~ Update dependency jsonargparse to v4.40.2 Aug 6, 2025

renovate Bot force-pushed the renovate/jsonargparse-4.x branch from f6d6484 to ee6ad13 Compare September 7, 2025 23:06

renovate Bot changed the title ~~Update dependency jsonargparse to v4.40.2~~ Update dependency jsonargparse to v4.41.0 Sep 7, 2025

renovate Bot force-pushed the renovate/jsonargparse-4.x branch from ee6ad13 to 2e2388c Compare October 14, 2025 09:01

renovate Bot changed the title ~~Update dependency jsonargparse to v4.41.0~~ Update dependency jsonargparse to v4.42.0 Oct 14, 2025

renovate Bot force-pushed the renovate/jsonargparse-4.x branch from 2e2388c to 05c120c Compare November 12, 2025 03:37

renovate Bot changed the title ~~Update dependency jsonargparse to v4.42.0~~ Update dependency jsonargparse to v4.43.0 Nov 12, 2025

renovate Bot force-pushed the renovate/jsonargparse-4.x branch from 05c120c to 3932f5b Compare November 25, 2025 18:52

renovate Bot changed the title ~~Update dependency jsonargparse to v4.43.0~~ Update dependency jsonargparse to v4.44.0 Nov 25, 2025

renovate Bot force-pushed the renovate/jsonargparse-4.x branch from 3932f5b to 0a03bec Compare December 26, 2025 17:34

renovate Bot changed the title ~~Update dependency jsonargparse to v4.44.0~~ Update dependency jsonargparse to v4.45.0 Dec 26, 2025

renovate Bot force-pushed the renovate/jsonargparse-4.x branch from 0a03bec to 9671f08 Compare February 2, 2026 13:57

renovate Bot changed the title ~~Update dependency jsonargparse to v4.45.0~~ Update dependency jsonargparse to v4.46.0 Feb 2, 2026

renovate Bot force-pushed the renovate/jsonargparse-4.x branch from 9671f08 to 70c2f58 Compare March 13, 2026 15:51

renovate Bot changed the title ~~Update dependency jsonargparse to v4.46.0~~ Update dependency jsonargparse to v4.47.0 Mar 13, 2026

renovate Bot force-pushed the renovate/jsonargparse-4.x branch from 70c2f58 to acceced Compare April 10, 2026 10:10

renovate Bot changed the title ~~Update dependency jsonargparse to v4.47.0~~ Update dependency jsonargparse to v4.48.0 Apr 10, 2026

renovate Bot force-pushed the renovate/jsonargparse-4.x branch from acceced to e058cd8 Compare May 15, 2026 09:11

renovate Bot changed the title ~~Update dependency jsonargparse to v4.48.0~~ Update dependency jsonargparse to v4.49.0 May 15, 2026

renovate Bot force-pushed the renovate/jsonargparse-4.x branch from e058cd8 to 94f2380 Compare July 22, 2026 06:36

renovate Bot changed the title ~~Update dependency jsonargparse to v4.49.0~~ Update dependency jsonargparse to v4.50.0 Jul 22, 2026

Update dependency jsonargparse to v4.51.0

b06d747

renovate Bot force-pushed the renovate/jsonargparse-4.x branch from 94f2380 to b06d747 Compare August 20, 2026 06:29

renovate Bot changed the title ~~Update dependency jsonargparse to v4.50.0~~ Update dependency jsonargparse to v4.51.0 Aug 20, 2026

Navigation Menu

Update dependency jsonargparse to v4.51.0 - #368

Update dependency jsonargparse to v4.51.0#368
renovate[bot] wants to merge 1 commit into
masterfrom
renovate/jsonargparse-4.x

renovate Bot commented Feb 14, 2025 •

edited

Loading

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

0 participants

Conversation

renovate Bot commented Feb 14, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Release Notes

Configuration

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

0 participants

renovate Bot commented Feb 14, 2025 •

edited

Loading