1# How to Set Up Python in Zed
  2
  3Python support is available natively in Zed.
  4
  5- Tree-sitter: [tree-sitter-python](https://github.com/zed-industries/tree-sitter-python)
  6- Language Servers:
  7  - [DetachHead/basedpyright](https://github.com/DetachHead/basedpyright)
  8  - [astral-sh/ruff](https://github.com/astral-sh/ruff)
  9  - [astral-sh/ty](https://github.com/astral-sh/ty)
 10  - [microsoft/pyright](https://github.com/microsoft/pyright)
 11  - [python-lsp/python-lsp-server](https://github.com/python-lsp/python-lsp-server) (PyLSP)
 12- Debug Adapter: [debugpy](https://github.com/microsoft/debugpy)
 13
 14## Install Python
 15
 16You'll need both Zed and Python installed before you can begin.
 17
 18### Step 1: Install Python
 19
 20Zed does not bundle a Python runtime, so you’ll need to install one yourself.
 21Choose one of the following options:
 22
 23- uv (recommended)
 24
 25```bash
 26curl -LsSf https://astral.sh/uv/install.sh | sh
 27```
 28
 29To learn more, visit [Astral’s installation guide](https://docs.astral.sh/uv/getting-started/installation/).
 30
 31- Homebrew:
 32
 33```bash
 34brew install python
 35```
 36
 37- Python.org installer: Download the latest version from [python.org/downloads](https://python.org/downloads).
 38
 39### Step 2: Verify Python Installation
 40
 41Confirm Python is installed and available in your shell:
 42
 43```bash
 44python3 --version
 45```
 46
 47You should see an output like `Python 3.x.x`.
 48
 49## Open Your First Python Project in Zed
 50
 51Once Zed and Python are installed, open a folder containing Python code to start working.
 52
 53### Step 1: Launch Zed with a Python Project
 54
 55Open Zed.
 56From the menu bar, choose File > Open Folder, or launch from the terminal:
 57
 58```bash
 59zed path/to/your/project
 60```
 61
 62Zed will recognize `.py` files automatically using its native tree-sitter-python parser, with no plugins or manual setup required.
 63
 64### Step 2: Use the Integrated Terminal (Optional)
 65
 66Zed includes an integrated terminal, accessible from the bottom panel. If Zed detects that your project is using a [virtual environment](#virtual-environments), it will be activated automatically in newly-created terminals. You can configure this behavior with the [`detect_venv`](../configuring-zed.md#terminal-detect_venv) setting.
 67
 68## Configure Python Language Servers in Zed
 69
 70Zed provides several Python language servers out of the box. By default, [basedpyright](https://github.com/DetachHead/basedpyright) is the primary language server, and [Ruff](https://github.com/astral-sh/ruff) is used for formatting and linting.
 71
 72Other built-in language servers are:
 73
 74- [Ty](https://docs.astral.sh/ty/)—Up-and-coming language server from Astral, built for speed.
 75- [Pyright](https://github.com/microsoft/pyright)—The basis for basedpyright.
 76- [PyLSP](https://github.com/python-lsp/python-lsp-server)—A plugin-based language server that integrates with tools like `pycodestyle`, `autopep8`, and `yapf`.
 77
 78These are disabled by default, but can be enabled in your settings. For example:
 79
 80```json [settings]
 81{
 82  "languages": {
 83    "Python": {
 84      "language_servers": [
 85        // Disable basedpyright and enable Ty, and otherwise
 86        // use the default configuration.
 87        "ty",
 88        "!basedpyright",
 89        "..."
 90      ]
 91    }
 92  }
 93}
 94```
 95
 96See: [Working with Language Servers](https://zed.dev/docs/configuring-languages#working-with-language-servers) for more information about how to enable and disable language servers.
 97
 98### Basedpyright
 99
100[basedpyright](https://docs.basedpyright.com/latest/) is the primary Python language server in Zed beginning with Zed v0.204.0. It provides core language server functionality like navigation (go to definition/find all references) and type checking. Compared to Pyright, it adds support for additional language server features (like inlay hints) and checking rules.
101
102Note that while basedpyright in isolation defaults to the `recommended` [type-checking mode](https://docs.basedpyright.com/latest/benefits-over-pyright/better-defaults/#typecheckingmode), Zed configures it to use the less-strict `standard` mode by default, which matches the behavior of Pyright. You can set the type-checking mode for your project using the `typeCheckingMode` setting in `pyrightconfig.json` or `pyproject.toml`, which will override Zed's default. Read on more for more details about how to configure basedpyright.
103
104#### Basedpyright Configuration
105
106basedpyright reads configuration options from two different kinds of sources:
107
108- Language server settings ("workspace configuration"), which must be configured per-editor (using `settings.json` in Zed's case) but apply to all projects opened in that editor
109- Configuration files (`pyrightconfig.json`, `pyproject.toml`), which are editor-independent but specific to the project where they are placed
110
111As a rule of thumb, options that are only relevant when using basedpyright from an editor must be set in language server settings, and options that are relevant even if you're running it [as a command-line tool](https://docs.basedpyright.com/latest/configuration/command-line/) must be set in configuration files. Settings related to inlay hints are examples of the first category, and the [diagnostic category](https://docs.basedpyright.com/latest/configuration/config-files/#diagnostic-categories) settings are examples of the second category.
112
113Examples of both kinds of configuration are provided below. Refer to the basedpyright documentation on [language server settings](https://docs.basedpyright.com/latest/configuration/language-server-settings/) and [configuration files](https://docs.basedpyright.com/latest/configuration/config-files/) for comprehensive lists of available options.
114
115##### Language server settings
116
117Language server settings for basedpyright in Zed can be set in the `lsp` section of your `settings.json`.
118
119For example, in order to:
120
121- diagnose all files in the workspace instead of the only open files default
122- disable inlay hints on function arguments
123
124You can use the following configuration:
125
126```json [settings]
127{
128  "lsp": {
129    "basedpyright": {
130      "settings": {
131        "analysis": {
132          "diagnosticMode": "workspace",
133          "inlayHints.callArgumentNames": false
134        }
135      }
136    }
137  }
138}
139```
140
141##### Configuration files
142
143basedpyright reads project-specific configuration from the `pyrightconfig.json` configuration file and from the `[tool.basedpyright]` and `[tool.pyright]` sections of `pyproject.toml` manifests. `pyrightconfig.json` overrides `pyproject.toml` if configuration is present in both places.
144
145Here's an example `pyrightconfig.json` file that configures basedpyright to use the `strict` type-checking mode and not to issue diagnostics for any files in `__pycache__` directories:
146
147```json [settings]
148{
149  "typeCheckingMode": "strict",
150  "ignore": ["**/__pycache__"]
151}
152```
153
154### PyLSP
155
156[python-lsp-server](https://github.com/python-lsp/python-lsp-server/), more commonly known as PyLSP, by default integrates with a number of external tools (autopep8, mccabe, pycodestyle, yapf) while others are optional and must be explicitly enabled and configured (flake8, pylint).
157
158See [Python Language Server Configuration](https://github.com/python-lsp/python-lsp-server/blob/develop/CONFIGURATION.md) for more.
159
160## Virtual Environments
161
162[Virtual environments](https://docs.python.org/3/library/venv.html) are a useful tool for fixing a Python version and set of dependencies for a specific project, in a way that's isolated from other projects on the same machine. Zed has built-in support for discovering, configuring, and activating virtual environments, based on the language-agnostic concept of a [toolchain](../toolchains.md).
163
164Note that if you have a global Python installation, it is also counted as a toolchain for Zed's purposes.
165
166### Create a Virtual Environment
167
168If your project doesn't have a virtual environment set up already, you can create one as follows:
169
170```bash
171python3 -m venv .venv
172```
173
174Alternatively, if you're using `uv`, running `uv sync` will create a virtual environment the first time you run it.
175
176### How Zed Uses Python Toolchains
177
178Zed uses the selected Python toolchain for your project in the following ways:
179
180- Built-in language servers will be automatically configured with the path to the toolchain's Python interpreter and, if applicable, virtual environment. This is important so that they can resolve dependencies. (Note that language servers provided by extensions can't be automatically configured like this currently.)
181- Python tasks (such as pytest tests) will be run using the toolchain's Python interpreter.
182- If the toolchain is a virtual environment, the environment's activation script will be run automatically when you launch a new shell in Zed's integrated terminal, giving you convenient access to the selected Python interpreter and dependency set.
183- If a built-in language server is installed in the active virtual environment, that binary will be used instead of Zed's private automatically-installed binary. This also applies to debugpy.
184
185### Selecting a Toolchain
186
187For most projects, Zed will automatically select the right Python toolchain. In complex projects with multiple virtual environments, it might be necessary to override this selection. You can use the [toolchain selector](../toolchains.md#selecting-toolchains) to pick a toolchain from the list discovered by Zed, or [specify the path to a toolchain manually](../toolchains.md#adding-toolchains-manually) if it's not on the list.
188
189## Code Formatting & Linting
190
191Zed provides the [Ruff](https://docs.astral.sh/ruff/) formatter and linter for Python code. (Specifically, Zed runs Ruff as an LSP server using the `ruff server` subcommand.) Both formatting and linting are enabled by default, including format-on-save.
192
193### Configuring formatting
194
195You can disable format-on-save for Python files in your `settings.json`:
196
197```json [settings]
198{
199  "languages": {
200    "Python": {
201      "format_on_save": "off"
202    }
203  }
204}
205```
206
207Alternatively, you can use the `black` command-line tool for Python formatting, while keeping Ruff enabled for linting:
208
209```json [settings]
210{
211  "languages": {
212    "Python": {
213      "formatter": {
214        "external": {
215          "command": "black",
216          "arguments": ["--stdin-filename", "{buffer_path}", "-"]
217        }
218      }
219      // Or use `"formatter": null` to disable formatting entirely.
220    }
221  }
222}
223```
224
225### Configuring Ruff
226
227Like basedpyright, Ruff reads options from both Zed's language server settings and configuration files (`ruff.toml`) when used in Zed. Unlike basedpyright, _all_ options can be configured in either of these locations, so the choice of where to put your Ruff configuration comes down to whether you want it to be shared between projects but specific to Zed (in which case you should use language server settings), or specific to one project but common to all Ruff invocations (in which case you should use `ruff.toml`).
228
229Here's an example of using language server settings in Zed's `settings.json` to disable all Ruff lints in Zed (while still using Ruff as a formatter):
230
231```json [settings]
232{
233  "lsp": {
234    "ruff": {
235      "initialization_options": {
236        "settings": {
237          "exclude": ["*"]
238        }
239      }
240    }
241  }
242}
243```
244
245And here's an example `ruff.toml` with linting and formatting options, adapted from the Ruff documentation:
246
247```toml
248[lint]
249# Avoid enforcing line-length violations (`E501`)
250ignore = ["E501"]
251
252[format]
253# Use single quotes when formatting.
254quote-style = "single"
255```
256
257For more details, refer to the Ruff documentation about [configuration files](https://docs.astral.sh/ruff/configuration/) and [language server settings](https://docs.astral.sh/ruff/editors/settings/), and the [list of options](https://docs.astral.sh/ruff/settings/).
258
259## Debugging
260
261Zed supports Python debugging through the `debugpy` adapter. You can start with no configuration or define custom launch profiles in `.zed/debug.json`.
262
263### Start Debugging with No Setup
264
265Zed can automatically detect debuggable Python entry points. Press F4 (or run debugger: start from the Command Palette) to see available options for your current project.
266This works for:
267
268- Python scripts
269- Modules
270- pytest tests
271
272Zed uses `debugpy` under the hood, but no manual adapter configuration is required.
273
274### Define Custom Debug Configurations
275
276For reusable setups, create a `.zed/debug.json` file in your project root. This gives you more control over how Zed runs and debugs your code.
277
278#### Debug Active File
279
280```json [debug]
281[
282  {
283    "label": "Python Active File",
284    "adapter": "Debugpy",
285    "program": "$ZED_FILE",
286    "request": "launch"
287  }
288]
289```
290
291This runs the file currently open in the editor.
292
293#### Debug a Flask App
294
295For projects using Flask, you can define a full launch configuration:
296
297```
298.venv/
299app/
300  init.py
301  main.py
302  routes.py
303templates/
304  index.html
305static/
306  style.css
307requirements.txt
308```
309
310…the following configuration can be used:
311
312```json [debug]
313[
314  {
315    "label": "Python: Flask",
316    "adapter": "Debugpy",
317    "request": "launch",
318    "module": "app",
319    "cwd": "$ZED_WORKTREE_ROOT",
320    "env": {
321      "FLASK_APP": "app",
322      "FLASK_DEBUG": "1"
323    },
324    "args": [
325      "run",
326      "--reload", // Enables Flask reloader that watches for file changes
327      "--debugger" // Enables Flask debugger
328    ],
329    "autoReload": {
330      "enable": true
331    },
332    "jinja": true,
333    "justMyCode": true
334  }
335]
336```
337
338These can be combined to tailor the experience for web servers, test runners, or custom scripts.
339
340## Troubleshoot and Maintain a Productive Python Setup
341
342Zed is designed to minimize configuration overhead, but occasional issues can still arise—especially around environments, language servers, or tooling. Here's how to keep your Python setup working smoothly.
343
344### Resolve Language Server Startup Issues
345
346If a language server isn't responding or features like diagnostics or autocomplete aren't available:
347
348- Check your Zed log (using the {#action zed::OpenLog} action) for errors related to the language server you're trying to use. This is where you're likely to find useful information if the language server failed to start up at all.
349- Use the language server logs view to understand the lifecycle of the affected language server. You can access this view using the {#action dev::OpenLanguageServerLogs} action, or by clicking the lightning bolt icon in the status bar and selecting your language server. The most useful pieces of data in this view are:
350  - "Server Logs", which shows any errors printed by the language server
351  - "Server Info", which shows details about how the language server was started
352- Verify your `settings.json` or `pyrightconfig.json` is syntactically correct.
353- Restart Zed to reinitialize language server connections, or try restarting the language server using the {#action editor::RestartLanguageServer}
354
355If the language server is failing to resolve imports, and you're using a virtual environment, make sure that the right environment is chosen in the selector. You can use "Server Info" view to confirm which virtual environment Zed is sending to the language server—look for the `* Configuration` section at the end.