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)
打赏 微信扫一扫 微信扫一扫
shineshishineshi管理团队
人工智能创业的两种形态三大规律
上一篇 2017-04-17 17:21
10个步骤,了解新手入门过程的设计原则
下一篇 2017-04-17 22:54

相关推荐

  • 遂宁一小区物业管理,无视物权法,激怒广大业主

    遂宁东城绿洲小区,地处遂宁万达广场以北,也就是遂宁的公务员小区,里面住了很多在职或退休的大大小小的公职人员,这次因为物管换届引起了不小的风波 该小区从之前的紫薇物业到如今的英联华物业,管理水平都严重底下,暴露出很多问题,导致很多业主都拖欠物管费。 而这些业主都将矛头指向了他们不认可的业委会不作为身上,据一些知情业主反映,小区业委会选举时存在猫腻,而小区内停车费收入的70%都交由了业委会代管,小区共…

    2020-07-05
    05.2K0
  • 指南在手,物业博览会参观无忧!

      时间:2018年10月15-17日 地点:深圳 地址:深圳市福田区福华三路深圳会展中心 活动安排                              1 博览会 时间:10月15-17日8:30-17:30 地点:2号馆 2 总体安排 3 主论坛 备注:1.主论坛下午12:30开始入场,13:15准时开始第一阶段会议; 2.下午12:30开始凭嘉宾证和代表证,可在5号馆门口领取…

    2018-10-14
    05.3K0
  • 尼尔森:中国的白酒市场从渠道驱动转型为消费驱动

    随着茅台、五粮液的降价,未来高端白酒价格将进入下行通道,同时白酒行业也将迎来新的变化,白酒行业可能会像乳品、啤酒等行业一样进入整合阶段,受到更多人的追捧。

    2017-04-18
    05.5K0
  • 【官宣】物博会长城物业精彩亮相:科技化+人性化,让社区变得更美好

    【官宣】物博会长城物业精彩亮相:科技化+人性化,让社区变得更美好【官宣】物博会长城物业精彩亮相:科技化+人性化,让社区变得更美好【官宣】物博会长城物业精彩亮相:科技化+人性化,让社区变得更美好【官宣】物博会长城物业精彩亮相:科技化+人性化,让社区变得更美好

    10月15日,第二届国际物业管理产业博览会正式开幕。在深圳会展中心2号馆展厅,超过120家物业管理企业在这里举办为期3天的展览活动。 本届博览会以“融合发展 共创美好”为主题,展览面积达到1.5万平方米,参展单位120家,并同期举办第四届中国物业管理创新发展论坛主论坛和19场分论坛,以及大量形式多样的交流活动。可以说,这是一场亮点颇多,精彩纷呈的盛会。 在第四届物业管理创新发展论坛暨中国物业管理协…

    2018-10-18 • 生活百科
    06.6K0
  • 深圳市市场监管局关于印发深圳市推进电梯按需维保试点工作方案的通知

    为改进电梯维护保养模式,进一步提升电梯安全管理水平,根据《市场监管总局关于进一步做好改进电梯维护保养模式和调整电梯检验检测方式试点工作的意见》(国市监特设〔2020〕56号)、《广东省市场监督管理局转发市场监管总局关于进一步做好改进电梯维护保养模式和调整电梯检验检测方式试点工作意见的通知》(粤市监特设〔2020〕580号)要求,结合深圳实际,我局研究制定了《深圳市推进电梯按需维保试点工作方案》,现印发给你们,请认真组织落实。

    2020-12-11
    13.8K0
  • 深圳:马田街道围合式物业管理正式由社区“接棒”

    近日,一项名为“城中村固化围合项目工程”的移交仪式在马田街道举行。该街道城建办负责人现场与辖区各社区党委主要负责人,签署了《市政基础设施移交证书》,这意味着该街道城中村固化围合施工完成后,围合设施设备正式移交给各社区使用管理。 通讯员供图 2020年以来,马田街道按照“因地制宜、先易后难、多种模式、逐个推进”的工作思路,逐步推进城中村实施物业管理并收费,城中村围合式物业管理工作取得了较好的成效。 …

    2021-01-09
    04.3K0