Support for Fish shell for debugging Python Functions

[drewsilcock]

When trying to run Python functions where my user shell is set to Fish, I am unable to debug functions using VS Code.

The error produced is:

> Executing task: . .venv/bin/activate && func host start <

.venv/bin/activate (line 40): Unsupported use of '='. In fish, please use 'set VIRTUAL_ENV "/Users/drew.silcock/Dev/vv/vv-functions/.venv"'.
from sourcing file .venv/bin/activate
.: Error while reading file '.venv/bin/activate'
The terminal process "/opt/homebrew/bin/fish '-c', '. .venv/bin/activate && func host start'" terminated with exit code: 1.

Terminal will be reused by tasks, press any key to close it.

For bash/zsh, activating a virtual environment meaning doing . .venv/bin/activate but for Fish it is . .venv/bin/activate.fish.

Looking at src/utils/venvUtils.ts, it looks like:

• The extension assumes that the user is using bash (from getTerminal()) if they're not on Windows.
• The extension (on non-Windows) only supports the activate command .venv/bin/activate, not .venv/bin/activate.fish.

This would be fine if there were some way to customise which shell to run the task with, but adding:

  "options": {
    "shell": {
      "executable": "/bin/bash",
      "args": ["-c"]
    }
  },

doesn't seem to work as VS Code still uses my default shell for running the task, presumably because this only applies to tasks of type "shell" whereas this is a task of type "func". I'm using the default task generated by the extension here.

Possible solutions:

• Detect whether user shell is fish and adjust venv activate command accordingly.
• Ensure that task is run with bash when on non-Windows platform instead of assuming that user shell is bash.
• Allow user to customise which shell the func task should run in via some configuration parameter.

[alexweininger]

Fellow fish shell user here 😄 , thanks for filing a detailed issue 🚀

This would be fine if there were some way to customise which shell to run the task with

Although you can't customize the shell executable on a per task basis for the func tasks, if you just need a workaround for debugging your Functions project, I recommend making the tasks run in bash/zsh by resetting the value of the Automation Profile: Osx (terminal.integrated.automationProfile.osx) setting.

It's possible to use fish as the default shell for the integrated terminal, but make tasks use zsh (or bash). This is what I've setup on my VS Code. If this is what you want and you have questions about my setup, I'm happy to help.

---

As for the proposed possible solutions for providing support for running the func tasks in the fish shell, I think

• Allow user to customise which shell the func task should run in via some configuration parameter.

makes the most sense. Since this pattern is already present on the shell tasks. If for some reason that wouldn't work, I think

• Ensure that task is run with bash when on non-Windows platform instead of assuming that user shell is bash.

would be fine too.

[drewsilcock]

Hi Alex, thanks so much for the info, that setting was exactly what I was looking for! That seems to do work perfectly. For others reading this I added the following to the project's .vscode/settings.json:

{
  "terminal.integrated.automationProfile.linux": {
    "path": "/usr/bin/bash"
  }
}

(Replace linux with osx for macOS, obviously.)