gh-124096: Enable REPL virtual terminal support on Windows by y5c4l3 · Pull Request #124119 · python/cpython

y5c4l3 · 2024-09-16T10:49:33Z

Issue: #124096

Issue: Pasting a function definition does not work in 3.13 REPL with Windows Terminal #124096

ghost · 2024-09-16T10:49:37Z

All commit authors signed the Contributor License Agreement.

pablogsal · 2024-09-19T13:50:16Z

@ambv @zooba can you test this on a windows machine?

zooba · 2024-09-20T10:35:58Z

I'm just testing that indentation works when I paste code? That seems fine.

As a side note, my Ctrl+Left and Ctrl+Right shortcuts (skip word) are broken now (possibly ever since the repl went in), and there's way too much ctypes for my liking in here - we should prioritise moving those to _winapi for 3.13.1.

y5c4l3 · 2024-09-20T12:27:15Z

As a side note, my Ctrl+Left and Ctrl+Right shortcuts (skip word) are broken now

It can be fixed by adding two entries in the keymap. I'll later check whether there are other sequences that I missed before and commit as soon.

Signed-off-by: y5c4l3 <y5c4l3@proton.me>

To support virtual terminal mode in Windows PYREPL, we need a scanner to read over the supported escaped VT sequences. Signed-off-by: y5c4l3 <y5c4l3@proton.me>

Windows REPL input was using virtual key mode, which does not support terminal escape sequences. This patch calls `SetConsoleMode` properly when initializing and send sequences to enable bracketed-paste modes to support verbatim copy-and-paste. Signed-off-by: y5c4l3 <y5c4l3@proton.me>

y5c4l3 · 2024-09-28T09:16:49Z

@pablogsal @ambv @zooba
Consider it's little bit hard to integrate Windows console tests, I recorded a GIF with screenkey for reference, it at least covers:

Ctrl + R
PgUp / PgDown
Home / End / Ctrl + A / Ctrl + E / Ctrl + ← / Ctrl + →
bracketed pastes

cbrnr · 2025-01-14T10:02:43Z

I just wanted to ask if there is something that I could do to help get this PR merged? It is currently not possible to paste a code snippet containing indentation into the REPL on Windows. I think this is a pretty serious limitation, because many tools (e.g. Visual Studio Code) rely on this mechanism to run selected code portions. I was hoping that this fix would make it into 3.13.1, but unfortunately this was not the case. Currently, this forces people on 3.13 to either disable the new REPL experience or switch to 3.12, both of which are very suboptimal workarounds (because the new REPL is great!).

pavlovc2 · 2025-01-15T21:22:02Z

I second the need to get this merged as I am also impacted by the issue.

wheeheee · 2025-01-17T08:10:33Z

Would this PR also work for VSCode's integrated terminal? There's a comment here: # Currently enable bracketed-paste only if it's Windows Terminal.

pablogsal · 2025-01-22T12:51:32Z

I just wanted to ask if there is something that I could do to help get this PR merged? It is currently not possible to paste a code snippet containing indentation into the REPL on Windows. I think this is a pretty serious limitation, because many tools (e.g. Visual Studio Code) rely on this mechanism to run selected code portions. I was hoping that this fix would make it into 3.13.1, but unfortunately this was not the case. Currently, this forces people on 3.13 to either disable the new REPL experience or switch to 3.12, both of which are very suboptimal workarounds (because the new REPL is great!).

We need someone with windows knowledge to validate the PR. Unfortunately I don't have a windows machine or enough knowledge of the platform to validate the correctness.

So if you can review the PR or get some windows expert to do we probably can continue landing it

pablogsal · 2025-01-22T12:51:57Z

CC @ambv @zooba

encukou

I've made the change to enable bracketed mode (if VT is supported).

I've tested on Windows 10 on Command Prompt (PS & cmd), VS Code embedded terminal (PS & cmd), and conhost.exe. Bracketed paste works on the first two (there is no confirmation dialog when pasting in multiple lines and the text is not auto-indented; pasting ends the F3 paste mode). On conhost.exe, ~~bracketed~~ paste works as before (dialog appears, text is auto-indented; F3 needs to be ended with another F3).
Ctrl+arrows, PgUp/PgDn, Alt+. still work.

