Python 是一门动态语言, 在编写程序时,往往只有在执行的时候才能发现隐藏的错误, 所以需要一套静态检查工具。
一个用于检查Python源文件错误的简单程序。
Pyflakes 可以分析程序并且检查各种错误。它是通过解析源文件实现,运行相当快,但是它不会检查文件的代码风格。
安装命令:pip install --upgrade pyflakes
使用方法:
命令行 pyflakes [ file name or directory name], 简单运行结果如下:
parser.py:1: 'os' imported but unused
client.py:1: 'sys' imported but unused
原名为pep8,后来改成了pycodestyle, 中间有段有趣的小故事,大家可以查找看看。
pycodestyle 检查代码是否符合 PEP 8 规范, PEP 8 是一种 Python 代码规范指南。
安装命令:pip install pycodestyle
使用方法:
命令行 pycodestyle [file name or directory name], 简单运行结果如下:
client.py:107:55: E231 missing whitespace after ','
server.py:22:80: E501 line too long (89 > 79 characters)
--statistics -qq: 对结果进行汇总
--show-source: 更详细的输出
--select E501: 忽略指定输出
Flake8 是由 Python 官方发布的一款辅助检测 Python 代码是否规范的工具。Flake8 检查规则灵活,支持集成额外插件,扩展性强。
Flake8 是对下面三个工具的封装, 即该工具可以同时检查以下的功能范围, 但运行相对较慢。
PyFlakes:静态检查 Python 代码逻辑错误的工具。
Pep8: 静态检查 PEP8 编码风格的工具。
NedBatchelder’s McCabe :静态分析 Python 代码复杂度的工具。
安装命令:pip install flake8
使用方法:
命令行 flake8 [ file name or directory name] --max-complexity=12, 简单运行结果如下:
parser.py:1: 'os' imported but unused
nbs/handler.py:15:80: E501 line too long (87 > 79 characters)
client:67:1: C901 'If 67' is too complex (14)
--max-complexity=12 : 检查代码代码复杂度, 官网建议值为12, 该参数可不写
--ignore E501,E203: 忽略指定风格检查
--select E501: 指定风格检查
Pylint是Python源代码分析器,查找不符合代码风格标准和有潜在问题的代码,具有高度可配置性, 还会给你代码打分。
安装命令:pip install pylint
使用方法:
命令行 pylint [options] module_or_package, 简单运行结果如下:
client.py:51:0: R0904: Too many public methods (28/20) (too-many-public-methods)
client.py:327:0: C0103: Constant name "NetAct" doesn't conform to UPPER_CASE naming style (invalid-name)
-----------------------------------
Your code has been rated at 6.79/10
生成report 格式可用pylint --help 查询。
错误代码含义
C:惯例,违反了编码风格标准
R:重构,代码非常糟糕
W:警告,某些 Python 特定的问题
E:错误,很可能是代码中的错误
F:致命错误,阻止 Pylint 进一步运行的错误