Add types to input.py, console.pu, and commands.py

Author: ambv

Lib/_pyrepl/commands.py

@@ -17,6 +17,7 @@
 # CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF OR IN
 # CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
 
+from abc import ABC, abstractmethod
 import dataclasses
 
 
@@ -27,66 +28,87 @@ class Event:
     raw: bytes = b""
 
 
-class Console:
+class Console(ABC):
     """Attributes:
 
     screen,
     height,
     width,
     """
 
-    def refresh(self, screen, xy):
-        pass
+    @abstractmethod
+    def refresh(self, screen: list[str], xy: tuple[int, int]) -> None:
+        ...
 
-    def prepare(self):
-        pass
+    @abstractmethod
+    def prepare(self) -> None:
+        ...
 
-    def restore(self):
-        pass
+    @abstractmethod
+    def restore(self) -> None:
+        ...
 
-    def move_cursor(self, x, y):
-        pass
+    @abstractmethod
+    def move_cursor(self, x: int, y: int) -> None:
+        ...
 
-    def set_cursor_vis(self, vis):
-        pass
+    @abstractmethod
+    def set_cursor_vis(self, visible: bool) -> None:
+        ...
 
-    def getheightwidth(self):
+    @abstractmethod
+    def getheightwidth(self) -> tuple[int, int]:
         """Return (height, width) where height and width are the height
         and width of the terminal window in characters."""
-        pass
+        ...
 
-    def get_event(self, block=1):
+    @abstractmethod
+    def get_event(self, block: bool  = True) -> Event:
         """Return an Event instance.  Returns None if |block| is false
         and there is no event pending, otherwise waits for the
         completion of an event."""
-        pass
+        ...
 
-    def beep(self):
-        pass
+    @abstractmethod
+    def push_char(self, char: str) -> None:
+        """
+        Push a character to the console event queue.
+        """
+        ...
 
-    def clear(self):
+    @abstractmethod
+    def beep(self) -> None:
+        ...
+
+    @abstractmethod
+    def clear(self) -> None:
         """Wipe the screen"""
-        pass
+        ...
 
-    def finish(self):
+    @abstractmethod
+    def finish(self) -> None:
         """Move the cursor to the end of the display and otherwise get
         ready for end.  XXX could be merged with restore?  Hmm."""
-        pass
+        ...
 
-    def flushoutput(self):
+    @abstractmethod
+    def flushoutput(self) -> None:
         """Flush all output to the screen (assuming there's some
         buffering going on somewhere)."""
-        pass
+        ...
 
-    def forgetinput(self):
+    @abstractmethod
+    def forgetinput(self) -> None:
         """Forget all pending, but not yet processed input."""
-        pass
+        ...
 
-    def getpending(self):
+    @abstractmethod
+    def getpending(self) -> Event:
         """Return the characters that have been typed but not yet
         processed."""
-        pass
+        ...
 
-    def wait(self):
+    @abstractmethod
+    def wait(self) -> None:
         """Wait for an event."""
-        pass
+        ...

Lib/_pyrepl/console.py

@@ -17,12 +17,19 @@
 # CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF OR IN
 # CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
 
+from __future__ import annotations
+
 from contextlib import contextmanager
 
 from . import commands, input
-from .reader import Reader as R
+from .reader import Reader
+
+
+if False:
+    from .types import Callback, SimpleContextManager, KeySpec, CommandName
 
