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

声明:本文为网友发布,若内容若侵犯到您的权益,请发送邮件至:257218569@qq.com,我们将第一时间处理!版权归原作者所有。

(13)
源代码的头像源代码
上一篇 2017年4月17日 17:21
下一篇 2017年4月17日 22:54

相关推荐

  • 马斯克回应特斯拉机器人袭击工程师:媒体真无耻

    据国内媒体报道,一份事故报告显示,美国特斯拉得州超级工厂的一名工程师在2021年遭到特斯拉机器人“擎天柱”袭击。 这一事件给这位受害者左手留下了一个“开放性伤口”,特斯拉提交给特拉维斯县和联邦监管机构的2021年工伤报告披露了该事件。 特斯拉对此解释道,受害者伤势轻微,不需要休息时间,但人们对特斯拉得州超级工厂的工作环境越来越感到担忧。 数据显示,该工厂工人…

    2023年12月28日
    2180
  • 是什么让你就抢到0.01!腾讯揭秘微信红包算法

    5月23日消息,微信红包已成为节日庆祝和亲友互动的一种流行方式,但你是否曾疑惑,是什么决定了你抢到的红包金额,特别是当它只有0.01元时?腾讯云开发者社区最近揭秘了背后的算法。 微信红包最初的随机算法中,先抢者有更高的几率获得大额红包,但为了避免抢红包变成速度竞赛,算法进行了调整。 腾讯详细探讨了几种主流的红包分配算法。首先是普通随机法,它基于剩余金额进行随…

    2024年5月23日
    1680
  • 微信官方发布青少年模式使用手册:一键带娃健康冲浪

    6月2日消息,刚刚度过六一儿童节,微信官方发布了一份微信青少年模式使用手册,让家长更好的了解该功能,守护青少年的健康成长。 据介绍,开启微信青少年模式后,青少年用户累计使用视频号和直播总时长满40分钟后,需要监护人输入密码才可延长使用时间。 而且在每日晚22时至次日早6时期间无法使用视频号和直播服务,如需使用须经监护人授权。 青少年内容分级 青少年模式下,家…

    2024年6月2日
    760
  • 周鸿祎谈Sora视觉模型:给人工智能补上了“眼睛”

    2月22日消息,据媒体报道,360集团创始人周鸿祎在2024亚布力中国企业家论坛上讨论了OpenAI旗下模型Sora“横空出世”的意义。 周鸿祎表示,Sora实现了机器对这个世界的感知、观察和交互的能力,也就是说真正的给人工智能补上了眼睛。周鸿祎特别强调,这只眼睛不是工作在感知层面,而是能够工作在认知层面。 周鸿祎此前就对Sora进行了评价,一旦人工智能接上…

    2024年2月22日
    1290
  • 国产x86雄起!兆芯新一代KX-7000整机纷纷亮相

    5月20日消息,近日,四川省政府采购分享会在成都圆满举办,兆芯联合主办单位之一分享了自主x86通用处理器产品的最新创新、应用成果,并展示了基于新一代开先KX-7000、开胜KH-40000系列处理器的高端台式机、超薄笔记本、交互智能平板、高性能双路服务器。 兆芯处理器兼容x86指令集,支持自主研发的SM2/SM3/SM4算法加速指令,支持处理器和IO虚拟化技…

    2024年5月20日
    530

联系我们

在线咨询: QQ交谈

QQ:1205677645

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

关注微信