Poetry virtualenv not activated properly with zsh on macOS

[pquadri]

Type: Bug

Behaviour

Expected vs. Actual

The shell loads a virtualenv with the correct PATH variables

Steps to reproduce:

1. set up .zshrc file that overrides the default PATH
2. open VsCode with a virtualenv
3. the PATH is overriden by the .zshrc file and you have to manually activate the environment to fix it

Diagnostic data

• Python version (& distribution if applicable, e.g. Anaconda): 3.10.9
• Type of virtual environment used (e.g. conda, venv, virtualenv, etc.): Poetry
• Value of the python.languageServer setting: Pylance

Output for Python in the Output panel (View→Output, change the drop-down the upper-right of the Output panel to Python)

Extension log: here

User Settings

venvFolders: "<placeholder>"

languageServer: "Pylance"

Extension version: 2024.0.1
VS Code version: Code 1.86.1 (Universal) (31c37ee8f63491495ac49e43b8544550fbae4533, 2024-02-07T09:09:01.236Z)
OS version: Darwin arm64 23.3.0
Modes:

System Info

Item	Value
CPUs	Apple M2 Pro (10 x 24)
GPU Status	2d_canvas: enabled canvas_oop_rasterization: enabled_on direct_rendering_display_compositor: disabled_off_ok gpu_compositing: enabled multiple_raster_threads: enabled_on opengl: enabled_on rasterization: enabled raw_draw: disabled_off_ok skia_graphite: disabled_off video_decode: enabled video_encode: enabled webgl: enabled webgl2: enabled webgpu: enabled
Load (avg)	1, 3, 4
Memory (System)	32.00GB (1.41GB free)
Process Argv	--crash-reporter-id 0993b21c-ed0f-4a13-81f3-8f189d042a2f
Screen Reader	no
VM	0%

A/B Experiments

vsliv368cf:30146710
vspor879:30202332
vspor708:30202333
vspor363:30204092
vscoreces:30445986
vscod805cf:30301675
binariesv615:30325510
vsaa593:30376534
py29gd2263:30899288
c4g48928:30535728
azure-dev_surveyone:30548225
a9j8j154:30646983
962ge761:30959799
pythongtdpath:30769146
welcomedialog:30910333
pythonidxpt:30866567
pythonnoceb:30805159
asynctok:30898717
pythontestfixt:30902429
pythonregdiag2:30936856
pyreplss1:30897532
pythonmypyd1:30879173
pythoncet0:30885854
h48ei257:30961340
pythontbext0:30879054
accentitlementst:30887150
dsvsc016:30899300
dsvsc017:30899301
dsvsc018:30899302
b1063948:30958189
a89i1917:30961429
3ef8e399:30962115

[pquadri]

I think the issue is just the PATH environment variable being changed in my .zshrc file and VsCode initializing the virtualenv before that happens (somehow), but it was working properly until last week.
Terminal before opening VsCode:

/Users/paolo.quadri/.local/bin:/Users/paolo.quadri/.asdf/shims:/opt/homebrew/opt/asdf/libexec/bin:/opt/homebrew/bin:/opt/homebrew/sbin:/usr/local/bin:/System/Cryptexes/App/usr/bin:/usr/bin:/bin:/usr/sbin:/sbin:/var/run/com.apple.security.cryptexd/codex.system/bootstrap/usr/local/bin:/var/run/com.apple.security.cryptexd/codex.system/bootstrap/usr/bin:/var/run/com.apple.security.cryptexd/codex.system/bootstrap/usr/appleinternal/bin

Terminal in Vscode (notice how asdf shims takes priority over the virtualenv):

/Users/paolo.quadri/.local/bin:/Users/paolo.quadri/.asdf/shims:/opt/homebrew/opt/asdf/libexec/bin:/Users/paolo.quadri/.vscode/extensions/ms-python.python-2024.0.1/pythonFiles/deactivate/zsh:/Users/paolo.quadri/Library/Caches/pypoetry/virtualenvs/warehouse-dbt-QNbhN6Y_-py3.10/bin:/opt/homebrew/bin:/opt/homebrew/sbin:/usr/local/bin:/System/Cryptexes/App/usr/bin:/usr/bin:/bin:/usr/sbin:/sbin:/var/run/com.apple.security.cryptexd/codex.system/bootstrap/usr/local/bin:/var/run/com.apple.security.cryptexd/codex.system/bootstrap/usr/bin:/var/run/com.apple.security.cryptexd/codex.system/bootstrap/usr/appleinternal/bin

