代码收藏家 Python代码质量提升的最佳实践与工具指南（三）
之前已经就本文话题写了两篇：
本篇内容是接着《Python 代码质量：最佳实践与工具(2)》的 【在 Python 中应用高质量代码的最佳实践】继续列举最佳实践项目。
代码检查工具（Linters）
Python 社区开发了一些工具，称为 代码检查工具（linters），你可以设置并使用它们来检查代码的不同方面。代码检查工具会分析代码中的潜在错误、代码异味，以及是否符合 PEP 8 等编码风格指南。它们能够检查以下内容：
except 块。eval() 和 exec()。以下是一些现代 Python 检查工具及其简要描述：
| 检查工具 | 描述 |
|---|---|
| Pylint | 一个检查工具，用于检测错误、强制执行 PEP 8 编码风格标准、发现代码异味，并评估代码复杂度。 |
| Flake8 | 一款轻量级检查工具，用于检查 PEP 8 合规性、语法错误和常见编码问题。它可以通过插件进行扩展。 |
| Ruff | 一个快速的基于 Rust 的工具，提供代码检查、格式化和类型检查功能。它的目标是成为 Flake8 和 Black 的替代品。 |
为了使用这些检查工具，需要根据所选工具使用不同的命令。大多数这些工具都可以很好地集成到主流的 Python 代码编辑器和 IDE 中，例如 Visual Studio Code 和 PyCharm。
这些编辑器和 IDE 能够在输入或保存代码时在后台运行检查工具。它们通常会在你运行代码之前突出显示、下划线标注或以其他方式标识代码中的问题。可以把这个功能看作是代码的高级拼写检查工具。
静态类型检查工具
静态类型检查工具是另一类代码检查工具。与覆盖广泛问题和潜在问题的代码检查工具（linters）不同，静态类型检查工具专注于验证类型注解或类型提示。它们无需运行代码即可捕获可能的类型相关错误。
使用静态类型检查工具检查的代码方面包括以下内容：
None 相关问题：捕获潜在的 NoneType 属性错误。以下是几个现代的 Python 静态类型检查工具：
| 类型检查工具 | 描述 |
|---|---|
| mypy | 一个静态类型检查工具，用于验证类型提示，并帮助在运行前捕获类型相关错误。 |
| Pyright | 一款快速的静态类型检查工具和代码检查工具，针对大型代码库进行了优化，并且也被用于 VS Code 的 Python 扩展中。 |
同样，可以通过命令行安装并针对代码运行这些工具。然而，现代代码编辑器和 IDE 通常内置了这些工具，或者可以作为扩展使用。一旦集成了类型检查工具，编辑器会通过可视化信号（例如高亮或下划线）指出检查工具标记的问题。
代码格式化工具
代码格式化工具是一种能够自动解析代码并将其格式化为符合公认编码风格的工具。通常，标准的做法是以 PEP 8 作为风格参考。对代码运行格式化工具会产生与风格相关的更改，包括以下内容：
以下是一些代码格式化工具：
| 格式化工具 | 描述 |
|---|---|
| Black | 不妥协的 Python 代码格式化工具 |
| Isort | 按字母顺序对导入语句进行排序，并将其分组 |
| Ruff | 提供代码检查、格式化和导入排序功能 |
可以通过命令行安装并运行这些工具。同样，这些工具已经集成到代码编辑器和 IDE 中，或者可以通过扩展将其纳入。
通常情况下，这些工具会在保存更改时应用格式化，但它们也提供了在粘贴代码、输入代码等操作时进行格式化的选项。
如果在一个开发团队中工作，可以配置每个人的环境以使用相同的代码格式化工具和默认设置，并依赖自动化格式化。这让你无需在代码审查中指出格式问题。
代码测试
编写并持续运行针对代码的测试，有助于确保其正确性、可靠性和可维护性。结构良好的测试可以通过早期发现错误、实施最佳实践以及在不破坏功能的情况下更轻松地重构代码，从而显著提高代码质量。
测试可以通过以下几种方式提升代码质量：
在 Python 中，有多种工具可以协助编写和自动化测试。可以使用标准库中的 doctest 和 unittest，或者使用第三方库 pytest。
此外，还可以使用 AI 助手来为 Python 代码编写测试。这些工具将极大地提高生产力。
代码性能分析工具
代码性能分析工具（Code profilers）用于分析程序的运行时行为。它们测量与性能相关的指标，例如执行速度、内存使用、CPU 使用率以及函数调用频率。代码性能分析工具会标记出代码中消耗最多资源的部分，从而帮助你进行优化以提高代码的效率。
对代码运行性能分析工具可以帮助你：
常用的 Python 性能分析工具包括以下几种：
| 工具 | 描述 |
|---|---|
cProfile |
测量函数执行时间 |
timeit |
对小型代码片段进行计时 |
perf |
找到代码、库甚至操作系统代码中的热点 |
py-spy |
在不重启程序或修改代码的情况下，找出程序在哪些地方花费了时间 |
| Scalene | 检测性能瓶颈和内存泄漏 |
可以安装并运行这些工具。最终，选择哪种性能分析工具取决于具体使用场景。对于快速检查，可以使用 Python 标准库中的 cProfile 和 timeit，而无需安装第三方库。
如果用的是 Linux，可以尝试 perf，这是一款功能强大的性能分析工具，现已在 Python 3.12 中得到支持。
最后，py-spy 和 Scalene 是可以从 Python 包索引（PyPI）安装的第三方库。当希望通过 Python 包来分析代码性能时，可以考虑使用它们。
漏洞检查工具
在代码中，可能会无意间泄露敏感数据（例如用户凭据和 API 密钥），或者使代码暴露于其他安全漏洞（如 SQL 注入攻击）。为了降低此类安全事件的风险，应对 Python 代码进行安全性或漏洞扫描。
Bandit 是一款专注于安全性的代码检查工具（linter），用于扫描 Python 代码中的常见漏洞和不安全的编码模式。这些模式包括以下内容的使用：
exec()、eval() 和 pickle.load() 函数assert 语句以上只是 Bandit 可以针对代码运行的部分测试示例。甚至可以利用它编写自己的测试，然后将其应用于 Python 项目。一旦获得检测到的问题列表，就可以采取措施修复这些问题，从而提高代码的安全性。
决定何时检查代码质量
应该经常检查代码的质量。如果缺乏自动化和一致性，大型团队或项目可能会逐渐忽视目标，开始编写低质量的代码。这种情况可能慢慢发生，一个微小的问题接一个地出现。随着时间推移，所有这些问题堆积起来，最终可能导致代码库充满漏洞、难以阅读、难以维护，并且在添加新功能时让人头疼不已。
为了避免陷入低质量的恶性循环，请经常检查你的代码！例如，可以在以下时候检查代码：
在编写代码时，可以使用代码检查工具（linters）、静态类型检查工具、格式化工具和漏洞检查工具。为了避免增加额外的工作量，应该花时间配置开发环境，使这些工具在编写和保存代码时自动运行。通常只需找到适合你所选 IDE 或编辑器的插件或扩展即可。
你可能使用版本控制系统 (VCS) 来管理代码。大多数这类系统都有功能，可以在提交代码前运行脚本、测试和其他检查。可以利用这些功能阻止任何不符合质量标准的新代码进入代码库。
虽然这看似严格，但对每一段代码强制执行质量检查是确保稳定性和高质量的重要一步。在代码入口处自动化这一过程是避免低质量代码的好方法。
最后，当你有一套完善的测试并频繁运行它们时，添加新代码或进行更改和修复后可能会导致测试失败。这些失败的测试需要代码修正，并为提高代码质量提供了绝佳机会。测试驱动开发 也是一种确保代码质量的良好策略。
总结
通过以上已经了解了定义 Python 代码质量的不同方面，从基本的功能性到高级特性，如可读性、可维护性和可扩展性。
为了生成高质量的代码，应该遵循编码标准，并使用诸如代码检查工具、类型检查工具和格式化工具等工具。系列文章中还深入探讨了代码审查、测试以及使用 AI 助手等策略和技术。
作为一名 Python 开发者，编写高质量代码对你至关重要。高质量代码降低了开发成本，减少了错误，并促进了同事之间的协作。
作者：CS创新实验室
