你如何忽略项目、文件、行的特定 Pyright 类型检查？

Question

我找不到关于如何忽略一项或多项特定 Pyright 检查的明确文档：

1. 使用项目根目录下的配置文件。
2. 在文件、函数或方法的顶部。
3. 每一行作为尾随注释。

提前感谢您分享此信息。

Answer 1

像 # type: ignore 这样的常用 mypy 内联 cmets 应该可以工作 (see details)，对于 pyright 特定配置，您可以在项目根目录中放置 pyrightconfig.json。您可以找到可用的配置选项here。它只是一个 JSON 文件，所以看起来像这样：

{
    "venvPath": "/home/username/.virtualenvs/",
    "venv": "myenv",
    "reportOptionalSubscript": false,
    "reportOptionalMemberAccess": false
}

编辑：

源内配置只能作为mypy 支持的类型忽略语句。 # type: ignore 不是其他东西的占位符，它是字面意思。缩小范围并忽略特定错误（它只能是mypy 错误代码之一），如下所示：# type: ignore[error-code]

要使用cmets中提到的import的具体例子，这里有两种变体：

from os import non_existent  # type: ignore[attr-defined]

from missing_module import name  # type: ignore

这一切都在我提供的mypy 文档的链接以及从那里链接的list of error codes 中进行了讨论。

pyright 特定配置只能是项目范围的，可以通过在 pyproject.toml 文件的 [tool.pyright] 部分中指定它们，或者通过在顶级项目目录中创建像上面一样的 pyrightconfig.json。

EDIT2：

在 cmets 中，OP 提出了如何找到与 pyright 配置选项对应的 mypy 错误代码的问题。不幸的是，除了彻底阅读文档以及对语言有所了解之外，没有其他简单的方法。例如在from os import name 的情况下，Python 实际上是将模块对象os 的属性os.name 导入到当前命名空间中。以下交互式会话应该清楚地说明这一点：

In [1]: import os

In [2]: type(os)
Out[2]: module

In [3]: locals()["curdir"]
-------------------------------------------------------------------
KeyError                          Traceback (most recent call last)
<ipython-input-3-a31c5782bef1> in <module>
----> 1 locals()["curdir"]

KeyError: 'curdir'

In [4]: from os import curdir

In [5]: locals()["curdir"]
Out[5]: '.'

In [6]: os.curdir == curdir
Out[6]: True