欢迎来到天天文库
浏览记录
ID:15277055
大小:42.00 KB
页数:13页
时间:2018-08-02
《python开发编码规范》由会员上传分享,免费在线阅读,更多相关内容在教育资源-天天文库。
1、Python开发编码规范(13P)Python开发编码规范这篇文档所给出的编码约定适用于在主要的Python发布版本中组成标准库的Python代码,请查阅相关的关于在Python的C实现中C代码风格指南的描述。这篇文档改编自Guido最初的《Python风格指南》一文,并从《Barry'sstyleguide》中添加了部分内容。在有冲突的地方,Guide的风格规则应该是符合本(译注:指当有冲突时,应以Guido风格为准)。这篇PEP仍然尚未完PEP的意图成(实际上,它可能永远都不会完成)。在这篇风格指导中的一致
2、性是重要的。在一个项目内的一致性更重要。在一个模块或函数内的一致性最重要。但最重要的是:知道何时会不一致——有时只是没有实施风格指导。当出现疑惑时,运用你的最佳判断,看看别的例子,然后决定怎样看起来更好。并且要不耻下问~打破一条既定规则的两个好理由:(1)当应用这个规则是将导致代码可读性下降,即便对某人来说,他已经习惯于按这条规则来阅读代码了。(2)为了和周围的代码保持一致而打破规则(也许是历史原因),虽然这也是个清除其它混乱的好机会(真正的XP风格)。代码的布局缩进使用Emacs的Python-mode的默认
3、值:4个空格一个缩进层次。对于确实古老的代码,你不希望产生混乱,可以继续使用8空格的制表符(8-spacetabs)。EmacsPython-mode自动发现文件中主要的缩进层次,依此设定缩进参数。制表符还是空格永远不要混用制表符和空格。最流行的Python缩进方式是仅使用空格,其次是仅使用制表符,混合着制表符和空格缩进的代码将被转换成仅使用空格。(在Emacs中,选中整个缓冲区,按ESC-x去除制表符。)调用Python命令行解释器时使用-t选项,可对代码中不合法得混合制表符和空格发出警告,使用-tt时警告将
4、变成错误。这些选项是被高度推荐的。对于新的项目,强烈推荐仅使用空格而不是制表符。许多编辑器拥有使之易于实现的功能(在Emacs中,确认indent-tabs-mode是nil)。行的最大长度周围仍然有许多设备被限制在每行80字符:而且,窗口限制在80个字符。使将多个窗口并排放置成为可能。在这些设备上使用默认的折叠方式看起来有点丑陋。因此,请将所有行限制在最大79字符(Emacs准确得将行限制为长80字符),对顺序排放的大块文本(文档字符串或注释),推荐将长度限制在72字符。折叠长行的首选方法是使用Pyhon支持
5、的圆括号,方括号和花括号内的行延续。如果需要,你可以在表达式周围增加一对额外的圆括号,但是有时使用反斜杠看起来更好,确认恰当得缩进了延续的行。Emacs的Python-mode正确得完成了这些。一些例子:#!PythonclassRectangle(Blob):def__init__(self,width,height,color='black',emphasis=None,highlight=0):ifwidth==0andheight==0andcolor=='red'andemphasis=='stro
6、ng'orhighlight>100:raiseValueError,"sorry,youlose"ifwidth==0andheight==0and(color=='red'oremphasisisNone):raiseValueError,"Idon'tthinkso"width,height,color,emphasis,highlight)Blob.__init__(self,空行用两行空行分割顶层函数和类的定义,类内方法的定义用单个空行分割,额外的空行可被用于(保守的)分割相关函数组成的群,在一组相
7、关的单句中间可以省略空行。(例如:一组哑元素)。当空行用于分割方法的定义时,在‘class’行和第一个方法定义之间也要有一个空行。在函数中使用空行时,请谨慎的用于表示一个逻辑段落。Python接受contol-L(即^L)换页符作为空格:Emacs(和一些打印工具),视这个字符为页面分割符,因此在你的文件中,可以用他们来为相关片段分页。编码Python核心发布中的代码必须始终使用ASCII或Latin-1编码(又名ISO-8859-1),使用ASCII的文件不必有编码cookie,Latin-1仅当注释或文档字
8、符串涉及作者名字需要Latin-1时才被使用:另外使用x转义字符是在字符串中包含非ASCII(non-ASCII)数据的首选方法。作为PEP263实现代码的测试套件的部分文件是个例外。导入通常应该在单独的行中导入(Imports),例如:No:importsys,osYes:importsysimportos但是这样也是可以的:fromtypesimportStringType,Li
此文档下载收益归作者所有