Test that UI indicates terminal activation when activating using environment variables

[karrtikr]

Refs: #21793

• windows @eleanorjboyd
• linux @lramos15
• macOS @aiday-mar

Complexity: 5

Create Issue

---

Requirements

Similar to #21102 hence preassigning.

• Python extension pre-release
• Latest VSCode Insiders
• Ability to create virtual environment
  • Use python -m venv <name> to create virtual envs.
• Ability to create conda environment
  • Install conda via: https://conda.io/projects/conda/en/latest/user-guide/install/index.html. Make sure it's on PATH during installation.
  • Run conda init --all & restart the shell.
  • Create conda env using conda create -n <name> python -y.
• Basic terminal shell types, please tick whatever is available in your OS:
  • Windows:
    • cmd
    • powershell
    • powershellcore
  • Linux:
    • bash
    • zsh
    • fish
  • macOS :
    • bash
    • zsh
• Nice to have:
  • sh
  • ksh
  • csh
  • tcsh
  • nushell
  • xonsh

Verification

• Add following to user settings and reload window:

"python.experiments.optInto": ["pythonTerminalEnvVarActivation"]

• Run conda config --set auto_activate_base True.

• Open a workspace folder and activate Python extension by opening a Python file.

• Select a virtual environment using Python: Select Interpreter command.

• Loop -> Do the following for all terminal shell types:

  • Open a new terminal.
  • Ensure we indicate the env is activated in at least one of the following ways:
    • Terminal prompt carrying selected environment's name is present (please ignore if you see (base): Active venv is activated in terminal but terminal indicates that (base) is activated #21887):
      
    • Notification appears, simply close it for now:
      
  • Make sure terminal is activated using the selected environment. Run the following in terminal:

    python -c"import sys;print(sys.executable)"
    

  • Output should contain the path to interpreter selected. For eg. for .venv created via python -m venv .venv it looks something like:

    C:\Users\karraj\OneDrive - Microsoft\Desktop\folders\crap\.venv\Scripts\python.exe
    

  • Change the default shell in your OS using Terminal: Select Default Profile, say bash->fish

• Select a conda environment using Python: Select Interpreter command and repeat the above loop.

• If the notification was visible at some point:

  • Verify clicking "learn more" opens this wiki.
  • Verify that opening a new terminal after clicking "Don't show again" does not show the notification.

[amunger]

This isn't working for me at all:

After running conda config --set auto_activate_base True, it always just activates the base conda environment, not the interpreter I have selected.

Before I ran that, the environment never activated, but I get the notification: #21887

[eleanorjboyd]

mine always says (base) PS C:\Users\eleanorboyd\testFilesWindows\conda-shell> is it ok that it says base and not .venv?

[karrtikr]

Yes you can ignore that for now. Please run the Python command specified to see which environment is actually activated.

[karrtikr]

This isn't working for me at all:

Me and Aaron discussed here that it actually works: #21887 (comment), but it was the same confusion that @eleanorjboyd has, which is that it always shows (base) regardless of which env is actually activated.

Sorry for the trouble.

[lramos15]

Is it standard for Python docs to be in a GH wiki. I'm wondering if this should be on the VS Code website so we can track things like page views?

[karrtikr]

@lramos15 We have plans to move it there, but right now this is behind an experiment hence isn't applicable for everyone.

[karrtikr]

@lramos15 Were you able to test for zsh and fish on Linux?

[lramos15]

@lramos15 Were you able to test for zsh and fish on Linux?

Oh I do not have those installed, do I need to install them for the TPI. I got confused by the wording please tick whatever is available in your OS which made me think it was test what you have.

[karrtikr]

Sorry, if you could install them that would be great. Our codespaces already has it pre-installed so you can also use that, thanks!

[lramos15]

Sorry, if you could install them that would be great. Our codespaces already has it pre-installed so you can also use that, thanks!

Done 👍