Repository navigation
Debugger commands sent to terminal get swallowed by previous terminal command #67692
Description
- VSCode Version:Version 1.31.0-insider (1.31.0-insider)
- OS Version:Mac
Steps to Reproduce:
- Install latest version of Python Extension
- Install python
- Brew install
pipenv - Open a folder in VSC
- Add a python file with a simple
print("Hello")statement - Open the terminal in VSC and type the command
pipenv shell- This will create a virtual environment for the current folder
- Open another terminal and notice how the Python extension will automatically add
pipenv shell, causing the previously created environment to get activated in this new terminal. - Reload VSC
- The above
pipenvenvironment will now be automatically selected - If not, please use the command
Select Python Interpreter - From the list, of interpreters select the interpreter with the name same as the folder name you are in.
- The above
- Debug the python file
- The terminal will now open automatically
- Python Extension will send the text
pipenv shellto activate the environment in the terminal - VSC Debugger sends the necessary commands to the terminal
- Unfortunately there's a race condition here,
pipenv shellhas not yet completed, and the commands sent by VSC debugger get swallowed up
- End result, debugger doesn't start
Causes:
- There's no way to determine when terminal has completed processing previously sent commands.
- VSC is sending messages to the terminal, when its busy
Solutions:
- Python extension can take complete control of opening terminals, etc and not use
runInTerminalrequest (i.e. python extension re-invent the wheel). - VSC DAP accepts additional commands that need to be invokved in the
runInTerminalrequest.
Currently we can only sendargs, how about extending this to sendcommandsas well.
This way the extension can send some custom commands that need to be executed before the VSC debugger commands. I.e. chain them together.
Reacted by Joshua Sleeper
Activity
Tyriar commentedon Feb 1, 2019
See #67693 (comment)
brettcannon commentedon Jul 9, 2019
To help kickstart this again, the two ideas we had today for solving our debugger issues (if you all would be so gracious as to implement one of them 😉 ) are:
Tyriar commentedon Jul 10, 2019
I haven't really looked into DAP much, but I had a look at how runInTerminal works. You might be able to pass in this as the first arg in the
argsarray to string together multiple commands?sh -c "pipenv shell && debug"cmd.exe /k ...or equivalent in PSAlso created #77110 and #77111 after looking into the feature.
brettcannon commentedon Jul 10, 2019
Will that quote what's in those quotes correctly? E.g. if one of the args that you need has a space will that get quoted appropriately in that string you pass to
sh?Tyriar commentedon Jul 10, 2019
Brett Cannon (@brettcannon) provided the quotes get escaped correctly in debug I would think so.
weinand commentedon Jul 26, 2019
I've fixed issues #77110 and #77111, but they don't really help with the issue at hand.
As Daniel Imms (@Tyriar) has pointed out in #67693 (comment), there is not much we can do here. His recommendation in #67692 (comment) is the way to go.
Quoting should work fine; if not, please file separate issues for them.