Repository navigation
experiment 'pythonTerminalEnvVarActivation' not working because shell integration is not working #22418
Description
Type: Bug
The experiment 'pythonTerminalEnvVarActivation' does not work when "terminal.integrated.shellIntegration.enabled": true and the user's PowerShell ExecutionPolicy is Restricted. This experiment was originally touted as a way to get around the conda init powershell issues which required users to elevate their ExecutionPolicy, but it seems to be only a partial fix.
Current solution: set "terminal.integrated.shellIntegration.enabled": false. The display does not show currently activate environment etc. but everything seems to working correctly.
Note: elevating the user's ExecutionPolicy is not a viable solution as organizations may not allow that.
Extension version: 2023.20.0
VS Code version: Code 1.84.0 (d037ac076cee195194f93ce6fe2bdfe2969cc82d, 2023-11-01T11:29:04.398Z)
OS version: Windows_NT x64 10.0.19044
Modes:
System Info
| Item | Value |
|---|---|
| CPUs | 13th Gen Intel(R) Core(TM) i9-13950HX (32 x 2419) |
| 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 video_decode: enabled video_encode: enabled vulkan: disabled_off webgl: enabled webgl2: enabled webgpu: enabled |
| Load (avg) | undefined |
| Memory (System) | 63.66GB (46.45GB free) |
| Process Argv | --crash-reporter-id 8fccd002-37e2-4ae0-aa9d-23225dec9d0a |
| Screen Reader | no |
| VM | 0% |
A/B Experiments
vsliv368cf:30146710
vsreu685:30147344
python383:30185418
vspor879:30202332
vspor708:30202333
vspor363:30204092
vslsvsres303:30308271
vserr242cf:30382550
pythontb:30283811
vsjup518:30340749
pythonptprofiler:30281270
vshan820:30294714
vstes263:30335439
vscoreces:30445986
vscod805cf:30301675
binariesv615:30325510
bridge0708:30335490
bridge0723:30353136
vsaa593cf:30376535
pythonvs932:30410667
py29gd2263:30880072
vsclangdf:30486550
c4g48928:30535728
dsvsc012:30540252
pynewext54:30695312
azure-dev_surveyone:30548225
282f8724:30602487
f6dab269:30613381
a9j8j154:30646983
showlangstatbar:30737416
03d35959:30757346
pythonfmttext:30731395
fixshowwlkth:30771522
showindicator:30805244
pythongtdpath:30769146
i26e3531:30792625
pythonnosmt12:30797651
pythonidxpt:30866567
pythonnoceb:30805159
synctok:30869157
dsvsc013:30795093
dsvsc014:30804076
dsvsc015:30845448
pythontestfixtcf:30871695
pythonregdiag2:30871582
pyreplss2:30879913
pythonmypyd1:30879173
pythoncet00cf:30874137
pythontbext0:30879054
Activity
karrtikr commentedon Nov 6, 2023
Can you please elaborate on what you see as screenshots which leads you to conclude that it is not working?
Also, try the pre-release version of the Python extension:
karrtikr commentedon Nov 6, 2023
If none of these work, we would further need the debug logs to diagnose the issue:
Developer: Set log levelcommandTraceDeveloper: Reload WindowcommandOutput for
Pythonin theOutputpanel (View→Output, change the drop-down the upper-right of theOutputpanel toPython)mkoohafkan commentedon Nov 7, 2023
Here are screenshots:
Not working
Working
No change when switching to pre-release version.
Log:
karrtikr commentedon Nov 7, 2023
I see, let me look deeper into it. Meanwhile, is changing the policy even for just the current user not an option?
#2559 (comment)
Also, I assume
conda initis not run for your Powershell. If it was run previously, one can revert it using,karrtikr commentedon Nov 7, 2023
It seems conda executable is not on
PATHwhich is leading to this behavior:Can you print
PATHwhen it fails and see if it containsC:\LocalPrograms\g2encmck\miniconda3\Scripts? Also, compare it toPATHwhen it succeeds and see if it contains it.mkoohafkan commentedon Nov 7, 2023
When it is working (
"terminal.integrated.shellIntegration.enabled": false)PATHcontains the following Conda-related paths (wherestratsampthe Conda environment I am using in the project)as well as the variable
CONDA_EXEwhich isC:\LocalPrograms\g2encmck\miniconda3\Scripts\conda.exe.When it is not working (
"terminal.integrated.shellIntegration.enabled": true) there are no Conda-related paths inPATH, but theCONDA_EXEvariable does exist and has the same valueC:\LocalPrograms\g2encmck\miniconda3\Scripts\conda.exe.I do not have
CONDA_EXEdefined in my system or user environment variables, so presumably VSCode is generating that from the"python.condaPath"setting.mkoohafkan commentedon Nov 8, 2023
No it is not, the organization sets this policy and will not change it. Would VSCode be able to pass
-ExecutionPolicy ByPasswitu the environment injection script? That might work.karrtikr commentedon Nov 8, 2023
Issue arises from the fact that we're not able to reliably figure out whether Shell integration is working or not. In this case, it boils down to reliably finding out whether Powershell execution is restricted, can you run the following command on your system:
I'm expecting it would result in
Restricted, which I'm hoping is something we could check to figure out whether shell integration is working.mkoohafkan commentedon Nov 8, 2023
Yes, PowerShell ExecutionPolicy is
Restrictedin this case which is why the shell integration call fails (see top right of first image and reference toshellIntegration.ps1). I am curious if modifying the shell integration command to include-ExecutionPolicy ByPasswould generally resolve the issue, but perhaps that is outside of the Python extension scope.karrtikr commentedon Nov 8, 2023
Yes, that's not something we currently control, Python extension does not have it's own profile, we just use the selected one.
I've created #22439 to make sure we solve your issue. Where we will more generally work on a way to figure out whether shell integration is working, rather than just checking the powershell execution policy.
karrtikr commentedon Nov 8, 2023
Btw, the issue is your case was here:
vscode-python/src/client/terminals/envCollectionActivation/service.ts
Lines 343 to 356 in cc38abb
isActivewas returningtruewhen shell integration was failing, leading to us not being able to apply the envs.