Python规范PEP8的阅读笔记

重要的事情说三遍:可读性很重要;

PEP8规范的官方地址

PEP8规范要点笔记:

一、代码布局问题

1.缩进

每一级缩进四个空格。

参数缩进案例如下:

# Aligned with opening delimiter.

foo = long_function_name(var_one, var_two,

var_three, var_four)

# More indentation included to distinguish this from the rest.

def long_function_name(

var_one, var_two, var_three,

var_four):

print(var_one)

# Hanging indents should add a level.

foo = long_function_name(

var_one, var_two,

var_three, var_four)

2.空格和制表符

绝对不要混合使用制表符和空格,可以用python -t来检查是否存在混合使用的情况,混合使用容易造成问题。

3.行的最大长度

限制所有行的最大长度为79个字符,

4.空行

顶层函数和类之间两个空行

类的方法之间一个空行

谨慎的使用空行,将相关函数一组组的分割开来,谨慎意味着尽量少用

函数或者方法体内,谨慎的使用空行,表示不同的逻辑段落,谨慎意味着尽量少用

5.编码

python2.x的核心编码为ascII或者latin-1(iso-8859-1)编码,而python3的编码方式为utf-8,

6.导入

导入模块module使用单独的行

import os,sys应该改为如下方式

import os

import sys

导入同一个包或者模块的类

from subprocess import  Popen,PIPE

导入顺序:分三组导入,组与组之间用一个空行分割

standard library imports 标准库导入

related third party imports 相关第三方导入

local application/library specific imports 本地应用程序/库的特定导入

绝对路径:不推荐使用.相对路径,推荐绝对路径导入

防止命名冲突的方法:

import myclass

import foo.bar.yourclass



二、表达式和语句中的空格问题

1. 表达式中尽量避免空格:

2. 紧贴在三种括号前

3. 紧贴在逗号,分号,冒号前,但是之后留一空格以便阅读

4. 二元运算符,以及算数运算符前后一个空格即可,不要多余空格

5. 关键字参数不要前后增加一个空格。

三、注释

1. 首字母大写,句号结尾,结尾后两个空格。英语注释。(国内还是习惯中文,虽然官方建议英文注释。)

2. 块注释,以#开头,其后紧跟一个空格

3. 行内注释,与执行语句相隔至少两个空格,以#开头,其后紧根一个空格。

4. 编写良好的文档字符串,这很有意义。

"""Return a foobang

Optional plotz says to frobnicate the bizbaz first.

"""

四、命名风格

1. 不用l(L的小写),I(大写的i),O(大写的o),做变量名

2. 从大到小,项目名称,包名,模块名,类名,函数名,变量名,参数名

    项目名称随意

    包名,模块名,小写,可用下划线分割,便于阅读

    类名,首字母大写,内部类建议加上前导下划线

    异常,异常也是类,首字母大写,而且添加Error作为自定义异常的名称后缀,方便后续引用。

    函数名,小写,可用下划线分割

    变量名,小写,可用下划线。如果是常量的话,全部大写。

    参数名,参数名如果与保留字冲突,建议结尾下划线。

3. 下划线规则

    私有方法和实例变量,使用单下划线开头

    使用前导双下划线调用Python的名字变化规则来避免与子类中的名字冲突

4. 用户代码不应定义以Py或_Py开头的名称,此类型名称python内部使用来确定函数是Python/C API函数。如果用户自用,会危及用户代码对未来Python版本的可移植性。

五、程序设计建议

建议1. 例如,不要依赖于CPython的高效内置字符连接语句a += bora = a + b.这些语句在Jython中运行较慢。在性能敏感的库中,应该用''.join()来取代。这样可以保证在不同的实现中,字符链接花费的时间都呈线性。

建议2. 与诸如None这样的字符比较时,要使用is or is not,永远不要用等于操作。

# 以下语句执行成功,None

str =""

ifstris not None:

print("空字符串不等于None")

建议3. 为了实现复杂的排序操作,最好通过实现6个操作六个操作(__eq__,__ne__,__lt__,__le__,__gt__,__ge__)完成,而非自定义一些特别的代码

建议4. 使用Based-object Exception,自定义类应该继承Exception,并且Error后缀名,非错误类异常可以不用Error后缀。

class MessageError(Exception):

"""Base class for errors in the email package."""

使用具体的异常声明代替光秃秃的的exception:。例如:(ps:若想捕捉所有异常,至少使用except Exception:)

try:

import platform_specific_module

except ImportError:

platform_specific_module = None

建议5. 关于字符串操作

使用String方法而非String模块

使用''.startswith()和''.endswith()而非字符切片去检测前缀或后缀。

建议6. 对象类型比较使用isinstance()方法

检查一个变量是否字符串类型的方法:if isinstance(obj, basestring):

建议7.对于序列,(strings, lists, tuples),利用空序列为false这一点,作为判断条件

