检查代码的质量不失为保护项目未来可维护性

使用外部库来检查代码质量是保护项目未来可维护性的好方法。 以下是我们最喜欢的一些用于检查代码（包括检查 PEP 8 和其他编码风格错误）的库，以强制执行一致的代码风格并确保随着项目的成熟具有可接受的测试覆盖率。

检查你的编码风格

PEP 8 是一种代码风格规范，指定行长度、缩进、多行表达式、变量命名约定等。尽管您的团队可能有自己的编码风格指南，与 PEP 8 略有不同，但任何编码的目标风格指南是在整个代码库中强制执行一致的标准，使代码更具可读性且更易于维护。 。 下面三个库可以用来帮助你美化你的代码。

1、

是一个检查 PEP 8 规范违规和常见错误的库。 它集成到一些流行的编辑器和IDE中，也可以从命令行独立运行。

执行 pip 安装。 然后运行 ​​[] path/to/dir 或 [] path/to/.py 在命令行上使用它。 它将输出到控制台，其中代码中出现规范和错误。

您还可以使用配置文件来自定义检查哪些代码错误。

2、

它是“一个集成 PEP 8、（类似）、（代码复杂度检查器）和第三方插件来检查代码风格和质量的工具。”

执行pip安装，然后执行[]path/to/dir或[]path/to/.py即可查看报告的错误和警告。

与配置文件类似，检查的内容是允许自定义的。 它具有非常清晰的文档，并包含一些有用的提交挂钩，可将自动代码检查合并到您的开发工作流程中。

它还可以集成到一些流行的编辑器和IDE中，但文档中没有详细描述。 要集成到您喜欢的编辑器或 IDE，请搜索插件（例如 Text 的插件）。

3.排序

isort是一个库，可以将你导入到项目中的库按照字母顺序进行排序，并正确地将它们划分为不同的部分（例如标准库、第三方库、自建库等）。 这提高了代码的可读性，并且当导入的库很多时可以很容易地找到每个库。

执行 pip isort 安装 isort，然后执行 isort path/to/.py 运行。 该文档还提供了更多配置项，例如配置 .isort.cfg 文件以确定 isor 如何处理库的多行导入。

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

分享您的编码风格 每次更改文件时使用命令行手动检查代码是一件痛苦的事情，而且您可能不喜欢在 IDE 中运行插件来实现此功能。 同样，你的同事可能使用不同的代码检查方法，也许他们的编辑器中没有那种插件，甚至你自己也可能没有严格检查代码并根据警告纠正代码。 简而言之，您共享的代码库将逐渐变得混乱且难以阅读。

一个好的解决方案是使用一个根据 PEP 8 规范自动格式化代码的库。 我们推荐的三个库都有不同级别的自定义来控制代码的格式。 有些设置比较特殊，比如 和 ，需要先测试一下，看看是否有一些你无法忍受但又无法修改的默认配置。

4.

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

运行 pip --。 然后执行 --in-place -- -- 重新格式化您的代码。 选项的数量表明您对编码风格的控制程度。 在此处了解有关选项的更多信息。

5. 亚普夫

Yapf 是另一个代码重新格式化工具，它有自己的配置项列表。 不同的是，它不仅会指出代码中违反 PEP 8 规范的地方，还会对不违反 PEP 8 但代码风格不一致的地方进行重新格式化，旨在让代码更具可读性。

执行 pip yapf 安装 Yapf，然后执行 yapf [] path/to/dir 或 yapf [] path/to/.py 重新格式化代码。 自定义选项的完整列表位于此处。