update examples, test, version etc.

README.md

@@ -118,8 +118,7 @@ import os
 import sys
 from typing import Dict, List, Optional, Tuple, Union
 
-from typed_argparser import ArgumentClass
-from typed_argparser.fields import argfield
+from typed_argparser import ArgumentClass, argfield
 
 
 class Example1(ArgumentClass):

examples/example_1.py

@@ -5,8 +5,7 @@
 cwd = os.path.dirname(os.path.realpath(__file__))
 sys.path.append(f"{cwd}/../")
 
-from typed_argparser import ArgumentClass  # noqa: E402
-from typed_argparser.fields import argfield  # noqa: E402
+from typed_argparser import ArgumentClass, argfield  # noqa: E402
 
 
 class Example1(ArgumentClass):

examples/example_2.py

@@ -1,17 +1,16 @@
-from io import TextIOWrapper
 import os
 import sys
-from typing import Dict, List, Optional, Union
-from typing_extensions import Annotated
+from io import TextIOWrapper
 from pathlib import Path
+from typing import Dict, List, Optional, Union
 
+from typing_extensions import Annotated
 
 cwd = os.path.dirname(os.path.realpath(__file__))
 sys.path.append(f"{cwd}/../")
 
+from typed_argparser import ArgumentClass, argfield  # noqa: E402
 from typed_argparser.types import Args  # noqa: E402
-from typed_argparser import ArgumentClass  # noqa: E402
-from typed_argparser.fields import argfield  # noqa: E402
 
 
 class Example2(ArgumentClass):
@@ -32,18 +31,18 @@ class Example2(ArgumentClass):
 
 
 @cli.execute("opt1", "opt2")
-def execute_1(opt1: str, opt2: List[str]):
+def execute_1(opt1: str, opt2: List[str]) -> None:
     print("This function is executed when both function arguments are provided.")
     print(f"opt1: {opt1}, opt2: {opt2}")
 
 
 @cli.execute("opt3")
-def execute_2(opt3: TextIOWrapper):
+def execute_2(opt3: TextIOWrapper) -> None:
     opt3.write("This is written to the output file.")
 
 
 @cli.execute("opt4")
-def execute_3(opt4: Dict[str, int]):
+def execute_3(opt4: Dict[str, int]) -> None:
     print("This will not be executed as opt4 is not provided.")
 
 

examples/git_cli/add_group.py

@@ -1,13 +1,12 @@
-from typing import List, Optional
 from pathlib import Path
+from typing import List, Optional
 
 from typing_extensions import Annotated, Doc
 
-from typed_argparser import SUPPRESS, ArgumentClass
-from typed_argparser.fields import argfield
+from typed_argparser import ArgumentClass, argfield
+from typed_argparser.constants import SUPPRESS
 from typed_argparser.groups import ArgumentGroup
 
-
 from .common import CommonParameters
 
 

examples/git_cli/common.py

@@ -2,8 +2,8 @@
 
 from typing_extensions import Annotated, Doc, List
 
+from typed_argparser import argfield
 from typed_argparser.constants import SUPPRESS
-from typed_argparser.fields import argfield
 
 
 class CommonParameters:

examples/git_cli/git.py

@@ -6,12 +6,12 @@
 cwd = os.path.dirname(os.path.realpath(__file__))
 sys.path.append(f"{cwd}/../../")
 
-from typed_argparser import SUPPRESS, ArgumentClass  # noqa: E402
+from typed_argparser import ArgumentClass, argfield  # noqa: E402
+from typed_argparser.constants import SUPPRESS  # noqa: E402
 from typed_argparser.config import ArgumentConfig  # noqa: E402
 from examples.git_cli.add_group import AddGroup  # noqa: E402
 from examples.git_cli.init_group import InitGroup  # noqa: E402
 from examples.git_cli.remote_group import RemoteCommand  # noqa: E402
-from typed_argparser.fields import argfield  # noqa: E402
 
 
 class Git(ArgumentClass, AddGroup, InitGroup):
@@ -58,25 +58,17 @@ class Git(ArgumentClass, AddGroup, InitGroup):
 
 
 @git_cli.execute
-def show_help():
+def show_help() -> None:
     git_cli.print_help()
 
 
 @git_cli.remote.execute
-def show_remote():
+def show_remote() -> None:
     git_cli.remote.print_help()
 
 
 @git_cli.remote.add.execute
-def add_remote(name, url, *, branch: Optional[str] = None):
+def add_remote(name: str, url: str, *, branch: Optional[str] = None) -> None:
     print(f"Adding remote {name} at {url}")
     print("Info:")
     print(f"\tBranch {branch}")
-    # print(f"\tMaster {master}")
-    # print(f"\tTags {tags}")
-    # print(f"\tMirror {mirror}")
-
-
-# @git_cli.execute()
-# def show_default():
-#     print("this is default")

examples/git_cli/init_group.py

@@ -3,8 +3,7 @@
 
 from typing_extensions import Annotated, Doc
 
-from typed_argparser import ArgumentClass
-from typed_argparser.fields import argfield
+from typed_argparser import ArgumentClass, argfield
 from typed_argparser.groups import ArgumentGroup
 
 from .common import Directory

examples/git_cli/remote_group.py

@@ -1,7 +1,7 @@
 from typing import Literal, Optional
 
+from typed_argparser import argfield
 from typed_argparser.constants import SUPPRESS
-from typed_argparser.fields import argfield
 from typed_argparser.groups import ArgumentGroup
 from typed_argparser.parser import ArgumentClass
 from typed_argparser.validators import UrlValidator

tests/tests.py

@@ -11,10 +11,10 @@
 
 from typing_extensions import Annotated, Doc
 
-from typed_argparser import ArgumentClass, ArgumentConfig
+from typed_argparser import ArgumentClass, ArgumentConfig, argfield
 from typed_argparser.constants import SUPPRESS
 from typed_argparser.exceptions import ArgumentError, ValidatorInitError
-from typed_argparser.fields import argfield
+
 from typed_argparser.groups import ArgumentGroup
 from typed_argparser.types import Args, UrlType
 from typed_argparser.validators import (

typed_argparser/__init__.py

@@ -1,11 +1,13 @@
 from .config import ArgumentConfig
-from .constants import SUPPRESS
 from .parser import ArgumentClass
 from .validators import ArgumentValidator
+from .fields import argfield
 
 __all__ = [
     "ArgumentClass",
     "ArgumentConfig",
-    "SUPPRESS",
     "ArgumentValidator",
+    "argfield",
 ]
+
+__version__ = "1.0.0"