Python好库推荐之Pylint安装及使用教程_Python

前言

pylint 是一个用于 python 代码静态分析的强大工具，主要用于代码质量检查和风格规范。它可以自动检测代码中的错误、潜在问题以及不符合 pep 8 规范的地方，帮助开发者编写更清晰、更规范的代码。

pylint 的主要功能包括：

语法错误检测
代码风格检查（如命名规范、行长度等）
未使用变量或导入的检测
代码重复识别
代码复杂度评估

一、安装

安装 pylint 非常简单，推荐使用 python 的包管理工具 pip。打开终端或命令行，执行以下命令：

pip install pylint

安装完成后使用下面命令来检查是否安装成功：

pylint --version

或者使用uv tool来安装：

uv tool install pylint

二、使用

（1）如何运行

使用 pylint 的方法非常直接，主要是在命令行调用，并指定要检查的模块或文件。下面是详细用法和输出解释，基于 pylint 官方文档。pylint 的基本命令格式为：

pylint [options] module_or_package

module_or_package：可以是一个 python 文件（如 mymodule.py）、一个模块，或者一个 python 包。如果是包的话要确保有__init__.py
pylint 会分析指定目标并输出检测结果。

pylint mymodule.py

常用命令行选项：

选项	说明
`--version`	显示 pylint 版本。
`--help`	显示帮助信息。
`--disable=<msg>`	禁用某些消息或检查器，例如 `--disable=c0111`。
`--enable=<msg>`	只启用某些消息或检查器。
`--output-format=<format>`	指定输出格式，支持 `text`（默认）、`html`、`parseable` 等。
`--generate-rcfile`	生成一个默认配置文件模板，便于自定义规则。
`-j <n>`	并行执行，加快分析速度，例如 `-j 4` 会用 4 个子进程并行分析。
`-f <format>`	可指定格式（如 `text`、`html`、`json`、`parseable` 等），再配合重定向即可保存到指定路径。和`--output-format是一样的作用。`

同时检查多份py文件并将结果输出到一份txt里面：

# 直接把文件名全部列出来
pylint file1.py file2.py file3.py > pylint_report.txt

# 检查当前目录下所有的 python 文件
pylint *.py > pylint_report.txt

# 检查一个目录（递归检查所有 .py 文件）
pylint your_directory/ > pylint_report.txt

（2）怎么查看输出

pylint 默认输出是纯文本，每条信息格式为：

file_path: line_num: column_num: message_type: message (消息符号)

# 例如：
c0301: line too long (133/100) (line-too-long)

# 完整示例：
************* module run_dpsk_ocr
run_dpsk_ocr.py:13:0: c0301: line too long (133/100) (line-too-long)
run_dpsk_ocr.py:26:0: c0301: line too long (169/100) (line-too-long)
run_dpsk_ocr.py:35:0: c0301: line too long (188/100) (line-too-long)
run_dpsk_ocr.py:1:0: c0114: missing module docstring (missing-module-docstring)
run_dpsk_ocr.py:1:0: e0401: unable to import 'transformers' (import-error)
run_dpsk_ocr.py:2:0: e0401: unable to import 'torch' (import-error)
run_dpsk_ocr.py:9:0: c0103: constant name "model_name" doesn't conform to upper_case naming style (invalid-name)
run_dpsk_ocr.py:19:0: c0103: constant name "prompt" doesn't conform to upper_case naming style (invalid-name)
run_dpsk_ocr.py:21:0: c0103: constant name "image_file" doesn't conform to upper_case naming style (invalid-name)
run_dpsk_ocr.py:22:0: c0103: constant name "output_path" doesn't conform to upper_case naming style (invalid-name)
run_dpsk_ocr.py:3:0: c0411: standard import "os" should be placed before third party imports "transformers.automodel", "torch" (wrong-import-order)

-----------------------------------
your code has been rated at 0.00/10

在最后还会给你的代码整体打一个分（满分十分）：

your code has been rated at 6/10

每条输出信息的解释如下

file_path：文件路径
message_type：消息类型，包括：
- c（convention）：代码风格建议（如 pep 8 违规）。
- r（refactor）：建议重构的代码。
- w（warning）：警告。
- e（error）：错误。
- f（fatal）：严重错误，导致无法继续分析。
line_num：问题所在行号。
column_num：问题所在列号。
message：具体问题描述。

run_dpsk_ocr.py:13:0: c0301: line too long (133/100) (line-too-long)

run_dpsk_ocr.py: 检查的文件名。
13: 问题所在的行号。
0: 问题所在的列号（通常为0表示整行）。
c0301: 这是消息类型代码（message id）。
c 代表 “convention”（代码风格建议）。
0301 是这个具体问题的唯一编号。
line too long (133/100): 这是消息描述（message），清晰地说明了问题：这行太长了（133个字符，超过了100个字符的限制）。
(line-too-long): 这是消息符号（symbol），是一个更易读、更容易在配置文件中引用的名字。

pylint 默认会将分析结果直接输出到标准输出（stdout），也就是你运行命令的终端或命令行窗口，并不会自动保存到文件。如果你想将结果保存到指定路径，可以通过重定向或者使用 --output-format或-f 结合命令行重定向实现。例如：

# 默认输出的结果就是txt
pylint mymodule.py > /path/to/your/report/pylint_report.txt

# 可以指定保存成html
pylint --output-format=html mymodule.py > pylint_report.html
# 指定保存为json
pylint -f json mymodule.py > pylint_report.json

【注】更多用法和详细介绍可以跳转官方文档：pylint官方文档