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

相关推荐

  • 10月11日鑫苑物业服务集团在港交所上市

    10月11日,鑫苑物业服务集团(01895.HK)在港交所成功上市,这是中部区域第一家在港上市的物业公司。

    2019-10-12 行业动态
    017.7K0
  • 云南昆明:加强党建引领社区物业服务

    近日,昆明市委组织部制定下发了《关于全面加强党建引领社区物业服务工作的意见(试行)》,此举旨在健全党的组织体系和组织覆盖,以构建党组织领导下社区、物业企业、业主三方联动运行机制为重点,积极构建党建引领社区物业组织、工作、运行、服务“四个体系”,全面凝聚社区治理合力。

    2019-08-15
    013.5K0
  • 《2018年全国物业管理行业发展报告》正式发布

      物业服务企业综合实力 TOP100 测评结果 测评工作由中国物业管理协会、上海易居房地产研究院中国房地产测评中心共同主办,会同各地方行业协会面向会员单位组织开展,历时 5 个月。

    2018-10-16 行业动态
    012.0K0
  • 太惊险!福田区万科金色家园小区一台空调主机从11楼坠下

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

    2019-07-01 行业动态
    09.5K0
  • 女业主因房屋漏水问题找开发商协调,反被工作人员掌掴

    “无良开发商”,近日一业主因房屋漏水问题找开发商协调处理,没想到被一巴掌打倒在地。 从视频中可以看到一名壮汉一巴掌将女子打倒在地,原来这名女子是小区的业主,而对面的壮汉是工作人员。 据家属介绍,女子在小区买了一套300万的房子,入住才一个月就出现了各种问题。他们找开发商和物业协调,结果他们互相推诿扯皮,互踢皮球。当天他们去和开发商签订一个书面处理协议方案,结果被开发商的人打了一巴掌,目前打人者已经…

    2022-07-11 行业动态
    08390
  • 郑州市明天花园小区消防隐患大火灾来了无水可救

    河南省郑州市金水区明天花园小区,2019.7.21中午11-1楼,15层,突发大火,家中物品尽数烧毁,而小区消防栓无水,警报不响,物业无作为,还是消防员来了组织疏散人员,始终不见物业身影,消防车却被堵在大门口进不来

    2019-07-21 行业动态
    010.4K0