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

相关推荐

  • 住建部倡导物业企业发展线上线下生活服务,社区增值有得搞了

    近日,住房和城乡建设部等部门联合发布了关于推动物业服务企业加快发展线上线下生活服务的意见,通知具体内容如下: 重要通知 各省、自治区、直辖市及新疆生产建设兵团住房和城乡建设厅(委、管委、局)、工业和信息化主管部门、公安厅(局)、商务主管部门、卫生健康委、市场监管局(厅、委): 为深入贯彻落实《中共中央 国务院关于加强和完善城乡社区治理的意见》《国务院关于加快推进”互联网+政务服务&#8…

    2020-12-24
    02.8K0
  • 奥迪车主霸占车位还怒怼业主!对方这样操作,车主看后连忙服软

    相信对于有车一族来说,停车难的问题是一个丝毫不亚于道路拥堵的烦心事,不过相比拥堵,停车难只要花钱够多就能解决,比如自己买独立车位,但是如果自己辛辛苦苦赚钱买来的车位还要被对方长期霸占相信谁都不会太舒服,脾气也不会好到哪里去。 尤其是近些年“蹭”别人的停车位已经是十分常见的了,只是有些人还知道是占了便宜,所以比较客气,大家互相理解就过去了,但是有些人“吃霸王餐”习惯了,就会养成一些十分无理的赖脾气,…

    2021-10-01 生活百科
    02.3K0
  • 邻居家深夜传来女子特别“叫声”,令人困扰,怀疑从事特殊职业

    导语:现在的房价越来越高,每个城市都在开发新的楼盘。可是这些房子看起来外观很漂亮,但几乎都存在同一个令人懊恼的问题,那就是隔音不好。有很多住户都因为这个问题闹矛盾,但是绝大多数时候都能协商解决,但如果对方避而不见也没有办法。 女子租房遇到奇葩邻居,每到傍晚时常传来尖叫声? 小刘在外上班,公司为她在附近找了个房子,每月的房租为2500元。房子的格局光线都很不错,她还是比较满意的。可就在搬进来没多久之…

    2021-10-03
    02.2K0
  • 公共空间被占、每月缴纳费用高达23.8元每平 深圳汇展阁大厦业主维权数年无果

    一心想改善居住环境的秦女士与其先生最终打定主意,结束租房生涯,买房入伙。2016年,秦女士一家购买了深圳汇展阁大厦的一处面积约43平方米的二手住宅,费用约95万。

    2019-05-19 生活百科
    012.7K0
  • 先收购再分拆,越秀物业也开始准备上市了

    记者| 陶婷 从年初到年底,越秀地产对分拆越秀物业上市的态度逐渐明晰。11月23日的一则公告,揭开了越秀物业讲述资本故事的第一幕。 越秀地产公告称,公司正考虑分拆物业管理业务独立上市。值得注意的是,越秀地产同时发布以2.82亿元的代价收购广州地铁环境工程有限公司及广州地铁物业管理有限责任公司各67%的股权。 这两家物业公司原属于广州地铁集团旗下,交易完成后,越秀物业将积累营运和管理列车停放处及列车…

    2020-11-25
    02.6K0
  • 重庆某小区业委会主任收物业近二百万贿赂款被判八年

    江月胜,男,55岁,重庆垫江县人,硕士,案发时系重庆江北区朗晴广场小区(以下简称朗晴广场)业主委员会(以下简称业委会)主任,因涉嫌犯非国家工作人员受贿罪,于2017年5月23日被刑拘。

    2019-11-24
    08.2K0