《编写高质量Python代码的59个有效方法》——第2条:遵循PEP 8风格指南

第2条:遵循PEP 8风格指南
《Python Enhancement Proposal #8》(8号Python增强提案)又叫PEP 8,它是针对Python代码格式而编订的风格指南。尽管可以在保证语法正确的前提下随意编写Python代码,但是,采用一致的风格来书写可以令代码更加易懂、更加易读。采用和其他Python程序员相同的风格来写代码,也可以使项目更利于多人协作。即便代码只会由你自己阅读,遵循这套风格也依然可以令后续的修改变得容易一些。
PEP 8列出了许多细节,以描述如何撰写清晰的Python代码。它会随着Python语言持续更新。大家应该把整份指南都读一遍(http://www.python.org/dev/peps/pep-0008)。下面列出几条绝对应该遵守的规则。
空白:Python中的空白(whitespace)会影响代码的含义。Python程序员使用空白的时候尤其在意,因为它们还会影响代码的清晰程度。
使用space(空格)来表示缩进,而不要用tab(制表符)。
和语法相关的每一层缩进都用4个空格来表示。
每行的字符数不应超过79。
对于占据多行的长表达式来说,除了首行之外的其余各行都应该在通常的缩进级别之上再加4个空格。
文件中的函数与类之间应该用两个空行隔开。
在同一个类中,各方法之间应该用一个空行隔开。
在使用下标来获取列表元素、调用函数或给关键字参数赋值的时候,不要在两旁添加空格。
为变量赋值的时候,赋值符号的左侧和右侧应该各自写上一个空格,而且只写一个就好。
命名:PEP 8提倡采用不同的命名风格来编写Python代码中的各个部分,以便在阅读代码时可以根据这些名称看出它们在Python语言中的角色。
函数、变量及属性应该用小写字母来拼写,各单词之间以下划线相连,例如,lowercase_underscore。
受保护的实例属性,应该以单个下划线开头,例如,_leading_underscore。
私有的实例属性,应该以两个下划线开头,例如,__double_leading_underscore。
类与异常,应该以每个单词首字母均大写的形式来命名,例如,CapitalizedWord。
模块级别的常量,应该全部采用大写字母来拼写,各单词之间以下划线相连,例如,ALL_CAPS。
类中的实例方法(instance method),应该把首个参数命名为self,以表示该对象自身。
类方法(class method)的首个参数,应该命名为cls,以表示该类自身。
表达式和语句:《The Zen of Python》(Python之禅)中说:“每件事都应该有直白的做法,而且最好只有一种。”PEP 8在制定表达式和语句的风格时,就试着体现了这种思想。
采用内联形式的否定词,而不要把否定词放在整个表达式的前面,例如,应该写if a is not b而不是if not a is b。
不要通过检测长度的办法(如if len(somelist) == 0)来判断somelist是否为[]或''等空值,而是应该采用if not somelist这种写法来判断,它会假定:空值将自动评估为False。
检测somelist是否为[1]或'hi'等非空值时,也应如此,if somelist语句默认会把非空的值判断为True。
不要编写单行的if语句、for循环、while循环及except复合语句,而是应该把这些语句分成多行来书写,以示清晰。
import语句应该总是放在文件开头。
引入模块的时候,总是应该使用绝对名称,而不应该根据当前模块的路径来使用相对名称。例如,引入bar包中的foo模块时,应该完整地写出from bar import foo,而不应该简写为import foo。
如果一定要以相对名称来编写import语句,那就采用明确的写法:from.import foo。
文件中的那些import语句应该按顺序划分成三个部分,分别表示标准库模块、第三方模块以及自用模块。在每一部分之中,各import语句应该按模块的字母顺序来排列。
Pylint(http://www.pylint.org/)是一款流行的Python源码静态分析工具。它可以自动检查受测代码是否符合PEP 8风格指南,而且还能找出Python程序里的多种常见错误。
要点
当编写Python代码时,总是应该遵循PEP 8风格指南。
与广大Python开发者采用同一套代码风格,可以使项目更利于多人协作。
采用一致的风格来编写代码,可以令后续的修改工作变得更为容易。

时间: 2024-08-29 05:38:53

《编写高质量Python代码的59个有效方法》——第2条:遵循PEP 8风格指南的相关文章

《编写高质量Python代码的59个有效方法》——导读

目 录 前 言 致 谢第1章 用Pythonic方式来思考 第1条:确认自己所用的Python版本 第2条:遵循PEP 8风格指南 第3条:了解bytes.str与unicode的区别第4条:用辅助函数来取代复杂的表达式第5条:了解切割序列的办法第6条:在单次切片操作内,不要同时指定start.end和stride第7条:用列表推导来取代map和f?ilter 第8条:不要使用含有两个以上表达式的列表推导第9条:用生成器表达式来改写数据量较大的列表推导第10条:尽量用enumerate取代ran

《编写高质量Python代码的59个有效方法》——第3条:了解bytes、str与unicode的区别

第3条:了解bytes.str与unicode的区别 Python 3有两种表示字符序列的类型:bytes和str.前者的实例包含原始的8位值:后者的实例包含Unicode字符. Python 2也有两种表示字符序列的类型,分别叫做str和unicode.与Python 3不同的是,str的实例包含原始的8位值:而unicode的实例,则包含Unicode字符. 把Unicode字符表示为二进制数据(也就是原始8位值)有许多种办法.最常见的编码方式就是UTF-8.但是大家要记住,Python 3

《编写高质量Python代码的59个有效方法》——第8条:不要使用含有两个以上表达式的列表推导

第8条:不要使用含有两个以上表达式的列表推导除了基本的用法(参见本书第7条)之外,列表推导也支持多重循环.例如,要把矩阵(也就是包含列表的列表,即二维列表)简化成一维列表,使原来的每个单元格都成为新列表中的普通元素.这个功能采用包含两个for表达式的列表推导即可实现,这些for表达式会按照从左至右的顺序来评估. 上面这个例子简单易懂,这就是多重循环的合理用法.还有一种包含多重循环的合理用法,那就是根据输入列表来创建有两层深度的新列表.例如,我们要对二维矩阵中的每个单元格取平方,然后用这些平方值构

《编写高质量Python代码的59个有效方法》——第15条:了解如何在闭包里使用外围作用域中的变量

第15条:了解如何在闭包里使用外围作用域中的变量 假如有一份列表,其中的元素都是数字,现在要对其排序,但排序时,要把出现在某个群组内的数字,放在群组外的那些数字之前.这种用法在绘制用户界面时候可能会遇到,我们可以用这个办法把重要的消息或意外的事件优先显示在其他内容前面. 实现该功能的一种常见做法,是在调用列表的sort方法时,把辅助函数传给key参数.这个辅助函数的返回值,将会用来确定列表中各元素的顺序.辅助函数可以判断受测元素是否处在重要群组中,并据此返回相应的排序关键字(sort key).

《编写高质量Python代码的59个有效方法》——第12条:不要在for和while循环后面写else块

第12条:不要在for和while循环后面写else块 Python提供了一种很多编程语言都不支持的功能,那就是可以在循环内部的语句块后面直接编写else块. 奇怪的是,这种else块会在整个循环执行完之后立刻运行.既然如此,那它为什么叫做else呢?为什么不叫and?在if/else语句中,else的意思是:如果不执行前面那个if块,那就执行else块.在try/except语句中,except的定义也类似:如果前面那个try块没有成功执行,那就执行except块. 同理,try/except

《编写高质量Python代码的59个有效方法》——第13条:合理利用try/except/else/f?inally结构中的每个代码块

第13条:合理利用try/except/else/f?inally结构中的每个代码块Python程序的异常处理可能要考虑四种不同的时机.这些时机可以用try.except.else和f?inally块来表述.复合语句中的每个块都有特定的用途,它们可以构成很多种有用的组合方式(参见本书第51条).1.?f?inally块如果既要将异常向上传播,又要在异常发生时执行清理工作,那就可以使用try/f?inally结构.这种结构有一项常见的用途,就是确保程序能够可靠地关闭文件句柄(还有另外一种写法,参见

《编写高质量Python代码的59个有效方法》——第17条:在参数上面迭代时,要多加小心

第17条:在参数上面迭代时,要多加小心如果函数接受的参数是个对象列表,那么很有可能要在这个列表上面多次迭代.例如,要分析来美国Texas旅游的人数.假设数据集是由每个城市的游客数量构成的(单位是每年百万人).现在要统计来每个城市旅游的人数,占总游客数的百分比.为此,需要编写标准化函数(normalization function).它会把所有的输入值加总,以求出每年的游客总数.然后,用每个城市的游客数除以总数,以求出该城市所占的比例. 把各城市的游客数量放在一份列表里,传给该函数,可以得到正确结

《编写高质量Python代码的59个有效方法》——第7条:用列表推导来取代map和f?ilter

第7条:用列表推导来取代map和f?ilterPython提供了一种精练的写法,可以根据一份列表来制作另外一份.这种表达式称为list comprehension(列表推导).例如,要用列表中每个元素的平方值构建另一份列表.如果采用列表推导来实现,那就同时指定制作新列表时所要迭代的输入序列,以及计算新列表中每个元素的值时所用的表达式. 除非是调用只有一个参数的函数,否则,对于简单的情况来说,列表推导要比内置的map函数更清晰.如果使用map,那就要创建lambda函数,以便计算新列表中各个元素的

《编写高质量Python代码的59个有效方法》——第20条:用None和文档字符串来描述具有动态默认值的参数

第20条:用None和文档字符串来描述具有动态默认值的参数有时我们想采用一种非静态的类型,来做关键字参数的默认值.例如,在打印日志消息的时候,要把相关事件的记录时间也标注在这条消息中.默认情况下,消息里面所包含的时间,应该是调用log函数那一刻的时间.如果我们以为参数的默认值会在每次执行函数时得到评估,那可能就会写出下面这种代码. 两条消息的时间戳(timestamp)是一样的,这是因为datetime.now只执行了一次,也就是它只在函数定义的时候执行了一次.参数的默认值,会在每个模块加载进来