Merge pull request #14 from SunDoge/new-api

update 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.2]
+
+- Add `ta.TypedArgs` for better intellisense.
+
 ## [0.6.1]
 
 - Add `@overload` for API.

README.md

@@ -23,7 +23,7 @@ from typing import List, Callable
 @ta.argument_parser(
     description='Process some integers.'
 )
-class Args:
+class Args(ta.TypedArgs):
     integers: List[int] = ta.add_argument(
         metavar='N', type=int, nargs='+',
         help='an integer for the accumulator'
@@ -110,7 +110,7 @@ parser = argparse.ArgumentParser(prog='ProgramName')
 import typed_args as ta
 
 @ta.argument_parser(prog='ProgramName')
-class Args:
+class Args(ta.TypedArgs):
     pass
 ```
 
@@ -133,7 +133,7 @@ parser.add_argument('-v', '--verbose',
 import typed_args as ta
 
 @ta.argument_parser()
-class Args:
+class Args(ta.TypedArgs):
     filename: str = ta.add_argument()                    # positional argument, use the attribute name automatically
     count: str = ta.add_argument('-c', '--count')        # option that takes a value, also can be annotated as Optional[str]
     verbose: bool = ta.add_argument('-v', '--verbose', 

_test_v0_6.py

@@ -35,7 +35,7 @@ class SubCommands(ta.SubcommandEnum):
 
 
 @ta.argument_parser(prog='dddd')
-class Args:
+class Args(ta.TypedArgs):
     x1: str = ta.add_argument()
     group1: Group1 = ta.add_argument_group()
     group2: Group2 = ta.add_argument_group()

docs/index.md

@@ -16,7 +16,7 @@ from typing import List, Callable
 @ta.argument_parser(
     description='Process some integers.'
 )
-class Args:
+class Args(ta.TypedArgs):
     integers: List[int] = ta.add_argument(
         metavar='N', type=int, nargs='+',
         help='an integer for the accumulator'

pyproject.toml

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

tests/test_add_argument.py

@@ -6,7 +6,7 @@
 
 def test_name_or_flags():
     @ta.argument_parser()
-    class Args:
+    class Args(ta.TypedArgs):
         foo: str = ta.add_argument('-f', '--foo')
         bar: str = ta.add_argument()
 
@@ -24,7 +24,7 @@ class Args:
 
 def test_store_action():
     @ta.argument_parser()
-    class Args:
+    class Args(ta.TypedArgs):
         foo: str = ta.add_argument('--foo')
 
     args = Args.parse_args('--foo 1'.split())
@@ -33,7 +33,7 @@ class Args:
 
 def test_store_const_action():
     @ta.argument_parser()
-    class Args:
+    class Args(ta.TypedArgs):
         foo: int = ta.add_argument('--foo', action='store_const', const=42)
 
     args = Args.parse_args(['--foo'])

tests/test_list.py

@@ -10,7 +10,7 @@ def test_list():
     """
 
     @ta.argument_parser()
-    class Args:
+    class Args(ta.TypedArgs):
         foo: List[str] = ta.add_argument('--foo', nargs=2, type=str)
         bar: List[str] = ta.add_argument(nargs=1, type=str)
 
@@ -22,7 +22,7 @@ class Args:
 
 def test_default_list():
     @ta.argument_parser()
-    class Args:
+    class Args(ta.TypedArgs):
         foo: int = ta.add_argument('--foo', type=int, default=42)
         bar: List[int] = ta.add_argument(nargs='*', default=[1, 2, 3])
         config: List[str] = ta.add_argument(

tests/test_pickle.py

@@ -6,7 +6,7 @@
 
 
 @ta.argument_parser()
-class Args:
+class Args(ta.TypedArgs):
     foo: Optional[str] = ta.add_argument('--foo')
     bar: List[int] = ta.add_argument(nargs='*', default=[1, 2, 3])
 

tests/test_readme.py

@@ -23,7 +23,7 @@
 TypedArgs
 """
 @ta.argument_parser()
-class Args:
+class Args(ta.TypedArgs):
     data: str = ta.add_argument(
         metavar='DIR', type=str, help='path to dataset'
     )

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.1"
+__version__ = "0.6.2"
 
 __all__ = [
     'dataclass',