Python高级技术之：`Python`的`Pyflakes`和`Pylint`：如何进行静态代码分析。 - 智猿学院-前后端，数据库，人工智能，云计算等领域前沿技术讲座

各位观众，大家好！我是你们今天的代码分析师，代号“Bug终结者”。今天咱们聊聊Python代码的“体检”工具——Pyflakes和Pylint。别怕，不是真的体检，不用脱衣服，只是给你的代码做个“全身检查”，看看有没有小毛病，提前预防“代码癌症”。

第一部分：静态代码分析是个啥？

想象一下，你写了一段代码，兴冲冲地运行，结果啪的一声，报错了！是不是很尴尬？静态代码分析就像一位经验丰富的医生，它在你运行代码之前，就能帮你找出代码中的潜在问题，比如：

语法错误： 比如少个括号，拼写错误，这些低级错误。
未使用的变量： 定义了变量，但是从来没用过，占着茅坑不拉屎。
导入错误： 导入了不存在的模块，或者循环导入。
代码风格问题： 代码写的不够优雅，不符合PEP 8规范。

为什么要在运行前发现这些问题呢？

节省时间： 避免运行时的错误，减少调试时间。
提高代码质量： 让你的代码更健壮，更易于维护。
团队协作： 统一代码风格，方便团队成员阅读和理解。

第二部分：Pyflakes：轻量级的“语法警察”

Pyflakes是一个非常轻量级的静态代码分析工具，它的目标是快速找到代码中的错误。你可以把它想象成一个“语法警察”，主要关注以下问题：

未使用的变量
未定义的名称
导入错误

如何安装Pyflakes？

非常简单，使用pip：

pip install pyflakes

如何使用Pyflakes？

在命令行中，直接运行 pyflakes 命令，后面跟上你要检查的Python文件：

pyflakes my_code.py

如果你的代码没问题，Pyflakes会悄无声息地退出，什么也不说。这才是最好的消息！如果发现了问题，它会输出错误信息，告诉你哪里出了问题。

举个栗子：

假设我们有以下代码 example.py:

def my_function():
    x = 10
    y = 20
    print(x)
    #print(z) # z 未定义

my_function()

运行 pyflakes example.py，你会看到：

example.py:5: undefined name 'z'
example.py:3: unused variable 'y'

Pyflakes告诉你，变量 z 未定义，变量 y 未使用。是不是很棒？

Pyflakes的优点：

速度快，非常快。
简单易用。
专注错误检测。

Pyflakes的缺点：

检查的范围有限，只关注错误，不关注代码风格。
不能自定义规则。

第三部分：Pylint：重量级的“代码医生”

Pylint是一个更强大的静态代码分析工具，它不仅能找到代码中的错误，还能检查代码风格、复杂度、重复代码等，并给出详细的报告和建议。你可以把它想象成一个“代码医生”，不仅能治病，还能帮你强身健体。

如何安装Pylint？

同样使用pip：

pip install pylint

如何使用Pylint？

在命令行中，运行 pylint 命令，后面跟上你要检查的Python文件：

pylint my_code.py

Pylint会输出大量的报告，告诉你代码的各种问题，并给出一个总体的评分。这个评分是根据你的代码质量计算出来的，分数越高，代码质量越好。

举个栗子：

还是用上面的 example.py 代码：

def my_function():
    x = 10
    y = 20
    print(x)
    #print(z) # z 未定义

my_function()

运行 pylint example.py，你会看到一大堆信息，其中可能包括：

************* Module example
example.py:2:0: C0114: Missing module docstring (missing-module-docstring)
example.py:2:0: C0116: Missing function or method docstring (missing-function-docstring)
example.py:3:4: W0612: Unused variable 'y' (unused-variable)
example.py:5:4: E0602: Undefined variable 'z' (undefined-variable)

--------------------------------------------------------------------
Your code has been rated at 6.67/10 (previous run: 6.67/10, +0.00)

Pylint告诉你，代码缺少模块和函数的文档字符串，变量 y 未使用，变量 z 未定义。而且，它还给你的代码打了个分：6.67/10。

Pylint的优点：

功能强大，能检查代码的各种问题。
可以自定义规则，根据自己的需求进行配置。
可以生成各种格式的报告。

Pylint的缺点：

速度慢，比Pyflakes慢很多。
配置复杂，需要花时间学习。
报告信息量大，可能会让你感到不知所措。

第四部分：Pylint的配置：让它更懂你

Pylint的强大之处在于它的可配置性。你可以通过配置文件来告诉Pylint，哪些问题需要关注，哪些问题可以忽略。

如何创建Pylint配置文件？

运行以下命令：

