Repolode
PyCQA

PyCQA/flake8

一个 Python 代码检查工具,将 PyFlakes、pycodestyle 和 McCabe 整合为单一命令。

Star
3,833
Fork
364
未关闭 Issue
24
最近提交
3天前

这是什么?

Flake8 用于检查 Python 源代码的风格问题和质量问题。它将 PyFlakes(检测未使用的导入等逻辑错误)、pycodestyle(检查 PEP 8 风格)和 McCabe(分析代码复杂度)合并运行,通过一条 flake8 命令输出按文件归类的统一报告。

除了整合这些工具,Flake8 还支持选择性忽略警告:文件中加入特定标记可跳过整个文件,行尾加 noqa 注释可屏蔽该行,指定错误代码的 noqa 注释则只忽略对应错误。它也支持 Git 和 Mercurial 钩子。

通过 flake8.extension 和 flake8.formatting 入口点,Flake8 可以扩展,第三方插件可以添加新的检查规则或自定义输出格式。

核心功能

  • 01通过单一命令同时运行 PyFlakes、pycodestyle 和 McCabe。
  • 02将警告合并为按文件归类的统一输出。
  • 03支持使用 noqa 注释在文件或行级别跳过检查。
  • 04可以只屏蔽某一行上指定的错误代码。
  • 05提供 Git 和 Mercurial 钩子。
  • 06通过入口点机制支持第三方插件扩展。

适用场景

  • 在 Python 项目的 CI 流程中执行 PEP 8 风格检查并发现常见缺陷。
  • 在提交代码前通过 Git 钩子运行代码检查。
  • 使用 McCabe 检查器识别并标记复杂度过高的函数。
  • 以 Flake8 插件的形式编写自定义检查规则或输出格式。

快速上手

  1. 1

    按照 README 中链接的快速入门文档安装并运行 Flake8

使用前须知

  • 项目元数据中未明确标注许可证。

收录于专题

标签

常见问题

flake8 是什么?
一个 Python 代码检查工具,将 PyFlakes、pycodestyle 和 McCabe 整合为单一命令。 Flake8 用于检查 Python 源代码的风格问题和质量问题。它将 PyFlakes(检测未使用的导入等逻辑错误)、pycodestyle(检查 PEP 8 风格)和 McCabe(分析代码复杂度)合并运行,通过一条 flake8 命令输出按文件归类的统一报告。
flake8 可以免费使用吗?用的什么许可证?
flake8 以 Other 许可证开源。用于商业产品前,请先确认许可证条款。
flake8 还在维护吗?
活跃维护中。flake8 最近一次提交是在 2026年11月4日。
flake8 适合用来做什么?
在 Python 项目的 CI 流程中执行 PEP 8 风格检查并发现常见缺陷。 在提交代码前通过 Git 钩子运行代码检查。 使用 McCabe 检查器识别并标记复杂度过高的函数。 以 Flake8 插件的形式编写自定义检查规则或输出格式。
flake8 怎么安装和运行?
按照 README 中链接的快速入门文档安装并运行 Flake8
在哪里获取 flake8?
源代码和安装说明在 GitHub 上:https://github.com/PyCQA/flake8

概要由 AI 根据项目 README 生成;GitHub 数据每日更新。

相关项目