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.tfuv.com/news/126.html

(13)
武汉汽车网的头像武汉汽车网
上一篇 2017年4月17日 下午5:21
下一篇 2017年4月17日 下午10:54

相关推荐

  • 特斯拉Model Y焕新版:全新升级,引领中型SUV新风尚

    2月18日,特斯拉官网更新了Model Y焕新版的交付时间,预计将于2月下旬开始交付。这款备受期待的中型SUV不仅在外观和内饰上进行了全面升级,还在性能和配置上带来了诸多惊喜。 外观升级:硬朗与流畅的完美结合 Model Y焕新版的外观设计借鉴了赛博越野旅行车的灵感,整车造型更加硬朗,线条更加流畅。新车采用了贯穿式灯带,分体式大灯与C字形包围相结合,保留了封…

    2025年2月18日
    12600
  • 仙人豆怎么扦插(扦插仙人豆)

    仙人豆,是一种美丽的观叶植物,常用于室内绿化和花坛装饰。它的扦插繁殖方法简单易行,下面给大家介绍一下。 选择健康的母株 要扦插仙人豆,首先需要选择一个健康的母株。母株的样子应该健壮,叶片翠绿,没有病虫害。 准备扦插材料 扦插仙人豆需要准备好一些扦插材料。你需要一把锋利的剪刀、适量的培养土和一个适合扦插的花盆。 剪取扦插枝 在母株上选择一根健康的侧枝,长度大约…

    2025年3月26日
    5100
  • 吉利银河星耀8:电混新旗舰,科技与安全并重的未来之选

    在春意渐浓的2月19日,工信部最新一期目录中,吉利银河品牌的一款全新电混轿车悄然亮相,它就是备受瞩目的“星耀8”。作为银河“星”系列的最新旗舰车型,星耀8继星愿、星舰7之后,再次展现了吉利在新能源汽车领域的雄心壮志。这款新车不仅采用了全新的设计语言,更全系标配了雷神EM-P超级电混系统,预示着它将在未来与比亚迪汉L等车型展开一场激烈的竞争。 一提到新车,我们…

    2025年2月20日
    10800
  • 仙客来怎么施肥图解(仙客来施肥攻略)

    在仙客来养花过程中,正确施肥是保证植物生长健康的关键。通过合理施肥,可以提供植物所需的养分,促进植物的生长和开花。下面是仙客来施肥的图解,帮助您更好地进行养花。 1.选择适合的肥料 根据仙客来的生长特点,选择适合的肥料非常重要。一般可以选择全面肥,或者针对性肥料,如富含氮、磷、钾的肥料。 2.施肥时机 仙客来的施肥时机要视植物生长状况而定。一般来说,春季和夏…

    2025年3月26日
    5900
  • 特斯拉Model Y焕新版:全新升级,2月下旬开启交付

    近日,特斯拉官网更新了Model Y焕新版的交付时间,新车预计将在2月下旬正式开启交付。此前发布的焕新首发版车型已公布了售价,两款车型分别为26.35万元和30.35万元,并限时优惠至2月28日。对于追求个性化的消费者来说,首发版车型还配备了多项专属配置,进一步提升了辨识度与豪华感。 外观设计:细节优化,科技感十足 焕新版Model Y在外观上进行了全面升级…

    2025年2月18日
    10500

发表回复

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

联系我们

400-800-8888

在线咨询: QQ交谈

邮件:admin@example.com

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

关注微信