Merge pull request #15 from SunDoge/change-api

Change api

Author: SunDoge

CHANGELOG.md

@@ -7,6 +7,10 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 ## [Unreleased]
 
+## [0.6.3]
+
+- Update `class TypedArgs`.
+
 ## [0.6.2]
 
 - Add `ta.TypedArgs` for better intellisense.
@@ -73,6 +77,8 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 - Replace attributes by name
 
 [unreleased]: https://github.com/SunDoge/typed-args
+[0.6.3]: https://github.com/SunDoge/typed-args/tree/v0.6.3
+[0.6.2]: https://github.com/SunDoge/typed-args/tree/v0.6.2
 [0.6.1]: https://github.com/SunDoge/typed-args/tree/v0.6.1
 [0.6.0]: https://github.com/SunDoge/typed-args/tree/v0.6.0
 [0.5.2]: https://github.com/SunDoge/typed-args/tree/v0.5.2

pyproject.toml

@@ -1,6 +1,6 @@
 [tool.poetry]
 name = "typed-args"
-version = "0.6.2"
+version = "0.6.3"
 description = "Parse command line arguments by defining dataclasses"
 authors = ["SunDoge <[email protected]>"]
 readme = "README.md"

tests/test_add_argument.py

@@ -18,7 +18,7 @@ class Args(ta.TypedArgs):
 
     # with pytest.raises()
     with pytest.raises(SystemExit) as e:
-        args3 = Args.parse_args(['--foo', 'FOO'])
+        _args3 = Args.parse_args(['--foo', 'FOO'])
     assert e.value.code == 2
 
 

tests/test_append.py

@@ -11,7 +11,7 @@
 #     class Args(TypedArgs):
 #         foo: List[str] = add_argument('--foo', action='append')
 
-#     args = Args.from_args('--foo 1 --foo 2'.split())
+#     args = Args.parse_args('--foo 1 --foo 2'.split())
 
 #     # assert args.foo == ['1', '2']
 
@@ -28,7 +28,7 @@
 #     # parser.add_argument('--str', dest='types', action='append_const', const=str)
 #     # parser.add_argument('--int', dest='types', action='append_const', const=int)
 
-#     args = Args.from_args('--str --int'.split())
+#     args = Args.parse_args('--str --int'.split())
 #     # args = parser.parse_args('--str --int'.split())
 #     # args = parser.parse_args('--int --str'.split())
 

typed_args/__init__.py

@@ -13,7 +13,7 @@
 from ._utils import SubcommandEnum, DefaultHelpFormatter
 from argparse import SUPPRESS, OPTIONAL, ZERO_OR_MORE, ONE_OR_MORE, REMAINDER
 
-__version__ = "0.6.2"
+__version__ = "0.6.3"
 
 __all__ = [
     'dataclass',

typed_args/_core.py

@@ -18,8 +18,10 @@ def parse_args(
     args: Optional[Sequence[str]] = None,
     namespace:  Optional[argparse.Namespace] = None,
 ) -> T:
+    assert dataclasses.is_dataclass(
+        klass), "{} must be dataclass".format(klass)
     if not parser:
-        parser = argparse.ArgumentParser()
+        parser = _make_parser(klass)
     parse(parser, klass)
     ns = parser.parse_args(args=args, namespace=namespace)
     opts = klass()
@@ -33,8 +35,10 @@ def parse_known_args(
     args: Optional[Sequence[str]] = None,
     namespace:  Optional[argparse.Namespace] = None,
 ) -> Tuple[T, List[str]]:
+    assert dataclasses.is_dataclass(
+        klass), "{} must be dataclass".format(klass)
     if not parser:
-        parser = argparse.ArgumentParser()
+        parser = _make_parser(klass)
     parse(parser, klass)
     ns, unknown = parser.parse_known_args(args=args, namespace=namespace)
     opts = klass()
@@ -43,13 +47,22 @@ def parse_known_args(
 
 
 class TypedArgs:
+
     @classmethod
-    def parse_args(cls: Type[T], args: Optional[Sequence[str]] = None, namespace:  Optional[argparse.Namespace] = None) -> T:
-        pass
+    def parse_args(
+        cls: Type[T],
+        args: Optional[Sequence[str]] = None,
+        namespace:  Optional[argparse.Namespace] = None
+    ) -> T:
+        return parse_args(cls, args=args, namespace=namespace)
 
     @classmethod
-    def parse_known_args(cls: Type[T], args: Optional[Sequence[str]] = None, namespace:  Optional[argparse.Namespace] = None) -> Tuple[T, List[str]]:
-        pass
+    def parse_known_args(
+        cls: Type[T],
+        args: Optional[Sequence[str]] = None,
+        namespace:  Optional[argparse.Namespace] = None
+    ) -> Tuple[T, List[str]]:
+        return parse_known_args(cls, args=args, namespace=namespace)
 
 
 @overload
@@ -73,23 +86,22 @@ def argument_parser(
 def argument_parser(**kwargs):
 
     def f(klass):
-        def _make_parser():
+        def make_parser():
             return argparse.ArgumentParser(**kwargs)
 
-        def _parse_args(args=None, namespace=None):
-            parser = _make_parser()
-            return parse_args(klass, parser=parser, args=args, namespace=namespace)
-
-        def _parse_known_args(args=None, namespace=None):
-            parser = _make_parser()
-            return parse_known_args(klass, parser=parser, args=args, namespace=namespace)
-
         if not dataclasses.is_dataclass(klass):
             logger.debug("make %s a dataclass", klass)
             klass = dataclasses.dataclass(klass)
 
-        setattr(klass, 'parse_args', _parse_args)
-        setattr(klass, 'parse_known_args', _parse_known_args)
+        setattr(klass, '__make_parser', make_parser)
         return klass
 
     return f
+
+
+def _make_parser(klass):
+    if hasattr(klass, '__make_parser'):
+        parser = getattr(klass, '__make_parser')()
+    else:
+        parser = argparse.ArgumentParser()
+    return parser

typed_args/_parser.py

@@ -69,7 +69,10 @@ def add_argument(
 
 
 def add_argument(*args, **kwargs):
-    return dataclasses.field(default=None, metadata=dict(args=args, kwargs=kwargs, action='add_argument'))
+    return dataclasses.field(
+        default=None,
+        metadata=dict(args=args, kwargs=kwargs, action='add_argument')
+    )
 
 
 @overload
@@ -80,7 +83,10 @@ def add_argument_group(
 
 
 def add_argument_group(*args, **kwargs):
-    return dataclasses.field(default=None, metadata=dict(args=args, kwargs=kwargs, action='add_argument_group'))
+    return dataclasses.field(
+        default=None,
+        metadata=dict(args=args, kwargs=kwargs, action='add_argument_group')
+    )
 
 
 @overload
@@ -97,7 +103,10 @@ def add_subparsers(
 
 
 def add_subparsers(*args, **kwargs):
-    return dataclasses.field(default=None, metadata=dict(args=args, kwargs=kwargs, action='add_subparsers'))
+    return dataclasses.field(
+        default=None,
+        metadata=dict(args=args, kwargs=kwargs, action='add_subparsers')
+    )
 
 
 @overload

typed_args/_utils.py

@@ -74,3 +74,9 @@ def _get_default_metavar_for_optional(self, action: argparse.Action) -> str:
 
     def _get_default_metavar_for_positional(self, action: argparse.Action) -> str:
         return action.dest.split('.')[-1]
+
+
+# @dataclasses.dataclass
+# class _Params:
+#     args: tuple
+#     kwargs: dict