Merge branch 'main' into dev/scriptconfig_integration

Author: mauvilsa

.bumpversion.cfg

@@ -1,5 +1,5 @@
 [bumpversion]
-current_version = 4.30.0
+current_version = 4.31.0
 commit = True
 tag = True
 tag_name = v{new_version}

.github/workflows/codeql.yml

@@ -6,7 +6,7 @@ on:
   pull_request:
     branches: [ "main" ]
   schedule:
-    - cron: "57 5 * * 3"
+    - cron: "57 5 * * 3"  # M H d m w (Every Wednesday at 5:57 AM)
 
 jobs:
   analyze:

.github/workflows/tests.yml

@@ -28,7 +28,7 @@ jobs:
     strategy:
       fail-fast: false
       matrix:
-        python: [3.8, "3.10"]
+        python: [3.8, "3.10", 3.12]
     steps:
       - uses: actions/checkout@v4
       - uses: actions/setup-python@v5
@@ -39,7 +39,7 @@ jobs:
       - run: tox -e py-all-extras
 
   unittest-omegaconf:
-    runs-on: ubuntu-20.04
+    runs-on: ubuntu-latest
     steps:
       - uses: actions/checkout@v4
       - uses: actions/setup-python@v5
@@ -50,7 +50,7 @@ jobs:
       - run: tox -e omegaconf
 
   doctest:
-    runs-on: ubuntu-20.04
+    runs-on: ubuntu-latest
     steps:
       - uses: actions/checkout@v4
       - uses: actions/setup-python@v5

.sonarcloud.properties

@@ -1,3 +1,3 @@
 sonar.sources=jsonargparse
-sonar.projectVersion=4.30.0
+sonar.projectVersion=4.31.0
 sonar.python.version=3.7, 3.8, 3.9, 3.10, 3.11, 3.12

CHANGELOG.rst

@@ -12,6 +12,40 @@ The semantic versioning only considers the public API as described in
 paths are considered internals and can change in minor and patch releases.
 
 
+v4.32.0 (2024-07-??)
+--------------------
+
+Added
+^^^^^
+- Support for ``MappingProxyType`` as a type and as default for mapping types
+  (`#540 <https://github.com/omni-us/jsonargparse/pull/540>`__).
+
+
+v4.31.0 (2024-06-27)
+--------------------
+
+Added
+^^^^^
+- Support async functions and methods in ``CLI`` (`#531
+  <https://github.com/omni-us/jsonargparse/pull/531>`__).
+- Support for ``Protocol`` types only accepting exact matching signature of
+  public methods (`#526
+  <https://github.com/omni-us/jsonargparse/pull/526>`__).
+
+Fixed
+^^^^^
+- Resolving of import paths for some ``torch`` functions not working (`#535
+  <https://github.com/omni-us/jsonargparse/pull/535>`__).
+- ``--print_shtab`` crashing on failure to get signature parameters from one
+  class (`lightning#10858 comment
+  <https://github.com/Lightning-AI/pytorch-lightning/discussions/10858#discussioncomment-9846252>`__).
+
+Changed
+^^^^^^^
+- Now ``--*.help`` output shows options without ``init_args`` (`#533
+  <https://github.com/omni-us/jsonargparse/pull/533>`__).
+
+
 v4.30.0 (2024-06-18)
 --------------------
 

DOCUMENTATION.rst

@@ -400,8 +400,9 @@ Some notes about this support are:
   :ref:`restricted-strings` and paths and URLs as explained in sections
   :ref:`parsing-paths` and :ref:`parsing-urls`.
 
-- ``Dict``, ``Mapping``, ``MutableMapping``, and ``TypedDict`` are supported but
-  only with ``str`` or ``int`` keys. For more details see :ref:`dict-items`.
+- ``Dict``, ``Mapping``, ``MutableMapping``, ``MappingProxyType``, and
+  ``TypedDict`` are supported but only with ``str`` or ``int`` keys. For more
+  details see :ref:`dict-items`.
 
 - ``Tuple``, ``Set`` and ``MutableSet`` are supported even though they can't be
   represented in json distinguishable from a list. Each ``Tuple`` element
@@ -421,6 +422,10 @@ Some notes about this support are:
   :py:meth:`.ArgumentParser.instantiate_classes` can be used to instantiate all
   classes in a config object. For more details see :ref:`sub-classes`.
 
+- ``Protocol`` types are also supported the same as sub-classes. The protocols
+  are not required to be ``runtime_checkable``. But the accepted classes must
+  match exactly the signature of the protocol's public methods.
+
 - ``dataclasses`` are supported even when nested. Final classes, attrs'
   ``define`` decorator, and pydantic's ``dataclass`` decorator and ``BaseModel``
   classes are supported and behave like standard dataclasses. For more details

