PEP8 Python 编码规范整理

决定开始Python之路了,利用业余时间,争取更深入学习Python。编程语言不是艺术,而是工作或者说是工具,所以整理并遵循一套编码规范是十分必要的。所以今天根据PEP8整理了一份,以后都照此编码了,还会持续更新。

一 代码编排

1 缩进。4个空格的缩进(编辑器都可以完成此功能),不使用Tap,更不能混合使用Tap和空格。

2 每行最大长度79,换行可以使用反斜杠,最好使用圆括号。换行点要在操作符的后边敲回车。

3 类和top-level函数定义之间空两行;类中的方法定义之间空一行;函数内逻辑无关段落之间空一行;其他地方尽量不要再空行。

二 文档编排

1 模块内容的顺序:模块说明和docstring—import—globals&constants—其他定义。其中import部分,又按标准、三方和自己编写顺序依次排放,之间空一行。

2 不要在一句import中多个库,比如import os, sys不推荐。

3 如果采用from XX import XX引用库,可以省略‘module.’,都是可能出现命名冲突,这时就要采用import XX。

三 空格的使用

总体原则,避免不必要的空格。

1 各种右括号前不要加空格。

2 逗号、冒号、分号前不要加空格。3 函数的左括号前不要加空格。如Func(1)。4 序列的左括号前不要加空格。如list[2]。5 操作符左右各加一个空格,不要为了对齐增加空格。6 函数默认参数使用的赋值符左右省略空格。7 不要将多句语句写在同一行,尽管使用‘;’允许。8 if/for/while语句中,即使执行语句只有一句,也必须另起一行。

四 注释

总体原则,错误的注释不如没有注释。所以当一段代码发生变化时,第一件事就是要修改注释!注释必须使用英文,最好是完整的句子,首字母大写,句后要有结束符,结束符后跟两个空格,开始下一句。如果是短语,可以省略结束符。

1 块注释,在一段代码前增加的注释。在‘#’后加一空格。段落之间以只有‘#’的行间隔。比如:

# Description : Module config. # # Input : None # # Output : None

2 行注释,在一句代码后加注释。比如:x = x + 1 # Increment x但是这种方式尽量少使用。3 避免无谓的注释。

五 文档描述

1 为所有的共有模块、函数、类、方法写docstrings;非共有的没有必要,但是可以写注释(在def的下一行)。2 如果docstring要换行,参考如下例子,详见PEP 257

“””Return a foobang Optional plotz says to frobnicate the bizbaz first. “””

六 命名规范

总体原则,新编代码必须按下面命名风格进行,现有库的编码尽量保持风格。1 尽量单独使用小写字母‘l’,大写字母‘O’等容易混淆的字母。2 模块命名尽量短小,使用全部小写的方式,可以使用下划线。3 包命名尽量短小,使用全部小写的方式,不可以使用下划线。4 类的命名使用CapWords的方式,模块内部使用的类采用_CapWords的方式。5 异常命名使用CapWords+Error后缀的方式。6 全局变量尽量只在模块内有效,类似C语言中的static。实现方法有两种,一是__all__机制;二是前缀一个下划线。7 函数命名使用全部小写的方式,可以使用下划线。8 常量命名使用全部大写的方式,可以使用下划线。9 类的属性(方法和变量)命名使用全部小写的方式,可以使用下划线。9 类的属性有3种作用域public、non-public和subclass API,可以理解成C++中的public、private、protected,non-public属性前,前缀一条下划线。11 类的属性若与关键字名字冲突,后缀一下划线,尽量不要使用缩略等其他方式。12 为避免与子类属性命名冲突,在类的一些属性前,前缀两条下划线。比如:类Foo中声明__a,访问时,只能通过Foo._Foo__a,避免歧义。如果子类也叫Foo,那就无能为力了。13 类的方法第一个参数必须是self,而静态方法第一个参数必须是cls。

七 编码建议

1 编码中考虑到其他python实现的效率等问题,比如运算符‘+’在CPython(Python)中效率很高,都是Jython中却非常低,所以应该采用.join()的方式。2 尽可能使用‘is’‘is not’取代‘==’,比如if x is not None 要优于if x。3 使用基于类的异常,每个模块或包都有自己的异常类,此异常类继承自Exception。4 异常中不要使用裸露的except,except后跟具体的exceptions。5 异常中try的代码尽可能少。比如:

try: value = collection[key] except KeyError: return key_not_found(key) else: return handle_value(value)

要优于

try: # Too broad! return handle_value(collection[key]) except KeyError: # Will also catch KeyError raised by handle_value() return key_not_found(key)

6 使用startswith() and endswith()代替切片进行序列前缀或后缀的检查。比如

Yes: if foo.startswith(‘bar’):优于No: if foo[:3] == ‘bar’:7 使用isinstance()比较对象的类型。比如Yes: if isinstance(obj, int): 优于No: if type(obj) is type(1):8 判断序列空或不空,有如下规则Yes: if not seq:if seq:优于No: if len(seq)if not len(seq)9 字符串不要以空格收尾。10 二进制数据判断使用 if boolvalue的方式。

主题测试文章,只做测试使用。发布者:爱法社,转转请注明出处:https://www.nsxn.com.cn/126.html

(13)
爱法社的头像爱法社
上一篇 2017年4月17日 下午5:21
下一篇 2017年4月17日 下午10:54

相关推荐

  • 有出生证明的领养孩子户口怎么上

    有出生证明的领养孩子,户口登记应由收养人向常住地户口登记机关申报,具体来说,收养人需携带出生证明等材料,及时办理出生登记,以保障孩子合法权益,体现户籍管理规范性。 有出生证明的领养孩子户口怎么上   对于有出生证明的领养孩子,其户口登记应由收养人或者育婴机关向户口登记机关申报出生登记,具体如下:   1.收养人作为孩子的法定监护人,有责任在领养孩子后,及时向…

    2025年7月17日
    3700
  • 拘留所会作出什么处罚

    导读: 拘留所是对被处以拘留行政处罚的执行场所。在拘留所执行拘留的人员包括被人民法院依法决定拘留的人和被公安机关、国家安全机关依法给予拘留行政处罚的人。 一、 拘留所会作出什么处罚   拘留所是执行拘留行政处罚的场所。   1.行政拘留是对那些扰乱社会治安、但尚未构成犯罪的行为人进行的一种惩罚措施。   2.《拘留所条例》第二条规定,对下列人员的拘留在拘留所…

    2025年6月4日
    5900
  • 离婚协议书按手印有法律效力吗

    导读: 离婚协议书按手印,不一定具有法律效力。需书面形式,双方签字与按手印同等有效,但内容须合法且不违背公序良俗。经婚姻登记机关登记备案、领取离婚证后,协议才正式生效。 一、 离婚协议书按手印有法律效力吗   离婚协议书按手印,并不一定具有法律效力。需要从以下几个方面详细分析:   1.从形式上来看,离婚协议需以书面形式呈现,双方按手印在一定程度上可视为对协…

    2025年4月28日
    5300
  • 交警没抓现场的醉驾怎么处理

    交警没抓现场的醉驾处理方式是若未达醉酒状态,将暂扣驾照并罚款;若达醉酒状态,即使未现场抓获,事后查实也将被拘留、罚款,并吊销驾照,同时依法追究危险驾驶罪刑事责任。 交警没抓现场的醉驾怎么处理   交警没抓现场的醉驾,若饮酒后驾驶机动车且未达到醉酒状态,依据相关规定,虽未现场抓获,但仍会面临暂扣一个月以上三个月以下机动车驾驶证,并处二百元以上五百元以下罚款的处…

    2025年6月26日
    7300
  • 领取职工死亡丧葬费需要哪些手续

    导读: 领取职工死亡丧葬费需要的手续离退休人员死亡后,法定继承人3个月内应申报丧葬补助费,填报申领表并盖章签字,再携火化证及代领人身份证复印件,前往社保局办理申领。 一、 领取职工死亡丧葬费需要哪些手续   领取职工死亡丧葬费需要的手续具体如下:   1.对于离退休人员死亡的情况,其法定继承人应当在3个月内向社会保险经办机构申报丧葬补助费。   2.办理时,…

    2025年5月6日
    4100

发表回复

您的邮箱地址不会被公开。 必填项已用 * 标注

联系我们

400-800-8888

在线咨询: QQ交谈

邮件:admin@example.com

工作时间:周一至周五,9:30-18:30,节假日休息

关注微信