如何从 VSCode 任务运行 python 模块命令

Question

I am trying to run my alembic migration which is in a subdirectory so I am writing VSCode tasks for it but when I run it I get command not found error:

{
    // See https://go.microsoft.com/fwlink/?LinkId=733558
    // for the documentation about the tasks.json format
    "version": "2.0.0",
    "tasks": [
        {
            "label": "Alembic autogenerated revision",
            "type": "shell",
            "command": "alembic revision --autogenerate -m init",
            "options": {
                "cwd": "${workspaceFolder}/my_sub_directory"
            }
        }
    ]
}

How can I run it under my virtual environment?

Answer 1

Activating the virtual environment, then installing alembic , you can run alembic revision directly, that's because it's in the virtual environment and able to call the module.

So, when executing alembic command in task, you also need to activate env first.

Copy the activation command and paste it before alembic and separated by ;, the task should be ran successfully:

Answer 2

Unfortunately, I've not been able to find a solution that doesn't require hardcoding the virtualenv path.

I believe an extension would be able to solve this, possibly by adding support for python in the tasks's type field.

A workaround

Use launch configurations instead of tasks for running python scripts. It is a bit weird, but it works.

Here's your code adapted to launch.json schema:

{
    "version": "0.2.0",
    "configurations": [
        {
            "name": "Alembic autogenerated revision",
            "type": "python",
            "request": "launch",
            "module": "alembic",
            "args": ["revision", "--autogenerate", "-m", "init"],
            "cwd": "${workspaceFolder}/my_sub_directory"
        }
    ]
}

Also, consider using input variables for specifying revision messages and other variable things.

Answer 3

Thanks for your responses. To resolve this we can use the selected interpreter path and run the module.

        {
            "label": "Alembic autogenerated revision",
            "type": "shell",
            "command": "${command:python.interpreterPath} -m alembic revision --autogenerate -m init",
            "options": {
                "cwd": "${workspaceFolder}/ts_tools"
            }
        },

Reference: https://github.com/microsoft/vscode-python/issues/18728

Regards.