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

Posted 范桂飓51cto

tags:

篇首语:本文由小常识网(cha138.com)小编为大家整理,主要介绍了Python 进阶 — Flake8 静态代码检查工具相关的知识,希望对你有一定的参考价值。

目录


文章目录


Flake8

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

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

  1. PyFlakes:静态检查 Python 代码逻辑错误的工具。
  2. PEP8:静态检查 PEP8 编码风格的工具。
  3. NedBatchelder’s McCabe:静态分析Python代码复杂度的工具。
错误返回码

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

  1. Fxxx:PyFlakes 返回的代码逻辑错误 Error。
  2. Exxx、Wxxx:PEP8 返回的编码规范 Error 和 Warning。
  3. C9xx:McCabe 返回的代码复杂度。通过 Flake8 的 --max-complexity 选项可以设定 McCabe 的函数复杂度数值,高出则告警。Flake8 建议值为 12。
安装

$ python -m pip install flake8
$ flake8 –help

使用
  • 直接使用:
$ cd /project_path/
$ flake8 .

  • 通常的 flake8 会集成到 tox 一同更方便使用:
[tox]
minversion = 2.0
envlist = pep8

[testenv:pep8]
commands =
flake8

  • 展示特定错误码:
# e.g. 以 E 开头
flake8 --select E project_path

# e.g. H233
flake8 --select H233 project_path

  • 忽略特定错误码:
# e.g. H233
flake8 --ignore H233 project_path

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

  • 输出修改格式:
flake8 --format=%(path)s::%(row)d,%(col)d::%(code)s::%(text)s project_path

插件

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

  1. 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

以上是关于Python 进阶 — Flake8 静态代码检查工具的主要内容,如果未能解决你的问题,请参考以下文章

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

vscode写python时的代码错误提醒和自动格式化

Python入门教程第62篇 函数进阶之类型提示

vscode 编写python如何禁止 flake8 提示 line too long

如何配置hound-ci来支持python2.7

2021 年 VS Code 必备 Python 插件!