Improved some type definitions

Fixes #29

Signed-off-by: Pedro Algarvio <[email protected]>

Author: s0undt3ch

changelog/29.bugfix.rst

@@ -0,0 +1 @@
+Improved some type definitions

src/ptscripts/parser.py

@@ -22,8 +22,8 @@
 from typing import Any
 from typing import cast
 from typing import ContextManager
+from typing import NoReturn
 from typing import TYPE_CHECKING
-from typing import TypedDict
 
 import requests
 import rich
@@ -35,6 +35,11 @@
 from ptscripts.virtualenv import VirtualEnv
 from ptscripts.virtualenv import VirtualEnvConfig
 
+if sys.version_info < (3, 11):
+    from typing_extensions import TypedDict, NotRequired
+else:
+    from typing import TypedDict, NotRequired
+
 try:
     import importlib.metadata
 
@@ -56,14 +61,15 @@ class ArgumentOptions(TypedDict):
     TypedDict class documenting the acceptable keys and their types for arguments.
     """
 
-    flags: list[str]
-    help: str
-    action: str | argparse.Action
-    nargs: int | str
-    const: Any
-    choices: list[str]
-    required: bool
-    metavar: str
+    help: NotRequired[str]
+    flags: NotRequired[list[str]]
+    action: NotRequired[str | argparse.Action]
+    nargs: NotRequired[int | str]
+    const: NotRequired[Any]
+    choices: NotRequired[list[str] | tuple[str, ...]]
+    required: NotRequired[bool]
+    metavar: NotRequired[str]
+    default: NotRequired[Any]
 
 
 class FullArgumentOptions(ArgumentOptions):
@@ -73,7 +79,6 @@ class FullArgumentOptions(ArgumentOptions):
 
     dest: str
     type: type[Any]
-    default: Any
 
 
 class Context:
@@ -137,7 +142,7 @@ def error(self, *args):
         """
         self.console.log(*args, style="log-error", _stack_offset=2)
 
-    def exit(self, status=0, message=None):
+    def exit(self, status=0, message=None) -> NoReturn:  # type: ignore[misc]
         """
         Exit the command execution.
         """
@@ -158,7 +163,7 @@ def _run(
         capture: bool = False,
         interactive: bool = False,
         **kwargs,
-    ) -> CompletedProcess[str]:
+    ) -> CompletedProcess[bytes]:
         """
         Run a subprocess.
         """
@@ -181,7 +186,7 @@ def run(
         capture: bool = False,
         interactive: bool = False,
         **kwargs,
-    ) -> CompletedProcess[str] | None:
+    ) -> CompletedProcess[bytes]:
         """
         Run a subprocess.
 
@@ -208,9 +213,11 @@ def run(
                 **kwargs,
             )
         except subprocess.CalledProcessError as exc:
-            self.error(str(exc))
-            self.exit(exc.returncode)
-        return None
+            self._exit(str(exc), exc.returncode)
+
+    def _exit(self, msg: str, returncode: int) -> NoReturn:
+        self.error(msg)
+        self.exit(returncode)
 
     @contextmanager
     def chdir(self, path: pathlib.Path) -> Iterator[pathlib.Path]:
@@ -653,7 +660,7 @@ def command(
                     if not kwargs["help"].endswith("."):
                         kwargs["help"] += "."
                     kwargs["help"] += " [default: %(default)s]"
-            flags = kwargs.pop("flags", None)  # type: ignore[misc]
+            flags = kwargs.pop("flags", None)
             if flags is None:
                 flags = [f"--{parameter.name.replace('_', '-')}"]
             log.debug("Adding Command %r. Flags: %s; KwArgs: %s", name, flags, kwargs)
@@ -708,7 +715,7 @@ def command_group(
     help: str,
     description: str | None = None,
     venv_config: VirtualEnvConfig | None = None,
-    parent: CommandGroup | None = None,
+    parent: CommandGroup | str | list[str] | tuple[str] | None = None,
 ) -> CommandGroup:
     """
     Create a new command group.

src/ptscripts/process.py

@@ -254,7 +254,7 @@ def run(
     capture: bool = False,
     interactive: bool = False,
     **kwargs,
-) -> subprocess.CompletedProcess[str]:
+) -> subprocess.CompletedProcess[bytes]:
     """
     Run a command.
     """
@@ -276,7 +276,7 @@ def run(
         result = future.result()
         if check is True:
             result.check_returncode()
-        return cast(subprocess.CompletedProcess[str], result)
+        return cast(subprocess.CompletedProcess[bytes], result)
     finally:
         loop.run_until_complete(loop.shutdown_asyncgens())
         loop.close()

src/ptscripts/virtualenv.py

@@ -10,13 +10,13 @@
 import subprocess
 import sys
 import textwrap
+from subprocess import CompletedProcess
 from typing import TYPE_CHECKING
-from typing import TypedDict
 
-try:
-    from typing import NotRequired  # type: ignore[attr-defined]
-except ImportError:
-    from typing_extensions import NotRequired
+if sys.version_info < (3, 11):
+    from typing_extensions import TypedDict, NotRequired
+else:
+    from typing import TypedDict, NotRequired
 
 import attr
 
@@ -227,7 +227,7 @@ def uninstall(self, *args, **kwargs):
         """
         return self.run(self.venv_python, "-m", "pip", "uninstall", "-y", *args, **kwargs)
 
-    def run(self, *args, **kwargs):
+    def run(self, *args, **kwargs) -> CompletedProcess[bytes]:
         """
         Run a command in the context of the virtual environment.
         """