python.md

 1# Python
 2
 3- Tree Sitter: [tree-sitter-python](https://github.com/tree-sitter/tree-sitter-python)
 4- Language Server: [pyright](https://github.com/microsoft/pyright)
 5
 6### Configuration
 7
 8The [pyright](https://github.com/microsoft/pyright) language server offers flexible configuration options specified in a JSON-formatted text configuration. By default, the file is called `pyrightconfig.json` and is located within the root directory of your project. Pyright settings can also be specified in a `[tool.pyright]` section of a `pyproject.toml` file. A `pyrightconfig.json` file always takes precedent over `pyproject.toml` if both are present.
 9
10For more information, see the Pyright [configuration documentation](https://microsoft.github.io/pyright/#/configuration).
11
12### Virtual environments
13
14A python [virtual environment](https://docs.python.org/3/tutorial/venv.html) allows you to store all of a project's dependencies, including the Python interpreter and package manager, in a single directory that's isolated from any other Python projects on your computer.
15
16By default, the Pyright language server will look for Python packages in the default global locations. But you can also configure Pyright to use the packages installed in a given virtual environment.
17
18To do this, create a JSON file called `pyrightconfig.json` at the root of your project. This file must include two keys:
19
20- `venvPath`: a relative path from your project directory to any directory that _contains_ one or more virtual environment directories
21- `venv`: the name of a virtual environment directory
22
23For example, a common approach is to create a virtual environment directory called `.venv` at the root of your project directory with the following commands:
24
25```bash
26# create a virtual environment in the .venv directory
27python3 -m venv .venv
28# set up the current shell to use that virtual environment
29source .venv/bin/activate
30```
31
32Having done that, you would create a `pyrightconfig.json` with the following content:
33
34```json
35{
36  "venvPath": ".",
37  "venv": ".venv"
38}
39```
40
41If you prefer to use a `pyproject.toml` file, you can add the following section:
42
43```toml
44[tool.pyright]
45venvPath = "."
46venv = ".venv"
47```
48
49### Code formatting
50
51The Pyright language server does not provide code formatting. If you want to automatically reformat your Python code when saving, you'll need to specify an \_external_code formatter in your settings. See the [configuration](../configuring-zed.md) documentation for more information.
52
53A common tool for formatting python code is [Black](https://black.readthedocs.io/en/stable/). If you have Black installed globally, you can use it to format Python files by adding the following to your `settings.json`:
54
55```json
56{
57  "languages": {
58    "Python": {
59      "format_on_save": {
60        "external": {
61          "command": "black",
62          "arguments": ["-"]
63        }
64      }
65    }
66  }
67}
68```