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

相关推荐

  • 陕西省物业服务收费管理办法 (征求意见稿)

    陕西省物业服务收费管理办法 (征求意见稿) 第一章  总 则 第一条 为规范物业服务收费行为,维护业主或使用人(以下统称”业主”)和物业服务企业合法权益,根据《中华人民共和国价格法》、《物业管理条例》和《陕西省物业管理条例》等法律法规,结合我省实际,制定本办法。 第二条 本办法适用于本省行政区域内的物业服务收费行为及监督管理。 第三条 本办法所称物业服务收费,是指物业服务企…

    2019-03-27
    013.8K0
  • 【物管百态】小区业主拉横幅声讨业主委员会捞黑钱!

    【物管百态】小区业主拉横幅声讨业主委员会捞黑钱!【物管百态】小区业主拉横幅声讨业主委员会捞黑钱!【物管百态】小区业主拉横幅声讨业主委员会捞黑钱!【物管百态】小区业主拉横幅声讨业主委员会捞黑钱!

    随着经济与社会发展 人类的居住环境也在不断变化 现如今 越来越多人都进了商品房小区 购置了汽车 因此 车位、物业、业主委员会 都是绝大多数城市人 所必然遇到的一个问题 昨日,在广西北流的一个小区,就发生了一起业主与物业、业主委员会关于停车收费的问题冲突。 近日,此小区对露天停车位停车进行了收费,但是业主们对于物业此举极力反对,而代表业主利益的业主委员会却不能为业主们解决问题,于是一些业主们则直接在…

    2018-10-14 • 生活百科
    010.6K0
  • 长沙一小区实行物业自管 向全体业主返利170万元现金

    长沙晚报掌上长沙5月10日讯(全媒体记者 周莹莺)在长沙市开福区,有一小区实行物业自管已经五年,从今年的5月8日起,该小区进行第二次自管返还,向全小区1820户业主发放700元至2000元不等的返利现金。 据小区业委会主任彭颖琳介绍,此次返还红利的来源是2019年至2020年的小区公共收入和物业自管的物业费结余,按照5个月物业费的标准来返还,总返还金额达到170万元。 在金色比华利小区服务中心,记…

    2021-05-11
    04.7K0
  • 太惊险!福田区万科金色家园小区一台空调主机从11楼坠下

    太惊险!福田区万科金色家园小区一台空调主机从11楼坠下太惊险!福田区万科金色家园小区一台空调主机从11楼坠下太惊险!福田区万科金色家园小区一台空调主机从11楼坠下太惊险!福田区万科金色家园小区一台空调主机从11楼坠下

    今天下午,福田区万科金色家园小区一台空调主机从11楼坠下!巨大的声音把业主吓得不轻!!!空调外机应该是固定好的怎么就会掉下来了? 监控还原坠落瞬间 工人放主机时脱手 两名业主先后经过事发地,所幸逃过一劫。今天下午3点多,刘先生从家里出门,走到2栋楼下时就看到了一台空调主机在地上,刘先生吓了一跳。 ▲高空掉落砸坏变形的空调外机 业主装修安装新空调 工人在放置时脱手 据了解,空调主机从2栋中间楼层的一…

    2019-07-01 • 生活百科
    012.8K0
  • 滨江服务、奥园健康生活发布招股公告;新大正物业拟A股上市,募资4.99亿元;中奥到家收购建屋物业66%股权

    滨江服务、奥园健康生活发布招股公告;新大正物业拟A股上市,募资4.99亿元;中奥到家收购建屋物业66%股权滨江服务、奥园健康生活发布招股公告;新大正物业拟A股上市,募资4.99亿元;中奥到家收购建屋物业66%股权滨江服务、奥园健康生活发布招股公告;新大正物业拟A股上市,募资4.99亿元;中奥到家收购建屋物业66%股权滨江服务、奥园健康生活发布招股公告;新大正物业拟A股上市,募资4.99亿元;中奥到家收购建屋物业66%股权

    重庆新大正物业集团股份有限公司报送了首次公开发行股票招股说明书(申报稿2019年2月15日报送)称,公司拟发行不超过1791.07万股新股并计划A股上市,预计募集资金总额为4.99亿元。

    2019-03-04 • 生活百科
    017.0K0
  • “物业+中介”模式再升温!青岛七部门发文鼓励物业进军房产中介

    “物业+中介”模式再升温!青岛七部门发文鼓励物业进军房产中介 CIH中国房屋管理研究2020-11-23 08:33:03 日前,青岛市住建局等七部门联合发布了《关于支持物业服务企业开展中介服务促进房地产中介服务行业健康发展有关意见的通知(征求意见稿)》(以下简称《通知》)。 明确表态鼓励物业开展房地产中介服务,实现线上交易服务,支持物业服务企业做大做强。 征求意见稿一出,立即引发了物业和中介行业…

    2020-11-26
    05.0K0