使用 Ruff 忽略特定目录中的特定规则

Question

我在用Ruff，这是一个用于 Python 代码的格式化程序或 linter 工具。

\n

我想忽略一些特定的规则，并将该配置写入pyproject.toml.

\n

我的包结构如下。

\n

.\n\xe2\x94\x9c\xe2\x94\x80\xe2\x94\x80 LICENSE\n\xe2\x94\x9c\xe2\x94\x80\xe2\x94\x80 pyproject.toml\n\xe2\x94\x9c\xe2\x94\x80\xe2\x94\x80 README.md\n\xe2\x94\x9c\xe2\x94\x80\xe2\x94\x80 src\n\xe2\x94\x82\xc2\xa0\xc2\xa0 \xe2\x94\x94\xe2\x94\x80\xe2\x94\x80 mypackage/mymodule.py\n\xe2\x94\x94\xe2\x94\x80\xe2\x94\x80 tests\n \xc2\xa0\xc2\xa0 \xe2\x94\x9c\xe2\x94\x80\xe2\x94\x80 doc.md\n \xc2\xa0\xc2\xa0 \xe2\x94\x94\xe2\x94\x80\xe2\x94\x80 test_mymodule.py\n

\n

而且，我想忽略规则pydocstyle (D)tests/。

\n

Answer 1

您可以使用 Ruffper-file-ignores并指定单个文件，或使用通配符（星号）选择目录树。您可以通过仅指定字母来忽略“字母类别”。

示例：忽略特定文件中的特定规则

要忽略测试中的行长度违规，请将其添加到 pyproject.toml 中：

[tool.ruff.lint.per-file-ignores]
"foofile.py" = ["E501"]

示例：忽略整个目录树中的一类规则

要忽略测试中的所有 pydocstyle 错误（以“D”开头），请将以下内容添加到 pyproject.toml 中：

[tool.ruff.lint.per-file-ignores]
"tests/*" = ["D"]

相关的 Ruff 文档在这里。