Skip to content

GH-130328: further speedup of pasting in new REPL on Windows by reading in chunks #132889

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Closed
wants to merge 14 commits into from
Closed
Show file tree
Hide file tree
Changes from 7 commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
92 changes: 66 additions & 26 deletions Lib/_pyrepl/windows_console.py
Original file line number Diff line number Diff line change
Expand Up @@ -22,8 +22,6 @@
import io
import os
import sys
import time
import msvcrt

import ctypes
from ctypes.wintypes import (
Expand All @@ -44,14 +42,17 @@
from .windows_eventqueue import EventQueue

try:
from ctypes import GetLastError, WinDLL, windll, WinError # type: ignore[attr-defined]
from ctypes import get_last_error, GetLastError, WinDLL, windll, WinError # type: ignore[attr-defined]
except:
# Keep MyPy happy off Windows
from ctypes import CDLL as WinDLL, cdll as windll

def GetLastError() -> int:
return 42

def get_last_error() -> int:
return 42

class WinError(OSError): # type: ignore[no-redef]
def __init__(self, err: int | None, descr: str | None = None) -> None:
self.err = err
Expand All @@ -63,6 +64,8 @@ def __init__(self, err: int | None, descr: str | None = None) -> None:
if TYPE_CHECKING:
from typing import IO

INPUT_BUFFER_LEN = 10 * 1024

# Virtual-Key Codes: https://learn.microsoft.com/en-us/windows/win32/inputdev/virtual-key-codes
VK_MAP: dict[int, str] = {
0x23: "end", # VK_END
Expand Down Expand Up @@ -108,6 +111,12 @@ def __init__(self, err: int | None, descr: str | None = None) -> None:
ALT_ACTIVE = 0x01 | 0x02
CTRL_ACTIVE = 0x04 | 0x08

WAIT_TIMEOUT = 0x102
WAIT_FAILED = 0xFFFFFFFF

# from winbase.h
INFINITE = 0xFFFFFFFF


class _error(Exception):
pass
Expand Down Expand Up @@ -158,6 +167,10 @@ def __init__(
# Console I/O is redirected, fallback...
self.out = None

self.input_buffer = (INPUT_RECORD * INPUT_BUFFER_LEN)()
self.input_buffer_pos = 0
self.input_buffer_count = 0

def refresh(self, screen: list[str], c_xy: tuple[int, int]) -> None:
"""
Refresh the console screen.
Expand Down Expand Up @@ -408,20 +421,27 @@ def _getscrollbacksize(self) -> int:

return info.srWindow.Bottom # type: ignore[no-any-return]

def more_in_buffer(self) -> bool:
return self.input_buffer_pos < self.input_buffer_count - 1

def _read_input(self, block: bool = True) -> INPUT_RECORD | None:
if not block:
events = DWORD()
if not GetNumberOfConsoleInputEvents(InHandle, events):
raise WinError(GetLastError())
if not events.value:
return None
if not block and not self.wait(timeout=0):
return None

if self.more_in_buffer():
self.input_buffer_pos += 1
return self.input_buffer[self.input_buffer_pos]

rec = INPUT_RECORD()
# read next chunk
self.input_buffer_pos = 0
self.input_buffer_count = 0
read = DWORD()
if not ReadConsoleInput(InHandle, rec, 1, read):

if not ReadConsoleInput(InHandle, self.input_buffer, INPUT_BUFFER_LEN, read):
raise WinError(GetLastError())

return rec
self.input_buffer_count = read.value
return self.input_buffer[0]

def get_event(self, block: bool = True) -> Event | None:
"""Return an Event instance. Returns None if |block| is false
Expand Down Expand Up @@ -518,18 +538,37 @@ def forgetinput(self) -> None:
def getpending(self) -> Event:
"""Return the characters that have been typed but not yet
processed."""
return Event("key", "", b"")
e = Event("key", "", b"")
Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I've just copy-pasted this from

def getpending(self):
"""
Get pending events from the console event queue.
Returns:
- Event: Pending event from the event queue.
"""
e = Event("key", "", b"")
while not self.event_queue.empty():
e2 = self.event_queue.get()
e.data += e2.data
e.raw += e.raw
amount = 10000
raw = self.__read(amount)
data = str(raw, self.encoding, "replace")
e.data += data
e.raw += raw
return e

and dropped the reading of the next chunk, since IMHO this does not fit the doc string.

mypy fires here

Lib/_pyrepl/windows_console.py:545: error: Item "None" of "Event | None" has no
attribute "data"  [union-attr]
                e.data += e2.data
                          ^~~~~~~
Found 1 error in 1 file (checked 25 source files)

and is indeed correct. Have to dig in why we do not see this in case of unix_console.py ...


while not self.event_queue.empty():
e2 = self.event_queue.get()
e.data += e2.data
e.raw += e.raw

return e

def wait(self, timeout: float | None) -> bool:
def wait_for_event(self, timeout: float | None) -> bool:
"""Wait for an event."""
# Poor man's Windows select loop
start_time = time.time()
while True:
if msvcrt.kbhit(): # type: ignore[attr-defined]
return True
if timeout and time.time() - start_time > timeout / 1000:
return False
time.sleep(0.01)
if timeout is None:
timeout = INFINITE
else:
timeout = int(timeout)
ret = WaitForSingleObject(InHandle, timeout)
if ret == WAIT_FAILED:
raise WinError(get_last_error())
elif ret == WAIT_TIMEOUT:
return False
return True

def wait(self, timeout: float | None = None) -> bool:
Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Full in sync with unix_console.py now :)

def wait(self, timeout: float | None = None) -> bool:
"""
Wait for events on the console.
"""
return (
not self.event_queue.empty()
or self.more_in_buffer()
or bool(self.pollob.poll(timeout))
)

"""
Wait for events on the console.
"""
return (
not self.event_queue.empty()
or self.more_in_buffer()
or self.wait_for_event(timeout)
)

def repaint(self) -> None:
raise NotImplementedError("No repaint support")
Expand Down Expand Up @@ -649,14 +688,15 @@ class INPUT_RECORD(Structure):
ReadConsoleInput.argtypes = [HANDLE, POINTER(INPUT_RECORD), DWORD, POINTER(DWORD)]
ReadConsoleInput.restype = BOOL

GetNumberOfConsoleInputEvents = _KERNEL32.GetNumberOfConsoleInputEvents
GetNumberOfConsoleInputEvents.argtypes = [HANDLE, POINTER(DWORD)]
GetNumberOfConsoleInputEvents.restype = BOOL

FlushConsoleInputBuffer = _KERNEL32.FlushConsoleInputBuffer
FlushConsoleInputBuffer.argtypes = [HANDLE]
FlushConsoleInputBuffer.restype = BOOL

WaitForSingleObject = _KERNEL32.WaitForSingleObject
WaitForSingleObject.argtypes = [HANDLE, DWORD]
WaitForSingleObject.restype = DWORD

OutHandle = GetStdHandle(STD_OUTPUT_HANDLE)
InHandle = GetStdHandle(STD_INPUT_HANDLE)
else:
Expand All @@ -670,7 +710,7 @@ def _win_only(*args, **kwargs):
GetConsoleMode = _win_only
SetConsoleMode = _win_only
ReadConsoleInput = _win_only
GetNumberOfConsoleInputEvents = _win_only
FlushConsoleInputBuffer = _win_only
WaitForSingleObject = _win_only
OutHandle = 0
InHandle = 0
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
Speedup pasting in ``PyREPL`` on Windows. Fix by Chris Eibl.
Loading