PEP 8 部分规则

一些应该遵守的规则

遵循一定的规则能使代码更加整洁、规范,提高可读性。PEP 8 是针对 Python 代码格式而编订的风格指南,下面列举出一些重要的 PEP 8 的规则。

代码格式

  • 使用 space 表示缩进而不是 tab。
  • 和语法相关的每一层缩进都用 4 个空格表示。
  • 每行字符数不应超过 79。
  • 占据多行的表达式,除首行外其余各行都应在缩进级别上再加四个空格。
  • 文件中的函数与类使用两个空行隔开。
  • 同一个类中,各方法间用一个空行隔开。
  • 使用下标获取列表元素、调用函数或给关键字复制的时候,不要在两旁加空格。
  • 变量赋值时,赋值符号左右各加一个空格即可。

命名

  • 变量、函数及属性使用小写单词下划线相连,如 my_car
  • 受保护的实例属性,单下划线开头,如 _len_of_bmw
  • 私有实例属性,双下划线开头, 如 __color_of_bmw
  • 类与异常,大驼峰命名,如 CarFactory
  • 模块级别常量,全大写用下划线相连, 如TOTAL_PRICE
  • 类中的实例方法,首个参数应为 self,以表示该对象自身。
  • 类方法的首个参数应该为 cls, 以表示类自身。

表达式和语句

  • 使用 if a is not b 而不是 if not a is b, 不要把否定词放在整个表达式前面。
  • 不要通过 if len(somelist)==0 之类的语句来判断列表是否为空,应该使用 if not somelistif somelist
  • 不要编写单行的 if 语句、forwhile 循环及 except 复合句,应该分成多行,使得层级更加清晰。
  • import 语句应该放在文件开头
  • import 时不应简写,应该使用 from package import module 而不是直接 import module
  • import 语句应该分为三部分,分别表示标准模块库、第三方模块及自用模块
最后编辑于
©著作权归作者所有,转载或内容合作请联系作者
  • 序言:七十年代末,一起剥皮案震惊了整个滨河市,随后出现的几起案子,更是在滨河造成了极大的恐慌,老刑警刘岩,带你破解...
    沈念sama阅读 217,907评论 6 506
  • 序言:滨河连续发生了三起死亡事件,死亡现场离奇诡异,居然都是意外死亡,警方通过查阅死者的电脑和手机,发现死者居然都...
    沈念sama阅读 92,987评论 3 395
  • 文/潘晓璐 我一进店门,熙熙楼的掌柜王于贵愁眉苦脸地迎上来,“玉大人,你说我怎么就摊上这事。” “怎么了?”我有些...
    开封第一讲书人阅读 164,298评论 0 354
  • 文/不坏的土叔 我叫张陵,是天一观的道长。 经常有香客问我,道长,这世上最难降的妖魔是什么? 我笑而不...
    开封第一讲书人阅读 58,586评论 1 293
  • 正文 为了忘掉前任,我火速办了婚礼,结果婚礼上,老公的妹妹穿的比我还像新娘。我一直安慰自己,他们只是感情好,可当我...
    茶点故事阅读 67,633评论 6 392
  • 文/花漫 我一把揭开白布。 她就那样静静地躺着,像睡着了一般。 火红的嫁衣衬着肌肤如雪。 梳的纹丝不乱的头发上,一...
    开封第一讲书人阅读 51,488评论 1 302
  • 那天,我揣着相机与录音,去河边找鬼。 笑死,一个胖子当着我的面吹牛,可吹牛的内容都是我干的。 我是一名探鬼主播,决...
    沈念sama阅读 40,275评论 3 418
  • 文/苍兰香墨 我猛地睁开眼,长吁一口气:“原来是场噩梦啊……” “哼!你这毒妇竟也来了?” 一声冷哼从身侧响起,我...
    开封第一讲书人阅读 39,176评论 0 276
  • 序言:老挝万荣一对情侣失踪,失踪者是张志新(化名)和其女友刘颖,没想到半个月后,有当地人在树林里发现了一具尸体,经...
    沈念sama阅读 45,619评论 1 314
  • 正文 独居荒郊野岭守林人离奇死亡,尸身上长有42处带血的脓包…… 初始之章·张勋 以下内容为张勋视角 年9月15日...
    茶点故事阅读 37,819评论 3 336
  • 正文 我和宋清朗相恋三年,在试婚纱的时候发现自己被绿了。 大学时的朋友给我发了我未婚夫和他白月光在一起吃饭的照片。...
    茶点故事阅读 39,932评论 1 348
  • 序言:一个原本活蹦乱跳的男人离奇死亡,死状恐怖,灵堂内的尸体忽然破棺而出,到底是诈尸还是另有隐情,我是刑警宁泽,带...
    沈念sama阅读 35,655评论 5 346
  • 正文 年R本政府宣布,位于F岛的核电站,受9级特大地震影响,放射性物质发生泄漏。R本人自食恶果不足惜,却给世界环境...
    茶点故事阅读 41,265评论 3 329
  • 文/蒙蒙 一、第九天 我趴在偏房一处隐蔽的房顶上张望。 院中可真热闹,春花似锦、人声如沸。这庄子的主人今日做“春日...
    开封第一讲书人阅读 31,871评论 0 22
  • 文/苍兰香墨 我抬头看了看天上的太阳。三九已至,却和暖如春,着一层夹袄步出监牢的瞬间,已是汗流浃背。 一阵脚步声响...
    开封第一讲书人阅读 32,994评论 1 269
  • 我被黑心中介骗来泰国打工, 没想到刚下飞机就差点儿被人妖公主榨干…… 1. 我叫王不留,地道东北人。 一个月前我还...
    沈念sama阅读 48,095评论 3 370
  • 正文 我出身青楼,却偏偏与公主长得像,于是被迫代替她去往敌国和亲。 传闻我的和亲对象是个残疾皇子,可洞房花烛夜当晚...
    茶点故事阅读 44,884评论 2 354