Python lsp: Pyright isn't good

[lctzz540]

Check for existing issues

• Completed

Describe the feature

it should be pylsp. The pyright has issues about recognize libraries installed

If applicable, add mockups / screenshots to help present your vision of the feature

No response

[JosephTLyons]

Yeah, pyright has been a big source of pain for us in the Zed-Python intersection. I think we should def swap out to something better. I've not heard of pylsp, but we should def add it to the list of ones to check out:

• pylsp
• pylyzer
• astral.sh will hopefully build a language server in Rust

We are working on language plugins at the moment, so, in the not-so-distant future, someone can just add these servers as plugins, but I do think we should swap out our provided one for a bettter one.

[plattenschieber]

Yeah, pyright has been a big source of pain for us in the Zed-Python intersection. I think we should def swap out to something better. I've not heard of pylsp, but we should def add it to the list of ones to check out:

• pylsp
• pylyzer
• astral.sh will hopefully build a language server in Rust

We are working on language plugins at the moment, so, in the not-so-distant future, someone can just add these servers as plugins, but I do think we should swap out our provided one for a bettter one.

Indeed they did build a language server protocol for Ruff already ruff-lsp @JosephTLyons 🔥

[JosephTLyons]

Yeah, pyright has been a big source of pain for us in the Zed-Python intersection. I think we should def swap out to something better. I've not heard of pylsp, but we should def add it to the list of ones to check out:

• pylsp
• pylyzer
• astral.sh will hopefully build a language server in Rust

We are working on language plugins at the moment, so, in the not-so-distant future, someone can just add these servers as plugins, but I do think we should swap out our provided one for a bettter one.

Indeed they did build a language server protocol for Ruff already ruff-lsp @JosephTLyons 🔥

AFAICT, ruff-lsp only support formatting and linting as of right now, as they haven't gotten to building things out like go to def and auto-completion, but I read they will be doing that at some point.

[failable]

https://github.com/pappasam/jedi-language-server

[JacobGoldenArt]

Yeah. I love Zed but when I open a Python project it's just strange. I will activate my .venv in my project directory and the script will run but when you look at the python file the imports are all red and can't be resolved.

[JacobGoldenArt]

See that python-dotenv is installed, along with pydantic in my env - (pip list) but I guess pyright is not checking for packages in the project-directory/.venv ???

[failable]

You need this file.

$ cat pyrightconfig.json
{
  "venvPath": ".",
  "venv": ".venv"
}

[Moshyfawn]

There's an issue #8541 about resolving modules with Pyright.

[newtome8888]

I see this problem last for months, but there's still no real solution?

[JosephTLyons]

You need this file.

$ cat pyrightconfig.json
{
  "venvPath": ".",
  "venv": ".venv"
}

This should actually solve the problem - for some reason, during the migration of our documentation, we lost our Python docs that mentions this config file. I've quickly dumped the old Python docs contents into the configuration section of our website, here. I need to bring back more documentation, so I will organize this better later on.

As a side note, I want to say that we are going to be doing more for Python here shortly - we recognize just how important this language is, being one of the top most-used languages, and we want to improve for Python devs in Zed.

[newtome8888]

You need this file.

$ cat pyrightconfig.json
{
  "venvPath": ".",
  "venv": ".venv"
}

This should actually solve the problem - for some reason, during the migration of our documentation, we lost our Python docs that mentions this config file. I've quickly dumped the old Python docs contents into the configuration section of our website, here. I need to bring back more documentation, so I will organize this better later on.

As a side note, I want to say that we are going to be doing more for Python here shortly - we recognize just how important this language is, being one of the top most-used languages, and we want to improve for Python devs in Zed.

I tried it, but no luck. I use poetry in my python project, does it matter?

[collinsinclair]

To add to the corpus of Pyright issues, in is_24hour = models.BooleanField(default=False), False is red-underlined for

Argument of type "Literal[False]" cannot be assigned to parameter "default" of type "type[NOT_PROVIDED]" in function "_init_" Type "Literal[False]" cannot be assigned to type "type[NOT_PROVIDED]"

Additionally, in def __str__(self):, __str__ is red-underlined for

Method "_str_" overrides class "Model" in an incompatible manner Return type mismatch: base method returns type "str", override returns type "CharField" "CharField" is incompatible with "str"

I have done no custom configuration. I believe these shouldn't be showing issues as they work as expected and are standard practices.

[r-cha]

I tried it, but no luck. I use poetry in my python project, does it matter?

@newtome8888 run poetry env info to find the path to your virtualenv, then add that to your pyrightconfig. Worth noting, this path will be different per machine, so don't add pyrightconfig.json to any version control. Mine looks something like this:

{
  "venvPath": "/Users/username/Library/Caches/pypoetry/virtualenvs",
  "venv": "projectname-p0LYZhue-py3.11"
}

[JosephTLyons]

I tried it, but no luck. I use poetry in my python project, does it matter?

