味燃,干式熟成制造专家
产品:干式熟成工艺技术,干式熟成柜,干式熟成库
微信咨询: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)
打赏 微信扫一扫 微信扫一扫
上一篇 2017-04-17 17:21
下一篇 2017-04-17 22:54

相关推荐

  • 物业管理区域实体化与引入职业经理人的思考

    文/屈昌辉 重庆城市管理职业学院副教授 [摘要] 中国物业管理行业向何处去是许多学者和社会管理者思考的问题。笔者认为,要从根本上改革物业管理的行业现状,做好物业管理这一民生产业,需要从制度和管理的层面重新构建物业管理体制,而物业管理区域实体化和在物业管理行业引入职业经理人这两项制度可以从根本上理顺物业管理的各种关系,促进物业管理行业的良性运行。 [关键词]物业管理;物业管理区域;实体化;职业经理人…

    2018-10-13
    03.2K0
  • 业主封阳台被物业告,一审败诉,二审胜诉!物业:将提起再审

    封自家阳台成被告,一审败诉。今年2月,成都绿城·诚园一期小区物业发出的一纸告示,在网络引发热议。物业在针对小区一封阳台业主的诉讼中获胜,当事业主被一审法院判决限期拆除。 因封阳台而被物业起诉的案件在全国较为罕见。 8月19日,红星新闻记者从被告业主高先生处获悉,8月12日,成都市中级人民法院二审宣判:撤销一审判决,并驳回物业公司的诉讼请求,业主方胜诉。此前报道:业主封阳台成被告,一审败诉!禁止封阳…

    2023-01-04
    07860
  • 勤博教育携手中海物业集团打造高水平产教融合实训平台及人才发展体系

    ▲勤博教育董事长周心怡(左四)与中海物业集团行政总裁杨鸥(右五)及双方高管在签约仪式上合影。 12月30日,又一家中国物业服务百强上市企业——中海物业集团与勤博教育签署了人才培养战略合作协议,双方结为人才培养战略伙伴,共同努力构建合作发展的平台和机制,进一步深化全方位的人才发展合作与交流。 中海物业集团起源于香港,1991年回归深圳,是中国首批一级资质物业管理企业,中海物业集团致力于成为集全球化战…

    2019-12-31
    08.4K0
  • 小区地库十多年没启用,物业:将开展业主需求调查

    海淀区润生园小区2008年开放入住,但地库十多年来一直没有启用。近日,市民段先生拨打北京12345市民热线反映,如今地面车位越来越紧张,希望开放地库方便居民停车。小区建成多年,地库为何迟迟不启用? 傍晚6点,海淀区西三旗街道润生园小区里的地面车位已经所剩无几。刚开车回来的车主李先生在家楼下转了一圈,把车停在了离楼门口稍远的位置。 李先生:晚点回来就是要找,像我住在这个地方,现在回来这一块都没有(车…

    2021-11-09 生活百科
    01.6K0
  • 博览会,明天见!

      经过大半年的筹备,第二届国际物业管理产业博览会明天就要拉开帷幕了。 本届博览会以“融合发展 共创美好”为主题,展览面积达到1.5万平方米,参展单位120家,还将同期举办第四届中国物业管理创新发展论坛主论坛和19场分论坛,以及大量形式多样的交流活动。可以说,这将是一场亮点颇多,精彩纷呈的盛会。 深圳是改革开放的标志性城市。40年前,正是深圳的星星之火燃起了全国改革开放的燎原之势,一时间…

    2018-10-14 生活百科
    03.7K0
  • 项目经理如何主持召开好物业晨会?

    如果对上班一族来一个调查问卷,内容是上午你大概需要多长时间才能进入工作状态,相信大部分的结论应该都是超过一个小时吧。如果来一个早会,尽快地让大家进入工作状态,进入处理工作的模式,对于提高工作效率的作用应该不难想像。

    2019-05-16
    015.4K0