magicli 2.1.6__tar.gz → 2.1.7__tar.gz

{magicli-2.1.6 → magicli-2.1.7}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: magicli
-Version: 2.1.6
+Version: 2.1.7
 Summary: Automatically generates a CLI from functions.
 Author-email: Patrick Elmer <patrick@elmer.ws>
 License-Expression: GPL-3.0-or-later

{magicli-2.1.6 → magicli-2.1.7}/magicli.egg-info/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: magicli
-Version: 2.1.6
+Version: 2.1.7
 Summary: Automatically generates a CLI from functions.
 Author-email: Patrick Elmer <patrick@elmer.ws>
 License-Expression: GPL-3.0-or-later

magicli-2.1.7/magicli.egg-info/scm_version.json

@@ -0,0 +1,8 @@
+{
+  "tag": "2.1.7",
+  "distance": 0,
+  "node": "g77bdefe7cdd5b64c471406870859b42350d0f8cc",
+  "dirty": false,
+  "branch": "HEAD",
+  "node_date": "2026-06-24"
+}

{magicli-2.1.6 → magicli-2.1.7}/magicli.py

@@ -70,7 +70,7 @@ def call(function, argv, module=None, name=None):
     docstring = inspect.getdoc(function) or ""
     parameters = inspect.signature(function).parameters
 
-    check_for_version(argv, parameters, docstring, module)
+    check_for_help_and_version(argv, parameters, docstring, module, function)
 
     try:
         args, kwargs = parse_argv(argv, parameters, docstring)
@@ -200,16 +200,19 @@ def get_type(parameter):
     return str
 
 
-def check_for_version(argv, parameters, docstring, module):
+def check_for_help_and_version(argv, parameters, docstring, module, function):
     """Displays version information if --version is specified in the docstring."""
-    if "version" in parameters or not module or len(argv) != 1:
+    if not module or len(argv) != 1:
         return
+    if argv[0] in ("--help", "-h") and "help" not in parameters:
+        logger.info(help_message(help_from_function, function, None, module))
+        raise SystemExit
     args = {
         "--version": "--version",
         "-v": "-v, --version",
         "-V": "-V, --version",
     }
-    if (doc := args.get(argv[0])) and doc in docstring:
+    if (doc := args.get(argv[0])) and doc in docstring and "version" not in parameters:
         logger.info(get_version(module))
         raise SystemExit
 

{magicli-2.1.6 → magicli-2.1.7}/tests/test_magicli.py

@@ -141,3 +141,18 @@ commands:
   command
   command_2\
 """
+
+@mock.patch("importlib.import_module", side_effect=module)
+def test_help_kwarg_displays_help_message(mocked, caplog):
+    sys.argv = ["name", "--help"]
+    name.__doc__ = None
+    with pytest.raises(SystemExit):
+        magicli()
+    doc = """usage:
+  name
+  name <command>
+
+commands:
+  command"""
+    assert caplog.messages[0] != name.__doc__
+    assert caplog.messages[0] == doc

magicli-2.1.6/magicli.egg-info/scm_version.json

@@ -1,8 +0,0 @@
-{
-  "tag": "2.1.6",
-  "distance": 0,
-  "node": "g7e30827f02d07921c90e83b73547295a32bd9915",
-  "dirty": false,
-  "branch": "HEAD",
-  "node_date": "2026-06-23"
-}