如何让Python代码更易维护

来源：千锋教育

发布人：xqq

时间： 2023-11-08 15:46:29

检查你的代码的质量，通过这些外部库使其更易维护。

可读性很重要。

—Python之禅TheZenofPython，TimPeters

随着软件项目进入“维护模式”，对可读性和编码标准的要求很容易落空(甚至从一开始就没有建立过那些标准)。然而，在代码库中保持一致的代码风格和测试标准能够显著减轻维护的压力，也能确保新的开发者能够快速了解项目的情况，同时能更好地全程保持应用程序的质量。

使用外部库来检查代码的质量不失为保护项目未来可维护性的一个好方法。以下会推荐一些我们最喜爱的检查代码(包括检查PEP8和其它代码风格错误)的库，用它们来强制保持代码风格一致，并确保在项目成熟时有一个可接受的测试覆盖率。

检查你的代码风格

PEP8是Python代码风格规范，它规定了类似行长度、缩进、多行表达式、变量命名约定等内容。尽管你的团队自身可能也会有稍微不同于PEP8的代码风格规范，但任何代码风格规范的目标都是在代码库中强制实施一致的标准，使代码的可读性更强、更易于维护。下面三个库就可以用来帮助你美化代码。

1、Pylint

Pylint是一个检查违反PEP8规范和常见错误的库。它在一些流行的编辑器和IDE中都有集成，也可以单独从命令行运行。

执行pipinstallpylint安装Pylint。然后运行pylint[options]path/to/dir或者pylint[options]path/to/module.py就可以在命令行中使用Pylint，它会向控制台输出代码中违反规范和出现错误的地方。

你还可以使用pylintrc配置文件来自定义Pylint对哪些代码错误进行检查。

2、Flake8

Flake8是“将PEP8、Pyflakes(类似Pylint)、McCabe(代码复杂性检查器)和第三方插件整合到一起，以检查Python代码风格和质量的一个Python工具”。

执行pipinstallflake8安装flake8，然后执行flake8[options]path/to/dir或者flake8[options]path/to/module.py可以查看报出的错误和警告。

和Pylint类似，Flake8允许通过配置文件来自定义检查的内容。它有非常清晰的文档，包括一些有用的提交钩子，可以将自动检查代码纳入到开发工作流程之中。

Flake8也可以集成到一些流行的编辑器和IDE当中，但在文档中并没有详细说明。要将Flake8集成到喜欢的编辑器或IDE中，可以搜索插件(例如SublimeText的Flake8插件)。

3、Isort

Isort这个库能将你在项目中导入的库按字母顺序排序，并将其正确划分为不同部分(例如标准库、第三方库、自建的库等)。这样提高了代码的可读性，并且可以在导入的库较多的时候轻松找到各个库。

执行pipinstallisort安装isort，然后执行isortpath/to/module.py就可以运行了。文档中还提供了更多的配置项，例如通过配置.isort.cfg文件来决定isort如何处理一个库的多行导入。

和Flake8、Pylint一样，isort也提供了将其与流行的编辑器和IDE集成的插件。

分享你的代码风格

每次文件发生变动之后都用命令行手动检查代码是一件痛苦的事，你可能也不太喜欢通过运行IDE中某个插件来实现这个功能。同样地，你的同事可能会用不同的代码检查方式，也许他们的编辑器中也没有那种插件，甚至你自己可能也不会严格检查代码和按照警告来更正代码。总之，你分享出来的代码库将会逐渐地变得混乱且难以阅读。

一个很好的解决方案是使用一个库，自动将代码按照PEP8规范进行格式化。我们推荐的三个库都有不同的自定义级别来控制如何格式化代码。其中有一些设置较为特殊，例如Pylint和Flake8，你需要先行测试，看看是否有你无法忍受但又不能修改的默认配置。

4、Autopep8

Autopep8可以自动格式化指定的模块中的代码，包括重新缩进行、修复缩进、删除多余的空格，并重构常见的比较错误(例如布尔值和None值)。你可以查看文档中完整的更正列表。

运行pipinstall--upgradeautopep8安装Autopep8。然后执行autopep8--in-place--aggressive--aggressive就可以重新格式化你的代码。aggressive选项的数量表示Auotopep8在代码风格控制上有多少控制权。在这里可以详细了解aggressive选项。

5、Yapf

Yapf是另一种有自己的配置项列表的重新格式化代码的工具。它与Autopep8的不同之处在于它不仅会指出代码中违反PEP8规范的地方，还会对没有违反PEP8但代码风格不一致的地方重新格式化，旨在令代码的可读性更强。

执行pipinstallyapf安装Yapf，然后执行yapf[options]path/to/dir或yapf[options]path/to/module.py可以对代码重新格式化。定制选项的完整列表在这里。

6、Black

Black在代码检查工具当中算是比较新的一个。它与Autopep8和Yapf类似，但限制较多，没有太多的自定义选项。这样的好处是你不需要去决定使用怎么样的代码风格，让Black来给你做决定就好。你可以在这里查阅Black有限的自定义选项以及如何在配置文件中对其进行设置。

Black依赖于Python3.6+，但它可以格式化用Python2编写的代码。执行pipinstallblack安装Black，然后执行blackpath/to/dir或blackpath/to/module.py就可以使用Black优化你的代码。

检查你的测试覆盖率

如果你正在进行编写测试，你需要确保提交到代码库的新代码都已经测试通过，并且不会降低测试覆盖率。虽然测试覆盖率不是衡量测试有效性和充分性的唯一指标，但它是确保项目遵循基本测试标准的一种方法。对于计算测试覆盖率，我们推荐使用Coverage这个库。

7、Coverage

Coverage有数种显示测试覆盖率的方式，包括将结果输出到控制台或HTML页面，并指出哪些具体哪些地方没有被覆盖到。你可以通过配置文件自定义Coverage检查的内容，让你更方便使用。

执行pipinstallcoverage安装Converage。然后执行coverage[path/to/module.py][args]可以运行程序并查看输出结果。如果要查看哪些代码行没有被覆盖，执行coveragereport-m即可。

持续集成工具