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)
打赏 微信扫一扫 微信扫一扫
上一篇 2017-04-17 17:21
下一篇 2017-04-17 22:54

相关推荐

  • 物业领军者:下个5年又是谁?

    来5年,是真正物业大鳄崛起的5年 文|潘永堂 2020这一年很特殊! 地产冷了,物业火了! 但就在这两大超级赛道,碧桂园成为一种独特的存在,即两大赛道都是“龙头”角色。 昨天,碧桂园地产坐上地产头把座椅后,连续4年稳坐泰山,而且看趋势,还将持续。今天,碧桂园服务5月成为首家破千亿上市物业,如今更是港股最大营收、最大市值。再观其战略,下个5年或将继续是物业龙头。 同时,2020年,堪称中国物业上市的…

    2020-12-02 行业动态
    02.2K0
  • 物业被强制迁出!昆明首例!

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

    2020-11-11 行业动态
    01.8K0
  • 自由创新之风吹拂——2018斯坦福物业管理总裁班全纪录

    继2017年中国物业管理协会与易居中国、易居实惠共同推出“易居沃顿首届中国物业总裁班”之后,在中国物业管理协会的大力推动下,由分众赞助富卡承办在美国西海岸的斯坦福大学开启了2018年的中国物业总裁班。

    2018-12-09 行业动态
    016.6K0
  • 小区物业管理人员离职后 多名业主遭贷款公司催款短信轰炸

    小区物管人员离职 业主手机却遭几百条催债短信轰炸 到底怎么回事? “实在受不了,只得求助警方,否则正常的工作都没得办法开展。”昨日(10月11日)上午,重庆江北区北滨路国奥村小区,物业公司副总经理宋立民大倒苦水。和他有一样遭遇的,还有小区的不少业主。 究其原因,还得与一名刚离职的管理人员唐英(化名)说起,此前,她或因贷款与放贷公司落下纠纷。目前,辖区警方已介入调查此事。 ▲唐英此前供职的国奥村一期…

    2018-10-13
    03.6K0
  • 10个步骤,了解新手入门过程的设计原则

    新手入门是每个应用程序最重要的元素之一。很多时候,它的难易程度决定了用户是否会继续使用应用程序。在用户界面上,新手入门不仅仅是简单的5个介绍软件的页面或说明性的工具提示内容。下面我会使用最有趣的例子来描述新手入门过程的设计原则。

    2017-04-17 行业动态
    12.2K0
  • 物业拖欠公摊电费,高层突遭停水 业主:明明已缴费,钱去哪里了

    南京市秦淮区双鸿小区的业主反映,他们高层住户突然遭遇停水,原因是物业拖欠了公摊电费,导致水泵无法运转。业主们这就纳闷了,明明自己已经缴纳了公摊水电费,为什么最终还是会欠费呢?问题到底出在哪? 双鸿小区位于南京市秦淮区石鼓路216号,是周边最早的高层住宅之一,11月30日中午时分,不少高层住户发现自己家里停水了。突然停水给居民的生活带来了不小的影响,家里没法做饭,吃饭就只能到外面去解决。 居民随后得…

    2020-12-05 行业动态
    02.0K0