PEP 8 摘要

Posted 2021-03-05 meteor-disappears-chen

 

 

1. 设置代码格式

　　随着你编写的程序越来越长，有必要了解一些代码格式设置约定。请花时间让你的代码竟可能易于阅读；让代码易于阅读有助于你掌握程序是怎么做的，也可以帮助他人理解你编写的代码。

　　为确保所有人编写的代码的结构都大致一致，Python程序员都遵循一些格式设置约定。学会编写整洁的Python后，就可以明白他人编写的Python代码的整体结构——这要他们和你遵循相同的指南。要成为装也程序员，应从现在开始就遵循这些指南，以养成良好的习惯。

 

2. 格式设置指南

　　若是要提出Python语言修改建议，需要编写Python改进提案（Python Enhancement Proposal ,PEP）。PEP 8是最古老的PEP之一，它向Python程序员提供了代码格式设置指南。PEP 8的篇幅很长，但是大部分与复杂的代码结构相关。

　　Python格式设置指南的编写者深知，代码被阅读的次数比编写的次数多。代码编写出来后，调试时你需要阅读它；给程序添加新功能是，需要花很长的时间阅读代码；与其他程序员分享代码时，这些程序员也将阅读它们。

　　如果一定要在让代码在易于编写和易于阅读之间做出选择，Python程序员几乎总是会选择后者。下面的指南可以帮助你从一开始就编写出清晰的代码。

 

3. 缩进

　　PEP 8建议每级缩进都是用四个空格，这既可以提高可读性，又留下了足够的多级缩进空间。

　　在字处理文档当中，大家常常使用制表符而不是空格来缩进。对于字处理文档来说，这样做的效果很好，但是混合使用制表符和空格会让Python解释器感到迷惑。每款文本编辑器都提供了一种设置，可以将输入的制表符转换为指定数量的空格。你在编写代码时应该使用制表符键，但是一定要对编辑器进行设置，使其在文档之中插入空格而不是制表符。

　　在程序当中混合使用制表符和空格可能导致极难解决的问题。如果你混合使用了制表符和空格，可以将文件当中所有的制表符转换为空格，大多数编辑器都提供了这样子的功能。

4. 行长

　　很多Python程序员都建议每行不超过80字符。最初制定这样的指南时，在大多数计算机当中，终端窗口每行只能容纳79字符；当前，计算机屏幕每行可以容纳的字符数量多得多，为何还要使用79字符的标准行长呢？这里有别的原因。专业的程序员通常会在同一个屏幕上打开多个文件，使用标准行长可以让他们在屏幕上并排打开两三个文件时能够同时看到各个文件的完整行。PEP 8还建议注释的行长不超过72字符，因为有一些工具为大型项目自动生成文档时，会在每一行注释开头添加格式化字符。

　　PEP 8当中有关行长的指南并非是不可逾越的红线，有一些小组将最大行长设置为99字符。在学习期间，你不用过多地考虑代码的行长，但是也别忘了，协作编写程序时，大家几乎都遵守PEP 8指南。在大多数编辑器当中，都可以设置一个视觉标志——通常是一条竖线，让你知道不能越过的界线在什么地方。

 

5. 空行

　　要将程序的不同部分分开，可以使用空行。你应该使用空行来组织程序文件，但是也不能滥用；只要掌握其中的平衡。例如，如果你有5行创建列表的代码，还有3行处理该列表的代码，那么用一个空行将这两部分隔开是合适的。然而，你不应使用三四个空行将它们隔开。

　　空行虽然不会影响到代码的运行，但是会影响到代码的可读性。Python解释器根据水平缩进情况来解读代码，但不关心垂直间距。