python 编码规范整理


Posted in Python onMay 05, 2018

一 代码编排

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 块注释,在一段代码前增加的注释。在‘#'后加一空格。段落之间以只有‘#'的行间隔。

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的方式。

以上就是在pytho开发过程中的一些注意的点!

Python 相关文章推荐
python操作数据库之sqlite3打开数据库、删除、修改示例
Mar 13 Python
详解python实现读取邮件数据并下载附件的实例
Aug 03 Python
Python入门学习指南分享
Apr 11 Python
PyQt5实现类似别踩白块游戏
Jan 24 Python
django的settings中设置中文支持的实现
Apr 28 Python
深入浅析Python中的迭代器
Jun 04 Python
Python面向对象之继承原理与用法案例分析
Dec 31 Python
python通过安装itchat包实现微信自动回复收到的春节祝福
Jan 19 Python
Python各种扩展名区别点整理
Feb 27 Python
Python类和实例的属性机制原理详解
Mar 21 Python
pycharm sciview的图片另存为操作
Jun 01 Python
用python按照图像灰度值统计并筛选图片的操作(PIL,shutil,os)
Jun 04 Python
PYTHON基础-时间日期处理小结
May 05 #Python
python 日期操作类代码
May 05 #Python
Python批量发送post请求的实现代码
May 05 #Python
PyQt5 pyqt多线程操作入门
May 05 #Python
详解pyqt5 动画在QThread线程中无法运行问题
May 05 #Python
python中in在list和dict中查找效率的对比分析
May 04 #Python
Django如何配置mysql数据库
May 04 #Python
You might like
常用的php ADODB使用方法集锦
2008/03/25 PHP
PHP实现股票趋势图和柱形图
2015/02/07 PHP
PHP生成随机密码4种方法及性能对比
2020/12/11 PHP
JavaScript Tips 使用DocumentFragment加快DOM渲染速度
2010/06/28 Javascript
最佳JS代码编写的14条技巧
2011/01/09 Javascript
javascript 进阶篇1 正则表达式,cookie管理,userData
2012/03/14 Javascript
简单几行JS Code实现IE邮件转发新浪微博
2013/07/03 Javascript
JS调用页面表格导出excel示例代码
2014/03/18 Javascript
AngularJS Bootstrap详细介绍及实例代码
2016/07/28 Javascript
javascript滚轮事件基础实例讲解(37)
2017/02/14 Javascript
JavaScript设计模式之模板方法模式原理与用法示例
2018/08/07 Javascript
angular将html代码输出为内容的实例
2018/09/30 Javascript
详解如何使用koa实现socket.io官网的例子
2018/11/04 Javascript
react实现复选框全选和反选组件效果
2020/08/25 Javascript
[01:04:29]DOTA2-DPC中国联赛 正赛 Phoenix vs XG BO3 第二场 1月31日
2021/03/11 DOTA
[07:54]DOTA2-DPC中国联赛 正赛 iG vs VG 选手采访
2021/03/11 DOTA
Python中断言Assertion的一些改进方案
2016/10/27 Python
详解Python 数据库 (sqlite3)应用
2016/12/07 Python
关于pip的安装,更新,卸载模块以及使用方法(详解)
2017/05/19 Python
Django基于ORM操作数据库的方法详解
2018/03/27 Python
深入理解Django-Signals信号量
2019/02/19 Python
利用python numpy+matplotlib绘制股票k线图的方法
2019/06/26 Python
django重新生成数据库中的某张表方法
2019/08/28 Python
python迭代器常见用法实例分析
2019/11/22 Python
matplotlib.pyplot.matshow 矩阵可视化实例
2020/06/16 Python
超级实用的8个Python列表技巧
2020/08/24 Python
trivago美国:全球最大的酒店价格比较网站
2018/01/18 全球购物
澳大利亚窗帘商店:Curtain Wonderland
2019/12/01 全球购物
企业面试题试卷附带答案
2015/12/20 面试题
优秀大学生自荐信
2014/06/09 职场文书
毕业生应聘求职信
2014/07/10 职场文书
工商局领导班子存在的问题整改措施思想汇报
2014/10/05 职场文书
2015共产党员公开承诺书
2015/01/22 职场文书
交通事故起诉书
2015/05/19 职场文书
python - timeit 时间模块
2021/04/06 Python
ubuntu下常用apt命令介绍
2022/06/05 Servers