[LSP] 试用Python开发新包 lsp-pyright

kenkangxgwe · 2020 年8 月 2 日 22:16

是时候弄个 vscode-as-a-language-server 了

yangyingchao · 2020 年8 月 3 日 01:03

多谢，貌似没起作用，也许是我的配置不对吧。

最后直接加了个 pyrightconfig.json 来搞定了：

microsoft/pyright/blob/main/docs/configuration.md

# Pyright Configuration

Pyright 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. Multi-root workspaces (“Add Folder to Workspace…”) are supported, and each workspace root can have its own “pyrightconfig.json” file. For a sample pyrightconfig.json file, see [below](https://github.com/microsoft/pyright/blob/main/docs/configuration.md#sample-config-file).

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. For a sample pyproject.toml file, see [below](https://github.com/microsoft/pyright/blob/main/docs/configuration.md#sample-pyprojecttoml-file).

Relative paths specified within the config file are relative to the config file’s location. Paths with shell variables (including `~`) are not supported. Paths within a the config file should generally be relative paths so the config file can be shared by other developers who contribute to the project.

## Main Pyright Config Options

**include** [array of paths, optional]: Paths of directories or files that should be included. If no paths are specified, pyright defaults to the directory that contains the config file. Paths may contain wildcard characters ** (a directory or multiple levels of directories), * (a sequence of zero or more characters), or ? (a single character). If no include paths are specified, the root path for the workspace is assumed.

**exclude** [array of paths, optional]: Paths of directories or files that should not be included. These override the includes directories, allowing specific subdirectories to be ignored. Note that files in the exclude paths may still be included in the analysis if they are referenced (imported) by source files that are not excluded. Paths may contain wildcard characters ** (a directory or multiple levels of directories), * (a sequence of zero or more characters), or ? (a single character). If no exclude paths are specified, Pyright automatically excludes the following: `**/node_modules`, `**/__pycache__`, `.git` and any virtual environment directories.

**ignore** [array of paths, optional]: Paths of directories or files whose diagnostic output (errors and warnings) should be suppressed even if they are an included file or within the transitive closure of an included file. Paths may contain wildcard characters ** (a directory or multiple levels of directories), * (a sequence of zero or more characters), or ? (a single character).

**strict** [array of paths, optional]: Paths of directories or files that should use “strict” analysis if they are included. This is the same as manually adding a “# pyright: strict” comment. In strict mode, most type-checking rules are enabled. Refer to [this table](https://github.com/microsoft/pyright/blob/main/docs/configuration.md#diagnostic-rule-defaults) for details about which rules are enabled in strict mode. Paths may contain wildcard characters ** (a directory or multiple levels of directories), * (a sequence of zero or more characters), or ? (a single character).

**defineConstant** [map of constants to values (boolean or string), optional]: Set of identifiers that should be assumed to contain a constant value wherever used within this program. For example, `{ "DEBUG": true }` indicates that pyright should assume that the identifier `DEBUG` will always be equal to `True`. If this identifier is used within a conditional expression (such as `if not DEBUG:`) pyright will use the indicated value to determine whether the guarded block is reachable or not. Member expressions that reference one of these constants (e.g. `my_module.DEBUG`) are also supported.

This file has been truncated. show original

seagle0128 · 2020 年8 月 3 日 02:19

你是增加这个配置吗？typeshedPath

yangyingchao · 2020 年8 月 3 日 02:58

不是的，我就修改了一下 executionEnvironments, like:

{
  "include": [
      "tools"
  ],

  "exclude": [
    "**/node_modules",
    "**/__pycache__",
    "src/experimental",
    "src/typestubs"
  ],

  "ignore": [
    "src/oldstuff"
  ],


  "pythonVersion": "2.7",
  "pythonPlatform": "Linux",


  "reportMissingImports": true,
  "reportMissingTypeStubs": false,

  "executionEnvironments": [
    {
      "root": "tools",
      "extraPaths": [
          "tools/bin"
      ]
    }
  ]
}

hek14 · 2020 年8 月 3 日 03:07

pyright能自动识别吗？还是得在lsp-pyright中配置。另外，这是每一个project的root里写一个这样的配置文件对吧

yangyingchao · 2020 年8 月 3 日 03:22

我没试过其他工程，至少在我这个工程里面，不需要修改 lsp-pyright，在 root 写这个配置，就可以自动识别了。

seagle0128 · 2020 年8 月 3 日 03:42

两种方式都支持，优先读取 json 配置。

hek14 · 2020 年8 月 3 日 09:54

刚才试了, 这个没有用呀. 我不太想每个project都写这么个配置文件. 偏向于用这种方式, 但是目前这个settings不起作用

我是用的more-settings分支, 然后这样设置: (setq lsp-pyright-extra-paths '(“/path/to/current_project”))

seagle0128 · 2020 年8 月 3 日 14:36

这个变量是vector，不是list，应该这样设置：

(setq lsp-pyright-extra-paths ["/path/to/current_project"])

hek14 · 2020 年8 月 3 日 15:25

我这样子设置之后, ‘lsp-workspace-restart’ 还是不行

yangyingchao · 2020 年8 月 4 日 02:02

我的环境下也不行，后来加了个 pyrightconfig.json 就可以了，没细研究。

seagle0128 · 2020 年8 月 4 日 04:07

试试 (setq lsp-pyright-auto-search-paths nil) 呢？还不行就用 pyrightconfig.json。

hek14 · 2020 年8 月 4 日 05:08

我用的一个minimal pyrightconfig.json如下:

{
    "executionEnvironments": [
        {
            "root": ".",
            "extraPaths": [
                "."
            ]
        }
    ]
}

添加这个文件, 然后lsp-workspace-restart 还是不行, 是这里不能用 ‘. ’ 表示当前文件夹嘛? 我试过全路径也不行.

seagle0128 · 2020 年8 月 6 日 15:55

这个肯定是起作用的，lsp-pyright中的配置确实还有问题。

seagle0128 · 2020 年8 月 10 日 02:33

补全的配置问题应该已经解决，PR正在review中。

MatthewZMD · 2020 年8 月 10 日 04:10

这个效果怎么样，如果与mspyls相差无几的话我近期就换过来试试

seagle0128 · 2020 年8 月 10 日 04:34

效果还行，功能还是比不过mspyls，其他方面都还不错。client我们也还在改进，欢迎尝试。

seagle0128 · 2020 年8 月 10 日 16:55

lsp-pyright已经通过melpa审核，可以用直接安装了。另外，自动搜索路径和补全也已经解决，请试用。

hek14 · 2020 年8 月 11 日 09:45

确认. 自动补全和搜索路径已经搞定, 还有一个问题: workspace/symbol 这个功能没有加进来嘛? (lsp-ivy-workspace-symbol)

seagle0128 · 2020 年8 月 11 日 10:02

什么意思？lsp-ivy-workspace-symbol 不是应该是个人配置的事吗？