Allow execute on enter and Intellisense for native REPL with notebook UI #23442

anthonykim1 · 2024-05-16T03:06:25Z

"Smartly" allow execute on enter for the #23235 experiment.
User should be able to execute when they press enter on text input box of interactive window trigger from Python extension, whereas we would "wait" and allow insertion of new line after detecting user's Python command is not complete.

When the user finally types enter again on a blank line, we should just proceed to execute whatever code, regardless of whether it is complete/valid or not to replicate Python's original interactive REPL behavior.

Basically creating Python command and registering that for keybinding of 'Enter'.
This would conditionally call interactive.execute which would then eventually call our execute handler contributed from Python n extension's REPL controller, or go ahead and insert,pass in Enter to the text input box to allow user to type "complete" code.

This PR only intends to implement/add changes regarding execute on enter logic, adding Intellisense support, and also adding things into disposables so they can be properly disposed. Trying to also add setting to allow toggling on/off to send Python command to Terminal or IW REPL if the user is in experiment.

Handling of interrupt for windows should be on separate PR.
Test will be added later as separate PR.

package.json

src/client/repl/replCommands.ts

karthiknadig · 2024-05-20T18:58:47Z

This looks like the package.nls.json file is missing an entry.

python_files/ctrlc.py

anthonykim1 · 2024-05-21T22:06:12Z

package.json

+            {
+                "command": "python.execInREPLEnter",
+                "key": "enter",
+                "when": "activeEditor == 'workbench.editor.interactive'"


should I also be adding !config.interactiveWindow.executeWithShiftEnter
here in the when clause? @amunger

For some reason, adding this when clause in makes the whole command get ignored when user presses enter. (I have not personally set up any shift enter keybinding override on my machine).

Found why it is not working..(As in figured out why after adding !config.interactiveWindow.executeWithShiftEnter to when clause would not let user execute with enter by default. Basically user has to have explicit "interactiveWindow.executeWithShiftEnter": false, in their settings.json.

Value for "interactiveWindow.executeWithShiftEnter" seems to be true by default, but Python extension would ideally want the default to be false. Should Python extension somehow override the value of this?

I was planning to switch the default, but I didn't get around to putting in the migration logic for jupyter IW users. So you should be able to leave it as is for now (and manually set the setting), and I'll still try to make the switch

@amunger When you say "leave it as is for now" and update the setting, do you still want the !config.interactiveWindow.executeWithShiftEnter clauses in the "when" condition, and also have Python extension manually set the "interactiveWindow.executeWithShiftEnter": false, for users?
OR
just exclude using !config.interactiveWindow.executeWithShiftEnter in when clause

We still need the when clause here, otherwise users who want to use shift+enter to execute will not be able to use enter for a newline.
By manually, I meant users will individually need to change that setting until the default is switched over, don't change anyone's configuration since we were planning on doing that in the other direction for jupyter IW users.

got it, it should be resolved with: 910783b

package.nls.json

Co-authored-by: Courtney Webster <60238438+cwebster-99@users.noreply.github.com>

karthiknadig · 2024-05-23T00:48:28Z

package.json

@@ -628,6 +628,12 @@
                    "scope": "resource",
                    "type": "boolean"
                },
+                "python.REPL.sendToNativeREPL": {


This does not have the experimental tag?

Right, this is the settings which the value is ultimately overridden by the experiment value "pythonRunREPL".
Initially thought everything was just going to be experiment, but got convoluted with going the settings based experiment route

Following:

We also should get rid of the experiment item that we added for this, as the setting itself can be controlled via experiment by using the settings tag.

I think I would need to replace of existing "pythonRunREPL" from just experiment to settings (basically replace the setting tag from sendToNativeREPL to pythonRunREPL ). Would that allow us to leave the control tower as is? @cwebster-99

I think it would be the fully require name python.REPL.sendToNativeREPL.

package.json

package.nls.json

src/client/extensionActivation.ts

src/client/repl/pythonServer.ts

src/client/repl/replCommands.ts

karthiknadig · 2024-05-23T01:13:35Z

We also should get rid of the experiment item that we added for this, as the setting itself can be controlled via experiment by using the settings tag.

Co-authored-by: Karthik Nadig <kanadig@microsoft.com>

anthonykim1 · 2024-05-23T22:43:23Z

I think I addressed all the requested changes. I will put up additional PR to better refactor this.

karthiknadig · 2024-05-23T23:01:04Z

src/client/repl/replCommands.ts

            }
        }),
    );
 }
