这7大神器,让你的Python 代码更易于维护

链接:https://opensource.com/article/18/7/7-python-libraries-more-maintainable-code

当软件项目进入“维护模式”时,对代码的可读性和编码标准经常就忽略了(甚至从一开始就没有建立起这些标准。)但是,在代码库中保持一致的风格和测试标准是减少维护负担的重要因素,它能确保未来的开发人员能够快速了解新的项目情况 - 并保持项目的良好运行

保护项目未来可维护性的一个好方法就是使用外部库来检查你的代码运行状况。以下是我们最喜欢的一些用于检查代码的库(包含检查PEP 8和其他样式错误),让代码风格保持一致,并确保在项目成熟时的测试覆盖率保持在可接受范围。

检查你的代码风格

PEP 8是Python代码风格规范,它对行长度,缩进,多行表达式和命名约定等内容有明确的规范。你的团队可能也有自己的代码规则,可能与PEP 8略有不同。但是,任何代码风格都是为了在代码库中强制实施一致的标准,使其更具可读性,从而更易于维护。这里有三个库来帮助美化你的代码。

1、 Pylint

Pylint 是一个 Python 代码分析工具,它分析 Python 代码中的错误,查找不符合代码风格标准(Pylint 默认使用的代码风格是 PEP 8)和有潜在问题的代码。 。它与几个流行的编辑器和IDE很好地集成,也可以从命令行运行。

要安装,请运行pip install pylint。

要从命令行运行 Pylint,请运行pylint [options] path/to/dir或pylint [options] path/to/module.py。Pylint 会向控制台输出不符合代码风格标准以及错误代码的地方

你还可以调用 pylintrc 配置文件来自定义 Pylint 检查的错误。(项目地址:https://www.pylint.org/)

2、Flake8

Flake8是一个“Python工具,它将PEP8,Pyflakes(类似于Pylint),McCabe(代码复杂性检查器)和第三方插件集合在一起,以检查某些Python代码的风格和质量。”

要使用Flake8,要先运行pip install flake8。然后运行flake8 [options] path/to/dir或flake8 [options] path/to/module.py查看其错误和警告。

与Pylint一样,Flake8允许对配置文件检查的内容进行一些自定义。它有非常清晰的文档,包括一些有用的Commit,可以作为开发工作流程的一部分自动检查代码。

Flake8能够与流行的编辑器和IDE集成,但这些指令通常在文档中并没有说明。要将Flake8与你喜欢的编辑器或IDE集成,可以在线搜索插件(例如 Sublime Text的Flake8插件)。(项目地址:http://flake8.pycqa.org/en/latest/)

3、Isort

isort 可自动对 Python的 import语句进行排序和分段。可将大量的 import结构转成非常适合阅读的排版。(例如,标准库导入,第三方库导入,从你自己的项目导入等),这样可以提高可读性,而且如果你导入的库较多,还能快速找到各个库

安装isort pip install isort,然后运行isort path/to/module.py。文档中提供了许多配置选项。例如,你可以配置 isort如何处理.isort.cfg文件来执行一个库的多行导入。

与Flake8和Pylint一样,isort还提供了将其与流行的编辑器和IDE集成的插件。(项目地址:https://github.com/timothycrosley/isort)

分享你的代码风格

记住从命令行手动为每个文件运行linters是一件很痛苦的事情,你可能也不太喜欢通过运行 IDE 中某个插件来实现这个功能。另外,您的同事可能更喜欢别的方式,或者可能他们最喜欢的编辑器的没有这个插件,或者你检查代码不够细致,久而久之,你们共享的代码库将变得混乱并且难以阅读。

一个很好的解决方案是使用一个库,自动将代码重新按照PEP 8规范进行格式化。我们推荐的三个库都有不同的自定义级别来控制如何格式化代码,像pylint的和Flake8,你要先测试,看看它是否存在你接受不了却无法更改的默认配置。

4、 Autopep8

Autopep8可以自动格式化你指定的模块中的代码。它将重新缩进行,修复缩进,删除无关的空白,并重构常见的比较错误(如布尔和None值)。你可以在它的文档中查看完整的更改列表

安装Autopep8,需要先运行pip install --upgrade autopep8。要重新格式化代码,请运行pip install --upgrade autopep8。然后执行autopep8 --in-place --aggressive --aggressive 就可以重新格式化你的代码。该aggressive标志(和它们的数量),表明autopep8对你的代码风格有多少控制权。(项目地址:https://github.com/hhatto/autopep8)

5、 Yapf

Yapf是重新格式化代码的另一种选择,它带有自己的配置选项列表。它与autopep8的不同之处在于它不仅仅解决了违反PEP 8规范的问题。它还重新格式化了没有违反PEP 8规范的代码,但没有一致地设置样式,可能是为了可读性而格式化得更好。

要安装Yapf,需要运行pip install yapf。要重新格式化代码,要运行yapf [options] path/to/dir或yapf [options] path/to/module.py。(项目地址:https://github.com/google/yapf)

6、 Black

在所有的代码检查工具中,Black算是比较新的一个。它与autopep8和Yapf类似,但限制比较多,它很少有自定义选项,这是重点,这意味着你无法自定义代码风格。

Black支持Python 3.6+以上的版本,但可以格式化Python 2代码。要使用Black,请运行pip install black。要美化您的代码,请运行:black path/to/dir或black path/to/module.py。(项目地址:https://github.com/ambv/black)

检查代码的测试覆盖率

假如你正在编写测试,你需要确保对代码库提交的新代码进行测试,并且不会降低代码的测试覆盖率。虽然测试覆盖率的百分比不是衡量测试有效性和充分性的唯一指标,但它是确保项目中遵循基本测试标准的一种方法。为了测量测试覆盖率,我们有一个建议:使用 Coverage 这个库。

7、Coverage

Coverage有多种向你报告测试覆盖率的方式,包括将结果输出到控制台或HTML页面,并提示哪些行号没有覆盖到。你可以设置配置文件以自定义Coverage检查的内容并使其更便于运行。

要安装Coverage,请运行pip install coverage。要运行程序并查看其输出,请运行coverage run [path/to/module.py] [args],接着你将看到程序的输出。要查看哪些代码行没有被覆盖,请运行coverage report -m。(项目地址:https://coverage.readthedocs.io/en/latest/)

持续集成工具

持续集成(CI)是在合并和部署代码之前,自动检查代码风格错误和测试最小覆盖率的一系列过程。有许多免费或付费的工具可以自动化这个过程,本文这里就不详细介绍了。但是,由于设置CI过程是将代码块删除为更易于阅读和维护的重要步骤,因此,你不得不重视。

●本文编号405,输入编号直达本文

●输入m获取文章目录

  • 发表于:
  • 原文链接https://kuaibao.qq.com/s/20180930B0JXRR00?refer=cp_1026
  • 腾讯「云+社区」是腾讯内容开放平台帐号(企鹅号)传播渠道之一,根据《腾讯内容开放平台服务协议》转载发布内容。
  • 如有侵权,请联系 yunjia_community@tencent.com 删除。

扫码关注云+社区

领取腾讯云代金券