feat: add clear_all function that clears screen AND scrollback

Author: sharmaigne

Lib/_pyrepl/unix_console.py

@@ -125,12 +125,13 @@ def __init__(self):
 
         def register(self, fd, flag):
             self.fd = fd
+
         # note: The 'timeout' argument is received as *milliseconds*
         def poll(self, timeout: float | None = None) -> list[int]:
             if timeout is None:
                 r, w, e = select.select([self.fd], [], [])
             else:
-                r, w, e = select.select([self.fd], [], [], timeout/1000)
+                r, w, e = select.select([self.fd], [], [], timeout / 1000)
             return r
 
     poll = MinimalPoll  # type: ignore[assignment]
@@ -213,7 +214,6 @@ def _sigcont_handler(self, signum, frame):
     def __read(self, n: int) -> bytes:
         return os.read(self.input_fd, n)
 
-
     def change_encoding(self, encoding: str) -> None:
         """
         Change the encoding used for I/O operations.
@@ -339,7 +339,10 @@ def prepare(self):
         tcsetattr(self.input_fd, termios.TCSADRAIN, raw)
 
         # In macOS terminal we need to deactivate line wrap via ANSI escape code
-        if platform.system() == "Darwin" and os.getenv("TERM_PROGRAM") == "Apple_Terminal":
+        if (
+            platform.system() == "Darwin"
+            and os.getenv("TERM_PROGRAM") == "Apple_Terminal"
+        ):
             os.write(self.output_fd, b"\033[?7l")
 
         self.screen = []
@@ -370,7 +373,10 @@ def restore(self):
         self.flushoutput()
         tcsetattr(self.input_fd, termios.TCSADRAIN, self.__svtermstate)
 
-        if platform.system() == "Darwin" and os.getenv("TERM_PROGRAM") == "Apple_Terminal":
+        if (
+            platform.system() == "Darwin"
+            and os.getenv("TERM_PROGRAM") == "Apple_Terminal"
+        ):
             os.write(self.output_fd, b"\033[?7h")
 
         if hasattr(self, "old_sigwinch"):
@@ -417,10 +423,7 @@ def wait(self, timeout: float | None = None) -> bool:
         """
         Wait for events on the console.
         """
-        return (
-            not self.event_queue.empty()
-            or bool(self.pollob.poll(timeout))
-        )
+        return not self.event_queue.empty() or bool(self.pollob.poll(timeout))
 
     def set_cursor_vis(self, visible):
         """
@@ -561,6 +564,11 @@ def clear(self):
         self.posxy = 0, 0
         self.screen = []
 
+    def clear_all(self) -> None:
+        """Clear screen and scrollback buffer."""
+        self.__write("\033[3J\033[2J\033[H")
+        self.clear()
+
     @property
     def input_hook(self):
         # avoid inline imports here so the repl doesn't get flooded

Lib/_pyrepl/windows_console.py

@@ -59,6 +59,7 @@ def __init__(self, err: int | None, descr: str | None = None) -> None:
             self.err = err
             self.descr = descr
 
+
 # declare nt optional to allow None assignment on other platforms
 nt: types.ModuleType | None
 try:
@@ -126,12 +127,14 @@ def __init__(self, err: int | None, descr: str | None = None) -> None:
 class _error(Exception):
     pass
 
+
 def _supports_vt():
     try:
         return nt._supports_virtual_terminal()
     except AttributeError:
         return False
 
+
 class WindowsConsole(Console):
     def __init__(
         self,
@@ -145,12 +148,12 @@ def __init__(
         self.__vt_support = _supports_vt()
 
         if self.__vt_support:
-            trace('console supports virtual terminal')
+            trace("console supports virtual terminal")
 
         # Save original console modes so we can recover on cleanup.
         original_input_mode = DWORD()
         GetConsoleMode(InHandle, original_input_mode)
-        trace(f'saved original input mode 0x{original_input_mode.value:x}')
+        trace(f"saved original input mode 0x{original_input_mode.value:x}")
         self.__original_input_mode = original_input_mode.value
 
         SetConsoleMode(
@@ -289,7 +292,7 @@ def __write_changed_line(
         else:
             self.posxy = wlen(newline), y
 
-            if "\x1b" in newline or y != self.posxy[1] or '\x1a' in newline:
+            if "\x1b" in newline or y != self.posxy[1] or "\x1a" in newline:
                 # ANSI escape characters are present, so we can't assume
                 # anything about the position of the cursor.  Moving the cursor
                 # to the left margin should work to get to a known position.
@@ -334,7 +337,7 @@ def _disable_bracketed_paste(self) -> None:
 
     def __write(self, text: str) -> None:
         if "\x1a" in text:
-            text = ''.join(["^Z" if x == '\x1a' else x for x in text])
+            text = "".join(["^Z" if x == "\x1a" else x for x in text])
 
         if self.out is not None:
             self.out.write(text.encode(self.encoding, "replace"))
@@ -362,7 +365,9 @@ def prepare(self) -> None:
         self.__offset = 0
 
         if self.__vt_support:
-            SetConsoleMode(InHandle, self.__original_input_mode | ENABLE_VIRTUAL_TERMINAL_INPUT)
+            SetConsoleMode(
+                InHandle, self.__original_input_mode | ENABLE_VIRTUAL_TERMINAL_INPUT
+            )
             self._enable_bracketed_paste()
 
     def restore(self) -> None:
@@ -427,9 +432,7 @@ def _read_input(self) -> INPUT_RECORD | None:
 
         return rec
 
-    def _read_input_bulk(
-        self, n: int
-    ) -> tuple[ctypes.Array[INPUT_RECORD], int]:
+    def _read_input_bulk(self, n: int) -> tuple[ctypes.Array[INPUT_RECORD], int]:
         rec = (n * INPUT_RECORD)()
         read = DWORD()
         if not ReadConsoleInput(InHandle, rec, n, read):
@@ -477,7 +480,9 @@ def get_event(self, block: bool = True) -> Event | None:
                     elif key_event.dwControlKeyState & ALT_ACTIVE:
                         # queue the key, return the meta command
                         self.event_queue.insert(Event(evt="key", data=key))
-                        return Event(evt="key", data="\033")  # keymap.py uses this for meta
+                        return Event(
+                            evt="key", data="\033"
+                        )  # keymap.py uses this for meta
                     return Event(evt="key", data=key)
                 if block:
                     continue
@@ -516,6 +521,14 @@ def clear(self) -> None:
         self.posxy = 0, 0
         self.screen = [""]
 
+
+    def clear_all(self) -> None:
+        """Clear screen and scrollback buffer."""
+        os.system("cls")  # This might not clear scrollback
+        # Fallback to ANSI escape sequences if terminal supports them
+        self.write_code("\033[3J\033[2J\033[H")
+        self.clear()
+
     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."""
@@ -697,7 +710,6 @@ class INPUT_RECORD(Structure):
     ReadConsoleInput.argtypes = [HANDLE, POINTER(INPUT_RECORD), DWORD, POINTER(DWORD)]
     ReadConsoleInput.restype = BOOL
 
-
     FlushConsoleInputBuffer = _KERNEL32.FlushConsoleInputBuffer
     FlushConsoleInputBuffer.argtypes = [HANDLE]
     FlushConsoleInputBuffer.restype = BOOL