python编码规范-PE8

《python enhancement proposal #8》(8号python增强提案)

空白

  • 用space表示缩进,不要用tab
  • 每层缩进用4个空格表示
  • 每行字符串不超过79
  • 占用多行的长表达式,除了首行外其余各行都应该在基础之上再加4个space
  • 文件中的函数与类应该用两个space隔开
  • 在同一个类中,各个方法用一个space隔开
  • 在使用下标获取列表元素,调用函数或者给关键词参数赋值的时候,不要在两旁加空格
  • 给变量赋值的时候,赋值符号左右两侧应该各加一个space

命名

  • 函数、变量及属性应该用小写字母拼写,各单词用 下划线连接,如lowercase_underscore
  • 受保护的实例属性,应该以单个下划线开头,如:_leading_underscore
  • 私有的实例属性,应该以两个下划线开头,如__double_leading_underscore
  • 类和异常,应该以每个单词的首字母大写命名,如CapitalizedWorld
  • 模块级别的产量,全部大写字母命名,如ALL_CAPS
  • 类中的实例方法,首个参数命名为self,表示该对象自身
  • 类方法的首个参数,应该命名为cls,表示该类自身

表达式和语句

  • 文件中import语句应该放在最前面,分为3个部分,分别表示标准库模块,第三方模块,自用模块
  • 引入模块的时候,应该使用绝对名称,而不是当前模块来的路径来使用相对名称。例如映入bar包中的foo模块,应该完整写出from bar import foo,而不是import foo
  • 如果一定要用相对名称写import语句,采用明确的写法from . import foo
  • 不要通过检测长度的办法if len(list)==0来判断list是否为[],或者‘’等空值,而是应该采用if not list来判断,它会将空值自动评估为false
  • 采用内联形式的否定词,而不要将否定词放在整个表达式的最前面,如 if a is not b而不是if not a is b
最后编辑于
©著作权归作者所有,转载或内容合作请联系作者
  • 序言:七十年代末,一起剥皮案震惊了整个滨河市,随后出现的几起案子,更是在滨河造成了极大的恐慌,老刑警刘岩,带你破解...
    沈念sama阅读 203,772评论 6 477
  • 序言:滨河连续发生了三起死亡事件,死亡现场离奇诡异,居然都是意外死亡,警方通过查阅死者的电脑和手机,发现死者居然都...
    沈念sama阅读 85,458评论 2 381
  • 文/潘晓璐 我一进店门,熙熙楼的掌柜王于贵愁眉苦脸地迎上来,“玉大人,你说我怎么就摊上这事。” “怎么了?”我有些...
    开封第一讲书人阅读 150,610评论 0 337
  • 文/不坏的土叔 我叫张陵,是天一观的道长。 经常有香客问我,道长,这世上最难降的妖魔是什么? 我笑而不...
    开封第一讲书人阅读 54,640评论 1 276
  • 正文 为了忘掉前任,我火速办了婚礼,结果婚礼上,老公的妹妹穿的比我还像新娘。我一直安慰自己,他们只是感情好,可当我...
    茶点故事阅读 63,657评论 5 365
  • 文/花漫 我一把揭开白布。 她就那样静静地躺着,像睡着了一般。 火红的嫁衣衬着肌肤如雪。 梳的纹丝不乱的头发上,一...
    开封第一讲书人阅读 48,590评论 1 281
  • 那天,我揣着相机与录音,去河边找鬼。 笑死,一个胖子当着我的面吹牛,可吹牛的内容都是我干的。 我是一名探鬼主播,决...
    沈念sama阅读 37,962评论 3 395
  • 文/苍兰香墨 我猛地睁开眼,长吁一口气:“原来是场噩梦啊……” “哼!你这毒妇竟也来了?” 一声冷哼从身侧响起,我...
    开封第一讲书人阅读 36,631评论 0 258
  • 序言:老挝万荣一对情侣失踪,失踪者是张志新(化名)和其女友刘颖,没想到半个月后,有当地人在树林里发现了一具尸体,经...
    沈念sama阅读 40,870评论 1 297
  • 正文 独居荒郊野岭守林人离奇死亡,尸身上长有42处带血的脓包…… 初始之章·张勋 以下内容为张勋视角 年9月15日...
    茶点故事阅读 35,611评论 2 321
  • 正文 我和宋清朗相恋三年,在试婚纱的时候发现自己被绿了。 大学时的朋友给我发了我未婚夫和他白月光在一起吃饭的照片。...
    茶点故事阅读 37,704评论 1 329
  • 序言:一个原本活蹦乱跳的男人离奇死亡,死状恐怖,灵堂内的尸体忽然破棺而出,到底是诈尸还是另有隐情,我是刑警宁泽,带...
    沈念sama阅读 33,386评论 4 319
  • 正文 年R本政府宣布,位于F岛的核电站,受9级特大地震影响,放射性物质发生泄漏。R本人自食恶果不足惜,却给世界环境...
    茶点故事阅读 38,969评论 3 307
  • 文/蒙蒙 一、第九天 我趴在偏房一处隐蔽的房顶上张望。 院中可真热闹,春花似锦、人声如沸。这庄子的主人今日做“春日...
    开封第一讲书人阅读 29,944评论 0 19
  • 文/苍兰香墨 我抬头看了看天上的太阳。三九已至,却和暖如春,着一层夹袄步出监牢的瞬间,已是汗流浃背。 一阵脚步声响...
    开封第一讲书人阅读 31,179评论 1 260
  • 我被黑心中介骗来泰国打工, 没想到刚下飞机就差点儿被人妖公主榨干…… 1. 我叫王不留,地道东北人。 一个月前我还...
    沈念sama阅读 44,742评论 2 349
  • 正文 我出身青楼,却偏偏与公主长得像,于是被迫代替她去往敌国和亲。 传闻我的和亲对象是个残疾皇子,可洞房花烛夜当晚...
    茶点故事阅读 42,440评论 2 342

推荐阅读更多精彩内容

  • --< > 令人讨厌的小人物身上有着愚蠢的一致性 --(A Foolish Consistency is the ...
    LittleWizard阅读 3,208评论 0 4
  • 以前翻译过<effective python>的几章, 后来发现已经有人翻译过了, 就停了想想还是放上来吧 第二条...
    buyu007阅读 390评论 0 0
  • 代码布局 缩进 每一行缩进使用四个空格 延续行与圆括号、方括号和花括号内的左部垂直对齐,或使用悬挂缩进。 悬挂缩进...
    IT白阅读 974评论 0 0
  • 介绍 本文档给出了Python代码的编码约定。 该样式指南会随着时间的流逝而发展,因为会发现其他约定,而过去的约定...
    Eazow阅读 467评论 0 0
  • Introduction This document gives coding conventions for t...
    wuutiing阅读 4,521评论 0 9