如何在 Python 中配置 VSCode 自动格式化和 Linting

VSCode Python 自动格式化和代码检查配置指南

VSCode 以其灵活性与强大的功能，成为众多 Python 开发者的首选 IDE。然而，代码编辑和自动化远不止 VSCode 一种工具。PyCharm、Sublime Text 甚至 Vim 等其他 IDE 或编辑器也各有千秋，选择取决于个人工作流程。本指南以 VSCode 为例，讲解如何设置自动格式化和代码检查，但其中原理同样适用于其他工具。

Python 开发者追求简洁易读的代码，而 VSCode 等工具可通过自动格式化和代码检查轻松实现这一目标。本指南将演示如何利用配置文件和命令行工具配置 VSCode，实现 Python 代码的自动化格式化和检查，从而避免手动操作。

一、为什么要进行自动格式化和代码检查？

立即学习“Python免费学习笔记（深入）”；

• 自动格式化： 确保代码风格一致，遵循 PEP 8 规范，节省手动调整时间。
• 代码检查： 早期发现语法错误、未使用导入以及其他潜在问题。

两者共同维护代码质量，减少错误。

二、所需工具

高效格式化和检查 Python 代码，需要以下工具：

• Black (格式化工具): 一个严格的代码格式化程序，自动确保风格一致，遵循 PEP 8 规范。主要功能是简化代码格式，免除手动调整。安装命令：pip install black

• Pylint (代码检查工具): 分析 Python 代码，识别错误、执行编码规范并突出显示潜在问题，例如未使用导入或未定义变量。主要功能是检测错误并实施最佳实践。安装命令：pip install pylint

三、自动化配置：Black 和 Pylint

为了简化工作流程，可以将 VSCode 配置为在保存时自动格式化和检查代码。此举省去了手动检查的步骤，确保代码保持一致性，无需额外操作。

1. 启用保存时自动格式化和代码检查

将以下选项添加到 settings.json 文件：

{   "editor.formatOnSave": true,   "editor.codeActionsOnSave": {     "source.fixAll": true   } }

• "editor.formatOnSave"：保存文件时自动格式化代码。
• "editor.codeActionsOnSave"：保存时运行所有可用的代码检查修复，自动解决已识别的问题。

2. 编程方式更新 VSCode 设置

在 .vscode 目录下创建或更新 settings.json 文件：

{   "python.formatting.provider": "black",   "editor.formatOnSave": true,   "python.linting.enabled": true,   "python.linting.pylintEnabled": true,   "python.formatting.blackArgs": ["--line-length=79"],   "python.linting.pylintArgs": ["--disable=C0114,C0115,C0116"] }

此配置启用 Black 作为格式化程序，将行长度设置为 79 个字符，启用 Pylint 代码检查，并禁用特定的文档字符串警告。

3. 添加推荐扩展

为了增强团队一致性，确保所有成员都使用必要的工具，可在项目中添加 extensions.json 文件：

{   "recommendations": [     "ms-python.python",     "ms-python.black-formatter",     "ms-python.pylint"   ] }

将此文件保存在 .vscode 目录下，命名为 extensions.json。

四、配置文件说明

目录结构示例：

.vscode/ ├── settings.json └── extensions.json

五、测试配置

1. 格式化和代码检查示例

• 有问题的代码：

import os  def example_function():         print ( "hello world" ) print(undefined_variable)

• Black 格式化后：

import os  def example_function():     print("hello world")  print(undefined_variable)

• Pylint 检查后： 将标记以下警告：
  • 未使用的导入 os
  • 未定义的变量 undefined_variable

2. Black 和 Pylint 结合使用

• 原因： Black 确保格式一致，自动遵循 PEP 8；Pylint 识别代码问题（例如未使用导入、未定义变量）并强制执行编码规范。

• 工作流程： 更新 settings.json 文件（如步骤三所示）。

六、总结

通过 settings.json 和命令行工具配置 VSCode 自动格式化和代码检查，可确保无缝一致的开发流程。自动化避免了手动步骤，让您专注于编写高质量的 Python 代码，而无需担心格式或代码检查问题。

祝您编码愉快！