(I found other behaviour that's surprising to me, including a bug, but no unintended changes to the status quo.)

cbrnr · 2025-01-23T15:29:51Z

I just wanted to thank everyone for helping get this PR merged! You are awesome! ❤️

Co-authored-by: Dustin L. Howett <dustin@howett.net>

wheeheee

🙂 hope this PR gets merged soon

Co-authored-by: wheeheee <104880306+wheeheee@users.noreply.github.com>

encukou · 2025-02-05T10:17:25Z

I plan to take some time this or next week to write the tests.

The patch decorator was being called even on the skipped test.

encukou · 2025-02-17T13:47:23Z

I added base_eventqueue, since the unix and Windows implementations are now identical except the __init__.
@ambv, does this look OK?

encukou · 2025-02-20T13:07:09Z

I'll merge next week if there are no objections.

miss-islington-app · 2025-05-05T16:57:59Z

Thanks @y5c4l3 for the PR, and @ambv for merging it 🌮🎉.. I'm working now to backport this PR to: 3.13.
🐍🍒⛏🤖

…honGH-124119) To support virtual terminal mode in Windows PYREPL, we need a scanner to read over the supported escaped VT sequences. Windows REPL input was using virtual key mode, which does not support terminal escape sequences. This patch calls `SetConsoleMode` properly when initializing and send sequences to enable bracketed-paste modes to support verbatim copy-and-paste. (cherry picked from commit a65366e) Co-authored-by: Y5 <124019959+y5c4l3@users.noreply.github.com> Signed-off-by: y5c4l3 <y5c4l3@proton.me> Co-authored-by: Petr Viktorin <encukou@gmail.com> Co-authored-by: Pablo Galindo Salgado <Pablogsal@gmail.com> Co-authored-by: Dustin L. Howett <dustin@howett.net> Co-authored-by: wheeheee <104880306+wheeheee@users.noreply.github.com>

bedevere-app · 2025-05-05T16:58:10Z

GH-133457 is a backport of this pull request to the 3.13 branch.

…-124119) (GH-133457) To support virtual terminal mode in Windows PYREPL, we need a scanner to read over the supported escaped VT sequences. Windows REPL input was using virtual key mode, which does not support terminal escape sequences. This patch calls `SetConsoleMode` properly when initializing and send sequences to enable bracketed-paste modes to support verbatim copy-and-paste. (cherry picked from commit a65366e) Co-authored-by: Y5 <124019959+y5c4l3@users.noreply.github.com> Signed-off-by: y5c4l3 <y5c4l3@proton.me> Co-authored-by: Petr Viktorin <encukou@gmail.com> Co-authored-by: Pablo Galindo Salgado <Pablogsal@gmail.com> Co-authored-by: Dustin L. Howett <dustin@howett.net> Co-authored-by: wheeheee <104880306+wheeheee@users.noreply.github.com>

tpnga95 · 2025-08-28T04:13:38Z

I still get that error even using the latest version 3.13.7. Is there any solution?

encukou · 2025-08-28T08:30:23Z

What's your setup? Are you using Windows Terminal?

A workaround is using “paste mode” (the F3 key) for pasting text to the console.

y5c4l3 requested review from ambv, lysnikolaou and pablogsal as code owners September 16, 2024 10:49

bedevere-appBot added the awaiting review label Sep 16, 2024

bedevere-appBot mentioned this pull request Sep 16, 2024
Pasting a function definition does not work in 3.13 REPL with Windows Terminal #124096
Closed

y5c4l3 force-pushed the windows-vt branch from 1ad693a to 5bea85dCompare September 16, 2024 10:59

vstinner reviewed Sep 16, 2024
View reviewed changes

Comment threadLib/_pyrepl/windows_console.py Outdated

y5c4l3 force-pushed the windows-vt branch 2 times, most recently from 42a48dc to 13bb26fCompare September 19, 2024 12:31

y5c4l3 force-pushed the windows-vt branch 5 times, most recently from 3c1502a to 718110fCompare September 20, 2024 18:07

y5c4l3 added 3 commits September 28, 2024 08:16

NEWS for Windows REPL virtual terminal support
3db0eb7
Signed-off-by: y5c4l3 <y5c4l3@proton.me>

