Python tasks

[JosephTLyons]

A couple of simple tasks to enable faster python execution. Add these to your tasks.json file. Swap out python3 for whatever interpreter/alias you are using. Use tasks: spawn in the command palette to pick a task and then relaunch the same task via opt-t (task: rerun).

Executing code

{
  "label": "Run python selection",
  "command": "python3",
  "args": ["-c", "\"$ZED_SELECTED_TEXT\""],
  "use_new_terminal": false
},

{
  "label": "Run python file",
  "command": "python3",
  "args": ["$ZED_FILE"],
  "use_new_terminal": false
}

Managing venvs (utilizing uv)

{
  "label": "Create venv",
  "command": "uv",
  "args": ["venv", "$ZED_WORKTREE_ROOT/.venv"],
  "use_new_terminal": false
},

{
  "label": "Delete venv",
  "command": "rm",
  "args": ["-rf", "$ZED_WORKTREE_ROOT/.venv"],
  "use_new_terminal": false
}

For more general info on tasks, see the docs.

[KiraMelnikov]

i dont understand how it works (
for me it doesnt works (

[bennetbo]

And what happens when you run open tasks in the command palette? If you see the python task in that file I am not sure what's going wrong. You could check the logs for any errors via the command palette (zed: open log)

[KiraMelnikov]

i understood whats going on )
im created a tasks.json into project dir
if i press cmd+shift+p
ive seen this "Zed: open tasks"
Now i understand what i need to do
to add new tasks into .config/zed dir )
Thx for help and supporting to me!)

[JosephTLyons]

Sorry for not providing more details - we have some documentation here:

• https://zed.dev/docs/tasks

[KiraMelnikov]

Thank you Joseph)
I had to check this earlier

[distrair]

Hi, I pasted your code in my tasks.json and for some reason, it doesn't appear in any of the .py files, but it appears in any other file type. How can I fix this?

[Tom-Boscher]

I wrote a Nu task to initialize a Python project. It create a pyrightconfig.json, a .venv and install all Python package in requirements.txt or create the file if missing. You have to have Nushell as login shell.
Sorry for the long command.

  {
    "label": "Setup Python project",
    "command": "if ('pyrightconfig.json' | path exists) == false {{'venvPath': '.', 'venv': '.venv'} | to json o> pyrightconfig.json} ; if ('.venv' | path exists) == false {uv venv} ; if ('requirements.txt' | path exists) == false {touch requirements.txt} ; if (cat requirements.txt | is-not-empty) {uv pip install -r requirements.txt}",
    "reveal": "never",
    "use_new_terminal": false
  }

[Tom-Boscher]

@KiraMelnikov If you use task to run a python file it doesn't use your virtual environment?

[KiraMelnikov]

@Tom-Boscher Exactly so
But if i install pip into main os path then its works
If i activate env using terminal, RUN FILE not see packages in my .API because look at main os packages...

[Tom-Boscher]

Zed will looks (by default) for .env, .venv, env, venv
You can add other folder names in your configuration file (I'm not on my computer now so I can't tell you the exact config name)

[KiraMelnikov]

@Tom-Boscher
I have create a new .venv then installed test_lib and my code is running
But the packages are installed into main folder and the same time into .venv
When i uninstall packages from main folder so .venv become is empty too ... ive no idea

[kacperkwapisz]

I made a Zsh version of this command. No need to install/setup anything new. Enjoy 👀

(utilizing uv):

{
    "label": "Setup Python project",
    "command": "[ ! -f \"pyrightconfig.json\" ] && echo '{\"venvPath\": \".\", \"venv\": \".venv\"}' > pyrightconfig.json; [ ! -d \".venv\" ] && uv venv; [ ! -f \"requirements.txt\" ] && touch requirements.txt; [ -s \"requirements.txt\" ] && uv pip install -r requirements.txt",
    "reveal": "never",
    "use_new_terminal": false
}

(utilizing pip):

{
  "label": "Setup Python project",
  "command": "[ ! -f \"pyrightconfig.json\" ] && echo '{\"venvPath\": \".\", \"venv\": \".venv\"}' > pyrightconfig.json; [ ! -d \".venv\" ] && python3 -m venv .venv; [ ! -f \"requirements.txt\" ] && touch requirements.txt; [ -s \"requirements.txt\" ] && .venv/bin/pip install -r requirements.txt",
  "reveal": "never",
  "use_new_terminal": false
}

[wmstack]

I am trying this with a simple java file, swapping python3 with java. It works in the terminal but the same command doesn't work with the task runner. Even though there is a "$ZED_FILE" argument, it still outputs as if java is called standalone.

The problem seems to be that with java files, "$ZED_FILE" is not outputting the correct name. I made a dummy task that does echo to the argument "$ZED_FILE" and it works for some files I have tried but not others. It doesn't work with txt files or java files, but seems to work with markdown and python files.

[HamzaFarhan]

Some more useful tasks:

[
  // run python file using uv
  {
    "label": "Run File: $ZED_FILENAME",
    "command": "uv run $ZED_FILENAME"
  },
  // run selected code using uv
  {
    "label": "Run Code",
    "command": "cat <<'EOF' > temp_run.py\n$ZED_SELECTED_TEXT\nEOF\nuv run temp_run.py && rm temp_run.py"
  },
  // push config to github
  {
    "label": "Push Config",
    "command": "cd ~/.config/zed && git add . && git commit -m 'Update Config' && git push"
  }
]

The keymap:

[
  {
    "context": "Workspace",
    "bindings": {
      "f4": ["task::Spawn", { "task_name": "Run Code" }],
      "f5": ["task::Spawn", { "task_name": "Run File: $ZED_FILENAME" }],
      "f7": "task::Spawn",
      "f6": "task::Rerun"
    }
  }
]

[injust]

This gets you pretty close to VS Code's "Python: Run Python File" command.

Keybinding:

{
  "context": "Editor && mode == full && !(ContextEditor > Editor) || Terminal",
  "use_key_equivalents": true,
  "bindings": {
    "cmd-r": ["task::Spawn", { "task_name": "Python: $ZED_STEM" }]
  }
}

Task:

{
  "label": "Python: $ZED_STEM",
  "command": "python3",
  "args": ["$ZED_FILE"],
  "allow_concurrent_runs": true
}

[injust]

This is what I use in my keymap now:

{
  "context": "Editor && mode == full && !(ContextEditor > Editor) && extension == py",
  "use_key_equivalents": true,
  "bindings": {
    "cmd-r": ["task::Spawn", { "task_name": "run '$ZED_FILE'" }]
  }
}

You don't even need to create a task, since Zed's Python support already creates the run '$ZED_FILE' task.

This has the added benefit of automatically using the configured venv.

[eyayaw]

If you want to run with a venv python, this may be useful.

 {
    "label": "Python: Run File",
    "command": "source $ZED_WORKTREE_ROOT/.venv/bin/activate; python3 || python3",
    "args": ["$ZED_FILE"],
    "use_new_terminal": false
  },
  {
    "label": "Python: Run Selection",
    "command": "source $ZED_WORKTREE_ROOT/.venv/bin/activate; python3 || python3",
    "args": ["-c", "\"$ZED_SELECTED_TEXT\""],
    "use_new_terminal": false
  }