Python开发编码规范.docxVIP

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

Python开辟编码规范

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

目录

1代码的布局 3

1。1缩进 3

1.2制表符还是空格? 3

1.3行的最大长度 3

1。4空行 4

2编码 5

2.1导入 5

2.2空格 6

2。3其它建议(OtherRecommendations) 8

2.4注释 10

2。4.1注释块 11

2。4.2行内注释 11

2。5文档化 12

2.6版本注记 14

2.7命名约定 15

2.7.1描述：命名风格 15

2。7。2说明：命名约定 17

2.7.3应避免的名字 17

2。7。3。1 模块名(ModuleNames)18

2。7.3.2 类名(ClassNames)18

2。7。3.3 异常名(ExceptionNames)18

2.7。3。4 全局变量名(GlobalVariableNames)19

2.7。3.5 函数名(FunctionNames)19

2.7.3。6方法名和实例变量(MethodNamesandInstanceVariables)19

2。7。3.7 继承的设计(Designingforinheritance)20

3设计建议(ProgrammingRecommendations) 21

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

1代码的布局

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正确得完成为了这些.一些例子：

Togglelinenumbers

1classRectangle(Blob):

(完整版)Python开辟编码规范2

3def__init__(self，width，height，

4

color=’black’,emphasis=None,highlight=0):

5ifwidth==0andheight==

0and\

color==red’andemphasis

==strong’or\

highlight〉100：

6

ValueError,”sorry，youlose

7

0and