在 Visual Studio Code 中使用 Python 进行 Linting
Linting 会突出显示 Python 源代码中的语义和样式问题，这通常有助于你识别和更正可能导致错误的细微编程错误或编码实践。例如，linting 可以检测未定义变量的使用、对未定义函数的调用、缺少括号，甚至更细微的问题，例如尝试重新定义内置类型或函数。Linting 与格式化不同，因为 linting 分析代码的运行方式并检测错误，而格式化仅重组代码的外观。
注意：Python 扩展的语言服务器默认启用语法错误检测。要了解如何配置语言服务器，请参阅语言服务器设置。本文档介绍如何为附加的代码检测（包括样式检查）启用 linting。
选择 linter
在VS Code Marketplace 中搜索你选择的 linter 扩展。如果愿意，你可以同时使用多个 linter。
Microsoft 发布了以下适用于 Python 的 linting 扩展
社区提供的 Linting 扩展
| Linter | 扩展 |
|---|---|
| Ruff | https://marketplace.visualstudio.com/items?itemName=charliermarsh.ruff |
| mypy | https://marketplace.visualstudio.com/items?itemName=matangover.mypy |
注意：如果你在上面的表格或 Marketplace 中找不到你喜欢的 linter，你可以通过扩展添加对其的支持。你可以使用 Python 扩展模板 将新的 Python 工具集成到 VS Code 中。
常规设置
你可以参考每个 linter 扩展的 README，了解支持的设置的更多详细信息。大多数 linter 扩展支持以下设置
| 设置 | 默认 | 说明 |
|---|---|---|
| args | [] |
要传递给 linter 的参数。注意：官方支持的 linters 在单个打开的文件上运行。请确保你的配置适用于该场景。 |
| importStrategy | useBundled |
当设置为 useBundled 时，扩展使用其自带的工具版本。当设置为 fromEnvironment 时，它首先尝试从你选择的 Python 环境中加载，否则会回退到捆绑版本。 |
| path | "" |
用于 linting 的 linter 二进制文件的路径。注意：使用此选项可能会减慢格式化速度。 |
| interpreter | [] |
当设置为 Python 可执行文件的路径时，扩展将使用该路径启动 linting 服务器及其子进程。 |
| showNotifications | off |
控制扩展显示通知的时间。支持的值包括 off、always、onError 和 onWarning。 |
禁用 linting
如果安装了 linters，它们默认是启用的。你可以通过在每个工作区中禁用扩展来禁用它们。
运行 linting
当打开或保存 Python 文件时，linting 将自动运行。
错误和警告会显示在已打开文件的问题面板中（⇧⌘M (Windows, Linux Ctrl+Shift+M)），并在代码编辑器中高亮显示。将鼠标悬停在带下划线的问题上会显示详细信息
代码操作
一些 linters 可能会提供代码操作来帮助解决报告的问题。你可以参考你喜欢的 linter 扩展下的功能贡献部分，了解它提供了哪些代码操作。
日志记录
从下拉菜单中选择 <linter name> 后，可在输出面板中查看 linters 的日志（⇧⌘U (Windows Ctrl+Shift+U, Linux Ctrl+K Ctrl+H)）。
可以通过命令面板（⇧⌘P (Windows, Linux Ctrl+Shift+P)）运行开发者：设置日志级别命令，更改 linter 扩展的日志级别。从扩展日志组中选择扩展，然后选择所需的日志级别。
严重性
Linters 以预定义的严重性报告问题。可以使用 linter 的 severity 设置更改此项。有关支持的值和严重性级别的更多详细信息，请参阅每个 linter 扩展的 README。
linting 疑难解答
| 问题 | 原因 | 解决方案 |
|---|---|---|
| Linter 扩展没有报告任何问题。 | 你的工作区没有选择 Python。 | 查看你正在使用的 linter 的日志，检查其使用的 Python 环境路径。如果没有选择 Python，请从命令面板运行 Python: Select Interpreter 命令，为你的工作区选择一个现有的解释器。 |
| 显示“你具有已弃用的 linting 或格式化设置”通知 | 如果你看到此通知，则表示你在 VS Code 中有 python.linting 或 python.formatting 等设置。这些设置不再受 Python 扩展支持，因为 linting 和格式化支持已迁移到工具扩展。 |
通过打开命令面板（⇧⌘P (Windows, Linux Ctrl+Shift+P)）并运行 首选项：打开用户设置 (JSON) 命令，查找这些设置在 VS Code 中的定义位置。如果它们不在用户设置中，则运行 首选项：打开工作区设置 (JSON) 命令。然后删除已弃用的设置。 注意：如果你正在使用远程开发扩展包中的任何扩展，你也可以通过运行 首选项：打开远程设置 (JSON) 命令检查远程设置。 |
| 即使我安装了 linter 扩展，linting 也不起作用。 | Linting 可能会因不同原因失败，例如使用了不受支持的 Python 版本，或者 linter 配置不正确。检查 linter 扩展的输出通道以了解 linter 失败的原因（在命令面板中运行 输出：聚焦输出 命令，然后选择 linter 扩展通道）。 |
后续步骤
- 格式化 - 了解如何格式化你的 Python 代码。
- 调试 - 学习在本地和远程调试 Python。
- 测试 - 配置测试环境，以及发现、运行和调试测试。
- 基本编辑 - 了解强大的 VS Code 编辑器。
- Python 扩展模板 - 创建一个扩展，将你喜欢的 linter 集成到 VS Code 中。