]> git.ipfire.org Git - thirdparty/Python/cpython.git/commitdiff
Improve `pyrepl` type-annotation coverage (#119081)
authorAlex Waygood <Alex.Waygood@Gmail.com>
Fri, 17 May 2024 10:13:24 +0000 (06:13 -0400)
committerGitHub <noreply@github.com>
Fri, 17 May 2024 10:13:24 +0000 (06:13 -0400)
Lib/_pyrepl/_minimal_curses.py
Lib/_pyrepl/input.py
Lib/_pyrepl/keymap.py
Lib/_pyrepl/pager.py
Lib/_pyrepl/readline.py
Lib/_pyrepl/unix_console.py

index 0757fb2c664addfdba4ba542e90ffcf3599ea4bd..849617bf7585e469e1ee7a89fbed50a8f56772c0 100644 (file)
@@ -17,7 +17,7 @@ class error(Exception):
     pass
 
 
-def _find_clib():
+def _find_clib() -> str:
     trylibs = ["ncursesw", "ncurses", "curses"]
 
     for lib in trylibs:
index 300e16d1d2544148ab90a79d2cc95897aae99f95..21c24eb5cde3e36459506f23f6e29e90472a5f92 100644 (file)
@@ -60,7 +60,7 @@ class InputTranslator(ABC):
 
 
 class KeymapTranslator(InputTranslator):
-    def __init__(self, keymap, verbose=0, invalid_cls=None, character_cls=None):
+    def __init__(self, keymap, verbose=False, invalid_cls=None, character_cls=None):
         self.verbose = verbose
         from .keymap import compile_keymap, parse_keys
 
@@ -110,5 +110,5 @@ class KeymapTranslator(InputTranslator):
         else:
             return None
 
-    def empty(self):
+    def empty(self) -> bool:
         return not self.results
index 31a02642ce8ceb6e1367a43675ba93850417ce33..e1421730e757174028e67f21ba04be0e1f90d7c4 100644 (file)
@@ -187,7 +187,7 @@ def _parse_key1(key, s):
     return ret, s
 
 
-def parse_keys(key):
+def parse_keys(key: str) -> list[str]:
     s = 0
     r = []
     while s < len(key):
index af0409c4523bc297ab0c4f1377f2cca359807dd1..6a076b5181d872d06f7c5e73f0eda3c805d74733 100644 (file)
@@ -76,10 +76,14 @@ def tty_pager(text: str, title: str = '') -> None:
         fd = sys.stdin.fileno()
         old = termios.tcgetattr(fd)
         tty.setcbreak(fd)
-        getchar = lambda: sys.stdin.read(1)
         has_tty = True
+
+        def getchar() -> str:
+            return sys.stdin.read(1)
+
     except (ImportError, AttributeError, io.UnsupportedOperation):
-        getchar = lambda: sys.stdin.readline()[:-1][:1]
+        def getchar() -> str:
+            return sys.stdin.readline()[:-1][:1]
 
     try:
         try:
index d28a7f3779f3021e2a83b1002e09702cc45156d7..0adecf235a4eb4ef9bab405c4856d08d5779f6cc 100644 (file)
@@ -48,6 +48,9 @@ from collections.abc import Callable, Collection
 from .types import Callback, Completer, KeySpec, CommandName
 
 
+MoreLinesCallable = Callable[[str], bool]
+
+
 __all__ = [
     "add_history",
     "clear_history",
@@ -94,7 +97,7 @@ class ReadlineAlikeReader(historical_reader.HistoricalReader, CompletingReader):
 
     # Instance fields
     config: ReadlineConfig
-    more_lines: Callable[[str], bool] | None = None
+    more_lines: MoreLinesCallable | None = None
 
     def __post_init__(self) -> None:
         super().__post_init__()
@@ -287,7 +290,7 @@ class _ReadlineWrapper:
         reader.ps1 = str(prompt)
         return reader.readline(startup_hook=self.startup_hook)
 
-    def multiline_input(self, more_lines, ps1, ps2):
+    def multiline_input(self, more_lines: MoreLinesCallable, ps1: str, ps2: str) -> tuple[str, bool]:
         """Read an input on possibly multiple lines, asking for more
         lines as long as 'more_lines(unicodetext)' returns an object whose
         boolean value is true.
index 605318c82ae2eae8df2e8f397c5d3cc128f95f0c..7c59f48df406e60f60745fb33dee01fa32d71d8e 100644 (file)
@@ -40,9 +40,13 @@ from .unix_eventqueue import EventQueue
 from .utils import wlen
 
 
+TYPE_CHECKING = False
+
 # types
-if False:
-    from typing import IO
+if TYPE_CHECKING:
+    from typing import IO, Literal, overload
+else:
+    overload = lambda func: None
 
 
 class InvalidTerminal(RuntimeError):
@@ -157,7 +161,13 @@ class UnixConsole(Console):
         curses.setupterm(term or None, self.output_fd)
         self.term = term
 
-        def _my_getstr(cap, optional=0):
+        @overload
+        def _my_getstr(cap: str, optional: Literal[False] = False) -> bytes: ...
+
+        @overload
+        def _my_getstr(cap: str, optional: bool) -> bytes | None: ...
+
+        def _my_getstr(cap: str, optional: bool = False) -> bytes | None:
             r = curses.tigetstr(cap)
             if not optional and r is None:
                 raise InvalidTerminal(
@@ -672,18 +682,18 @@ class UnixConsole(Console):
         elif dy < 0:
             self.__write_code(self._cuu, -dy)
 
-    def __move_x_hpa(self, x):
+    def __move_x_hpa(self, x: int) -> None:
         if x != self.__posxy[0]:
             self.__write_code(self._hpa, x)
 
-    def __move_x_cub1_cuf1(self, x):
+    def __move_x_cub1_cuf1(self, x: int) -> None:
         dx = x - self.__posxy[0]
         if dx > 0:
             self.__write_code(self._cuf1 * dx)
         elif dx < 0:
             self.__write_code(self._cub1 * (-dx))
 
-    def __move_x_cub_cuf(self, x):
+    def __move_x_cub_cuf(self, x: int) -> None:
         dx = x - self.__posxy[0]
         if dx > 0:
             self.__write_code(self._cuf, dx)