if not seq:

if seq:


建议8. 别用‘==’进行布尔值和 True 或者 False 的比较

六、引用

七、docString,代码字符串和pydoc的使用

单行文档字符串,建议首字母大写,尾部句号,感叹号结尾。例如:

defreverse_sort(items):

"""Sort items in reverse order."""

多行注释要求:第一行概述,首字母大写,句号结尾

第二行空行

第三行细节描述,同时注意与第一行的第一个引号对齐,最后"""结尾

"""OS routines for NT or Posix depending on what system we're on.


This exports:

......

"""


更多细节,请参考Github开源项目python编码风格指南



其他值得阅读的PEPs,参考知乎网友答案。

最后编辑于
©著作权归作者所有,转载或内容合作请联系作者
  • 序言:七十年代末,一起剥皮案震惊了整个滨河市,随后出现的几起案子,更是在滨河造成了极大的恐慌,老刑警刘岩,带你破解...
    沈念sama阅读 204,921评论 6 478
  • 序言:滨河连续发生了三起死亡事件,死亡现场离奇诡异,居然都是意外死亡,警方通过查阅死者的电脑和手机,发现死者居然都...
    沈念sama阅读 87,635评论 2 381
  • 文/潘晓璐 我一进店门,熙熙楼的掌柜王于贵愁眉苦脸地迎上来,“玉大人,你说我怎么就摊上这事。” “怎么了?”我有些...
    开封第一讲书人阅读 151,393评论 0 338
  • 文/不坏的土叔 我叫张陵,是天一观的道长。 经常有香客问我,道长,这世上最难降的妖魔是什么? 我笑而不...
    开封第一讲书人阅读 54,836评论 1 277
  • 正文 为了忘掉前任,我火速办了婚礼,结果婚礼上,老公的妹妹穿的比我还像新娘。我一直安慰自己,他们只是感情好,可当我...
    茶点故事阅读 63,833评论 5 368
  • 文/花漫 我一把揭开白布。 她就那样静静地躺着,像睡着了一般。 火红的嫁衣衬着肌肤如雪。 梳的纹丝不乱的头发上,一...
    开封第一讲书人阅读 48,685评论 1 281
  • 那天,我揣着相机与录音,去河边找鬼。 笑死,一个胖子当着我的面吹牛,可吹牛的内容都是我干的。 我是一名探鬼主播,决...
    沈念sama阅读 38,043评论 3 399
  • 文/苍兰香墨 我猛地睁开眼,长吁一口气:“原来是场噩梦啊……” “哼!你这毒妇竟也来了?” 一声冷哼从身侧响起,我...
    开封第一讲书人阅读 36,694评论 0 258
  • 序言:老挝万荣一对情侣失踪,失踪者是张志新(化名)和其女友刘颖,没想到半个月后,有当地人在树林里发现了一具尸体,经...
    沈念sama阅读 42,671评论 1 300
  • 正文 独居荒郊野岭守林人离奇死亡,尸身上长有42处带血的脓包…… 初始之章·张勋 以下内容为张勋视角 年9月15日...
    茶点故事阅读 35,670评论 2 321
  • 正文 我和宋清朗相恋三年,在试婚纱的时候发现自己被绿了。 大学时的朋友给我发了我未婚夫和他白月光在一起吃饭的照片。...
    茶点故事阅读 37,779评论 1 332
  • 序言:一个原本活蹦乱跳的男人离奇死亡,死状恐怖,灵堂内的尸体忽然破棺而出,到底是诈尸还是另有隐情,我是刑警宁泽,带...
    沈念sama阅读 33,424评论 4 321
  • 正文 年R本政府宣布,位于F岛的核电站,受9级特大地震影响,放射性物质发生泄漏。R本人自食恶果不足惜,却给世界环境...
    茶点故事阅读 39,027评论 3 307
  • 文/蒙蒙 一、第九天 我趴在偏房一处隐蔽的房顶上张望。 院中可真热闹,春花似锦、人声如沸。这庄子的主人今日做“春日...
    开封第一讲书人阅读 29,984评论 0 19
  • 文/苍兰香墨 我抬头看了看天上的太阳。三九已至,却和暖如春,着一层夹袄步出监牢的瞬间,已是汗流浃背。 一阵脚步声响...
    开封第一讲书人阅读 31,214评论 1 260
  • 我被黑心中介骗来泰国打工, 没想到刚下飞机就差点儿被人妖公主榨干…… 1. 我叫王不留,地道东北人。 一个月前我还...
    沈念sama阅读 45,108评论 2 351
  • 正文 我出身青楼,却偏偏与公主长得像,于是被迫代替她去往敌国和亲。 传闻我的和亲对象是个残疾皇子,可洞房花烛夜当晚...
    茶点故事阅读 42,517评论 2 343

推荐阅读更多精彩内容