Python开发编码规范.docx

Python 开发编码规范 目录 TOC \o "1-5" \h \z \o "Current Document" 代码的布局 3 缩进 3 制表符还是空格 ? 3 行的最大长度 3 空行 3 \o "Current Document" 编码 4 导入 4 空格 5 其它建议 (Other Recommendations) 6 注释 7 注释块 7 行内注释 7 文档化 8 版本注记 9 命名约定 9 2.7.1 描述 :命名风格 10 说明 :命名约定 11 应避免的名字 11 2.7.3.1 模块名 (Module Names) 11 类名 (Class Names) 11 异常名 (Exception Names) 11 全局变量名 (Global Variable Names) 12 函数名 (Function Names) 12 方法名和实例变量 (Method Names and Instance Variables) 12 继承的设计 (Designing for inheritance) 12 设计建议 (Programming Recommendations) 13 1 代码的布局 缩进 使用Emacs的Python-mode的默认值:4个空格一个缩进层次。 对于确实 古老的代码 ,你不希望产生混乱 ,可以继续使用 8空格的制表符 (8-space tabs)。 Emacs Pytho n-mode自动发现文件中主要的缩进层次,依此设定缩进参数。 制表符还是空格 ? 永远不要混用制表符和空格。最流行的 Python 缩进方式是仅使用空格 , 其次是仅使用制表符。 混合着制表符和空格缩进的代码将被转换成仅使用空 格。(在Emacs中,选中整个缓冲区，按ESC-x去除制表符(untabify)。)调用 python 命令行解释器时使用 -t 选项,可对代码中不合法得混合制表符和空格 发出警告(warnings)。使用-tt时警告(warnings)将变成错误(errors)。这些选项 是被高度推荐的。对于新的项目,强烈推荐仅使用空格(spaces-only而不是制 表 符 。 许 多编辑 器 拥有 使 之易于 实 现 的 功 能。 (在 Emacs 中 , 确认 indent-tabs-mode是 nil)。 行的最大长度 周围仍然有许多设备被限制在每行 80 字符;而且,窗口限制在 80 个字符 使将多个窗口并排放置成为可能。在这些设备上使用默认的折叠 (wrapping) 方式看起来有点丑陋。 因此，请将所有行限制在最大79字符(Emacs准确得 将行限制为长 80 字符), 对顺序排放的大块文本 (文档字符串或注释 ),推荐将 长度限制在72字符。折叠长行的首选方法是使用 Pyhon支持的圆括号 力括 号(brackets)和花括号(braces)内的行延续。如果需要，你可以在表达式周围增 加一对额外的圆括号 , 但是有时使用反斜杠看起来更好。确认恰当得缩进了 延续的行。Emacs的Python-mode正确得完成了这些。一些例子： Toggle line numbers class Rectangle(Blob)： 2 def __init__(self, width, height, color='black', emphasis=None, highlight=0)： if width == 0 and height == 0 and \ color == 'red' and emphasis == 'strong' or \ highlight > 100： raise ValueError, "sorry, you lose" if width == 0 and height == 0 and (color == 'red' or emphasis is None)： raise ValueError, "I don't think so" Blob。 __init__(self, width, height, color, emphasis, highlight) 空行 用两行空行分割顶层函数和类的定义 ,类内方法的定义用单个空行分割。 额外的空行可被用于(保守的(sparingly))分割相关函数组成的群 (groups of related functions)。 在一组相关的单句中间可以省略空行。 (例如。一组哑元 (a set of dummy implementations))。 当空行用于分害U方法 (method)的定义时, 在'class行和第一个方法定义之间也要有一个