使用PyLint分析评估代码质量
阅读原文时间:2023年07月10日阅读:1

什么是PyLint

PyLint是一款用于评估Python代码质量的分析工具,它诞生于2003年,其最初十年的主要作者和维护者是Sylvain Thénault。PyLint可以用来检查代码是否错误、是否符合编码规范(它默认使用的编码规范是PEP 8),在分析代码后PyLint将会输出一段信息,内容包括在代码中检查到的警告和错误,如果运行两次,它将会输出两次的统计信息,以便使用者分析代码是否得到改进。PyLint的特性是报告尽可能少的错误,但是它会输出非常多的警告信息,所以建议在程序提交之前或者想要整理代码时使用PyLint,这样可以忽略掉大量的无效警告。

自PyLint 1.4起,PyLint只支持Python 2.7+和Python 3.3+。

安装PyLint

在命令行界面执行如下代码,即可安装PyLint:

pip install pylint

在命令行界面执行如下代码,即可查询PyLint的安装路径:

where pylint

调用PyLint

分析Python包或者Python模块

pylint [options] module_or_package

分析Python文件

pylint [options] mymodule.py

并行分析Python文件

pylint -j 4 mymodule1.py mymodule2.py mymodule3.py mymodule4.py

上述语句将产生4个并行的PyLint子进程来对所需的四个文件并行检查,PyLint发现问题后不会立即显示,待所有模块检查完毕后才会显示。其中,参数-j用于指定所需的PyLint子进程数量,默认值为1。

常用的命令行选项

  • --version:显示PyLint以及Python的版本;

    使用示例:

    pylint --version
  • -h, --help :显示帮助信息;

    使用示例:

    示例一:
    pylint -h
    示例二:
    pylint --help
  • -ry:显示各项信息的报表统计;

    使用示例:

    pylint -ry mymodule.py
  • --generate-rcfile:生成配置信息示例;

    使用示例:

    ## 将persistent修改为n,并将配置信息保存至pylint.conf文件中
    pylint --persistent=n --generate-rcfile > pylint.conf
  • --rcfile= :指定所使用的的配置文件;

    使用示例:

    pylint --rcfile=pylint.conf mymodule.py
  • --persistent=y_or_n:是否使用Pickle存储上次结果;

    使用示例:

    pylint --persistent=y mynodule.py
  • --output-format=:指定输出格式( parseable, colorized, msvs);

    使用示例:

    pylint --output-format=parseable mymodule.py
  • --msg-template=