python编码规范

Python编码规范下载python2.7.9版本进行编码1编码所有的Python脚本文件都应在文件头标上如下标识或其兼容格式的标识：#-*-coding:utf-8-*-设置编辑器，默认新建或保存为utf-8格式。i.行的最大长度周围仍然有许多设备被限制在每行80字符：而且，窗口限制在80个字符。使将多个窗口并排放置成为可能。在这些设备上使用默认的折叠方式看起来有点丑陋。因此，请将所有行限制在最大79字符(Emacs准确得将行限制为长80字符)，对顺序排放的大块文本(文档字符串或注释)，推荐将长度限制在72字符。折叠长行的首选方法是使用Pyhon支持的圆括号，方括号和花括号内的行延续。如果需要，你可以在表达式周围增加一对额外的圆括号，但是有时使用反斜杠看起来更好，确认恰当得缩进了延续的行。Emacs的Python-mode正确得完成了这些。一些例子：#!PythonclassRectangle(Blob)：def__init__(self，width，height，color='black'，emphasis=None，highlight=0)：ifwidth==0andheight==0and\color=='red'andemphasis=='strong'or\highlight100：raiseValueError，sorry，youloseifwidth==0andheight==0and(color=='red'oremphasisisNone)：raiseValueError，Idon'tthinksoBlob.__init__(self，width，height，color，emphasis，highlight)i.i导入通常应该在单独的行中导入(Imports)，例如：No：importsys，osYes：importsysimportos但是这样也是可以的：fromtypesimportStringType，ListTypeImports通常被放置在文件的顶部，仅在模块注释和文档字符串之后，在模块的全局变量和常量之前。Imports应该有顺序地成组安放：1、标准库的导入(Imports)2、相关的主包(majorpackage)的导入(即，所有的email包在随后导入)3、特定应用的导入(imports)你应该在每组导入之间放置一个空行，对于内部包的导入是不推荐使用相对导入的，对所有导入都要使用包的绝对路径。从一个包含类的模块中导入类时，通常可以写成这样：fromMyClassimportMyClassfromfoo.bar.YourClassimportYourClass如果这样写导致了本地名字冲突，那么就这样写importMyClassimportfoo.bar.YourClass即使用MyClass.MyClass和foo.bar.YourClass.YourClass2注释业界普遍认同Python的注释分为两种的概念，一种是由#开头的“真正的”注释，另一种是docstrings。前者表明为何选择当前实现以及这种实现的原理和难点，后者表明如何使用这个包、模块、类、函数（方法），甚至包括使用示例和单元测试。坚持适当注释原则。对不存在技术难点的代码坚持不注释，对存在技术难点的代码必须注释。但与注释不同，推荐对每一个包、模块、类、函数（方法）写docstrings，除非代码一目了然，非常简单。3格式缩进Python依赖缩进来确定代码块的层次，行首空白符主要有两种：tab和空格，但严禁两者混用。使用4个空格的tab进行缩进，保持与python类库一致。4空格空格在Python代码中是有意义的，因为Python的语法依赖于缩进，在行首的空格称为前导空格。在这一节不讨论前导空格相关的内容，只讨论非前导空格。非前导空格在Python代码中没有意义，但适当地加入非前导空格可以增进代码的可读性。在二元算术、逻辑运算符前后加空格，如：a=b+c“:”用在行尾时前后皆不加空格，如分枝、循环、函数和类定义语言；用在非行尾时两端加空格，如dict对象的定义：d={'key':'value'}括号（含圆括号、方括号和花括号）前后不加空格，如：do_something(arg1,arg2)而不是do_something(arg1,arg2)逗号后面加一个空格，前面不加空格；函数中命名参数中的=前后不需要加空格，例如：defparse(fp=None,environ=os.environ,keep_blank_values=0,strict_parsing=0):pass5空行适当的空行有利于增加代码的可读性，加空行可以参考如下几个准则：在类、函数的定义间加空行；在import不同种类的模块间加空行；在函数中的逻辑段落间加空行，即把相关的代码紧凑写在一起，作为一个逻辑段落，段落间以空行分隔；6断行尽管现在的宽屏显示器已经可以单屏显示超过256列字符，但本规范仍然坚持行的最大长度不得超过78个字符的标准(我觉的notepad++默认值为100比较合适)。折叠长行的方法有以下几种方法：为长变量名换一个短名，如：this._is.a.very.long.variable_name=this._is.another.long.variable_name应改为：variable_name1=this._is.a.very.long.variable_namevariable_name2=this._is.another.variable_namevariable_name1=variable_name2在括号（包括圆括号、方括号和花括号）内换行，如：classEdit(Widget):def__init__(self,parent,width,font=FONT,color=BLACK,pos=POS,style=0):#注意：多一层缩进pass或：very_very_very_long_variable_name=Edit(parent,width,font,color,pos)#注意：多一层缩进do_sth_with(very_very_very_long_variable_name)如果行长到连第一个括号内的参数都放不下，则每个元素都单独占一行：very_very_very_long_variable_name=ui.widgets.Edit(panrent,width,font,color,pos)#注意：多一层缩进do_sth_with(very_very_very_long_variable_name)在长行加入续行符强行断行，断行的位置应在操作符前，且换行后多一个缩进，以使维护人员看代码的时候看到代码行首即可判定这里存在换行，如：ifcolor==WHITEorcolor==BLACK\orcolor==BLUE:#注意or操作符在新行的行首而不是旧行的行尾，上一行的续行符不可省略do_something(color);else:do_something(DEFAULT_COLOR);7命名一致的命名可以给开发人员减少许多麻烦，而恰如其分的命名则可以大幅提高代码的可读性，降低维护成本。常量常量名所有字母大写，由下划线连接各个单词，如：WHITE=0xffffffffTHIS_IS_A_CONSTANT=1变量变量名全部小写，由下划线连接各个单词，如：color=WHITEthis_is_a_variable=1不论是类成员变量还是全局变量，均不使用m或g前缀。私有类成员使用单一下划线前缀标识，多定义公开成员，少定义私有成员。变量名不应带有类型信息，因为Python是动态类型语言。如iValue、names_list、dict_obj等都是不好的命名。函数函数名的命名规则与变量名相同。类类名单词首字母大写，不使用下划线连接单词，也不加入C、T等前缀。如：classThisIsAClass(object):passs模块模块名全部小写，对于包内使用的模块，可以加一个下划线前缀，如：module.py_internal_module.py包包的命名规范与模块相同。8缩写命名应当尽量使用全拼写的单词，缩写的情况有如下两种：常用的缩写，如XML、ID等，在命名时也应只大写首字母，如：classXmlParser(object):pass命名中含有长单词，对某个单词进行缩写。这时应使用约定成俗的缩写方式，如去除元音、包含辅音的首字符等方式，例如：function缩写为fntext缩写为txtobject缩写为objcount缩写为cntnumber缩写为num，等。特定命名方式主要是指__xxx__形式的系统保留字命名法。项目中也可以使用这种命名，它的意义在于这种形式的变量是只读的，这种形式的类成员函数一般都有特定的含义，自定义时需要确保不要与系统的冲突，只有在确实需要的时候才重载系统保留的这些函数。如：classBase(object):def__init__(self,id,parent=None):self.__id__=idself.__parent__=parentdef__message__(self,msgid):pass其中__id__、__parent__和__message__都采用了系统保留字命名法。9语句importimport语句有以下几个原则需要遵守：import的次序，先importPython内置模块，再import第三方模块，最后import自己开发的项目中的其它模块；这几种模块中用空行分隔开来。一条import语句import一个模块。当从模块中import多个对象且超过一行时，使用如下断行法（此语法py2.5以上版本才支持）：frommoduleimport(obj1,obj2,obj3,obj4,obj5,obj6)不要使用frommoduleimport*，除非是import常量定义模块或其它你确保不会出现命名空间冲突的模块。赋值对于赋值语句，主要是不要做无谓的对齐，如：a=1#这是一个行注释variable=2#另一个行注释fn=callback_function#还是行注释没有必要做这种对齐，原因有两点：一是这种对齐会打乱编程时的注意力，大脑要同时处理两件事（编程和对齐）；二是以后阅读和维护都很困难，因为人眼的横向视野很窄，把三个字段看成一行很困难，而且维护时要增加一个更长的变量名也会破坏对齐。直接这样写为佳：a=1#这是一个行注释variable=2#另一个行注释fn=callback_function#还是行注释分支和循环对于分支和循环，有如下几点需要注意的：不要写成一行，如：ifnotflg:pass和foriinxrange(10):printi都不是好代码，应写成ifnotflg:passforiinxrange(10):printi注：本文档中出现写成一行的例子是因为排版的原因，不得作为编码中不断行的依据。条件表达式的编写应该足够pythonic，如以下形式的条件表达式是拙劣的：ifnotlen(alist)==0:do_something()ifnotalist==[]:do_something()ifnots==:do_something()ifnotvar==None:do_something()ifnotvar==False:do_something()因为python中None，0，''，[]等默认为False，上面的语句应该写成：ifseq:do_somethin()#注意，这里命名也更改了ifvar:do_something()用得着的时候多使用循环语句的else分句，以简化代码。10.其它建议始终在这些二元运算符两边放置一个空格：赋值(=)，比较(==，，，!=，，=，=，in，notin，is，isnot)，布尔运算(