How to Configure VSCode for Auto Formatting and Linting in Python

VSCode Python code automatic formatting and code inspection configuration guide

VSCode has become the code editor of choice for many Python developers due to its flexibility and powerful features, but it is just one of many code editing and automation tools. Depending on the workflow, developers may prefer other IDEs or editors like PyCharm, Sublime Text, or even Vim. This guide focuses on VSCode, showing how to set up automatic formatting and code inspection, but similar principles apply to other tools.

Python developers strive for concise and readable code, and tools like VSCode simplify this process through automatic formatting and code inspection. In this guide, we'll show you how to configure VSCode for Python formatting and code inspection using configuration files and CLI commands to ensure automation and avoid manual intervention.

Why do you need automatic formatting and code checking?

• Automatic formatting Ensure consistent code style, compliance with PEP 8, and save time on manual adjustments.
• Code inspection identifies syntax errors, unused imports, and other potential issues early on.

Together, the two help maintain high-quality code and reduce errors.

Tools needed for formatting and code inspection

To effectively format and inspect Python code, you need the following tools:

Black (formatting tool)

• Purpose: Black is a powerful code formatting tool that automatically ensures consistent code style and compliance with PEP 8 specifications.
• Main functions: Simplify code formatting without manual adjustments.
• Install: Run pip install black

pylint (code checking tool)

• Purpose: pylint analyzes Python code to identify errors, enforce coding standards, and highlight potential issues such as unused imports or undefined variables.
• Key Features: Detect errors and enforce best practices.
• Install: Run pip install pylint

Automated configuration using Black and pylint

To further streamline your workflow, you can configure VSCode to automatically format and check code on save. This eliminates the need for manual checking and ensures your code remains consistent without extra effort.

Enable automatic formatting and code inspection on save

Add the following options to your settings.json file:

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

• "editor.formatOnSave": Automatically format the code when saving the file.
• "editor.codeActionsOnSave": Runs all available code inspection fixes when saving, ensuring any identified issues are automatically resolved.

You can use settings.json configuration files to define formatting and code inspection preferences without having to manually adjust VSCode settings.

Update VSCode settings programmatically

Create or update .vscode files in your settings.json directory:

{
  "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"]
}

This will enable Black as a formatter, set line length to 79 characters, enable pylint code inspection, and disable specific docstring warnings.

Add recommended extensions

To enhance team-wide code consistency and ensure all members are using the necessary tools, you can add extensions.json files directly to your project:

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

Save this file in the .vscode directory and name it extensions.json.

Visual representation of configuration files

Here’s a breakdown of the files and their uses:

文件	用途
.vscode/settings.json	定义项目特定的格式化和代码检查行为设置。
.vscode/extensions.json	推荐团队范围内的开发 IDE 扩展。

Directory structure example

<code>.vscode/
├── settings.json   # 配置格式化和代码检查行为
├── extensions.json # 推荐 VSCode 扩展</code>

Test your configuration

Formatting and code inspection examples

1. Coding issues:

   import os

   def example_function():
           print ( "Hello World" )
   print(undefined_variable)

2. After running Black:

   import os

   def example_function():
       print("Hello World")

   print(undefined_variable)

3. After running pylint: the following warning will be marked:
   • Unused import: os
   • Undefined variable: undefined_variable

Use Black and pylint together

Why use Black and pylint together?

• Black automatically ensures consistent formatting and compliance with PEP 8.
• pylint identifies code issues (e.g. unused imports, undefined variables) and enforces coding standards.

Workflow using these two tools

Update 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"]
}

Conclusion

Configure VSCode for automatic formatting and code checking using settings.json and CLI commands to ensure a seamless and consistent development workflow. By avoiding manual steps and leveraging automation, you can focus on writing high-quality Python code without worrying about formatting or code inspection issues.

Happy programming!

The above is the detailed content of How to Configure VSCode for Auto Formatting and Linting in Python. For more information, please follow other related articles on the PHP Chinese website!