如何使用 flake8 检查 Python 代码格式？

知行合一，至于至善

已于 2024-08-15 15:25:20 修改

阅读量821

点赞数 19

文章标签： python 开发语言

于 2024-08-15 14:39:42 首次发布

本文链接：https://blog.csdn.net/qq_41800917/article/details/141220510

版权

一、基本用法

使用 flake8 检查 Python 代码格式的步骤如下：

1. 安装 Flake8

首先，确保你已经安装了 flake8。可以通过 pip 来安装：

pip install flake8

2. 检查代码

在终端中，导航到你的项目目录，然后运行 flake8 命令，后面可以跟你想检查的文件或目录：

flake8 path/to/your/code.py

或者检查整个项目目录：

flake8 .

3. 解析输出

flake8 会输出代码中存在的问题，包括错误类型、行号和具体的错误信息。例如：

path/to/your/code.py:10:1: E302 expected 2 blank lines, found 1

E302 是错误代码。
10:1 是行号和列号。
后面的信息是具体的错误描述。

4. 修复问题

根据 flake8 的输出，逐一修复代码中的问题，然后再次运行 flake8，直到没有错误输出为止。

5. 自动化检查（可选）

你可以将 flake8 集成到你的持续集成（CI）流程中，或者在保存文件时自动运行。可以使用 IDE 插件或脚本来实现。

示例

假设你有一个简单的 Python 文件 example.py：

def example():
    print("Hello, world!")

example()

运行 flake8 example.py，如果没有问题，它将不会输出任何内容。如果有问题，它会列出所有的格式问题。

二、基于配置文件用法

创建 .flake8 配置文件以定制 flake8 的检查规则。以下是具体步骤和一些示例配置。

步骤

创建 .flake8 文件：
在你的项目根目录下创建一个名为 .flake8 的文件。你可以使用文本编辑器如 Notepad、VS Code、Sublime Text 或命令行工具来创建该文件。
添加配置项：
在 .flake8 文件中添加你想要的配置项。以下是一些常见的配置项及其说明：

示例配置

[flake8]
# 设置最大行长度
max-line-length = 120

# 忽略特定的错误和警告
ignore = E501, W503, F403

# 只检查特定的文件类型
# 追加忽略的错误
extend-ignore = E501  

# 排除特定的目录或文件
exclude = .venv, .idea, .vscode, demo, resource, dev_test, lib

# 添加额外的配置（比如启用复杂度检查）
max-complexity = 10

配置项解释

max-line-length：设置最大行长度，默认为 79 行。可以根据团队的代码风格或个人偏好进行设置。
ignore：定义忽略的错误代码，例如 E501 代表行过长，W503 代表换行符问题。
exclude：指定不需要检查的文件或目录，多个目录用逗号分隔。
max-complexity：设置允许的最大复杂度（Cyclomatic Complexity），用于控制代码复杂性。

使用配置

一旦你创建并配置了 .flake8 文件，运行 flake8 时，它会自动读取该文件中的设置。例如，在终端中运行：

flake8 .

flake8 会根据你在 .flake8 文件中定义的规则来检查代码。

检查配置是否生效

你可以通过运行以下命令来确认配置是否生效：

flake8 --config=.flake8

这会显示 flake8 读取的配置内容，确保你的设置被正确加载。

使用 .flake8 文件可以帮助你集中管理所有的 flake8 配置，使得代码风格的一致性更容易维护。如果在项目中与其他开发者协作，建议将该文件加入版本控制（如 Git），以确保团队成员都遵循相同的代码风格规则。

三、Pycharm 配置使用 flake8 进行语法检测

创建工具

在这里TI插入图片描述

配置参数

在这里插入图片描述

参数说明

Program 的值为 $PyInterpreterDirectory$/python
Arguments 的值为 -m flake8 --max-line-length=120 --exclude venv,migrations $ProjectFileDir$
Working directory 的值为 $ProjectFileDir$

说明：
	$PyInterpreterDirectory$	 当前项目使用的python环境bin目录
	--exclude                    可以过滤掉不检测的目录或文件
	$ProjectFileDir$             当前项目所在目录