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将人民币转换大写的脚本代码
Feb 10 Python
python数据结构之二叉树的统计与转换实例
Apr 29 Python
对pandas中to_dict的用法详解
Jun 05 Python
Python Pandas实现数据分组求平均值并填充nan的示例
Jul 04 Python
微信公众号token验证失败解决方案
Jul 22 Python
在Python中使用MongoEngine操作数据库教程实例
Dec 03 Python
关于ZeroMQ 三种模式python3实现方式
Dec 23 Python
python多线程实现代码(模拟银行服务操作流程)
Jan 13 Python
解决tensorflow添加ptb库的问题
Feb 10 Python
python Django 反向访问器的外键冲突解决
May 20 Python
查看keras各种网络结构各层的名字方式
Jun 11 Python
Scrapy+Selenium自动获取cookie爬取网易云音乐个人喜爱歌单
Feb 01 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
MYSQL 小技巧 -- LAST_INSERT_ID
2009/11/24 PHP
如何在php中正确的使用json
2013/08/06 PHP
php实现Mongodb自定义方式生成自增ID的方法
2015/03/23 PHP
帝国CMS留言板回复后发送EMAIL通知客户
2015/07/06 PHP
基于PHP代码实现中奖概率算法可用于刮刮卡、大转盘等抽奖算法
2015/12/20 PHP
php图片裁剪函数
2018/10/31 PHP
PHP函数积累总结
2019/03/19 PHP
ExtJS Grid使用SimpleStore、多选框的方法
2009/11/20 Javascript
浅析jQuery中常用的元素查找方法总结
2013/07/04 Javascript
jQuery中:password选择器用法实例
2015/01/03 Javascript
全面解析Bootstrap布局组件应用
2016/02/22 Javascript
webpack学习笔记之代码分割和按需加载的实例详解
2017/07/20 Javascript
vue中实现methods一个方法调用另外一个方法
2018/02/08 Javascript
node.js博客项目开发手记
2018/03/16 Javascript
使用vue2实现购物车和地址选配功能
2018/03/29 Javascript
JavaScript设计模式之工厂模式简单实例教程
2018/07/03 Javascript
jquery实现动态添加附件功能
2018/10/23 jQuery
VUE写一个简单的表格实例
2019/08/06 Javascript
JavaScript实现切换多张图片
2021/01/27 Javascript
[01:19:23]2018DOTA2亚洲邀请赛 4.5 淘汰赛 Mineski vs VG 第二场
2018/04/06 DOTA
python时间整形转标准格式的示例分享
2014/02/14 Python
Python tkinter模块中类继承的三种方式分析
2017/08/08 Python
Python3中条件控制、循环与函数的简易教程
2017/11/21 Python
小 200 行 Python 代码制作一个换脸程序
2020/05/12 Python
python中有帮助函数吗
2020/06/19 Python
解析python 类方法、对象方法、静态方法
2020/08/15 Python
python单元测试框架pytest的使用示例
2020/10/07 Python
wordpress添加Html5的表单验证required方法小结
2020/08/18 HTML / CSS
企业宣传方案
2014/03/04 职场文书
大学生简历求职信
2014/06/24 职场文书
退休党员个人对照检查材料思想汇报
2014/09/29 职场文书
小学一年级数学教学计划
2015/01/20 职场文书
硕士毕业答辩开场白
2015/05/27 职场文书
Python列表删除重复元素与图像相似度判断及删除实例代码
2021/05/07 Python
php实例化对象的实例方法
2021/11/17 PHP
「天才王子的赤字国家重生术」妮妮姆·拉雷粘土人开订
2022/03/21 日漫