pyright and pyright-langserver gives different results?

[ebetica]

Hi! I'm trying to interface pyright with Kakoune, since it seems to be significantly faster than pyls. However, I'm having a problem with import resolution.

Here's a minimal working example:

$ tree
.
├── main.py
├── setup.py
└── testpkg
    ├── __init__.py
    └── pkg.py

1 directory, 4 files
$ cat main.py 
from testpkg import pkg # There is a problem in this line.

pkg.f()
$ cat testpkg/pkg.py 
def f():
    print("HI!")

First, I run pyright main.py, which claims there are no issues, and the import goes through. Then, I run it through the language server via Kakoune's kak-lsp package. I see that a textDocument/didOpen was sent to the server, with the correct uri (file:///path/to/main.py). The server claims no source files are found, which I think is correct since it's using pyright-langserver --stdio to communicate. However, it's incorrectly saying that it cannot import this package.

I'm not sure if this helps at all, but the language server also never displays that it found pyrightconfig.json if I include one, whereas pyright will find the configuration. Is there some other path I should be passing into the language server to get imports correct? Does it work in other editors?

[erictraut]

The pyright language server has been integrated successfully with neovim, sublime and emacs. You can find links to these projects on the main pyright page. The authors of these projects may be able to help you debug the issue you're hitting.

My guess is that the workspace root directory is not being passed through correctly from the editor to the LSP.

[erictraut]

It's fine for didChangeConfiguration to have an empty json.

I suspect that the problem is with the initialize message. It should be passed a set of parameters that includes either a workspaceFolders or rootPath field. The former is used for multi-root workspaces (if the editor supports that). The latter is used for simple single-root workspaces.

[ebetica]

Ah - thanks a lot! We are sending a rootUri field, which looks to be deprecated in favor of workspaceFolders. I'm guessing pyright somehow doesn't read this deprecated field then?

[erictraut]

Both rootPath and rootUri are deprecated. Pyright will use rootPath if it's provided, but it doesn't do anything with rootUri. So that explains the problem you're seeing.

[jakebailey]

MPLS used rootUri if present, then rootPath (predating workspaceFolders; URI replaced the path IIRC); perhaps we can just take it and use it if it's a valid file:// URI?

[erictraut]

I don't think there's a need to change it. Both fields are deprecated at this point. We will continue to support rootPath for backward compatibility.

[ebetica]

TL;DR: pyright supports rootPath but not rootUri, both are deprecated so workspaceFolders is what should be used going forwards.