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