写出一年后仍然易懂的 Python 代码

Source: Dev.to

Python 常常因其可读性而受到赞誉，但可读性并不会自动出现。写出今天能运行、但几个月后让人难以理解的 Python 很容易。语言的灵活性很强大，但如果缺乏约束，它会悄悄让复杂性渗入代码。

一些习惯始终决定了 Python 代码是能够经得起时间考验，还是会变成维护负担。

编写可持续 Python 的指南

更倾向显式而非灵活

Python 允许函数接受几乎任何参数并返回几乎任何值。虽然方便，但这常常隐藏意图。清晰的函数签名、可预测的返回类型以及明显的控制流可以降低理解代码所需的思考负担。

用意义而非机制来命名

变量和函数名应解释 为什么 存在，而不仅仅是 怎么 工作。一个好的名字可以省去注释的需求，使逻辑在没有额外上下文的情况下也易于阅读。

保持函数小且专注

只做一件事的函数更容易测试、复用和推理。当函数变大时，往往意味着职责混杂，这会让后续修改风险加大。

对巧妙的语言特性保持警惕

列表推导式、装饰器和元编程都很强大，但它们也会提升理解的门槛。为了减少代码行数而增加下一位阅读者的认知负担，往往得不偿失。

让控制流一目了然

避免深层嵌套的条件语句和隐式行为。代码应从上到下顺畅阅读，而不需要读者在脑中模拟各种边界情况。

使用测试作为文档

写得好的测试不仅验证正确性，还展示了代码的预期用法。关注行为的测试让未来的重构更安全、更容易。

为未来的读者进行优化

代码的最重要的读者是那个对它不熟悉、且时间紧迫的人。写代码时要把自己当作将要维护它的人，因为最终真的会是这样。

经得起时间考验的 Python 代码给人一种平静的感觉。你可以把它拆解成块来理解，自信地进行修改，并且毫无顾虑地继续前进。这种平静并非来源于严格的规则，而是源自于始终选择清晰而非巧妙。