pylint --generate-rcfile > .pylintrc

这会在当前目录下生成一个名为 .pylintrc 的配置文件。打开这个文件，你会看到密密麻麻的配置项，可以根据自己的需求进行修改。

一些常用的配置项：

disable： 禁用某些检查项。比如，如果你不想让Pylint检查文档字符串，可以添加 missing-docstring 到 disable 列表中。
```
disable=
    missing-module-docstring,
    missing-function-docstring
```
max-line-length： 设置最大行长度。PEP 8 建议的最大行长度是79个字符，你可以根据自己的喜好进行修改。
```
max-line-length=120
```
good-names： 设置可以接受的变量名。默认情况下，Pylint会认为单字符变量名（如 i、j）是不好的，你可以通过 good-names 来允许使用这些变量名。
```
good-names=
    i,
    j,
    k,
    ex,
    Run,
    _
```
ignore： 忽略某些目录或文件。比如，你可以忽略测试目录，因为测试代码通常不需要太多的文档字符串。
```
ignore=
    test
```

举个栗子：

假设我们想禁用文档字符串检查，并允许最大行长度为120个字符。我们可以修改 .pylintrc 文件，如下所示：

[MESSAGES CONTROL]
disable=
    missing-module-docstring,
    missing-function-docstring

[FORMAT]
max-line-length=120

修改完配置文件后，再次运行 pylint example.py，你会发现报告中的文档字符串相关的错误消失了。

第五部分：Pyflakes vs Pylint：如何选择？

Pyflakes和Pylint各有优缺点，选择哪个取决于你的需求。

特性	Pyflakes	Pylint
速度	快	慢
功能	简单，专注错误检测	强大，能检查代码的各种问题
配置	无	可配置
报告	简洁	详细
学习曲线	简单	复杂

我的建议：

小型项目或个人项目： 如果你只是想快速检查代码中的错误，可以选择Pyflakes。
大型项目或团队项目： 如果你需要更全面的代码质量分析，可以选择Pylint。
可以结合使用： 先用Pyflakes快速找到错误，再用Pylint进行更深入的分析。
使用Git hooks： 可以在代码提交前自动运行Pyflakes或Pylint，确保代码质量。

第六部分：实战演练：改进一段糟糕的代码

让我们来改进一段糟糕的Python代码，看看Pyflakes和Pylint是如何帮助我们的。

def calculate_area(length, width):
    area = length * width
    print("The area is:", area)

def main():
    l = 10
    w = 5
    calculate_area(l, w)

main()

这段代码虽然能正常运行，但是存在一些问题：

缺少文档字符串。
变量名不够清晰。
没有进行错误处理。

让我们先用Pyflakes检查一下：

pyflakes bad_code.py

Pyflakes没有发现任何问题，因为它只关注错误，不关注代码风格。

接下来，我们用Pylint检查一下：

pylint bad_code.py

Pylint输出了大量的报告，告诉我们代码的各种问题。

让我们根据Pylint的建议，对代码进行改进：

def calculate_area(length: float, width: float) -> float:
    """Calculates the area of a rectangle.

    Args:
        length: The length of the rectangle.
        width: The width of the rectangle.

    Returns:
        The area of the rectangle.
    """
    if not isinstance(length, (int, float)) or not isinstance(width, (int, float)):
        raise TypeError("Length and width must be numbers.")
    if length <= 0 or width <= 0:
        raise ValueError("Length and width must be positive.")

    area = length * width
    return area

def main():
    """Main function to demonstrate area calculation."""
    rectangle_length = 10
    rectangle_width = 5
    try:
        area = calculate_area(rectangle_length, rectangle_width)
        print(f"The area is: {area}")
    except (TypeError, ValueError) as e:
        print(f"Error: {e}")

if __name__ == "__main__":
    main()

改进后的代码：

添加了文档字符串，解释了函数的作用和参数。
使用了更清晰的变量名。
添加了错误处理，防止输入无效的参数。
添加了类型提示，增加了代码的可读性。

再次运行 pylint good_code.py，你会发现报告中的错误大大减少了，代码的评分也提高了。

第七部分：总结

Pyflakes和Pylint是Python代码的“体检”工具，可以帮助我们发现代码中的错误和问题，提高代码质量。Pyflakes轻量级，速度快，适合快速检查错误；Pylint功能强大，可配置，适合进行全面的代码质量分析。选择哪个取决于你的需求，也可以结合使用。记住，好的代码是写出来的，也是检查出来的！

好了，今天的“代码体检”讲座就到这里。希望大家以后都能写出高质量的Python代码，远离Bug的困扰！下次再见！

发表回复 取消回复

发表回复取消回复