Repolode
PyCQA

PyCQA/pycodestyle

一个单文件的 Python 代码风格检查工具,依据 PEP 8 规范检查代码,只依赖标准库。

Star
5,165
Fork
762
未关闭 Issue
105
最近提交
3天前

这是什么?

pycodestyle 用于检查 Python 源代码是否符合 PEP 8 官方风格指南中的部分规范。它会报告诸如同一行多个 import、函数之间空行数不对、多余空白以及行过长等问题,每条结果都带有 E401、E302 这样的错误代码和所在位置。

项目仅由一个 Python 文件组成,只依赖标准库,可以直接放进项目中使用。输出格式便于编辑器定位到具体错误,工具还可以显示出错的源码行及对应的 PEP 8 说明。统计模式可以汇总整个代码库中各类错误出现的次数。

该工具采用插件架构,便于添加新的检查规则。项目此前名为 pep8,后更名为 pycodestyle,以避免与 PEP 8 规范文档本身混淆。

核心功能

  • 01依据 PEP 8 检查多项风格规则,每条结果都带有固定的错误代码。
  • 02整个工具为单个文件,仅依赖 Python 标准库。
  • 03输出文件、行号和列号,方便编辑器直接跳转到错误位置。
  • 04可显示出错的源码行及对应的 PEP 8 说明。
  • 05提供统计模式,汇总整个代码库中的错误数量。
  • 06支持通过插件添加自定义检查规则。

适用场景

  • 在 Python 项目的持续集成中统一执行 PEP 8 格式检查。
  • 在编辑器中编写 Python 代码时获得实时的风格提示。
  • 审查大型遗留代码库,查看最常见的风格问题。
  • 在不引入额外依赖的情况下运行轻量级风格检查。

快速上手

  1. 1

    使用 pip 安装 pycodestyle

    pip install pycodestyle
  2. 2

    对 Python 文件运行检查以检测代码风格

    pycodestyle --first optparse.py

使用前须知

  • 元数据中的许可证不明确(NOASSERTION),在复用前请先查看仓库。

收录于专题

标签

常见问题

pycodestyle 是什么?
一个单文件的 Python 代码风格检查工具,依据 PEP 8 规范检查代码,只依赖标准库。 pycodestyle 用于检查 Python 源代码是否符合 PEP 8 官方风格指南中的部分规范。它会报告诸如同一行多个 import、函数之间空行数不对、多余空白以及行过长等问题,每条结果都带有 E401、E302 这样的错误代码和所在位置。
pycodestyle 可以免费使用吗?用的什么许可证?
pycodestyle 以 Other 许可证开源。用于商业产品前,请先确认许可证条款。
pycodestyle 还在维护吗?
活跃维护中。pycodestyle 最近一次提交是在 2026年11月4日。
pycodestyle 适合用来做什么?
在 Python 项目的持续集成中统一执行 PEP 8 格式检查。 在编辑器中编写 Python 代码时获得实时的风格提示。 审查大型遗留代码库,查看最常见的风格问题。 在不引入额外依赖的情况下运行轻量级风格检查。
pycodestyle 怎么安装和运行?
使用 pip 安装 pycodestyle: pip install pycodestyle 对 Python 文件运行检查以检测代码风格: pycodestyle --first optparse.py
在哪里获取 pycodestyle?
源代码和安装说明在 GitHub 上:https://github.com/PyCQA/pycodestyle

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

相关项目