Merge pull request #5 from apple1417/master

type hint argument parser and add argument wrappers

Author: apple1417

Readme.md

@@ -31,6 +31,8 @@ game specific things:
 - Changed the display version to be sourced from `mod_manager.display_version` in the unrealsdk
   config file, rather than an environment variable.
 
+- Gave `@command` and `ArgParseCommand.add_argument` default type hinting for the args they forward.
+
 ### v1.5
 - Added a default `rlm` command, which is a helper to reload Python modules during development.
 - Deprecated the `auto_enable` arg in the `@hook` decorator, since it was misleading and in 99% of

command.py

@@ -6,9 +6,9 @@
 import shlex
 import sys
 from abc import ABC, abstractmethod
-from collections.abc import Callable
+from collections.abc import Callable, Iterable, Sequence
 from dataclasses import dataclass
-from typing import Any, overload
+from typing import Any, Protocol, overload
 
 from unrealsdk import logging
 from unrealsdk.commands import NEXT_LINE, add_command, has_command, remove_command
@@ -75,6 +75,26 @@ def _handle_cmd(self, line: str, cmd_len: int) -> None:
         except SystemExit:
             pass
 
+    @overload
+    def add_argument[T](
+        self,
+        *name_or_flags: str,
+        action: str | type[argparse.Action] = ...,
+        nargs: int | str | None = None,
+        const: Any = ...,
+        default: Any = ...,
+        type: Callable[[str], Any] | argparse.FileType | str = ...,
+        choices: Iterable[T] | None = ...,
+        required: bool = ...,
+        help: str | None = ...,
+        metavar: str | tuple[str, ...] | None = ...,
+        dest: str | None = ...,
+        version: str = ...,
+        **kwargs: Any,
+    ) -> argparse.Action: ...
+    @overload
+    def add_argument(self, *args: Any, **kwargs: Any) -> argparse.Action: ...
+
     def add_argument(self, *args: Any, **kwargs: Any) -> argparse.Action:
         """Wrapper which forwards to the parser's add_argument method."""
         return self.parser.add_argument(*args, **kwargs)
@@ -84,6 +104,31 @@ def __call__(self, args: argparse.Namespace) -> None:
         self.callback(args)
 
 
+class _FormatterClass(Protocol):
+    def __call__(self, *, prog: str) -> argparse.HelpFormatter: ...
+
+
+@overload
+def command(
+    cmd: str | None = None,
+    splitter: ARGPARSE_SPLITTER = shlex.split,
+    *,
+    prog: str | None = None,
+    usage: str | None = None,
+    description: str | None = None,
+    epilog: str | None = None,
+    parents: Sequence[argparse.ArgumentParser] = [],
+    formatter_class: _FormatterClass = ...,
+    prefix_chars: str = "-",
+    fromfile_prefix_chars: str | None = None,
+    argument_default: Any = None,
+    conflict_handler: str = "error",
+    add_help: bool = True,
+    allow_abbrev: bool = True,
+    exit_on_error: bool = True,
+) -> Callable[[ARGPARSE_CALLBACK], ArgParseCommand]: ...
+
+
 @overload
 def command(
     cmd: str | None = None,