味燃,干式熟成制造专家
产品:干式熟成工艺技术,干式熟成柜,干式熟成库
微信咨询:13556860160,师先生
公司:味燃食品生物科技(深圳)有限公司
地址:深圳市福田区泰然六路泰然大厦C座1501

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

相关推荐

  • 杭州市下城区探索建立“一站式”物业管理服务新机制

    物业小区是人民群众生活的基本场所,是城市管理的基础单元,也是基层社会治理的重要领域。物业管理和服务水平直接关系到人民群众的满意度、获得感和幸福感,关系到能否实现人民群众对美好生活的向往。实践中,社区、业委会、物业企业三方权责不清、主体不明、关系不顺往往是困扰小区治理的难题。 为破解这一问题,近年来,杭州市住保房管局立足物业管理工作体制机制的健全完善,聚焦基层街道、乡镇和社区物业管理工作能力的提升,…

    2020-11-11
    03.5K0
  • 物业管理中“7S”管理活动(建议收藏转发)

    当你第一次踏入一家公司的大门时,你希望展现在你面前的是什么样的景象? 大门:保安人员有礼貌地向你问好,并迅速为你办完登记手续,开门放行。 写字楼:公司规划合理,环境整洁明亮,你顿时觉得心旷神怡。 办公室:各个写字间宽敞明亮,办公人员各司其职,办公物品摆放整齐,电话铃声井然有序,没有半点喧嚣嘈杂。 员工:着整齐的服装,情绪饱满,工作熟练。 为什么要执行“7S”管理 1.让客户留下深刻的印象,提升企业…

    2018-10-13
    04.7K0
  • 小区物业管理人员离职后 多名业主遭贷款公司催款短信轰炸

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

    2018-10-13
    04.9K0
  • 郑州市明天花园小区消防隐患大火灾来了无水可救

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

    2019-07-21 生活百科
    011.4K0
  • 未来已来——碧桂园服务智慧产城物业管理了解一下!

    01 地表最强的潼湖科技小镇是啥? 潼湖科技小镇是碧桂园集团首个产城融合标杆项目,开园当天已引进27家企业和机构入驻。除了日常办公,未来潼湖科技小镇还将涵盖产业、商业、学校、医院、公园、场馆、交通、酒店、住宅等多种业态,构建生活工作一体化的24小时生活圈,并且发展本地特色文化,打造产城融合、因城制宜的产业新城综合体。 涵盖多种业态的潼湖科技小镇西部组团 02 碧桂园服务智慧产城物业管理是啥? 碧桂…

    2018-10-12
    07.1K0
  • 深圳一小区安居房奇葩车位窄成“卡座”,部门介入清查不合格车位

    深圳龙华中海锦城小区有商品房和安居房了两部分。9月初,多位安居房业主反映,属于安居房的停车区域最近被物管擅自改为商品房业主使用,并加上隔离桩,造成车位不足。而该小区商品房的业主则指责是安居房业主拆除隔离桩,企图抢占商品房的停车位。

    2019-09-27
    010.5K0