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

本文来自投稿,不代表岑梧健康网立场,如若转载,请注明出处:岑我健康网

(13)
上一篇 2017年4月17日 17:21
下一篇 2017年4月18日 12:51

相关推荐

  • 《道德经》:人生以厚道处世,自身才不会被因果裹挟

    一、 在这世间生存,最正确的人生方式其实就是厚道。 这个世上任何事情都有其本质的规律,而人生不管处在何种局面之中,都是许多条因果链条组成的局面,一个人的智巧能够通达他眼前所看到的事情,但是除了眼前所见之外,所有的因果都在自己的意识之外。 一个人不管有多么明察秋毫,都不可能把持住所有事物的因果,当你在一件事情上因为智巧而占便宜时,在其他事情上就会因此吃亏,这就…

    2021年12月28日
    11500
  • 身体体能下降了,怎么办?

    随着年龄的增长,体能几乎是跟着年龄的增长在逐步下降,当我们意识到的时候,才发现现在的身体大不如前了。人的身体也是一部机器,由各个组件构成,在日常生活不断的“摩擦”,很多部件也在老化。尤其先进生活条件好,绝大数人的生活过着安逸,缺少了锻炼了心志。更是加快了身体老化的速度,很多人在追求容颜的时候,往往忽略身体的体能弱化,导致看上去显得很年轻,其实身体已经力不从心…

    2021年6月5日
    15500
  • 美女亲身演习五禽戏、八段锦(宅在家里也可运动起来)

    今天为大家带来五禽戏、八段锦的教学视频,课程老师周天慧是全国冠军、运动健将、中国武术六段,上海市健身气功师资培训班骨干教师,一级裁判员。一起来看看吧! 五禽戏 五禽戏是一种中国传统健身方法,由五种模仿动物的动作组成。五禽戏又称“五禽操”“五禽气功”“百步汗戏”等。据说由东汉医学家华佗创制,是中国民间广为流传的、也是流传时间最长的健身方法之一,其健身效果被历代…

    2022年7月24日
    3300
  • 适合生吃的3类蔬菜,很多人经常吃错

    有些蔬菜适合生吃,不仅能使维生素更好地保存下来,还有利于一些营养物质发挥功效。 白萝卜 夏天常食白萝卜,白萝卜含有丰富的维生素C,维生素C能抑制黑色素合成,阻止脂肪氧化,防止脂褐质沉积。 此外,白萝卜热量低,吃后容易产生饱胀感,有助于减肥。白萝卜中的芥子油和膳食纤维可促进胃肠蠕动,将一些代谢废物排出体外,从而起到一定的“清肠”作用。 在吃法上,白萝卜更适合生…

    2022年6月21日
    5400
  • 6月健康绿菜推荐(耐热蔬菜,全程不用农药)

    端午的小长假又结束了,而在6月6日就迎来了二十四节气中的芒种了。 农谚说“芒种不种,再种无用”,芒种的意思是说到了这个节气的时候,有芒之谷类作物就要抓紧时间种植了,不然错失了就不能在种植了,可见芒种节气是适合种植农作物时机的分界点。这是一个非常忙碌的节气,因此芒种在民间也称为“忙种”,既要忙着种植。 虽然到了芒种节气的时候,南方的水稻正在抓紧插秧,而北方的小…

    2022年6月8日
    16800

发表评论

登录后才能评论

联系我们

0874-3210859

在线咨询: QQ交谈

邮件:63385650@qq.com

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

关注微信
爱生活,爱健康。欢迎投稿,分享养生心得。