(完整版)Python开发编码规范

Python开发编码规范目录1代码的布局...............................................................................................................................31.1缩进...........................................................................................................................31.2制表符还是空格?.....................................................................................................31.3行的最大长度...........................................................................................................31.4空行...........................................................................................................................32编码..........................................................................................................................................42.1导入...........................................................................................................................42.2空格...........................................................................................................................52.3其它建议(OtherRecommendations)........................................................................62.4注释...........................................................................................................................72.4.1注释块...............................................................................................................72.4.2行内注释...........................................................................................................72.5文档化.......................................................................................................................82.6版本注记...................................................................................................................92.7命名约定...................................................................................................................92.7.1描述:命名风格...............................................................................................102.7.2说明:命名约定...............................................................................................112.7.3应避免的名字.................................................................................................112.7.3.1模块名(ModuleNames)..........................................................................112.7.3.2类名(ClassNames).................................................................................112.7.3.3异常名(ExceptionNames)......................................................................112.7.3.4全局变量名(GlobalVariableNames).....................................................122.7.3.5函数名(FunctionNames)........................................................................122.7.3.6方法名和实例变量(MethodNamesandInstanceVariables).................122.7.3.7继承的设计(Designingforinheritance).................................................123设计建议(ProgrammingRecommendations).........................................................................131代码的布局1.1缩进使用Emacs的Python-mode的默认值:4个空格一个缩进层次。对于确实古老的代码,你不希望产生混乱,可以继续使用8空格的制表符(8-spacetabs)。EmacsPython-mode自动发现文件中主要的缩进层次,依此设定缩进参数。1.2制表符还是空格?永远不要混用制表符和空格。最流行的Python缩进方式是仅使用空格,其次是仅使用制表符。混合着制表符和空格缩进的代码将被转换成仅使用空格。(在Emacs中,选中整个缓冲区,按ESC-x去除制表符(untabify)。)调用python命令行解释器时使用-t选项,可对代码中不合法得混合制表符和空格发出警告(warnings)。使用-tt时警告(warnings)将变成错误(errors)。这些选项是被高度推荐的。对于新的项目,强烈推荐仅使用空格(spaces-only)而不是制表符。许多编辑器拥有使之易于实现的功能。(在Emacs中,确认indent-tabs-mode是nil)。1.3行的最大长度周围仍然有许多设备被限制在每行80字符;而且,窗口限制在80个字符使将多个窗口并排放置成为可能。在这些设备上使用默认的折叠(wrapping)方式看起来有点丑陋。因此,请将所有行限制在最大79字符(Emacs准确得将行限制为长80字符),对顺序排放的大块文本(文档字符串或注释),推荐将长度限制在72字符。折叠长行的首选方法是使用Pyhon支持的圆括号,方括号(brackets)和花括号(braces)内的行延续。如果需要,你可以在表达式周围增加一对额外的圆括号,但是有时使用反斜杠看起来更好。确认恰当得缩进了延续的行。Emacs的Python-mode正确得完成了这些。一些例子:Togglelinenumbers1classRectangle(Blob):23def__init__(self,width,height,4color='black',emphasis=None,highlight=0):5ifwidth==0andheight==0and\color=='red'andemphasis=='strong'or\highlight100:6raiseValueError,sorry,youlose7ifwidth==0andheight==0and(color=='red'or8emphasisisNone):9raiseValueError,Idon'tthinkso10Blob。__init__(self,width,height,11color,emphasis,highlight)1.4空行用两行空行分割顶层函数和类的定义,类内方法的定义用单个空行分割。额外的空行可被用于(保守的(sparingly))分割相关函数组成的群(groupsofrelatedfunctions)。在一组相关的单句中间可以省略空行。(例如。一组哑元(asetofdummyimplementations))。当空行用于分割方法(method)的定义时,在'class'行和第一个方法定义之间也要有一个空行。在函数中使用空行时,请谨慎的用于表示一个逻辑段落(indicatelogicalsections)。Python接受contol-L(即^L)换页符作为空格;Emacs(和一些打印工具)视这个字符为页面分割符,因此在你的文件中,可以用他们来为相关片段(sections)分页。2编码Python核心发布中的代码必须始终使用ASCII或Latin-1编码(又名ISO-8859-1)。使用ASCII的文件不必有译码cookie(codingcookie)。Latin-1仅当注释或文档字符串涉及作者名字需要Latin-1时才被使用;另外使用\x转义字符是在字符串中包含非ASCII(non-ASCII)数据的首选方法。作为PEP263实现代码的测试套件的部分文件是个例外。Python2。4以后内核支持Unicode了！不论什么情况使用UTF-8吧！2.1导入通常应该在单独的行中导入(Imports),例如:No:importsys,osYes:importsysimportos但是这样也是可以的:fromtypesimportStringType,ListTypeImports通常被放置在文件的顶部,仅在模块注释和文档字符串之后,在模块的全局变量和常量之前。Imports应该有顺序地成组安放。1。标准库的导入(Imports)2。相关的主包(majorpackage)的导入(即,所有的email包在随后导入)3。特定应用的导入(imports)你应该在每组导入之间放置一个空行。对于内部包的导入是不推荐使用相对导入的。对所有导入都要使用包的绝对路径。从一个包含类的模块中导入类时,通常可以写成这样:fromMyClassimportMyClassfromfoo。