Add Windows REPL virtual terminal queue
6d96558
To support virtual terminal mode in Windows PYREPL, we need a scanner to read over the supported escaped VT sequences. Signed-off-by: y5c4l3 <y5c4l3@proton.me>

y5c4l3 force-pushed the windows-vt branch from 718110f to 0fed3f7Compare September 28, 2024 00:22

cbrnr mentioned this pull request Oct 24, 2024
Python3.13 All functions fail to send: IndentationError: unexpected indent microsoft/vscode-python#24256
Closed

anthonykim1 mentioned this pull request Dec 2, 2024
KeyboardInterrupt When Running Selection/Line in Python Terminal with 'Shift+Enter' microsoft/vscode-python#24422
Closed

encukou approved these changes Jan 23, 2025
View reviewed changes

bedevere-appBot added awaiting merge and removed awaiting review labels Jan 23, 2025

DHowett reviewed Jan 23, 2025
View reviewed changes

Comment threadLib/_pyrepl/windows_eventqueue.py Outdated

Update Lib/_pyrepl/windows_eventqueue.py
290aa5e
Co-authored-by: Dustin L. Howett <dustin@howett.net>

wheeheee reviewed Jan 24, 2025
View reviewed changes

Comment threadLib/_pyrepl/windows_eventqueue.py Outdated
Comment threadLib/_pyrepl/windows_eventqueue.py Outdated
Comment threadMisc/NEWS.d/next/Library/2024-09-16-17-03-52.gh-issue-124096.znin0O.rst Outdated

encukou added OS-windows topic-repl Related to the interactive shell labels Jan 24, 2025

encukouand others added 2 commits February 5, 2025 10:16

Apply suggestions from code review
2b90017
Co-authored-by: wheeheee <104880306+wheeheee@users.noreply.github.com>

Merge branch 'main' into windows-vt
74f8560

encukou added 4 commits February 14, 2025 16:58

Deduplicate common EventQueue code; run the tests on both OSes
cfc66eb

Merge in the main branch
0ccf330

Adjust the test
2867297
The patch decorator was being called even on the skipped test.

Annotation, not default...
b15261b

devdanzin mentioned this pull request Feb 22, 2025
Pasting in new REPL is slow #130328
Closed

ambv merged commit a65366e into python:mainFeb 23, 2025

bedevere-appBot removed the awaiting merge label Feb 23, 2025

chris-eibl mentioned this pull request Apr 12, 2025
GH-132439: Fix REPL swallowing characters entered with AltGr on cmd.exe #132440
Merged

ambv added the needs backport to 3.13 bugs and security fixes label May 5, 2025

bedevere-appBot removed the needs backport to 3.13 bugs and security fixes label May 5, 2025

Uh oh!

Uh oh!

Conversation

y5c4l3 commented Sep 16, 2024• edited by bedevere-app BotLoading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

ghost commented Sep 16, 2024• edited by ghost Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

Uh oh!

pablogsal commented Sep 19, 2024

Uh oh!

zooba commented Sep 20, 2024

Uh oh!

y5c4l3 commented Sep 20, 2024

Uh oh!

y5c4l3 commented Sep 28, 2024

Uh oh!

cbrnr commented Jan 14, 2025

Uh oh!

pavlovc2 commented Jan 15, 2025

Uh oh!

wheeheee commented Jan 17, 2025

Uh oh!

pablogsal commented Jan 22, 2025

Uh oh!

pablogsal commented Jan 22, 2025

Uh oh!

encukou left a comment • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

cbrnr commented Jan 23, 2025

Uh oh!

Uh oh!

wheeheee left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

encukou commented Feb 5, 2025

Uh oh!

encukou commented Feb 17, 2025

Uh oh!

encukou commented Feb 20, 2025

Uh oh!

miss-islington-appBot commented May 5, 2025

Uh oh!

bedevere-appBot commented May 5, 2025

Uh oh!

tpnga95 commented Aug 28, 2025

Uh oh!

encukou commented Aug 28, 2025

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

13 participants

y5c4l3 commented Sep 16, 2024•
edited by bedevere-app Bot
Loading

ghost commented Sep 16, 2024•
edited by ghost
Loading

encukou left a comment •
edited
Loading