More mypy validation changes. cmd2.py is nearly fully mypy compliant now.

Author: anselor

cmd2/__init__.py

@@ -3,10 +3,12 @@
 # flake8: noqa F401
 """This simply imports certain things for backwards compatibility."""
 
-try:
-    # For python 3.8 and later
+import sys
+
+# For python 3.8 and late
+if sys.version_info >= (3, 8):
     import importlib.metadata as importlib_metadata
-except ImportError:
+else:
     # For everyone else
     import importlib_metadata
 try:

cmd2/argparse_custom.py

@@ -215,7 +215,6 @@ def my_completer(self, text, line, begidx, endidx, arg_tokens)
     Tuple,
     Type,
     Union,
-    cast,
 )
 
 from . import (
@@ -279,7 +278,7 @@ class CompletionItem(str):
     """
 
     def __new__(cls, value: object, *args: Any, **kwargs: Any) -> 'CompletionItem':
-        return cast(CompletionItem, super(CompletionItem, cls).__new__(cls, value))  # type: ignore [call-arg]
+        return super(CompletionItem, cls).__new__(cls, value)
 
     # noinspection PyUnusedLocal
     def __init__(self, value: object, desc: str = '', *args: Any) -> None:
@@ -887,7 +886,7 @@ def __init__(
             description=description,
             epilog=epilog,
             parents=parents if parents else [],
-            formatter_class=formatter_class,
+            formatter_class=formatter_class,  # type: ignore[arg-type]
             prefix_chars=prefix_chars,
             fromfile_prefix_chars=fromfile_prefix_chars,
             argument_default=argument_default,
@@ -930,7 +929,7 @@ def format_help(self) -> str:
         formatter = self._get_formatter()
 
         # usage
-        formatter.add_usage(self.usage, self._actions, self._mutually_exclusive_groups)
+        formatter.add_usage(self.usage, self._actions, self._mutually_exclusive_groups)  # type: ignore[arg-type]
 
         # description
         formatter.add_text(self.description)

cmd2/cmd2.py

@@ -108,7 +108,7 @@ def _arg_swap(args: Union[Tuple[Any], List[Any]], search_arg: Any, *replace_arg:
 
 def with_argument_list(
     func_arg: Optional[Callable[[List[str]], Optional[bool]]] = None, *, preserve_quotes: bool = False
-) -> Union[Callable[[List[str]], Optional[bool]],]:
+) -> Union[Callable[[List[str]], Optional[bool]]]:
     """
     A decorator to alter the arguments passed to a ``do_*`` method. Default
     passes a string of whatever the user typed. With this decorator, the

cmd2/decorators.py

@@ -10,13 +10,13 @@
 # Prefer statically linked gnureadline if available (for macOS compatibility due to issues with libedit)
 try:
     # noinspection PyPackageRequirements
-    import gnureadline as readline
+    import gnureadline as readline  # type: ignore[import]
 except ImportError:
     # Try to import readline, but allow failure for convenience in Windows unit testing
     # Note: If this actually fails, you should install readline on Linux or Mac or pyreadline on Windows
     try:
         # noinspection PyUnresolvedReferences
-        import readline
+        import readline  # type: ignore[no-redef]
     except ImportError:  # pragma: no cover
         pass
 
@@ -182,7 +182,7 @@ def rl_get_point() -> int:  # pragma: no cover
         return ctypes.c_int.in_dll(readline_lib, "rl_point").value
 
     elif rl_type == RlType.PYREADLINE:
-        return readline.rl.mode.l_buffer.point
+        return int(readline.rl.mode.l_buffer.point)
 
     else:
         return 0

cmd2/rl_utils.py

@@ -12,14 +12,23 @@ class is used in cmd2.py::run_transcript_tests()
 import re
 import unittest
 from typing import (
+    TYPE_CHECKING,
+    List,
+    Optional,
     Tuple,
+    cast,
 )
 
 from . import (
     ansi,
     utils,
 )
 
+if TYPE_CHECKING:  # pragma: no cover
+    from cmd2 import (
+        Cmd,
+    )
+
 
 class Cmd2TestCase(unittest.TestCase):
     """A unittest class used for transcript testing.
@@ -31,7 +40,7 @@ class Cmd2TestCase(unittest.TestCase):
     See example.py
     """
 
-    cmdapp = None
+    cmdapp: Optional['Cmd'] = None
 
     def setUp(self):
         if self.cmdapp:
@@ -54,7 +63,8 @@ def runTest(self):  # was testall
 
     def _fetchTranscripts(self):
         self.transcripts = {}
-        for fname in self.cmdapp.testfiles:
+        testfiles = cast(List[str], getattr(self.cmdapp, 'testfiles', []))
+        for fname in testfiles:
             tfile = open(fname)
             self.transcripts[fname] = iter(tfile.readlines())
             tfile.close()

cmd2/transcript.py

@@ -1,6 +1,5 @@
 # coding=utf-8
 """Shared utility functions"""
-
 import argparse
 import collections
 import functools
@@ -17,7 +16,6 @@
     Enum,
 )
 from typing import (
-    IO,
     TYPE_CHECKING,
     Any,
     Callable,
@@ -45,6 +43,11 @@
 if TYPE_CHECKING:  # pragma: no cover
     import cmd2  # noqa: F401
 
+    PopenTextIO = subprocess.Popen[bytes]
+
+else:
+    PopenTextIO = subprocess.Popen
+
 
 _T = TypeVar('_T')
 
@@ -445,7 +448,7 @@ class StdSim:
 
     def __init__(
         self,
-        inner_stream: Union[TextIO, 'StdSim', IO[str]],
+        inner_stream: Union[TextIO, 'StdSim'],
         *,
         echo: bool = False,
         encoding: str = 'utf-8',
@@ -574,7 +577,7 @@ class ProcReader:
     If neither are pipes, then the process will run normally and no output will be captured.
     """
 
-    def __init__(self, proc: subprocess.Popen, stdout: Union[StdSim, IO[str]], stderr: Union[StdSim, IO[str]]) -> None:
+    def __init__(self, proc: PopenTextIO, stdout: Union[StdSim, TextIO], stderr: Union[StdSim, TextIO]) -> None:
         """
         ProcReader initializer
         :param proc: the Popen process being read from
@@ -650,7 +653,7 @@ def _reader_thread_func(self, read_stdout: bool) -> None:
         # Run until process completes
         while self._proc.poll() is None:
             # noinspection PyUnresolvedReferences
-            available = read_stream.peek()
+            available = read_stream.peek()  # type: ignore[attr-defined]
             if available:
                 read_stream.read(len(available))
                 self._write_bytes(write_stream, available)
@@ -699,8 +702,8 @@ class RedirectionSavedState:
 
     def __init__(
         self,
-        self_stdout: Union[StdSim, IO[str]],
-        sys_stdout: Union[StdSim, IO[str]],
+        self_stdout: Union[StdSim, TextIO],
+        sys_stdout: Union[StdSim, TextIO],
         pipe_proc_reader: Optional[ProcReader],
         saved_redirecting: bool,
     ) -> None: