KeyboardInterrupt When Running Selection/Line in Python Terminal with 'Shift+Enter'

[CardonaEA]

Environment:
Operating System: Windows 11
VS Code Version: 1.94.0
Python Extension Version: v2024.16.0

Steps to reproduce:

Default setting: the 'shift+enter' keyboard shortcut Runs Selection/Line in Python REPL.

1. Ensure that the setting "python.REPL.sendToNativeREPL" is set to false. (This setting leads to the 'Shift+Enter' keyboard shortcut running the Selection/Line in the Python Terminal.)
2. Open a Python script file (.py) in VS Code.
3. Highlight a line or selection of code in the editor.
4. Press Shift+Enter to run the selection or line in the Python Terminal.

Expected Behavior:
The selected line or code executes in the Python Terminal without any interruptions or errors.

Actual Behavior:
A KeyboardInterrupt is outputted before the selection or line continues executing in the Python Terminal.

Additional Information:

• The issue occurs consistently when running a selection or line with Shift+Enter with the specified configuration.
• The KeyboardInterrupt appears even when the execution continues after the interrupt message.
• If the execution starts from a Python terminal, an error message is displayed, but the KeyboardInterrupt does not appear anymore.
• The issue can be also triggered by setting a different keyboard shortcut.

Screen.Recording.2024-10-04.211253.mp4

Screen.Recording.2024-10-04.211730.mp4

[levibaguley]

I'm seeing the same thing. I rolled back to 14.1 and it doesn't do that anymore. Click dropdown on "uninstall" to roll back and uncheck "Auto update". I'm planning on coming back here at some point to check if it's been fixed.

[CardonaEA]

Yes, no issue with v2024.14.1. Thanks.

[lenarddome]

I was experiencing the same issue and can confirm that rolling back to previous versions gets rid of it.

[nbwosm]

Thanks @levibaguley! I had the same issue and this fixed.

[breininger88]

Phew. Same issue and this worked. Thanks!

[AdrianNewbiePython]

Hi. Thank you all for your contributions.
Just as it is shown in the video of @CardonaEA , the error started me after I disabled the REPL to be executed after the keyboard shortcut SHIFT + ENTER.

However, even specifying in "Preferences: Open Workplace Settings (JSON)" the setting "python.REPL.sendToNativeREPL" to false, the KeyboardInterrupt still shows up. I don't know if it is related to the issue, but even if I still turn it to false in "Preferences: Open Workplace Settings (JSON)", in the page "Preferences: Open Default Settings (JSON)" (which I cannot edit), the setting "python.REPL.sendToNativeREPL" is still set true.

[kcerniauskas3]

Issue remains in v2024.18.0.

[jafar-the-amazing]

Rolling Back did fix the issue and as @kcerniauskas3 said ; it still remains in v2024.18.0.

[dharmatech]

I'm seeing the same thing. I rolled back to 14.1 and it doesn't do that anymore. Click dropdown on "uninstall" to roll back and uncheck "Auto update". I'm planning on coming back here at some point to check if it's been fixed.

I see folks have rolled back to 14.1 to workaround the issue.

But is it really required? Yes, the KeyboardInterrupt appears in the console, but is it actually causing a functional issue besides that?

I'm using version v2024.18.0 and yes the KeyboardInterrupt is happening, but other than that the extension appears to work OK.

[rodo-nunez]

I'm seeing the same thing. I rolled back to 14.1 and it doesn't do that anymore. Click dropdown on "uninstall" to roll back and uncheck "Auto update". I'm planning on coming back here at some point to check if it's been fixed.

I see folks have rolled back to 14.1 to workaround the issue.

But is it really required? Yes, the KeyboardInterrupt appears in the console, but is it actually causing a functional issue besides that?

I'm using version v2024.18.0 and yes the KeyboardInterrupt is happening, but other than that the extension appears to work OK.

Yes, it is. At least for me.

That KeyboardInterrupt error was stopping my session after a real error or warning. So I was not able to debug my code without losing a lot of time and rerunning everything again and again. So I stopped using the extension and went back to another IDE not based on VSCode.

[anthonykim1]

Thanks everyone for the input here.
Is everyone on Windows? I can't seem to repro on my MacOS ARM machine.
I DO see the keyboard interrupt on my Windows machine though.

[levibaguley]

Yes, Windows 10 for me

[anthonykim1]

I see, can folks also give 2024.16.1 a try and see whether it also adds the keyboard interrupt or not?
I personally don't see the keyboard interrupt on 16.1 but just wanted to make sure. Make sure to restart extension and run command

Edit: After restarting extension, and reloading with Python clear cache, I can repro this on 16.1 too

'Python: Clear Cache and Reload' via command palette (cmd/ctrl + shift + p)
Trying to narrow down the cause here :) Thanks in advance.

[rodo-nunez]

it does fail for me

[rodo-nunez]

v2024.15.2024092702 fails for me

v2024.15.2024090406 works fine for me

Probably the bug was introduced somewhere in-between

[anthonykim1]

Thanks for this @rodo-nunez This is incredibly helpful!
I will go further investigate this and try to come up with the fix. Will let you all know if I have any updates/fix :)

[rodo-nunez]

Using binary search:

v2024.15.2024091801 failed
v2024.15.2024091202 worked fine
v2024.15.2024091601 failed
v2024.15.2024091301 failed

So my guess is that the bug was introduced on v2024.15.2024091301.

[rodo-nunez]

@anthonykim1 also, I was reproducing that using the "Python: Run Selection/Line in Python Terminal" command. I always change it to Ctrl+Enter, to be able to freely choose between "Python: Run Selection/Line in Python Terminal" and "Python: Run Selection/Line in Python REPL" whenever I want.

On v2024.15.2024091301, I don't see problems with the REPL, only with the Terminal. But I don't use the REPL that much.

[anthonykim1]

Ok, thanks to @rodo-nunez I was able to figure out where this is coming from quickly.

Its from this PR: https://github.com/microsoft/vscode-python/pull/24078/files
where we switched over to use executeCommand instead of sendText internally to send over Python code for Terminal REPL.
Now will try to come up with a fix without breaking people.

For now, the workaround to not get this keyboard interrupt would be going to setting and then disabling shell integration:

And Yes! the REPL you mentioned in the editor is our new native REPL. It has intellisense and syntax highlighting, autocomplete so feel free to give it a try :)

[nbwosm]

@anthonykim1 I upgraded to v2024.18.0 and disabled shell integration and can confirm that I am not getting the KeyboardInterupt error. Thanks.

Follow-up: After having made these changes, I noticed a modest amount of latency in sending the code to the Python terminal via Shift + Enter and getting executed. I have reverted to v2024.14.1 and undone the shell disable. This was most noticeable executing matplotlib plots.

[stats9]

I'm using version 2024.18.0 and I used the prerelease version, but unfortunately for every line of code I run through the script, I have this issue keyboardInterrupt.
the shortcut I defined is CTRL + Enter, but the shortcut I changed is the same.
I really don't know what idea I can implement to solve this problem.

update:

i add this line to my jason settings (workspace jason settings):
"terminal.integrated.shellIntegration.enabled": false,
and fix my problem!
i disable it shell integration actually.

[rzhao271]

I still see KeyboardInterrupt with a Python 3.11.9 venv on Windows and with python.terminal.shellIntegration.enabled set to true.

Python 3.11.9 (tags/v3.11.9:de54cf5, Apr  2 2024, 10:12:12) [MSC v.1938 64 bit (AMD64)] on win32
Type "help", "copyright", "credits" or "license" for more information.
>>> 
KeyboardInterrupt
>>> ids=["test adding", "2      +V", "\n ffda"],
>>> 
KeyboardInterrupt
>>> if num % 4 == 0:
...     subprocess.run(["python", "-c", "for i in range(0, 10000): print(i)"])
... 

I do not see it when python.terminal.shellIntegration.enabled is set to false.

[anthonykim1]

do you have shell integration enabled in upper shell?
This general terminal one @rzhao271

[anthonykim1]

Further fix is on the way for folks using windows in regards to preventing keyboard interrupt #24542
Note that indentation error for windows still persists as explained above but there is already PR up in cpython itself to address indentation error for windows REPL in terminal folks.

[dbaeumer]

I still see the KeyboardInterrupt

[dbaeumer]

I guess it needs a new Python extensions.

[dbaeumer]

@anthonykim1 I will reopen this. Please close again when ready for verification.

[dbaeumer]

My fault. Was not on latest insiders.

[dbaeumer]