history, py_bridge, transcript now passs mypy

Author: anselor

cmd2/cmd2.py

@@ -3635,7 +3635,7 @@ def _print_topics(self, header: str, cmds: List[str], verbose: bool) -> None:
                             stdout_orig = self.stdout
                             try:
                                 # redirect our internal stdout
-                                self.stdout = result
+                                self.stdout = cast(TextIO, result)
                                 help_func()
                             finally:
                                 # restore internal stdout
@@ -3883,7 +3883,7 @@ def do_shell(self, args: argparse.Namespace) -> None:
                 shell=True,
             )
 
-            proc_reader = utils.ProcReader(proc, self.stdout, sys.stderr)
+            proc_reader = utils.ProcReader(proc, cast(TextIO, self.stdout), sys.stderr)
             proc_reader.wait()
 
             # Save the return code of the application for use in a pyscript
@@ -4563,7 +4563,7 @@ def _generate_transcript(self, history: Union[List[HistoryItem], List[str]], tra
             with self.sigint_protection:
                 # Restore altered attributes to their original state
                 self.echo = saved_echo
-                self.stdout = saved_stdout
+                self.stdout = cast(TextIO, saved_stdout)
 
         # Check if all commands ran
         if commands_run < len(history):

cmd2/history.py

@@ -10,7 +10,7 @@
 from typing import (
     Callable,
     Optional,
-    Union,
+    Union, List, Iterable, overload,
 )
 
 import attr
@@ -23,16 +23,16 @@
 )
 
 
-@attr.s(frozen=True)
+@attr.s(auto_attribs=True, frozen=True)
 class HistoryItem:
     """Class used to represent one command in the history list"""
 
     _listformat = ' {:>4}  {}'
     _ex_listformat = ' {:>4}x {}'
 
-    statement = attr.ib(default=None, validator=attr.validators.instance_of(Statement))
+    statement: Statement = attr.ib(default=None, validator=attr.validators.instance_of(Statement))
 
-    def __str__(self):
+    def __str__(self) -> str:
         """A convenient human readable representation of the history item"""
         return self.statement.raw
 
@@ -66,11 +66,11 @@ def pr(self, idx: int, script: bool = False, expanded: bool = False, verbose: bo
         """
         if verbose:
             raw = self.raw.rstrip()
-            expanded = self.expanded
+            expanded_command = self.expanded
 
             ret_str = self._listformat.format(idx, raw)
-            if raw != expanded:
-                ret_str += '\n' + self._ex_listformat.format(idx, expanded)
+            if raw != expanded_command:
+                ret_str += '\n' + self._ex_listformat.format(idx, expanded_command)
         else:
             if expanded:
                 ret_str = self.expanded
@@ -92,7 +92,7 @@ def pr(self, idx: int, script: bool = False, expanded: bool = False, verbose: bo
         return ret_str
 
 
-class History(list):
+class History(List[HistoryItem]):
     """A list of :class:`~cmd2.history.HistoryItem` objects with additional methods
     for searching and managing the list.
 
@@ -106,8 +106,8 @@ class History(list):
     class to gain access to the historical record.
     """
 
-    def __init__(self, seq=()) -> None:
-        super().__init__(seq)
+    def __init__(self, seq: Iterable[HistoryItem] = ()) -> None:
+        super(History, self).__init__(seq)
         self.session_start_index = 0
 
     def start_session(self) -> None:
@@ -122,14 +122,25 @@ def _zero_based_index(self, onebased: Union[int, str]) -> int:
             result -= 1
         return result
 
+    @overload
+    def append(self, new: HistoryItem) -> None:
+        ...
+
+    @overload
     def append(self, new: Statement) -> None:
+        ...
+
+    def append(self, new: Union[Statement, HistoryItem]) -> None:
         """Append a new statement to the end of the History list.
 
         :param new: Statement object which will be composed into a HistoryItem
                     and added to the end of the list
         """
-        history_item = HistoryItem(new)
-        super().append(history_item)
+        if isinstance(new, Statement):
+            history_item = HistoryItem(new)
+        else:
+            history_item = new
+        super(History, self).append(history_item)
 
     def clear(self) -> None:
         """Remove all items from the History list."""
@@ -206,17 +217,17 @@ def span(self, span: str, include_persisted: bool = False) -> 'OrderedDict[int,
             # our regex doesn't match the input, bail out
             raise ValueError('History indices must be positive or negative integers, and may not be zero.')
 
-        start = results.group('start')
-        if start:
-            start = min(self._zero_based_index(start), len(self) - 1)
+        start_token = results.group('start')
+        if start_token:
+            start = min(self._zero_based_index(start_token), len(self) - 1)
             if start < 0:
                 start = max(0, len(self) + start)
         else:
             start = 0 if include_persisted else self.session_start_index
 
-        end = results.group('end')
-        if end:
-            end = min(int(end), len(self))
+        end_token = results.group('end')
+        if end_token:
+            end = min(int(end_token), len(self))
             if end < 0:
                 end = max(0, len(self) + end + 1)
         else:

cmd2/py_bridge.py

@@ -17,7 +17,7 @@
     NamedTuple,
     Optional,
     TextIO,
-    cast,
+    cast, Union,
 )
 
 from .utils import (  # namedtuple_with_defaults,
@@ -110,7 +110,7 @@ def __call__(self, command: str, *, echo: Optional[bool] = None) -> CommandResul
             echo = self.cmd_echo
 
         # This will be used to capture _cmd2_app.stdout and sys.stdout
-        copy_cmd_stdout = StdSim(self._cmd2_app.stdout, echo=echo)
+        copy_cmd_stdout = StdSim(cast(Union[TextIO, StdSim], self._cmd2_app.stdout), echo=echo)
 
         # Pause the storing of stdout until onecmd_plus_hooks enables it
         copy_cmd_stdout.pause_storage = True

cmd2/transcript.py

@@ -16,7 +16,7 @@ class is used in cmd2.py::run_transcript_tests()
     List,
     Optional,
     Tuple,
-    cast,
+    cast, Iterator, IO, TextIO,
 )
 
 from . import (
@@ -42,34 +42,34 @@ class Cmd2TestCase(unittest.TestCase):
 
     cmdapp: Optional['Cmd'] = None
 
-    def setUp(self):
+    def setUp(self) -> None:
         if self.cmdapp:
             self._fetchTranscripts()
 
             # Trap stdout
             self._orig_stdout = self.cmdapp.stdout
-            self.cmdapp.stdout = utils.StdSim(self.cmdapp.stdout)
+            self.cmdapp.stdout = cast(TextIO, utils.StdSim(cast(TextIO, self.cmdapp.stdout)))
 
-    def tearDown(self):
+    def tearDown(self) -> None:
         if self.cmdapp:
             # Restore stdout
             self.cmdapp.stdout = self._orig_stdout
 
-    def runTest(self):  # was testall
+    def runTest(self) -> None:  # was testall
         if self.cmdapp:
             its = sorted(self.transcripts.items())
             for (fname, transcript) in its:
                 self._test_transcript(fname, transcript)
 
-    def _fetchTranscripts(self):
+    def _fetchTranscripts(self) -> None:
         self.transcripts = {}
         testfiles = cast(List[str], getattr(self.cmdapp, 'testfiles', []))
         for fname in testfiles:
             tfile = open(fname)
             self.transcripts[fname] = iter(tfile.readlines())
             tfile.close()
 
-    def _test_transcript(self, fname: str, transcript):
+    def _test_transcript(self, fname: str, transcript: Iterator[str]) -> None:
         if self.cmdapp is None:
             return
 
@@ -86,24 +86,24 @@ def _test_transcript(self, fname: str, transcript):
                     finished = True
                     break
                 line_num += 1
-            command = [line[len(self.cmdapp.visible_prompt) :]]
+            command_parts = [line[len(self.cmdapp.visible_prompt) :]]
             try:
                 line = next(transcript)
             except StopIteration:
                 line = ''
             line_num += 1
             # Read the entirety of a multi-line command
             while line.startswith(self.cmdapp.continuation_prompt):
-                command.append(line[len(self.cmdapp.continuation_prompt) :])
+                command_parts.append(line[len(self.cmdapp.continuation_prompt) :])
                 try:
                     line = next(transcript)
                 except StopIteration as exc:
                     msg = 'Transcript broke off while reading command beginning at line {} with\n{}'.format(
-                        line_num, command[0]
+                        line_num, command_parts[0]
                     )
                     raise StopIteration(msg) from exc
                 line_num += 1
-            command = ''.join(command)
+            command = ''.join(command_parts)
             # Send the command into the application and capture the resulting output
             stop = self.cmdapp.onecmd_plus_hooks(command)
             result = self.cmdapp.stdout.read()
@@ -117,9 +117,9 @@ def _test_transcript(self, fname: str, transcript):
                 # If the command signaled the application to quit there should be no more commands
                 self.assertFalse(stop, stop_msg)
                 continue
-            expected = []
+            expected_parts = []
             while not ansi.strip_style(line).startswith(self.cmdapp.visible_prompt):
-                expected.append(line)
+                expected_parts.append(line)
                 try:
                     line = next(transcript)
                 except StopIteration:
@@ -132,7 +132,7 @@ def _test_transcript(self, fname: str, transcript):
                 self.assertTrue(finished, stop_msg)
 
             # transform the expected text into a valid regular expression
-            expected = ''.join(expected)
+            expected = ''.join(expected_parts)
             expected = self._transform_transcript_expected(expected)
             message = '\nFile {}, line {}\nCommand was:\n{}\nExpected:\n{}\nGot:\n{}\n'.format(
                 fname, line_num, command, expected, result