For Python Environment add the command that is need to setup the shells

[karthiknadig]

When returning the Python Environments currently hatch just returns run command. If users want to work in the terminal with a specific environment, then hatch setup that terminal. We make this easy if you can provide the CLI command that should be run to set it up for various shells.

The recommended ones to support are: Powershell, bash/sh, zsh, fish, cmd, gitbash

[flying-sheep]

They’re the same as for venvs, because hatch envs are venvs.

I’ll definitely not re-implement this here, that would be horrific code duplication. Rarely used code paths for various separate systems are the most important situation in which code should be re-used.

So how can we make this extension re-use the built-in venv’s behavior here?

[karthiknadig]

This is good to know. I can look at exposing built-in venv shell capabilities.

[karthiknadig]

@flying-sheep I was looking through the hatch commands and I see hatch shell, isn't that what users would use to setup env?

hatch shell --help
Usage: hatch shell [OPTIONS] [ENV_NAME]

  Enter a shell within a project's environment.

Options:
  --name TEXT
  --path TEXT
  -h, --help   Show this message and exit.

[flying-sheep]

I didn’t actually think about that, since as said, they’re just regular venvs, so the Python extension (and Python envs extension) knows how to activate them.

But that works! I’m not sure how well it would interact with custom shells though. Even more exotic shells like hatch env --name=Nushell --path=/bin/nu work, but I don’t know the capabilities of VS Code’s custom shells, which might go beyond “has a name and an executable path and inherits environment variables”

[karthiknadig]

I will create a PR for this. We have a shell type to command map that you can provide. Let me give it a try.

[karthiknadig]

Git Bash activated with hatch shell

Command Prompt activation using command:

Found some issues with hatch shell, essentially if you put the hatch command in the Command Prompt autoRun or Powershell profile. It seems to fail same issue as here pypa/hatch#1957. hatch runs into issues with running hash shell with PowerShell5 which ships in-the-box with Windows.

Bash and bash like are fine. Nu also works on Windows:

[karthiknadig]

There are two activation mechanisms the Python Environments extension supports:

1. Activation using command (this is default): sends the activation command like activate.ps1 or conda activate <env> or in hatch's case hatch shell --name <name> to the terminal as soon as the terminal is available. This approach works for most cases but hatch has issues with this in Powershell5, if we wrap hatch command in (), which is strange. The cons of sending command to terminal is that given the async nature of extension, if multiple extensions send command to the, the activation command might not be first. and any python command sent by other extensions can fail.
2. Activation using shellStartup : This adds the activation command to the shell start up script of a shell dynamically. so when the terminal is available to the users it is already activated. This approach makes it more robust, when working with multiple extensions. hatch seems to work well only in the bash like shells in this mode. For both powershell and cmd it failed with hatch command causes: Magic number 'UVSC' or 'UVPY' not found hatch#1957

This might be important to address. and can be repro by adding hatch shell in Powershell Profile or CMD AutoRun Script.

$env:HATCH_ACTIVATE=(hatch shell --name "default")
try {
        Invoke-Expression $env:HATCH_ACTIVATE
    } catch {
        Write-Error "Failed to activate Python environment: $_" -ErrorAction Continue
    }

[flying-sheep]

It’s not perfect but it works. Only issue is microsoft/vscode-python-environments#1391