Merge pull request #5 from python-project-templates/tkp/getarg

Add utility for getting extra args

Author: timkpaine

hatch_build/__init__.py

@@ -1 +1,3 @@
 __version__ = "0.1.0"
+
+from .cli import parse_extra_args

hatch_build/cli.py

@@ -1,10 +1,21 @@
-import argparse
+from argparse import ArgumentParser
+from typing import Callable, List, Optional, Tuple
 
 from hatchling.cli.build import build_command
 
+__all__ = (
+    "hatchling",
+    "parse_extra_args",
+)
+_extras = None
 
-def hatchling() -> int:
-    parser = argparse.ArgumentParser(prog="hatch-build", allow_abbrev=False)
+
+def parse_extra_args(subparser: Optional[ArgumentParser]) -> List[str]:
+    return subparser.parse_args(_extras) if _extras else {}, []
+
+
+def _hatchling_internal() -> Tuple[Optional[Callable], Optional[dict], List[str]]:
+    parser = ArgumentParser(prog="hatch-build", allow_abbrev=False)
     subparsers = parser.add_subparsers()
 
     defaults = {"metavar": ""}
@@ -21,7 +32,7 @@ def hatchling() -> int:
     # but they must be after a '--' separator
     if extras and extras[0] != "--":
         parser.print_help()
-        return 1
+        return None, None, None
 
     # Wrap the parsed arguments in a dictionary
     kwargs = vars(kwargs)
@@ -30,7 +41,19 @@ def hatchling() -> int:
         command = kwargs.pop("func")
     except KeyError:
         parser.print_help()
-    else:
-        command(**kwargs)
+        return None, None, None
+    return command, kwargs, extras[1:]  # Remove the '--' separator
+
+
+def hatchling() -> int:
+    global _extras
+
+    command, kwargs, extras = _hatchling_internal()
+    if command is None:
+        return 1
+
+    # Set so plugins can reference
+    _extras = extras
 
+    command(**kwargs)
     return 0

hatch_build/tests/test_cli.py

@@ -1,9 +1,10 @@
 import sys
+from argparse import ArgumentParser
 from unittest.mock import patch
 
 import pytest
 
-from hatch_build.cli import hatchling
+from hatch_build.cli import hatchling, parse_extra_args
 
 
 @pytest.fixture
@@ -46,6 +47,18 @@ def ok_extra_argv():
     sys.argv = tmp_argv
 
 
+@pytest.fixture
+def get_arg():
+    tmp_argv = sys.argv
+    sys.argv = ["hatch-build", "--", "--extra-arg", "--extra-arg-with-value", "value", "--extra-arg-with-value-equals=value2"]
+    parser = ArgumentParser()
+    parser.add_argument("--extra-arg", action="store_true")
+    parser.add_argument("--extra-arg-with-value")
+    parser.add_argument("--extra-arg-with-value-equals")
+    yield parser
+    sys.argv = tmp_argv
+
+
 class TestHatchBuild:
     def test_hatchling(self, ok_argv):
         assert hatchling() == 0
@@ -86,3 +99,10 @@ def test_bad_extras(self, bad_extra_argv):
 
     def test_ok_extras(self, ok_extra_argv):
         assert hatchling() == 0
+
+    def test_get_arg(self, get_arg):
+        assert hatchling() == 0
+        args, _ = parse_extra_args(get_arg)
+        assert args.extra_arg is True
+        assert args.extra_arg_with_value == "value"
+        assert args.extra_arg_with_value_equals == "value2"