jsonargparse/__init__.py

@@ -70,4 +70,4 @@
 __all__ += _deprecated.__all__
 
 
-__version__ = "4.30.0"
+__version__ = "4.31.0"

jsonargparse/_actions.py

@@ -20,6 +20,7 @@
     argument_error,
     change_to_path_dir,
     default_config_option_help,
+    get_import_path,
     get_typehint_origin,
     import_object,
     indent_text,
@@ -387,8 +388,7 @@ def print_help(self, call_args, baseclass, dest):
             baseclasses = [baseclass]
         if not any(is_subclass(val_class, b) for b in baseclasses):
             raise TypeError(f'{option_string}: Class "{value}" is not a subclass of {self._basename}')
-        dest += ".init_args"
-        subparser = type(parser)()
+        subparser = type(parser)(description=f"Help for {option_string}={get_import_path(val_class)}")
         subparser.add_class_arguments(val_class, dest, **self.sub_add_kwargs)
         remove_actions(subparser, (_HelpAction, _ActionPrintConfig, _ActionConfigLoad))
         args = self.get_args_after_opt(parser.args)

jsonargparse/_cli.py

@@ -92,8 +92,8 @@ def CLI(
             deprecation_warning_cli_return_parser()
             return parser
         cfg = parser.parse_args(args)
-        cfg_init = parser.instantiate_classes(cfg)
-        return _run_component(components, cfg_init)
+        init = parser.instantiate_classes(cfg)
+        return _run_component(components, init)
 
     elif isinstance(components, list):
         components = {c.__name__: c for c in components}
@@ -192,12 +192,13 @@ def _add_component_to_parser(
 
 def _run_component(component, cfg):
     cfg.pop("config", None)
-    if not inspect.isclass(component):
-        return component(**cfg)
     subcommand = cfg.pop("subcommand")
-    if not subcommand:
-        return component(**cfg)
-    subcommand_cfg = cfg.pop(subcommand, {})
-    subcommand_cfg.pop("config", None)
-    component_obj = component(**cfg)
-    return getattr(component_obj, subcommand)(**subcommand_cfg)
+    if inspect.isclass(component) and subcommand:
+        subcommand_cfg = cfg.pop(subcommand, {})
+        subcommand_cfg.pop("config", None)
+        component_obj = component(**cfg)
+        component = getattr(component_obj, subcommand)
+        cfg = subcommand_cfg
+    if inspect.iscoroutinefunction(component):
+        return __import__("asyncio").run(component(**cfg))
+    return component(**cfg)

jsonargparse/_completions.py

@@ -25,10 +25,6 @@
 )
 from ._util import NoneType, Path, import_object, unique
 
-shtab_shell: ContextVar = ContextVar("shtab_shell")
-shtab_prog: ContextVar = ContextVar("shtab_prog")
-shtab_preambles: ContextVar = ContextVar("shtab_preambles")
-
 
 def handle_completions(parser):
     if find_spec("argcomplete") and "_ARGCOMPLETE" in os.environ:
@@ -76,6 +72,10 @@ def argcomplete_warn_redraw_prompt(prefix, message):
 
 # shtab
 
+shtab_shell: ContextVar = ContextVar("shtab_shell")
+shtab_prog: ContextVar = ContextVar("shtab_prog")
+shtab_preambles: ContextVar = ContextVar("shtab_preambles")
+
 
 class ShtabAction(argparse.Action):
     def __init__(
@@ -236,7 +236,7 @@ def get_typehint_choices(typehint, prefix, parser, skip, choices=None, added_sub
         origin = get_typehint_origin(typehint)
         if origin == Union:
             for subtype in typehint.__args__:
-                if subtype in added_subclasses:
+                if subtype in added_subclasses or subtype is object:
                     continue
                 get_typehint_choices(subtype, prefix, parser, skip, choices, added_subclasses)
         elif ActionTypeHint.is_subclass_typehint(typehint):
@@ -261,8 +261,12 @@ def add_subactions_and_get_subclass_choices(typehint, prefix, parser, skip, adde
     subclasses = defaultdict(list)
     for path in paths:
         choices.append(path)
-        cls = import_object(path)
-        params = get_signature_parameters(cls)
+        try:
+            cls = import_object(path)
+            params = get_signature_parameters(cls, None, parser._logger)
+        except Exception as ex:
+            parser._logger.debug(f"Unable to get signature parameters for '{path}': {ex}")
+            continue
         num_skip = next((s for s in skip if isinstance(s, int)), 0)
         if num_skip > 0:
             params = params[num_skip:]