第2条:遵循PEP8风格指南
《Python Enhancement Proposal #8》(8号Python增强提案)又叫PEP8,它是针对Python代码格式而编订的风格指南。
尽管可以在保证语法正确的前提下随意编写Python代码,但是,采用一致的风格来书写可以让代码更加易懂、更加易读。
采用和其他Python程序员相同的风格来写代码,可以使项目更利于多人协作。
即便代码只会由你自己阅读,遵循这套风格也依然可以令后续的修改变得容易一些。
PEP8列出了许多细节,以描述如何撰写清晰的Python代码。它会随着Python语言持续更新。下面列出几条应该绝对遵守的规则:
1.空白:Python中的空白(whitespace)会影响代码的含义。python程序员使用空白的时候尤其在意,因为它们会影响代码代码的清晰程度。
(1)使用space(空格)来表示缩进,而不要用tab(制表符)。
为什么不建议用tab键,因为tab键和space键不能混用,这样格式检测时会直接报语法错误。
(2)和语法相关的每一层缩进都用4个空格来表示。
(3)每行的字符数不应超过79。
(4)对于占据多行的长表达式来说,除了首行之外的其余各行都应该在通常的缩进级别之上再加上4个空格。
(5)文件中的函数与类之间应该用两个空行隔开。
(6)在同一个类中,各方法之间应该用一个空行隔开。
(7)在使用下标来获取列表元素、调用函数或给关键字参数赋值的时候,不要在两旁添加空格。
(8)为变量赋值的时候,赋值符号的左侧和右侧应该各自写上一个空格,而且只写一个就好。
2.命名:PEP8提倡采用不同的命名风格来编写Python代码中的各个部分,以便在阅读代码时可以根据这些名称看出它们在Python语言中的角色。
(1)函数、变量及属性应该用小写字母来拼写,各单词之间以下划线相连,例如,lowercase_underscore。
(2)受保护的实例属性,应该以单个下划线开头,例如,_leading_underscore。
(3)私有的实例属性,应该以两个下划线开头,例如,__double_leading_underscore。
(4)类与异常,应该以每个单词首字母均大写的形式来命名,例如,CapitailzedWord。
(5)模块级别的常量,应该全部采用大写字母来拼写,各单词之间以下划线相连,例如,ALL_CAPS
(6)类中的实例方法(instance method),应该把首个参数命名为self,以表示该对象自身。
(7)类方法(class method)的首个参数,应该命名为cls,以表示该类自身。
3.表达式和语句:《The Zen of Python》(Python之禅)中说:每件事都应该有直白的做法,而且最好只有一种。PEP8在制定表达式和语句的风格时,就试着体现了这种思想。
(1)采用内联形式的否定词,而不要把否定词放在整个表达式的前面,例如,应该写if a is not b而不是if not a is b。
(2)不要通过检测长度的方法(例如if len(somelist) == 0)来判断somelist是否为[]或等空值,
而是应该采用if not somelist这种写法来判断,它会假定:空值将自动评估为False。
(3)检测somelist是否为[]或‘hi’等非空值,也应如此,if somelist语句会默认把非空值判断为True。
(4)不要编写单行的if语句、for循环、while循环及expect复合语句,而是应该把这些语句分成多行来书写,以示清晰。
(5)import语句应该总是放在文件开头。
(6)引入模块的时候,总是应该使用绝对名称,而不应该根据当前模块的路径来使用相对名称。
例如,引入bar包中的foo模块时,应该完整的写出from bar import foo,而不是应该简写为import foo。
(7)如果一定要以相对名称来编写import语句,那就采用明确的写法:from.import foo。
(8)文件中的那些import语句应该按顺序划分成三部分,分别表示标准库模块、第三方模块以及自用模块。
在每一部分中,各import语句应该按模块的字母顺序来排列。
拓展:Pylint(http://www.pylint.org)是一款流行的Python源码静态分析工具。它可以自动检查受测代码是否符合PEP8风格指南,而且还能找出Python程序里的多种常见错误。
后面一章会介绍这个软件的使用。
第2条:遵循PEP8风格指南的更多相关文章
- 遵循PEP8风格指南
整理来自 effective python 一 空白 1 使用space来标识缩进,而不是tab 2 和语法相关的每层缩进都使用4个空格 3 每行的字符数不应该超过79 4 对于多行的表达式,除了首行 ...
- 遵循PEP8风格
遵循PEP8风格 在编写python代码的时候我们应该采用统一的风格来编写代码,可以使代码更加容易读懂.采用和其他程序员统一的编码风格来写代码,也可以使项目更利于多人协作开发.即便代码只有你自己能看懂 ...
- python的PEP8 代码风格指南
PEP8 代码风格指南 这篇文章原文实际上来自于这里:https://www.python.org/dev/peps/pep-0008/ 知识点 代码排版 字符串引号 表达式和语句中的空格 注释 版本 ...
- python代码风格指南:pep8 中文翻译
摘要 本文给出主Python版本标准库的编码约定.CPython的C代码风格参见PEP7.本文和PEP 257 文档字符串标准改编自Guido最初的<Python Style Guide&g ...
- Python PEP-8编码风格指南中文版
#PEP 8 – Python编码风格指南 PEP: 8 Title: Style Guide for Python Code Author: Guido van Rossum , Barry War ...
- python代码风格指南:pep8 中文版
本文档所提供的编码规范,适用于主要的Python发行版中组成标准库的Python代码.请参阅PEP关于Python的C实现的C编码风格指南的描述. 本文档和PEP257(文档字符串规范)改编自Guid ...
- PEP8中文版 -- Python编码风格指南
Python部落组织翻译, 禁止转载 目录 缩进 制表符还是空格? 行的最大长度 空行 源文件编码 导入 无法忍受的 其 ...
- Python 编码风格指南
原文:http://python.jobbole.com/84618/ 本文超出 PEP8 的范畴以涵盖我认为优秀的 Python 风格.本文虽然坚持己见,却不偏执.不仅仅涉及语法.模块布局等问题,同 ...
- Google Java编程风格指南
出处:http://hawstein.com/posts/google-java-style.html 声明:本文采用以下协议进行授权: 自由转载-非商用-非衍生-保持署名|Creative Comm ...
随机推荐
- PHP结巴程序实现
<?php $str="我...我要要要...学学学..编编程"; $str=preg_replace('/\./','',$str);//我我要要要学学学编编程 $str= ...
- JUnit编写单元测试代码注意点小结
用eclipse编写单元测试的时候,可以直接选中某个类,然后右键new新疆一个junit case,界面如下图1所示: 图1:新建test case 选 择图1中的JUnit Test Case,然后 ...
- CALayer的contentsRect
contentsRect 想像下contentsRect作为层内容的可视区域.内容的矩形区域(x,y,width,height)也是绑定到层的框架上的.contentRect是一个比例值,而不是屏幕上 ...
- 工作总结 @Html.EditorFor @Html.TextBoxFor 表达式树 绑定显示日期格式数据
页面显示 不出来 没有 这个input ............. 换成 @Html.TextBoxFor input 出来了 这是 为什么呢 ? 用@Html.TextBox 也可以出来 为什么 @ ...
- lua学习笔记(八)
元表与元方法 基本概念 1.lua中每个值都有一个元表 2.table和userdata可以有各自独立的元表 3.其它类型的值共享其类型所属的单一 ...
- iOS CAGradientLayer白色渐变至上向下
项目需求当显示富文本内容高度太高的的时候不全部显示出来,而是显示查看更多按钮,当点击查看更多时把全部内容展开.同时未展开部分要加一个渐变模糊的效果. 上效果图: 这里要用到CAGradientLaye ...
- nginx做反向代理proxy_pass,proxy_redirect的使用
大 | 中 | 小 今天用nginx作为trac的反代,发现一个问题,就是登入登出跳转的时候是白页,看了下网页相应内容,发现相应的location是空的.查了一下发现是只单纯用了proxy_pas ...
- 关于ES6的let,const与var之间的三生三世
首先需要明确的是let.const.var都是用来定义变量的 在ES6之前,我们一般都用var来定义变量,例如 : function test(){ var i=1; console.log(i); ...
- easyui首页模板
Easyui首页html代码 <!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "htt ...
- a byte of vim -- 学习摘要
说在前面的话 -- a byte of vim 是我见过的最介绍vim 最好的书,想了解强大的vim的人,或者是已经在使用vim而打算进一步了解的人,我感觉都应该看看这个,内容精炼但涵盖非常广,--& ...