Terminal in VsCode, after running poetry shell or source ${virtualenv}/bin/activate (virtualenv is correctly at the beginning of the path)

/Users/paolo.quadri/Library/Caches/pypoetry/virtualenvs/warehouse-dbt-QNbhN6Y_-py3.10/bin:/Users/paolo.quadri/.local/bin:/Users/paolo.quadri/.asdf/shims:/opt/homebrew/opt/asdf/libexec/bin:/Users/paolo.quadri/.vscode/extensions/ms-python.python-2024.0.1/pythonFiles/deactivate/zsh:/Users/paolo.quadri/Library/Caches/pypoetry/virtualenvs/warehouse-dbt-QNbhN6Y_-py3.10/bin:/opt/homebrew/bin:/opt/homebrew/sbin:/usr/local/bin:/System/Cryptexes/App/usr/bin:/usr/bin:/bin:/usr/sbin:/sbin:/var/run/com.apple.security.cryptexd/codex.system/bootstrap/usr/local/bin:/var/run/com.apple.security.cryptexd/codex.system/bootstrap/usr/bin:/var/run/com.apple.security.cryptexd/codex.system/bootstrap/usr/appleinternal/bin

I confirmed that a python executable that only exists within the virtualenv works properly, and it's the python command path that is overshadowed.

[karrtikr]

Thanks for the detailed analysis. Can you try the same with the pre-release version of the Python extension and then provide the logs?

[pquadri]

Thanks for the detailed analysis. Can you try the same with the pre-release version of the Python extension and then provide the logs?

New logs: https://gist.github.com/pquadri/f9d7096f80f8076d3b2853b4cb138a69
(Issue is still there, but now i get a pop-up:

)

[karrtikr]

Thank you, it seems like shell integration (which is meant to override .zshrc) isn't quite working for you. Just to confirm, can you run the following in the terminal:

echo $PATH 

and send me the output.
Also, please report the following:

• Run 'Python: Clear cache and reload window' command

• A screenshot when you hover over zsh:
  

• Whether shell integration is actually working:
  
  try running any random command see if you get the "cross" icon

I see in the logs that:

Prepending environment variable PATH in collection with /Users/paolo.quadri/.vscode/extensions/ms-python.python-2024.1.10440830/pythonFiles/deactivate/zsh:/Users/paolo.quadri/Library/Caches/pypoetry/virtualenvs/warehouse-dbt-QNbhN6Y_-py3.10/bin: {"applyAtShellIntegration":true,"applyAtProcessCreation":true}

which indicates Python extension is applying these environments correctly, but VS Code is failing to set it due to a bug on their end.

[pquadri]

zsh:

shell integration:

current PATH:

/Users/paolo.quadri/.local/bin:/Users/paolo.quadri/.asdf/shims:/opt/homebrew/opt/asdf/libexec/bin:/Users/paolo.quadri/.vscode/extensions/ms-python.python-2024.1.10440830/pythonFiles/deactivate/zsh:/Users/paolo.quadri/Library/Caches/pypoetry/virtualenvs/warehouse-dbt-QNbhN6Y_-py3.10/bin:/opt/homebrew/bin:/opt/homebrew/sbin:/usr/local/bin:/System/Cryptexes/App/usr/bin:/usr/bin:/bin:/usr/sbin:/sbin:/var/run/com.apple.security.cryptexd/codex.system/bootstrap/usr/local/bin:/var/run/com.apple.security.cryptexd/codex.system/bootstrap/usr/bin:/var/run/com.apple.security.cryptexd/codex.system/bootstrap/usr/appleinternal/bin:/Users/paolo.quadri/.vscode/extensions/ms-python.python-2024.1.10440830/pythonFiles/deactivate/zsh:/Users/paolo.quadri/Library/Caches/pypoetry/virtualenvs/warehouse-dbt-QNbhN6Y_-py3.10/bin

it seems that it is prepending the variables, but then there are some more prepended again (i would say it's sourcing from .zshrc twice, but i wouldn't know how)

[karrtikr]

The PATH tells me that shell integration is indeed working, but .zshrc is still overriding the value set by shell integration, which I wouldn't expect to happen. I can open up an issue for you on VS Code to investigate, if you could also chime it there that would be appreciated.

Meanwhile, you can solve this by doing the following: https://code.visualstudio.com/docs/terminal/shell-integration#_manual-installation.