@newtome8888 run poetry env info to find the path to your virtualenv, then add that to your pyrightconfig. Worth noting, this path will be different per machine, so don't add pyrightconfig.json to any version control. Mine looks something like this:

{
  "venvPath": "/Users/username/Library/Caches/pypoetry/virtualenvs",
  "venv": "projectname-p0LYZhue-py3.11"
}

Just to mention, there is a setting in poetry tells poetry to install the venv within the project:

• https://python-poetry.org/docs/configuration#virtualenvsin-project

Which would stabilize where the pyrightconfig.json points to, when running the project on multiple machines.

[failable]

Using pyright is literally painful.

[bersace]

Thus far I'm enjoying it and it feels like one I should submit to the extensions repo. python-lsp-server has mypy support but I've yet to see it working in practice. Happy to hack with folks on it!

How to disable pyright and move to pylsp ?

[rgbkrk]

You can now search for "Python LSP" in extensions to enable it.

Note that you will need to install the python lsp server directly first.

Read more in the python-lsp-zed-extension README and file issues there. I'm still figuring out what else I can enable. I would ❤️ if someone gets mypy configuration working with it.

[a-kachurin]

You can now search for "Python LSP" in extensions to enable it.

Note that you will need to install the python lsp server directly first.

Read more in the python-lsp-zed-extension README and file issues there. I'm still figuring out what else I can enable. I would ❤️ if someone gets mypy configuration working with it.

Is the "Go to Definition" feature implemented in your plugin? I would like to try Zed on Win11. Could you please provide more detailed instructions on how to set up the plugin?

[lucianosrp]

Is the "Go to Definition" feature implemented in your plugin? I would like to try Zed on Win11.

Even with pylsp and basedpyright I am still not able to "Go to Definition" on Windows 11

[failable]

Has anyone successfully started pylsp and been able to use the code completion feature? Even though I installed python-lsp-server, I still can't use any of its functions.

[vrslev]

@failable You should also have pylsp installed—then it works

[failable]

@vrslev

Even though I installed python-lsp-server

[vrslev]

Do you have it in PATH?

[fabioz]

Question (I can open a different issue if needed, but I thought asking here is Ok, if not, please let me know).

I have my own language server that I do for Python (https://marketplace.visualstudio.com/items?itemName=fabioz.vscode-pydev), how can I stop using the builtin one to use my own?

-- i.e.: if I register another Python extension (as in https://github.com/rgbkrk/python-lsp-zed-extension/), will it stop using the builtin one, which is giving me pyright errors?

[Herraj]

Looks like pylsp was added as of today: #20358. Also mentioned in the release notes!

also see issue: #20646

[JaagupAverin]

Since pyright and basedpyright don't support formatting, I agree with implementing pylsp as default
...
I'd appreciate any thoughts on this approach.

My only gripe with pylsp is that, as of today, basedpyright is a more fleshed out type checker with more features such as inlay hints, and a very active developer who's pushing patches on a weekly basis, whereas pylsp seems to be a bit stale and features such as inlay hints are still missing.

Furthermore from my perspective having the formatter (Ruff) in parallel to the LSP is a more flexible experience than having the formatter hierarchically under the the LSP (as a plugin). But I am not well acquainted with the technicalities of this topic so perhaps there is a performance/scaling consideration that I'm not aware of.

[ryukinix]

There is any simple way to replace pyright with mypy? Pyright being the default is kinda a deal breaker for me.

[osiewicz]

You can use mypy with pylsp that's the other language server provided out of the box.

[smparekh]

for macOS using pylsp with ruff, here is my setup:

...
  "languages": {
    "Python": {
      "language_servers": ["pylsp", "!pyright", "..."],
      "preferred_line_length": 120
    }
  },
  "lsp": {
    "pylsp": {
      "binary": {
        "path": "/Users/<USERNAME>/.local/bin/pylsp"
      },
      "settings": {
        "plugins": {
          "ruff": {
            "enabled": true,
            "formatEnabled": true,
            "lineLength": 120,
            "targetVersion": "py311"
          }
        }
      }
    },
...

Install python-lsp-ruff:

pipx install python-lsp-ruff --include-deps

[g0di]

Furthermore from my perspective having the formatter (Ruff) in parallel to the LSP is a more flexible experience than having the formatter hierarchically under the the LSP (as a plugin). But I am not well acquainted with the technicalities of this topic so perhaps there is a performance/scaling consideration that I'm not aware of.

I can rely on that. I've give a try to python-lsp-ruff plugin to use only pylsp as my one and only language server in Zed for python and it appeared that formatting (and code fixes) were lot more slower (more than a second) compared to using directly the ruff lsp (instantaneous) next to pylsp or pyright for handling the rest. I don't know if I'm the only one noticing this.

By the way, I actually have to use pyright, pylsp and ruff servers next to each others in my Zed config because using only pylsp and ruff does not provide any autocompletion anymore... Not sure why. So pyright gives me autocompletion (and more), pylsp gives me mypy type checking (through plugin) and ruff gives me linting and formatting.

Not sure if this is the best config but it works as intended. Just my 2 cents experience.