logo资料库

Google Python Style Guide中文版.pdf

发布时间：2022-05-30 发布人：admin 分类：说明书 资料大小：0.31M 资料格式：pdf 举报 版权申诉
第1页 / 共27页
第2页 / 共27页
第3页 / 共27页
第4页 / 共27页
第5页 / 共27页
第6页 / 共27页
第7页 / 共27页
第8页 / 共27页
资料共27页，剩余部分请下载后查看
    Google Python 编程风格指南 原文出处：http://code.google.com/p/zh-google-styleguide/ 本文整理：li3p AT yahoo.cn 目录 Google Python 编程风格指南 ...................................................................................................... 1  Python 风格规范 .............................................................................................................................. 3  分号 ................................................................................................................................................ 3  行长度 ............................................................................................................................................ 3  括号 ................................................................................................................................................ 3  缩进 ................................................................................................................................................ 4  空行 ................................................................................................................................................ 4  空格 ................................................................................................................................................ 5  Python 解释器 .............................................................................................................................. 6  注释 ................................................................................................................................................ 6  类 .................................................................................................................................................... 9  字符串 ............................................................................................................................................ 9  TODO 注释 .................................................................................................................................. 10  导入格式 ...................................................................................................................................... 11  语句 .............................................................................................................................................. 11  访问控制 ...................................................................................................................................... 12  命名 .............................................................................................................................................. 12  Main ............................................................................................................................................. 13  Python 语言规范 ............................................................................................................................ 15  pychecker ................................................................................................................................. 15  导入 .............................................................................................................................................. 16  包 .................................................................................................................................................. 16  异常 .............................................................................................................................................. 17  全局变量 ...................................................................................................................................... 17    1
    嵌套/本地/内部类或函数 ........................................................................................................... 18  列表推导(List Comprehensions) ............................................................................................ 18  默认迭代器和操作符 .................................................................................................................. 19  生成器 .......................................................................................................................................... 20  Lambda 函数 ............................................................................................................................. 20  默认参数值 .................................................................................................................................. 21  属性(properties) ........................................................................................................................ 22  True/False 的求值 ...................................................................................................................... 23  过时的语言特性 .......................................................................................................................... 24  静态 Scoping(Lexical Scoping) ............................................................................................. 25  函数与方法装饰器 ...................................................................................................................... 26  线程 .............................................................................................................................................. 27  威力过大的特性 .......................................................................................................................... 27      2
    Python 风格规范 分号  不要在行尾加分号, 也不要用分号将两条命令放在同一行. 行长度  每行不超过 80 个字符 例外: 如果使用 Python 2.4 或更早的版本, 导入模块的行可能多于 80 个字符. Python 会将圆括号, 中括号和花括号中的行隐式的连接起来, 你可以利用这个特点. 如 果需要, 你可以在表达式外围增加一对额外的圆括号. Yes: foo_bar(self, width, height, color='black', design=None, x='foo', emphasis=None, highlight=0) if (width == 0 and height == 0 and color == 'red' and emphasis == 'strong'): 如果一个文本字符串在一行放不下, 可以使用圆括号来实现隐式行连接: x = ('This will build a very long long ' 'long long long long long long string') 注意上面例子中的元素缩进; 你可以在本文的 缩进 部分找到解释. 括号  宁缺毋滥的使用括号 除非是用于实现行连接, 否则不要在返回语句或条件语句中使用括号. 不过在元组两边使用 括号是可以的. Yes: if foo: bar() while x: x = bar() if x and y: bar() if not x:   3
    bar() return foo for (x, y) in dict.items(): ... No: if (x): bar() if not(x): bar() return (foo) 缩进  用 4 个空格来缩进代码 绝对不要用 tab, 也不要 tab 和空格混用. 对于行连接的情况, 你应该要么垂直对齐换行的 元素(见 行长度 部分的示例), 或者使用 4 空格的悬挂式缩进(这时第一行不应该有参数): Yes: # Aligned with opening delimiter foo = long_function_name(var_one, var_two, var_three, var_four) # 4-space hanging indent; nothing on first line foo = long_function_name( var_one, var_two, var_three, var_four) No: # Stuff on first line forbidden foo = long_function_name(var_one, var_two, var_three, var_four) # 2-space hanging indent forbidden foo = long_function_name( var_one, var_two, var_three, var_four) 空行  顶级定义之间空两行, 方法定义之间空一行 顶级定义之间空两行, 比如函数或者类定义. 方法定义, 类定义与第一个方法之间, 都应该 空一行. 函数或方法中, 某些地方要是你觉得合适, 就空一行.   4
    空格  按照标准的排版规范来使用标点两边的空格 1. 括号内不要有空格. Yes: spam(ham[1], {eggs: 2}, []) No: spam( ham[ 1 ], { eggs: 2 }, [ ] ) 2. 不要在逗号, 分号, 冒号前面加空格, 但应该在它们后面加(除了在行尾). Yes: if x == 4: print x, y x, y = y, x No: if x == 4 : print x , y x , y = y , x 3. 参数列表, 索引或切片的左括号前不应加空格. Yes: spam(1) Yes: spam (1) Yes: dict['key'] = list[index] No: dict ['key'] = list [index] 4. 在二元操作符两边都加上一个空格, 比如赋值(=), 比较(==, <, >, !=, <>, <=, >=, in, not in, is, is not), 布尔(and, or, not). 至于算术操作符两边的空格该如何使用, 需要你自己 好好判断. 不过两侧务必要保持一致. Yes: x == 1 No: x<1 5. 当’=’用于指示关键字参数或默认参数值时, 不要在其两侧使用空格. Yes: def complex(real, imag=0.0): return magic(r=real, i=imag) No: def complex(real, imag = 0.0): return magic(r = real, i = imag) 6. 不要用空格来垂直对齐多行间的标记, 因为这会成为维护的负担(适用于:, #, =等): Yes: foo = 1000 # comment long_name = 2 # comment that should not be aligned dictionary = {   5
    "foo": 1, "long_name": 2, } No: foo = 1000 # comment long_name = 2 # comment that should not be aligned dictionary = { "foo" : 1, "long_name": 2, } Python 解释器  每个模块都应该以#!/usr/bin/env python开头 模块应该以一个构造行开始, 以指定执行这个程序用到的 Python 解释器: #!/usr/bin/env python2.4 总是使用最特化的版本, 例如, 使用/usr/bin/python2.4, 而不是 /usr/bin/python2. 这样, 当升级到不同的 Python 版本时, 能轻松找到依赖关系, 同时也避免了使用时的迷惑. 例如, /usr/bin/python2 是表示/usr/bin/python2.0.1 还是/usr/bin/python2.3.0? 注释  确保对模块, 函数, 方法和行内注释使用正确的风格 文档字符串 Python 有一种独一无二的的注释方式: 使用文档字符串. 文档字符串是包, 模块, 类或函数 里的第一个语句. 这些字符串可以通过对象的__doc__成员被自动提取, 并且被 pydoc 所 用. (你可以在你的模块上运行 pydoc 试一把, 看看它长什么样). 我们对文档字符串的惯例 是使用三重双引号. 一个文档字符串应该这样组织: 首先是一行以句号, 问号或惊叹号结尾 的概述. 接着是一个空行. 接着是文档字符串剩下的部分, 它应该与文档字符串的第一行的 第一个引号对齐. 下面有更多文档字符串的格式化规范. 模块 每个文件应该包含下列项, 依次是: 1. 版权声明(例如, Copyright 2008 Google Inc.)   6
    2. 一个许可样板. 根据项目使用的许可(例如, Apache 2.0, BSD, LGPL, GPL), 选择合适 的样板 3. 作者声明, 标识文件的原作者. 函数和方法 如果不是既显然又简短, 任何函数或方法都需要一个文档字符串. 而且, 任何外部可访问的 函数或方法, 不管多短多简单, 都需要文档字符串. 文档字符串应该包含函数做什么, 以及 输入和输出的详细描述. 通常, 不应该描述”怎么做”, 除非是一些复杂的算法. 对于技巧 性的代码, 块注释或者行内注释是最重要的. 文档字符串应该提供足够的信息, 当别人编写 代码调用该函数时, 他不需要看一行代码, 只要看文档字符串就可以了. 应该给参数单独写 文档. 在冒号后跟上解释, 而且应该用统一的悬挂式2或4空格缩进. 文档字符串应该在需要 特定类型的地方指定期望的类型. “Raise:”部分应该列出该函数可能触发的所有异常. 生 成器函数的文档字符串应该用”Yields:”而非”Returns:”. def fetch_bigtable_rows(big_table, keys, other_silly_variable=None): """Fetches rows from a Bigtable. Retrieves rows pertaining to the given keys from the Table instance represented by big_table. Silly things may happen if other_silly_variable is not None. Args: big_table: An open Bigtable Table instance. keys: A sequence of strings representing the key of each table row to fetch. other_silly_variable: Another optional variable, that has a much longer name than the other args, and which does nothing. Returns: A dict mapping keys to the corresponding table row data fetched. Each row is represented as a tuple of strings. For example: {'Serak': ('Rigel VII', 'Preparer'), 'Zim': ('Irk', 'Invader'), 'Lrrr': ('Omicron Persei 8', 'Emperor')} If a key from the keys argument is missing from the dictionary, then that row was not found in the table. Raises: IOError: An error occurred accessing the bigtable.Table object. """ pass   7
    类  类应该在其定义下有一个用于描述该类的文档字符串. 如果你的类有公共属性 (Attributes), 那么文档中应该有一个属性(Attributes)段. 并且应该遵守和函数参数相 同的格式. class SampleClass(object): """Summary of class here. Longer class information.... Longer class information.... Attributes: likes_spam: A boolean indicating if we like SPAM or not. eggs: An integer count of the eggs we have laid. """ def __init__(self, likes_spam=False): """Inits SampleClass with blah.""" self.likes_spam = likes_spam self.eggs = 0 def public_method(self): """Performs operation blah.""" 块注释和行注释  最需要写注释的是代码中那些技巧性的部分. 如果你在下次代码走查的时候必须解释一 下, 那么你应该现在就给它写注释. 对于复杂的操作, 应该在其操作开始前写上若干行 注释. 对于不是一目了然的代码, 应在其行尾添加注释. # We use a weighted dictionary search to find out where i is in # the array. We extrapolate position based on the largest num # in the array and the array size and then do binary search to # get the exact number. if i & (i-1) == 0: # true iff i is a power of 2 为了提高可读性, 注释应该至少离开代码 2 个空格. 另一方面, 绝不要描述代码. 假设阅读代码的人比你更懂 Python, 他只是不知道你的代码要 做什么. # BAD COMMENT: Now go through the b array and make sure whenever i occurs # the next element is i+1   8
    分享到：
    赞 收藏

    相关推荐

    资料库

    开发技术

    共收录19306份资料，累计14个分类，关注成员有19位，主要包括：Actionscript,Javascript,PHP,VB,Perl,Delphi,Python,C#,C,Java,C++,Web开发,硬件开发,其它

    热门标签

    Actionscript Javascript PHP VB Perl Delphi Python C# C Java C++ Web开发 硬件开发 其它

    最新资料