Python 编程规范.doc

Python 编程规范编码??? 所有的 Python 脚本文件都应在文件头标上 # -*- coding:utf-8 -*- 。设置编辑器，默认保存为 utf-8 格式。注释??? 业界普遍认同 Python 的注释分为两种的概念，一种是由 # 开头的“真正的”注释，另一种是 docstrings。前者表明为何选择当前实现以及这种实现的原理和难点，后者表明如何使用这个包、模块、类、函数（方法），甚至包括使用示例和单元测试。??? 坚持适当注释原则。对不存在技术难点的代码坚持不注释，对存在技术难点的代码必须注释。但与注释不同，推荐对每一个包、模块、类、函数（方法）写 docstrings，除非代码一目了然，非常简单。缩进??? Python 依赖缩进来确定代码块的层次，行首空白符主要有两种：tab 和空格，但严禁两者混用。如果使用 tab 缩进，设定 tab 为 4 个空格。??? 公司内部推荐使用 4 个空格的 tab 进行缩进。空格??? 空格在 Python 代码中是有意义的，因为 Python 的语法依赖于缩进，在行首的空格称为前导空格。在这一节不讨论前导空格相关的内容，只讨论非前导空格。非前导空格在 Python 代码中没有意义，但适当地加入非前导空格可以增进代码的可读性。1）?在二元算术、逻辑运算符前后加空格：如 a = b + c；2）?在一元前缀运算符后不加空格，如 if !flg: pass；3）?“:”用在行尾时前后皆不加空格，如分枝、循环、函数和类定义语言；用在非行尾时两端加空格，如 dict 对象的定义 d = {‘key’ : ’value’}。4）?括号（含圆括号、方括号和花括号）前后不加空格，如 do_something(arg1, arg2)，而不是 do_something( arg1, arg2 )；5）?逗号后面加一个空格，前面不加空格；s空行??? 适当的空行有利于增加代码的可读性，加空行可以参考如下几个准则：1）?在类、函数的定义间加空行；2）?在 import 不同种类的模块间加工行；3）?在函数中的逻辑段落间加空行，即把相关的代码紧凑写在一起，作为一个逻辑段落，段落间以空行分隔；断行??? 尽管现在的宽屏显示器已经可以单屏显示超过 256 列字符，但本规范仍然坚持行的最大长度不得超过 78 个字符的标准。折叠长行的方法有以下几种方法：1)?为长变量名换一个短名，如：??? this.is.a.very.long.variable_name = this.is.another.long.variable_name??? 应改为：??? variable_name1 = this.is.a.very.long.variable_name??? variable_name2 = this.is.another.variable_name??? variable_name1 = variable_name2s2)?在括号（包括圆括号、方括号和花括号）内换行，如：??? class Edit(CBase):??????? def __init__(self, parent, width,???????????????????????????????? font = FONT, color = BLACK, pos = POS, style = 0):??? 或：??? very_very_very_long_variable_name = Edit(parent, \??????????????????????????????????????????????????????????????????????????? width, \??????????????????????????????????????????????????????????????????????????? font, \??????????????????????????????????????????????????????????????????????????? color, \??????????????????????????????????????????????????????????????????????????? pos)??? 如果行长到连第一个括号内的参数都放不下，则每个元素都单独占一行：??? very_very_very_long_variable_name = ui.widgets.Edit( \???????????????????????????????????????????????