Activation using Shell Startup

[karthiknadig]

Support for activation using shell startup scripts:

Windows

• cmd
• Powershell
• pwsh
• gitbash

Mac/Linux

• pwsh
• bash
• zsh
• fish

[karthiknadig]

CMD

1. Add or update HKCU\\Software\\Microsoft\\Command Processor AutoRun string value to use a command script.
2. A command script is added to %USERPROFILE%\.cmdrc\cmd_startup.bat
3. A script named vscode-python.bat is added to %USERPROFILE%\.cmdrc and called from cmd_startup.bat

contents of cmd_startup.bat

:: >>> vscode python
if "%TERM_PROGRAM%"=="vscode" (
    if not defined VSCODE_PYTHON_AUTOACTIVATE_GUARD (
        set "VSCODE_PYTHON_AUTOACTIVATE_GUARD=1"
        if exist "%USERPROFILE%\.cmdrc\vscode-python.bat" call "%USERPROFILE%\.cmdrc\vscode-python.bat"
    )
)
:: <<< vscode python

contents of vscode-python.bat

:: >>> vscode python
:: version: 0.1.0
if defined VSCODE_CMD_ACTIVATE (
    call %VSCODE_CMD_ACTIVATE%
)
:: <<< vscode python

Powershell/pwsh

1. Runs powershell -Command $profile to get the profile location
2. If it does not exist creates it.
3. Adds following code to the shell profile script:

#region vscode python
if ($null -ne $env:VSCODE_PWSH_ACTIVATE) {
    Invoke-Expression $env:VSCODE_PWSH_ACTIVATE
}
#endregion vscode python

sh/bash/gitbash

1. Adds or creates ~/.bashrc
2. Updates it with following code:

# >>> vscode python
# version: 0.1.0
if [ -n "$VSCODE_BASH_ACTIVATE" ] && [ "$TERM_PROGRAM" = "vscode" ]; then
    eval "$VSCODE_BASH_ACTIVATE" || true
fi
# <<< vscode python

zsh

1. Adds or creates ~/.zshrc
2. Updates it with following code:

# >>> vscode python
# version: 0.1.0
if [ -n "$VSCODE_BASH_ACTIVATE" ] && [ "$TERM_PROGRAM" = "vscode" ]; then
    eval "$VSCODE_BASH_ACTIVATE" || true
fi
# <<< vscode python

fish

1. Adds or creates ~/.config/fish/config.fish
2. Updates it with following code:

# >>> vscode python
# version: 0.1.0
if test "$TERM_PROGRAM" = "vscode"; and set -q  VSCODE_FISH_ACTIVATE
    eval $VSCODE_FISH_ACTIVATE
end
# <<< vscode python

[wzh4464]

Also zsh conda activation please! Thank you so much!

[karthiknadig]

@wzh4464 This should cover ZSH conda activation, assuming conda is setup with conda init for zsh.

[karthiknadig]

This is experimental and can be set up by using python-envs.terminal.autoActivationType to shellStartup.

[ACMCMC]

Thanks for all the work on this. I’ve been hitting this issue for months, and I did try the workaround suggested above, but when working on an SSH tunnel, I just get:

This setting cannot be applied in this window. It will be applied when you open a local window.

I get that this is tricky, but I really think the issue should be looked into in further detail... it should just work out of the box, even in remote setups, no workarounds needed :)