新疆吐鲁克精酿啤酒经销代理
微信咨询13556860160,师先生

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)
打赏 微信扫一扫 微信扫一扫
shineshi的头像shineshi管理团队
上一篇 2017-04-17 17:21
下一篇 2017-04-17 22:54

相关推荐

  • 深圳南山卓越维港别墅涉违法加建至5层 一层约“值”2000万

    图中红框处是违建别墅。 家住深圳南山卓越维港的罗女士近日向深圳商报报料称,其所在的小区有一别墅业主涉嫌违建,目前已加建了两层,且仍在施工中。 ​据了解,该小区房价均价每平方米约20万元,该别墅每加一层等值约2000万元。南山区规划土地监察局和蛇口街道执法队已介入调查。 ​卓越维港位于南山后海科苑大道西,招商路与工业八路之间,小区于2008年建成,毗邻深圳湾小学。100多套别墅的体量,让卓越维港成为…

    2020-12-03
    04.5K0
  • 物业管理需澄清的十大问题!

    中国物业管理行业的兴起,虽然经历了20多个春夏秋冬,而且涌现出了40多个国家一级物业管理企业,营造出一个又一个让广大业主安居乐业的生活环境,但是,由于多方面因素的制约,物业管理行业一直“没长大”。为此,物业管理发展的当务之急,需要从以下10个方面给物业管理行业正本清源: 1业主与物业管理企业不是“主仆”关系不少人对物业管理存在认识上的误区:有的认为物业管理企业与业主之间是管理者与被管理者的关系;有…

    2018-10-14
    04.2K0
  • 欠缴物业费,不仅要全额支付物业费,还有违约金以及律师费都要支付!

    广东省珠海市中级人民法院 民 事 判 决 书 (2018)粤04民终483号 上诉人(一审原告):家利物业管理(深圳)有限公司珠海分公司,住所地:广东省珠海市唐家湾镇。 负责人:叶少荣,经理。 委托诉讼代理人:钟宏炬,广东莱特律师事务所律师。 被上诉人(一审被告):余先剑,1977年11月23日出生,户籍地:江西省九江市九江县,住广东省珠海市唐家湾镇 上诉人家利物业管理(深圳)有限公司珠海分公司(…

    2019-02-28
    010.8K0
  • 强制性国家标准《物业服务安全与应急处置》编制核心小组工作会议在北京国基集团总部顺利召开

    2018年10月22~23日,由全国物业管理标准化技术委员会主办、北京国基伟业物业管理有限公司承办的强制性国家标准《物业服务安全与应急处置》编制核心小组工作会议在北京国基集团总部顺利召开。

    2018-10-30 生活百科
    015.4K0
  • 浙江祥生物业新设台州祥卓物业,持股51%

    10月17日,浙江祥生物业服务有限公司(以下简称“祥生物业”)新增对外投资,新增投资企业为台州祥卓物业服务有限公司,投资比例51%。 据了解,台州祥卓物业服务有限公司成立于2021年10月12日,法定代表人为石烨,注册资本为100万元。经营范围包括物业管理、非居住房地产租赁、住房租赁、房地产经纪、家政服务等。该公司由浙江祥生物业服务有限公司持股51%,知卓(台州)物业管理有限公司持股49%。 祥生…

    2021-10-19
    02.6K0
  • 物业被强制迁出!昆明首例!

    你们知道 一个小区群聊得热火朝天 他们在聊什么? 物管太闹心怎么办? 11月3日,官渡法院顺利执结全市首例物业迁出案件,将位于我市日新路日新小区已解除合同,却一直不愿离开的物业公司依法强制腾退,并勒令其退出了物业服务区域。 官渡法院 首例物业迁出案顺利执结 业主夹道欢迎拍手称快 小区业主委员会负责人: “(鼓掌)接下来,我们除了感谢官渡区人民法院以外,我们所有小区住户,全部按照我们的要求,相信我们…

    2020-11-11 生活百科
    03.5K0