Python 进阶 — Flake8 静态代码检查工具

目录

文章目录

目录

flake8

错误返回码

安装

使用

插件

Flake8

Flake8 是由 Python 官方发布的一款静态代码检查工具（https://pypi.python.org/pypi/flake8/），相对于 PyLint 而言，Flake8 的检查规则灵活，支持集成额外插件，扩展性强。

Flake8 是对下面 3 个工具的封装：

PyFlakes：静态检查 Python 代码逻辑错误的工具。

PEP8：静态检查 PEP8 编码风格的工具。

NedBatchelder’s McCabe：静态分析Python代码复杂度的工具。

错误返回码

Flake8 的基础错误返回码一共有 3 类：

Fxxx：PyFlakes 返回的代码逻辑错误 Error。

Exxx、Wxxx：PEP8 返回的编码规范 Error 和 Warning。

C9xx：McCabe 返回的代码复杂度。通过 Flake8 的 --max-complexity 选项可以设定 McCabe 的函数复杂度数值，高出则告警。Flake8 建议值为 12。

安装

$ python -m pip install flake8 $ flake8 –help

1

2

使用

直接使用：

$ cd /project_path/ $ flake8 .

1

2

通常的 flake8 会集成到 tox 一同更方便使用：

[tox] minversion = 2.0 envlist = pep8 [testenv:pep8] commands = flake8

1

2

3

4

5

6

7

展示特定错误码：

# e.g. 以 E 开头 flake8 --select E project_path # e.g. H233 flake8 --select H233 project_path

1

2

3

4

5

忽略特定错误码：

# e.g. H233 flake8 --ignore H233 project_path # e.g. 忽略检查 test1.py 文件 flake8 --exclude project_path/path2/test1.py project_path

1

2

3

4

5

输出修改格式：

flake8 --format=%(path)s::%(row)d,%(col)d::%(code)s::%(text)s project_path

1

插件

Flake8 相比其他 Python 静态代码检查工具的优势在于其良好的扩展性，以下介绍几款比较流行的插件：

hacking：根据 OpenStack Style Guidelines 产生，官方文档：https://pypi.python.org/pypi/hacking，错误返回码以 H 开头。

pip install hacking

1

flake8-chart：可视化插件，将 flake8 的分析结果转化为图形。

flake8 --statistics shadowtest |flake8chart--chart-type=BAR --chart-output=shadow.svg

1

Python 代码检查 CodeCheck

版权声明：本文内容由网络用户投稿，版权归原作者所有，本站不拥有其著作权，亦不承担相应法律责任。如果您发现本站中有涉嫌抄袭或描述失实的内容，请联系我们jiasou666@gmail.com 处理，核实后本网站将在24小时内删除侵权内容。