简明的 Python 编程规范.docx

简明的Python编程规范

简明的Python编程规范 使用编码规范编写程序，不仅可以别人让后面维护的人更方便，同时也方便自己检查程序。以下是百分网小编精心为大家整理的简明的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_name2s 2)在括号(包括圆括号、方括号和花括号)内换行，如： classEdit(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(\ panrent,\ width,\ font,\ color,\ pos) 3)在长行加入续行符强行断行，断行的位置应在操作符前，且换行后多一个缩进，以使维护人员看代码的时候看到代码行首即可判定这里存在换行，如： ifcolor==WHITEorcolor==BLACK\ orcolor==BLUE:#注意or操作符在新行的行首而不是旧行的行尾 do_something(color); 命名 一致的命名可以给开发人员减少许多麻烦，而恰如其分的命名则可以大幅提高代码的可读性，降低维护成本。 常量 常量名所有字母大写，由下划线连接各个单词，如 WHITE=0XFFFFFF THIS_IS_A_CONSTANT=1 变量 变量名全部小写，由下划线连接各个单词，如 color=