-isearch_keymap = tuple(
+
+isearch_keymap: tuple[tuple[KeySpec, CommandName], ...] = tuple(
     [("\\%03o" % c, "isearch-end") for c in range(256) if chr(c) != "\\"]
     + [(c, "isearch-add-character") for c in map(chr, range(32, 127)) if c != "\\"]
     + [
@@ -46,7 +53,7 @@
 
 
 class next_history(commands.Command):
-    def do(self):
+    def do(self) -> None:
         r = self.reader
         if r.historyi == len(r.history):
             r.error("end of history list")
@@ -190,7 +197,7 @@ def do(self):
         r.dirty = 1
 
 
-class HistoricalReader(R):
+class HistoricalReader(Reader):
     """Adds history support (with incremental history searching) to the
     Reader class.
 

Lib/_pyrepl/historical_reader.py

@@ -32,20 +32,32 @@
 # executive, temporary decision: [tab] and [C-i] are distinct, but
 # [meta-key] is identified with [esc key].  We demand that any console
 # class does quite a lot towards emulating a unix terminal.
+
+from __future__ import annotations
+
+from abc import ABC, abstractmethod
 import unicodedata
 from collections import deque
 
 
-class InputTranslator:
-    def push(self, evt):
-        pass
+# types
+if False:
+    from .types import EventTuple
 
-    def get(self):
-        pass
 
-    def empty(self):
+class InputTranslator(ABC):
+    @abstractmethod
+    def push(self, evt: EventTuple) -> None:
         pass
 
+    @abstractmethod
+    def get(self) -> EventTuple | None:
+        return None
+
+    @abstractmethod
+    def empty(self) -> bool:
+        return True
+
 
 class KeymapTranslator(InputTranslator):
     def __init__(self, keymap, verbose=0, invalid_cls=None, character_cls=None):

Lib/_pyrepl/input.py

@@ -105,10 +105,8 @@ def make_default_commands() -> dict[CommandName, type[Command]]:
         (r"\C-k", "kill-line"),
         (r"\C-l", "clear-screen"),
         (r"\C-m", "accept"),
-        (r"\C-q", "quoted-insert"),
         (r"\C-t", "transpose-characters"),
         (r"\C-u", "unix-line-discard"),
-        (r"\C-v", "quoted-insert"),
         (r"\C-w", "unix-word-rubout"),
         (r"\C-x\C-u", "upcase-region"),
         (r"\C-y", "yank"),
@@ -142,7 +140,6 @@ def make_default_commands() -> dict[CommandName, type[Command]]:
         (r"\<down>", "down"),
         (r"\<left>", "left"),
         (r"\<right>", "right"),
-        (r"\<insert>", "quoted-insert"),
         (r"\<delete>", "delete"),
         (r"\<backspace>", "backspace"),
         (r"\M-\<backspace>", "backward-kill-word"),
@@ -464,9 +461,9 @@ def update_cursor(self) -> None:
         self.cxy = self.pos2xy(self.pos)
         self.console.move_cursor(*self.cxy)
 
-    def after_command(self, cmd) -> None:
+    def after_command(self, cmd: Command) -> None:
         """This function is called to allow post command cleanup."""
-        if getattr(cmd, "kills_digit_arg", 1):
+        if getattr(cmd, "kills_digit_arg", True):
             if self.arg is not None:
                 self.dirty = True
             self.arg = None
@@ -537,7 +534,7 @@ def refresh(self) -> None:
     def do_cmd(self, cmd) -> None:
         if isinstance(cmd[0], str):
             cmd = self.commands.get(cmd[0], commands.invalid_command)(self, *cmd)
-        elif isinstance(cmd[0], type):
+        elif isinstance(cmd[0], type) and issubclass(cmd[0], commands.Command):
             cmd = cmd[0](self, *cmd)
         else:
             return  # nothing to do

Lib/_pyrepl/reader.py

@@ -28,7 +28,7 @@
 
 import os
 import readline
-from site import gethistoryfile
+from site import gethistoryfile   # type: ignore[attr-defined]
 import sys
 
 from . import commands, historical_reader

Lib/_pyrepl/readline.py

@@ -4,3 +4,4 @@
 SimpleContextManager = Iterator[None]
 KeySpec = str  # like r"\C-c"
 CommandName = str  # like "interrupt"
+EventTuple = tuple[CommandName, str]

Lib/_pyrepl/types.py

@@ -349,7 +349,7 @@ def push_char(self, char):
         trace("push char {char!r}", char=char)
         self.event_queue.push(char)
 
-    def get_event(self, block=True):
+    def get_event(self, block: bool = True) -> Event:
         """
         Get an event from the console event queue.
 

Lib/_pyrepl/unix_console.py

@@ -55,9 +55,51 @@ def __init__(self, events, encoding="utf-8"):
         self.height = 100
         self.width = 80
 
-    def get_event(self, block=True):
+    def get_event(self, block: bool = True) -> Event:
         return next(self.events)
 
+    def getpending(self) -> Event:
+        return self.get_event(block=False)
+
+    def getheightwidth(self) -> tuple[int, int]:
+        return self.height, self.width
+
+    def refresh(self, screen: list[str], xy: tuple[int, int]) -> None:
+        pass
+
+    def prepare(self) -> None:
+        pass
+
+    def restore(self) -> None:
+        pass
+
+    def move_cursor(self, x: int, y: int) -> None:
+        pass
+
+    def set_cursor_vis(self, visible: bool) -> None:
+        pass
+
+    def push_char(self, char: str) -> None:
+        pass
+
+    def beep(self) -> None:
+        pass
+
+    def clear(self) -> None:
+        pass
+
+    def finish(self) -> None:
+        pass
+
+    def flushoutput(self) -> None:
+        pass
+
+    def forgetinput(self) -> None:
+        pass
+
+    def wait(self) -> None:
+        pass
+
 
 class TestPyReplDriver(TestCase):
     def prepare_reader(self, events):