新疆吐鲁克精酿啤酒经销代理
微信咨询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

相关推荐

  • 震惊!银川一小区物业人员竟是逃亡20年的嫌犯!

    2000年5月24日,梁某和朋友在北京朝阳区某市场内活动,朋友与他人发生口角之后,梁某与朋友一起动手殴打了对方,一顿拳打脚踢后,梁某等人又从路边捡起砖头砸了上去。令他们至今悔恨不已的事情发生了,这一砖头直接将受害人打死了。

    2020-07-07
    03.6K0
  • 物业公司的盛世,物业第一股的悲歌

    彩生活选择出售核心资产给碧桂园,不仅是为了缓解其母公司花样年的债务困境,更是因为自己最近两年来业绩增长乏力 文 | 郑慧 王博 9月28日,碧桂园的物业版图“再下一城”,这次被其收入囊中的是有着“物业第一股”之称的彩生活(1778.HK)子公司邻里乐控股。 碧桂园服务(6098.HK)在当日晚间发布的公告称,公司拟以不超过33亿元的代价,收购邻里乐控股100%股权。邻里乐控股在剔除分拆业务及计入核…

    2021-10-03 生活百科
    02.6K0
  • 丁祖昱:未来最看好物业管理行业

    社区是一个复杂、多重消费场景的聚集体,近年来,物业管理行业的服务内涵不断延伸、革新;物业服务企业服务意识亦逐步提高,开始转向“全面的生活服务商”。 全面的来看,在社区多元服务上,物业服务企业已经依托社区布局教育、养老、新零售、家政等多个领域深度布局;在外部多业态服务上,物业服务企业对学校、医院、城市综合体等多种业态开启布局,并进一步扩展到城市服务领域。 物业服务企业服务内容的进一步多元,服务业态进…

    2019-01-08 生活百科
    012.0K0
  • 开平某楼盘物业互相踢皮球,业主表示很无助!

    网友报料:近日开平领美花园一业主计划安装充电桩,而跑去物业申请就说麻烦去业主委员会先申请盖章,而业主委员会又说不关她的的事,不可以盖章,于是反反复复,这个皮球踢来踢去,最后业主表示很无奈,最后只有报警协商!作为业主装个充电桩也这么难!难道不符合国家标准的吗?还是什么原因呢? ( 具体情况以相关部门公布为准) 目前业主已经报警!

    2021-10-02
    03.0K0
  • 2019年深圳第一张责令退出函–金洲花园迎来自治胜利曙光

    2019年深圳第一张责令退出函–金洲花园迎来自治胜利曙光 一路走来,不忘初心! 这个案子代表了每个更换物业的小区的困境,审判结果会很有指导意义。会指明物业管理条例中,如果物业公司赖着不走,清退物业的主体人到底是行政主管部门还是业委会?!业委会无权无钱无力,在物业公司暴力抗拒业主大会的情况下,行政部门应该如何作为?——冷锋 重要时间点回顾: 2016年9月30日:…

    2019-01-31
    015.5K0
  • “拉家常”议事会 议出社区治理新模式

    北京市大兴区创新开展形式多样的“拉家常”议事会机制,将协商程序化繁为简,一种“小事不出楼门、大事不出社区、难事不出镇街”的参与型社区治理模式已经形成—— 本报记者 安 娜 近年来,北京市大兴区不断健全社区协商议事制度,在推进“参与型”社区治理模式实践中,创新建立“拉家常”议事会工作机制。该机制的主要做法是:号召社区工作者和社区居民骨干通过主动巡查、入户走访、串门聊天等方式,广泛征求居民意见建议,进…

    2020-11-12 生活百科
    03.4K0