第4章 选择好的名称

大部分标准库在构建时都要考虑可用性。例如,内置类型的使用是很自然的,其设计非常易于使用。在这种情况下,Python可以与你开发程序时所思考的伪代码进行比较。大部分代码都可以大声朗读出来。例如,任何人都可以理解下面这个代码片段:

   my_list = []

   if 'd' not in my_list:
       my_list.append('d')

这就是编写Python比编写其他语言更加简单的原因之一。在编写程序时,你的思路可以快速转换成代码。

本章重点介绍编写易于理解和使用的代码的最佳实践,包括:

  • 使用PEP 8描述的命名约定。
  • 一组命名最佳实践。
  • 常用工具的简要介绍,这些工具可以让你检查是否遵守风格指南。

PEP 8为编写Python代码提供了一个风格指南。除了空格缩进、每行最大长度以及其他与代码布局有关的细节等基本规则之外,PEP 8还介绍了大部分代码库所遵循的命名约定。

本节给出了这一PEP的简要总结,并进一步给出了每种元素的命名最佳实践指南。但你仍然必须阅读PEP 8文档。

如果你正在创建一个打算开源的新软件包,那么答案很简单:始终遵守。PEP 8实际上是大多数Python开源软件的标准代码风格。如果你想接受来自其他程序员的任何协作,即使你对最佳代码风格指南有不同的看法,那么也应该坚持遵守PEP 8。这样做的好处是,其他程序员可以更容易地直接上手你的项目。对于新人来说,代码更容易阅读,因为它的风格与大多数其他Python开源包一致。

此外,开始时完全遵守PEP 8,可以让你在未来省时省事。如果你想向公众发布你的代码,最终其他程序员也会建议你切换到PEP 8。关于对某一特定项目是否真有必要这么做的争吵,可能会变成一场永无止境并且永远没有赢家的口水战(flame ...

Get Python高级编程(第2版) now with the O’Reilly learning platform.

O’Reilly members experience books, live events, courses curated by job role, and more from O’Reilly and nearly 200 top publishers.