本文转载自微信公众号《大数据DT》,作者BrettSlatkin。转载本文请联系大数据DT公众号。PEP8非常详细地描述了如何编写清晰的Py??thon代码,并将随着Python语言的发展不断更新。你应该阅读完整的指南:https://www.python.org/dev/peps/pep-0008作者认为应该绝对遵循以下规则。01与whitespace相关的建议(9项/26项)在Python中,whitespace(空白)在语法上非常重要。Python程序员特别关注空白字符的使用,因为它们会影响代码的清晰度。以下是您应该遵循的一些建议。使用空格进行缩进,而不是制表符。与语法相关的每一级缩进由4个空格表示。每行不超过79个字符。对于跨多行的长表达式,除第一行外的所有行都应在正常缩进级别之上缩进4个空格。在同一个文件中,函数和类之间用两个空行隔开。在同一个类中,方法之间用空行分隔。使用字典时,键和冒号之间不能有空格,写在同一行的冒号和值之间要加一个空格。给变量赋值时,赋值符号左右各加一个空格,只加一个空格。注解变量类型时,不要将变量名与冒号隔开,但在类型信息前应有一个空格。02与命名相关的建议(7项/26项)PEP8建议对Python代码的各个部分采用不同的命名方式,以便在阅读代码时,可以根据这些名称了解它们在Python语言中的作用。请遵循以下与命名相关的建议。函数、变量、属性用小写字母拼写,单词用下划线连接,例如:lowercase_underscore。受保护的实例属性以下划线开头,例如:_leading_underscore。私有实例属性,以两个下划线开头,例如:__double_leading_underscore。命名类(包括异常)时,每个单词的首字母大写,例如:CapitalizedWord。对于模块级常量,字母全部大写,单词之间用下划线连接,例如:ALL_CAPS。类中的实例方法应该将第一个参数命名为self,用来表示对象本身。类方法的第一个参数应命名为cls以表示类本身。03表达式和语句相关的建议(6条/26条)Python之禅提到:“凡事要有简单的方法,最好只有一个。”PEP8试图使用这个概念来标准化表达式和语句的编写。使用内联否定,即将否定词直接写在要否定的内容前面,而不是写在整个表达式的前面。例如,你应该写ifaisnotb而不是ifnotaisb。不通过长度判断一个容器或序列是否为空,例如不通过iflen(somelist)==0判断somelist是否为[]或''等空值,而是使用ifnotsomelist来判断,因为Python会自动将null值评估为False。如果要判断容器或序列中是否有内容(例如判断somelist是否为[1]或'hi'等非空值),不应该根据长度来判断,而应该使用ifsomelist语句,因为Python会自动将非空值评估为True。不要将if语句、for循环、while循环和except复合语句挤在一行中。为了清楚起见,这些语句应该写在多行上。如果表达式不适合一行,您可以将其括在括号中,并适当添加换行符和缩进以提高可读性。多行表达式应该用括号括起来,而不是使用\符号来继续该行。04与引入相关的建议(4项/26项)PEP8给出了以下关于如何在代码中引入和使用模块的建议。导入语句(包括fromximporty)应始终放在文件的开头。导入模块时,应始终使用绝对名称,而不是基于当前模块路径的相对名称。比如导入bar包中的foo模块,应该完整的写frombarimportfoo,即使当前路径在bar包中,也不应该简写为importfoo。如果一定要用相对名来写import语句,应该写清楚:from。进口富。文件中的import语句按顺序分为三部分:先导入标准库中的模块,再导入第三方模块,最后导入自己的模块。属于同一部分的导入语句按字母顺序列出。提示:Pylint是一种流行的Python源代码静态分析工具。它可以自动检查被测代码是否符合PEP8风格指南,也可以发现Python程序中的许多常见错误。许多IDE(集成开发环境)和编辑器都包含此类linting工具或支持类似的插件。https://www.pylint.org/重要编写Python代码时,您应该始终遵循PEP8风格指南。采用与大多数Python开发人员相同的代码风格,可以使项目更有利于多人协作。以一致的风格编写代码使后续修改代码变得更加容易。关于作者:BrettSlatkin是Google的首席软件工程师、GoogleSurveys的共同技术创始人以及PubSubHubbub协议的共同创建者。此外,斯拉特金还发布了谷歌的第一款云计算产品——AppEngine。早在15年前,斯拉特金就开始在工作中使用Python来管理谷歌的大型服务器群。他拥有纽约哥伦比亚大学的计算机工程学士学位。本文节选自《Effective Python:编写高质量Python代码的90个有效方法》(原书第2版),经出版社授权发布。
