Skip to content
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

PyREPL does not handle wRepeatCount on Windows, causing incorrect 'dead key' behavior #127947

Open
SimonvBez opened this issue Dec 14, 2024 · 0 comments
Labels
OS-windows topic-repl Related to the interactive shell type-bug An unexpected behavior, bug, or error

Comments

@SimonvBez
Copy link

SimonvBez commented Dec 14, 2024

Bug report

Bug description:

PyREPL (introduced in Python 3.13) fails to account for the wRepeatCount field in the KEY_EVENT_RECORD on Windows, resulting in incorrect behavior when keys are pressed repeatedly in the REPL. This issue is reproducible in the Windows Terminal on Windows 10 or 11, specifically when using a keyboard layout with dead keys (e.g., US International layout).

This issue can be bothering as it messes with muscle memory when typing quotes in the new PyREPL (which otherwise is AWESOME!)

Steps to Reproduce:

  1. Open Python 3.13+ in the Windows Terminal (NOT in an older conhost.exe-based terminal) on Windows 10 or 11.
  2. Use a keyboard layout with dead keys, such as the US International layout.
  3. Type a dead key character (e.g., ', ", ^, `, or ~) into the REPL input.
    • Expected behavior: No character is typed, as the dead key is waiting for the next key to combine.
    • Actual behavior: No character is typed, which is correct.
  4. Type the same dead key again.
    • Expected behavior: The character corresponding to the dead key should be typed twice.
    • Actual behavior: The character is only typed once.

Root Cause:

The Windows Terminal sends a single key event with wRepeatCount == 2 when a key is pressed repeatedly. PyREPL does not check the wRepeatCount value, so the REPL only processes the key press once. In contrast, conhost.exe-based terminals send two separate key events for the repeated key press, causing the REPL to handle the input correctly in those environments.

Desired Fix:

Modify PyREPL to correctly handle the wRepeatCount value in the KEY_EVENT_RECORD. When wRepeatCount > 1, the corresponding key should be processed the specified number of times to ensure correct handling of repeated key presses.

CPython versions tested on:

3.13, 3.14, CPython main branch

Operating systems tested on:

Windows

Linked PRs

@SimonvBez SimonvBez added the type-bug An unexpected behavior, bug, or error label Dec 14, 2024
@tomasr8 tomasr8 added OS-windows topic-repl Related to the interactive shell labels Dec 14, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
OS-windows topic-repl Related to the interactive shell type-bug An unexpected behavior, bug, or error
Projects
None yet
Development

No branches or pull requests

2 participants