Python开发编码规范

Python开发编码规范

PythonCodingRule

译稿 Python开发编码规范

1. Python开发编码规范

--- hoxide 初译 dreamingk 校对发布 040724 --- xyb 重新排版 040915

--- ZoomQuiet MoinMoin 美化 050610

用Python进行开发时的编码风格约定 原文:epes:PEP 008《Style Guide for Python Code》

1.1. 介绍

这篇文档所给出的编码约定适用于在主要的Python发布版本中组成标准库的Python 代码.请查阅相关的关于在Python的C实现中C代码风格指南的描述.

这篇文档改编自Guido最初的《Python风格指南》一文. 并从《Barry's style guide》中添加了部分内容. 在有冲突的地方，Guide的风格规则应该是符合本PEP的意图 (译注：就是当有冲突时，应以Guido风格为准) 这篇PEP也许仍然尚未完成(实际上，它可能永远不会结束).

1.2. 一致性的建议

愚蠢得使用一致性是无知的妖怪(A Foolish Consistency is the Hobgoblin of Little Minds)

呆板的坚持一致性是傻的没边了! -- Zoomq

在这篇风格指导中的一致性是重要的. 在一个项目内的一致性更重要. 在一个模块或函数内的一致性最重要.

但最重要的是:知道何时会不一致 -- 有时只是没有实施风格指导.当出现疑惑时,

1.Python开发编码规范1.介绍

2.一致性的建议3.代码的布局1.缩进

2.制表符还是空格?3.行的最大长度4.空行5.编码4.导入5.空格

1.其它建议6.注释

1.注释块2.行内注释7.文档化8.版本注记9.命名约定

1.描述:命名风格2.说明:命名约定1.应避免的名字2.模块名3.类名4.异常名5.全局变量名6.函数名

7.方法名和实例变量8.继承的设计

10.设计建议

Python开发编码规范

Python开发编码规范

折叠长行的首选方法是使用Pyhon支持的圆括号,方括号(brackets)和花括号(braces)内的行延续. 如果需要,你可以在表达式周围增加一对额外的圆括号, 但是有时使用反斜杠看起来更好.确认恰当得缩进了延续的行. Emacs的Python-mode正确得完成了这些.一些例子:Toggle line numbers

1 class Rectangle(Blob):

2

3 def __init__(self, width, height,

4 color='black', emphasis=None, highlight=0):

5 if width == 0 and height == 0 and \

color == 'red' and emphasis == 'strong' or \

highlight > 100:

6 raise ValueError, "sorry, you lose"

7 if width == 0 and height == 0 and (color == 'red' or

8 emphasis is None): 9 raise ValueError, "I don't think so"

10 Blob.__init__(self, width, height,

11 color, emphasis, highlight)

1.3.4. 空行

(Blank Lines)

用两行空行分割顶层函数和类的定义,类内方法的定义用单个空行分割. 额外的空行可被用于(保守的(sparingly))分割相关函数组成的群(groups of related functions). 在一组相关的单句中间可以省略空行.(例如.一组哑元(a set of dummy implementations)).

当空行用于分割方法(method)的定义时,在'class'行和第一个方法定义之间也要有一个空行.

在函数中使用空行时,请谨慎的用于表示一个逻辑段落(indicate logical sections).

Python接受contol-L(即^L)换页符作为空格;Emacs(和一些打印工具) 视这个字符为页面分割符,因此在你的文件中,可以用他们来为相关片段(sections)分页.

1.3.5. 编码

(Encodings)epes:(PEP 263)

Python核心发布中的代码必须始终使用ASCII或Latin-1编码(又名 ISO-8859-1). 使用ASCII的文件不必有译码cookie(coding http://wendang.chazidian.comtin-1仅当注释或文档字符串涉及作者名字需要Latin-1时才被使用; 另外使用\x转义字符是在字符串中包含非ASCII(non-ASCII)数据

Python开发编码规范

的首选方法. 作为PEP 263实现代码的测试套件的部分文件是个例外.

Python 2.4 以后内核支持 Unicode 了！

不论什么情况使用 UTF-8 吧！这是王道！

--ZoomQuiet

1.4. 导入

(Imports)

通常应该在单独的行中导入(Imports),例如:

No: import sys, os

Yes: import sys

import os

但是这样也是可以的:

from types import StringType, ListType

Imports 通常被放置在文件的顶部,仅在模块注释和文档字符串之后,在模块的全局变量和常量之前.Imports应该有顺序地成组安放.

1.标准库的导入(Imports )

2.相关的主包(major package)的导入(即,所有的email包在随后导入)

3.特定应用的导入(imports)你应该在每组导入之间放置一个空行.

对于内部包的导入是不推荐使用相对导入的.对所有导入都要使用包的绝对路径.

从一个包含类的模块中导入类时,通常可以写成这样:

from MyClass import MyClass

from foo.bar.YourClass import YourClass

如果这样写导致了本地名字冲突,那么就这样写

import MyClass

Python开发编码规范

import foo.bar.YourClass

即使用"MyClass.MyClass"和"foo.bar.YourClass.YourClass"

1.5. 空格

(Whitespace in Expressions and Statements)

Guido不喜欢在以下地方出现空格:

"spam( ham[ 1 ], { eggs: 2 } )". Always write this as "spam(ham[1], {eggs: 2})".

紧挨着圆括号,方括号和花括号的,如:"spam( ham[ 1 ], { eggs: 2 } )".

要始终将它写成"spam(ham[1], {eggs: 2})".

"if x == 4 : print x , y ; x , y = y , x". Always write this as "if x == 4: print x, y; x, y = y, x".

紧贴在逗号,分号或冒号前的,如:

"if x == 4 : print x , y ; x , y = y , x". 要始终将它写成 "if x == 4: print x, y; x, y = y, x".

紧贴着函数调用的参数列表前开式括号(open parenthesis )的,如"spam (1)".要始终将它写成"spam(1)". slicing, as in: "dict ['key'] = list [index]". Always write this as "dict['key'] = list[index]".

紧贴在索引或切片(slicing?下标?)开始的开式括号前的,如:

"dict ['key'] = list [index]".要始终将它写成"dict['key'] = list[index]".

在赋值(或其它)运算符周围的用于和其它并排的一个以上的空格,如:

Toggle line numbers

1 x = 1

2 y = 2

3 long_variable = 3

要始终将它写成

Toggle line numbers

1 x = 1

2 y = 2

3 long_variable = 3