编写整洁的Python代码（第2版）

第1章　简介、代码格式设置和工具

本章从整洁代码的含义入手，探索与整洁代码相关的第一个概念，主要目标是让你明白，在软件项目中，整洁代码不是锦上添花的奢侈品，而是必需品。没有高质量的代码，项目将不断累积技术债务，进而面临失败的风险（如果你没有听说过技术债务，也不用担心，本章后面会深入讨论）。

本章还将详细介绍代码格式设置、文档编写等概念。同样，这些需求或任务看似多余，却对确保代码库的可维护性和可操作性至关重要。

我们将分析遵循良好编码指南的重要性。考虑到确保代码遵循指导原则是个持续不断的过程，我们就会明白使用可简化工作的自动化工具大有裨益。有鉴于此，我们将讨论如何配置在项目构建过程中自动运行的工具。

本章的目标是让你了解如下方面：何谓整洁代码；整洁代码很重要的原因；为何给代码设置格式和编写文档至关重要；如何实现这个过程的自动化。阅读本章后，你将知道如何快速地组织新项目，向代码质量上乘的目标迈进。

通过阅读本章，你将学到如下知识。

● 整洁代码确实意味着比格式设置更重要的东西。

● 制定代码格式设置标准对确保软件项目易于维护至关重要。

● 如何使用Python提供的特性实现代码文档的自动生成。

● 如何配置工具以自动对代码进行静态验证。

1.1　简介

我们首先要理解何谓整洁代码及其对软件工程项目的成功至关重要的原因。在1.1.1小节和1.1.2小节中，我们将了解保持良好的代码质量对于高效工作是多么重要。

然后，我们将讨论这些规则的例外情况，即在什么情况下，不为偿还所有技术债务而重构代码更合算。毕竟，不存在放之四海皆准的规则，总会有例外存在。这里的重点是，正确地理解破例的原因，并确定在哪些情况下需要破例，避免在应该改进的情况下却认为不需要改进。

1.1.1　整洁代码的含义

对于整洁代码，不存在唯一或严格的定义，也不存在衡量代码整洁程度的正式标准，因此无法通过对代码库运行工具来判断代码的优劣和可维护性。诚然，你可以运行检查器、代码校验器（linter）、静态分析器等必不可少的工具，这些工具可提供极大的帮助，但光有它们还不够，代码整洁与否并非机器或脚本能够判断（到目前为止），但专业人士能够判断。 ...