+
+export async function registerReplExecuteOnShiftEnter(): Promise<void> {
+    commands.registerCommand(Commands.Exec_In_REPL_Shift_Enter, async () => {


This needs a disposable, similar to other commands registered.

Should be good with: e270705

… UI (#23442) "Smartly" allow execute on enter for the #23235 experiment. User should be able to execute when they press enter on text input box of interactive window trigger from Python extension, whereas we would "wait" and allow insertion of new line after detecting user's Python command is not complete. When the user finally types enter again on a blank line, we should just proceed to execute whatever code, regardless of whether it is complete/valid or not to replicate Python's original interactive REPL behavior. Basically creating Python command and registering that for keybinding of 'Enter'. This would conditionally call interactive.execute which would then eventually call our execute handler contributed from Python n extension's REPL controller, or go ahead and insert,pass in Enter to the text input box to allow user to type "complete" code. This PR only intends to implement/add changes regarding execute on enter logic, adding Intellisense support, and also adding things into disposables so they can be properly disposed. Trying to also add setting to allow toggling on/off to send Python command to Terminal or IW REPL if the user is in experiment. Handling of interrupt for windows should be on separate PR. Test will be added later as separate PR. --------- Co-authored-by: Courtney Webster <60238438+cwebster-99@users.noreply.github.com> Co-authored-by: Karthik Nadig <kanadig@microsoft.com>

anthonykim1 added 2 commits May 15, 2024 20:05

start adding command

5f279f1

allow execute on enter and execute on blank space with hard coded bool

7992d4b

karthiknadig reviewed May 16, 2024

View reviewed changes

package.json Outdated Show resolved Hide resolved

package.json Outdated Show resolved Hide resolved

src/client/repl/replCommands.ts Outdated Show resolved Hide resolved

anthonykim1 self-assigned this May 17, 2024

anthonykim1 added the area-repl label May 17, 2024

anthonykim1 added 6 commits May 17, 2024 00:33

remove unintended enum to experiment

31f7db4

change to TODO

4523502

compile() arg 1 must be a string, bytes or AST object

6defed9

WORKING --PROPERLY CHECKING IF SOMETHING IS VALID AND COMPLETE

ac7cc8c

Try to handle interrupt on windows

6389fdb

hide execute on enter from command palette

e3b974c

This was referenced May 20, 2024

Need for notebook pre-execute handler microsoft/vscode#212427

Closed

execution commands for contributed REPLs microsoft/vscode#212051

Closed

add execInREPLEnter to package.nls.json

3039670

karthiknadig reviewed May 20, 2024

View reviewed changes

python_files/ctrlc.py Outdated Show resolved Hide resolved

anthonykim1 added the feature-request Request for new features or functionality label May 20, 2024

anthonykim1 added 6 commits May 20, 2024 17:48

temp save interactive.open and multi-line

e6034b7

temp save --> sending to IW, intellisense pt2

ab490dd

refactoring, adding disposables

e25ec45

cleanup

58b7772

remove handling Windows interrupt for now

931f3bf

more cleanup

f1dd8a0

anthonykim1 changed the title ~~Allow execute on enter for IW REPL~~ Allow execute on enter for IW REPL and Intellisense May 21, 2024

anthonykim1 added the skip package*.json package.json and package-lock.json don't both need updating label May 21, 2024

anthonykim1 changed the title ~~Allow execute on enter for IW REPL and Intellisense~~ Allow execute on enter and Intellisense for IW REPL May 21, 2024

anthonykim1 added the skip tests Updates to tests unnecessary label May 21, 2024

anthonykim1 commented May 21, 2024

View reviewed changes

rename variable

55cad61

anthonykim1 marked this pull request as ready for review May 21, 2024 22:12

karthiknadig reopened this May 22, 2024

cwebster-99 reviewed May 22, 2024

View reviewed changes

package.nls.json Outdated Show resolved Hide resolved

cwebster-99 reviewed May 22, 2024

View reviewed changes

package.nls.json Outdated Show resolved Hide resolved

anthonykim1 and others added 2 commits May 22, 2024 16:46

remove execInREPLEnter from package.json and nls.json

c0bc3b8

Update package.nls.json

f512670

Co-authored-by: Courtney Webster <60238438+cwebster-99@users.noreply.github.com>

karthiknadig reviewed May 23, 2024

View reviewed changes

karthiknadig requested changes May 23, 2024

View reviewed changes

anthonykim1 and others added 2 commits May 22, 2024 18:55

match setting python.sendToNativeREPL.description

1b2c451

Co-authored-by: Karthik Nadig <kanadig@microsoft.com>

Update package.nls.json

d369f11

Co-authored-by: Karthik Nadig <kanadig@microsoft.com>

anthonykim1 marked this pull request as draft May 23, 2024 02:04

anthonykim1 and others added 7 commits May 22, 2024 23:01

Update src/client/repl/pythonServer.ts

8b27c2f

Co-authored-by: Karthik Nadig <kanadig@microsoft.com>

switch checkValidCommand to return boolean

a745cb1

Update src/client/repl/replCommands.ts

393d2fd

Co-authored-by: Karthik Nadig <kanadig@microsoft.com>

Stop using var!

0cffa5a

delete stale experiment, properly get setting

a6036cd

refactor registerReplCommands

57b2bdd

clean up more

0788e99

anthonykim1 marked this pull request as ready for review May 23, 2024 20:35

allow users with shift+enter functional

910783b

anthonykim1 changed the title ~~Allow execute on enter and Intellisense for IW REPL~~ Allow execute on enter and Intellisense for native REPL with IW UI May 23, 2024

anthonykim1 changed the title ~~Allow execute on enter and Intellisense for native REPL with IW UI~~ Allow execute on enter and Intellisense for native REPL with notebook UI May 23, 2024

karthiknadig reviewed May 23, 2024

View reviewed changes

properly add to disposables

e270705

karthiknadig approved these changes May 23, 2024

View reviewed changes

anthonykim1 merged commit 75cc52b into microsoft:main May 24, 2024
42 checks passed

This was referenced May 24, 2024

REPL input box intellisense #23333

Closed

Create setting for Python execution to be on Native REPL or Terminal #23458

Closed

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Allow execute on enter and Intellisense for native REPL with notebook UI #23442

Allow execute on enter and Intellisense for native REPL with notebook UI #23442

anthonykim1 commented May 16, 2024 •

edited

Loading

karthiknadig commented May 20, 2024

anthonykim1 May 21, 2024

amunger May 21, 2024

anthonykim1 May 21, 2024

anthonykim1 May 22, 2024 •

edited

Loading

amunger May 22, 2024

anthonykim1 May 22, 2024 •

edited

Loading

amunger May 23, 2024

anthonykim1 May 23, 2024

karthiknadig May 23, 2024

anthonykim1 May 23, 2024 •

edited

Loading

karthiknadig May 23, 2024 •

edited by anthonykim1

Loading

karthiknadig commented May 23, 2024

anthonykim1 commented May 23, 2024

karthiknadig May 23, 2024

anthonykim1 May 23, 2024 •

edited

Loading

Allow execute on enter and Intellisense for native REPL with notebook UI #23442

Allow execute on enter and Intellisense for native REPL with notebook UI #23442

Conversation

anthonykim1 commented May 16, 2024 • edited Loading

karthiknadig commented May 20, 2024

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

anthonykim1 May 22, 2024 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

anthonykim1 May 22, 2024 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

anthonykim1 May 23, 2024 • edited Loading

Choose a reason for hiding this comment

karthiknadig May 23, 2024 • edited by anthonykim1 Loading

Choose a reason for hiding this comment

karthiknadig commented May 23, 2024

anthonykim1 commented May 23, 2024

Choose a reason for hiding this comment

anthonykim1 May 23, 2024 • edited Loading

Choose a reason for hiding this comment

anthonykim1 commented May 16, 2024 •

edited

Loading

anthonykim1 May 22, 2024 •

edited

Loading

anthonykim1 May 22, 2024 •

edited

Loading

anthonykim1 May 23, 2024 •

edited

Loading

karthiknadig May 23, 2024 •

edited by anthonykim1

Loading

anthonykim1 May 23, 2024 •

edited

Loading