`debugpy.listen` fails in VS Code terminal

[samjijina]

After the latest release of VSCode, my debugging workflow has broken down due to the new feature "No‐Config Debugging". I would like to disable this feature as I use the pip installed and managed debugpy.

(My workflow is on a cluster managed by Slurm and VSCode's debugpy does not work well. Further, I use Anaconda to manage my python env)

[karthiknadig]

@samjijina How are you running the debugger? the no-config debugger should only impact you if you run debugpy <script> but if you run python -m debugpy <script> it should still use the one that is installed in your environment.

[samjijina]

@karthiknadig
I am running it using the following command:
python -m debugpy --listen 0.0.0.0:1239 --wait-for-client <file_name.py>

Further, I get the same error even in an interactive python interpreter (such as IPython):

$ which debugpy
~/.conda/envs/<env_name>/bin/debugpy
$ which python
~/.conda/envs/<env_name>/bin/python

[karthiknadig]

When importing the debugpy will come from the sys.path. Can you try this?

> import debugpy
> debugpy.__file__

Here is what I see from the terminal, where the no-config debug is enabled:

The first command shows that debugpy as a command works. Then I do a import debugpy from the same environment, and it does not work. Then I install debugpy and try import debugpy again. I was checking here to ensure that we were not accidentally adding the build-in debugpy to PYTHONPATH in terminal. If you try the above and it says site-packages then the issue is that debugpy itself might be failing for you.

[samjijina]

debugpy works fine when I use it in a non-VSCode terminal. For example, in the image below I am using Ubuntu's terminal with a SSH connection to a node in my cluster:

However, the error is occurring when using VSCode's terminal as shown in the image below:

Here are the environment contributors in VSCode:

[karthiknadig]

As far as I can tell, none of those contributors interfere. As you can see the debugpy here is coming from the site-packages, the one that is loaded is the one that is being used. I can think of two things that could cause issues when running from VS Code terminal, 1) port forwarding, 2) shell integration.

Try disabling these settings, and see if that helps:

[samjijina]

I disabled both those settings but the error still persists.

[karthiknadig]

Transferring this to debugpy to investigate while it is failing with File not found when doing debugpy.listen in VS Code Terminal.

[rchiodo]

I get a similar error in a VS code terminal (only in the stable version):

>>> import debugpy
>>> debugpy.listen(5678)
0.01s - Debugger warning: It seems that frozen modules are being used, which may
0.00s - make the debugger miss breakpoints. Please pass -Xfrozen_modules=off
0.00s - to python to disable frozen modules.
0.00s - Note: Debugging will proceed. Set PYDEVD_DISABLE_FILE_VALIDATION=1 to disable this validation.
Traceback (most recent call last):
  File "<stdin>", line 1, in <module>
  File "C:\Users\rchiodo\source\repos\pyrx-3\.venv\Lib\site-packages\debugpy\public_api.py", line 31, in wrapper
    return wrapped(*args, **kwargs)
           ^^^^^^^^^^^^^^^^^^^^^^^^
  File "C:\Users\rchiodo\source\repos\pyrx-3\.venv\Lib\site-packages\debugpy\server\api.py", line 132, in debug
    log.reraise_exception("{0}() failed:", func.__name__, level="info")
  File "C:\Users\rchiodo\source\repos\pyrx-3\.venv\Lib\site-packages\debugpy\server\api.py", line 130, in debug
    return func(address, settrace_kwargs, **kwargs)
           ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
  File "C:\Users\rchiodo\source\repos\pyrx-3\.venv\Lib\site-packages\debugpy\server\api.py", line 258, in listen
    raise RuntimeError(str(endpoints["error"]))
RuntimeError: Can't listen for client connections: [WinError 10013] An attempt was made to access a socket in a way forbidden by its access permissions

I just switch to a different port and it works.

>>> debugpy.listen(5679)
('127.0.0.1', 5679)