味燃,干式熟成制造专家
产品:干式熟成牛排,干式熟成柜,干式熟成库
电话:400-166-4696,13556860160
公司:味燃食品生物科技(深圳)有限公司
地址:深圳市福田区泰然六路泰然大厦C座1501

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的方式。

本文来自于用户投稿,本文观点不代表优帮百科立场,如侵犯版权,请联系删除。

(5)
打赏 微信扫一扫 微信扫一扫
上一篇 2017-04-17 17:21
下一篇 2017-04-17 22:54

相关推荐

  • 世界,您好!

    欢迎使用WPCOM。这是您的第一篇文章。编辑或删除它,然后开始您的博客!

    2017-04-14
    24.0K2
  • 汉中雅居乐花园一楼绿地变“私家花园” 城管:已约谈涉事业主

    “雅居乐小区花园洋房周围的绿植被一楼业主铲去,建成了私家花园。”陈先生告诉记者:“这种行为在他认为是把我们的公共财产,私自赠与他人。为此我多次向物业反映,物业说他们管不了。” 日前,汉台区雅居乐花园小区的业主陈先生向华商报-二三里反映,该小区一期花园洋房多名业主在一楼绿地改建凉亭和围栏。“明明是好好的绿地,改建以后,不仅破坏了公共资源,对于其它业主也不公平。”陈先生表示。 9月21日,记者来到该小…

    2022-09-24 生活百科
    01.6K0
  • 商铺招租需业委会同意?信和广场陷招商困境

    “之前招了一个商场被业委会赶走,现在又按照他们的要求招了一个超市,他们又不同意施工。我就搞不明白,我自己有完全产权的物业连招什么商家都要小区业主同意吗?”站在空荡荡的商铺门口,广州市洪晟商贸有限公司的陈经理意气难平。

    2021-01-13 生活百科
    02.0K0
  • 业主大会罢免物业,投票遭人暴力阻拦,物业经理:我保证没有参与

    物业作为改善社区居住环境,保障业主基本生活条件的存在,有时候并没有尽到自己的义务。而作为维护业主权益的业委会,有时候和物业的关系有些紧张。近日杭州绍兴柯桥世纪星城小区的物业因遭到业主质疑物业能力存在问题。业委会打算更换物业,召开业主大会投票表决是否另选物业管理。可是过程却并不怎么顺利,原因是半路有人过来捣乱选票 业主陈先生表示当时正在准备选票工作,地上准备摆放了选票箱。突然就来了几个人,冲上来对着…

    2019-01-22 生活百科
    012.0K0
  • 透明服务让物业管理看得见

    1月6日,在兰德华庭小区的社区公告栏里,张贴出了一份《2020年12月物业月度收/支报告》,引来了不少居民围观。“物业费本月收入770777.29元,垃圾消纳费7129.86元、装修管理费764.1元……”居民边看边念着,“这是咱们社区物业的新举措,公开账目,上个月就贴过。”“这方法不错,社区花销一目了然。”居民们边看边相互交流着。 业主大会行使权力选物业 走进田村路街道的兰德华庭小区,社区道路整…

    2021-01-21
    02.2K0
  • 太突然!人去楼空!福州上百名业主的血汗钱……

    近年来,一站式房屋托管运营公司十分火热,这不,福州的薛女士就把自己闲置的房子托管给了这样一家公司。本以为按照约定,她可以每月拿到高于市场价的租金,谁知,不但房子至今没有装修完,托管公司负责人还跑路了。 托管公司已人去楼空 市民薛女士:租金没收到,还倒贴5万多元 家住福州的薛女士在今年5月前后,接到了福州花满堂酒店管理有限公司(以下简称“福州花满堂公司”)的电话,告知可将她刚刚拿到的安置房托管给公司…

    2022-09-24
    09590