Python 编码规范(Google)

小咪咪 2023-10-15 19:12 201阅读 0赞

Python 风格规范(Google)

本项目并非 Google 官方项目, 而是由国内程序员凭热情创建和维护。

如果你关注的是 Google 官方英文版, 请移步 [Google Style Guide][]

以下代码中 **Yes** 表示推荐，**No** 表示不推荐。

--------------------

### 分号 ###

不要在行尾加分号, 也不要用分号将两条命令放在同一行。

--------------------

### 行长度 ###

每行不超过80个字符

以下情况除外：

1.  长的导入模块语句
2.  注释里的URL

不要使用反斜杠连接行。

Python会将 [圆括号, 中括号和花括号中的行隐式的连接起来][Link 1] , 你可以利用这个特点. 如果需要, 你可以在表达式外围增加一对额外的圆括号。

推荐: 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 = ('这是一个非常长非常长非常长非常长 '
         '非常长非常长非常长非常长非常长非常长的字符串')

在注释中，如果必要，将长的URL放在一行上。

Yes:  # See details at
          # http://www.example.com/us/developer/documentation/api/content/v2.0/csv_file_name_extension_full_specification.html

No:  # See details at
         # http://www.example.com/us/developer/documentation/api/content/\
         # v2.0/csv_file_name_extension_full_specification.html

注意上面例子中的元素缩进; 你可以在本文的 :ref:\`缩进 <indentation>\`部分找到解释.

--------------------

### 括号 ###

宁缺毋滥的使用括号

除非是用于实现行连接, 否则不要在返回语句或条件语句中使用括号. 不过在元组两边使用括号是可以的.

Yes: if foo:
             bar()
         while x:
             x = bar()
         if x and y:
             bar()
         if not x:
             bar()
         return foo
         for (x, y) in dict.items(): ...

No:  if (x):
             bar()
         if not(x):
             bar()
         return (foo)

--------------------

### 缩进 ###

用4个空格来缩进代码

绝对不要用tab, 也不要tab和空格混用. 对于行连接的情况, 你应该要么垂直对齐换行的元素(见 :ref:\`行长度 <line\_length>\` 部分的示例), 或者使用4空格的悬挂式缩进(这时第一行不应该有参数):

Yes:   # 与起始变量对齐
           foo = long_function_name(var_one, var_two,
                                    var_three, var_four)
    
           # 字典中与起始值对齐
           foo = {
               long_dictionary_key: value1 +
                                    value2,
               ...
           }
    
           # 4 个空格缩进，第一行不需要
           foo = long_function_name(
               var_one, var_two, var_three,
               var_four)
    
           # 字典中 4 个空格缩进
           foo = {
               long_dictionary_key:
                   long_dictionary_value,
               ...
           }

No:    # 第一行有空格是禁止的
          foo = long_function_name(var_one, var_two,
              var_three, var_four)
    
          # 2 个空格是禁止的
          foo = long_function_name(
            var_one, var_two, var_three,
            var_four)
    
          # 字典中没有处理缩进
          foo = {
              long_dictionary_key:
                  long_dictionary_value,
                  ...
          }

--------------------

### 空行 ###

顶级定义之间空两行, 方法定义之间空一行

顶级定义之间空两行, 比如函数或者类定义. 方法定义, 类定义与第一个方法之间, 都应该空一行. 函数或方法中, 某些地方要是你觉得合适, 就空一行.

--------------------

### 空格 ###

按照标准的排版规范来使用标点两边的空格

括号内不要有空格.

按照标准的排版规范来使用标点两边的空格

Yes: spam(ham[1], {eggs: 2}, [])

No:  spam( ham[ 1 ], { eggs: 2 }, [ ] )

不要在逗号, 分号, 冒号前面加空格, 但应该在它们后面加(行尾除外).

Yes: if x == 4:
             print x, y
         x, y = y, x

No:  if x == 4 :
             print x , y
         x , y = y , x

参数列表, 索引或切片的左括号前不应加空格.

Yes: spam(1)
    
    no: spam (1)
    
    Yes: dict['key'] = list[index]
    
    No:  dict ['key'] = list [index]

在二元操作符两边都加上一个空格, 比如赋值(=), 比较(==, <, >, !=, <>, <=, >=, in, not in, is, is not), 布尔(and, or, not). 至于算术操作符两边的空格该如何使用, 需要你自己好好判断. 不过两侧务必要保持一致.

Yes: x == 1
    
    No:  x<1

当'='用于指示关键字参数或默认参数值时, 不要在其两侧使用空格.

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)

不要用空格来垂直对齐多行间的标记, 因为这会成为维护的负担(适用于:, \#, =等):

Yes:
         foo = 1000  # 注释
         long_name = 2  # 注释不需要对齐
    
         dictionary = {
             "foo": 1,
             "long_name": 2,
             }

No:
         foo       = 1000  # 注释
         long_name = 2     # 注释不需要对齐
    
         dictionary = {
             "foo"      : 1,
             "long_name": 2,
             }

--------------------

### 命名 ###

module\_name, package\_name, ClassName, method\_name, ExceptionName, function\_name, GLOBAL\_VAR\_NAME, instance\_var\_name, function\_parameter\_name, local\_var\_name.

**应该避免的名称**

> 1.  单字符名称, 除了计数器和迭代器.
> 2.  包/模块名中的连字符(-)
> 3.  双下划线开头并结尾的名称(Python保留, 例如\_\_init\_\_)

**命名约定**

> 1.  所谓"内部(Internal)"表示仅模块内可用, 或者, 在类内是保护或私有的.
> 2.  用单下划线(\_)开头表示模块变量或函数是protected的(使用import \* from时不会包含).
> 3.  用双下划线(\_\_)开头的实例变量或方法表示类内私有.
> 4.  将相关的类和顶级函数放在同一个模块里. 不像Java, 没必要限制一个类一个模块.
> 5.  对类名使用大写字母开头的单词(如CapWords, 即Pascal风格), 但是模块名应该用小写加下划线的方式(如lower\_with\_under.py). 尽管已经有很多现存的模块使用类似于CapWords.py这样的命名, 但现在已经不鼓励这样做, 因为如果模块名碰巧和类名一致, 这会让人困扰.

**Python之父Guido推荐的规范**

<table style="width:500px;"> 
 <tbody> 
  <tr> 
   <th>Type</th> 
   <th>Public</th> 
   <th>Internal</th> 
  </tr> 
  <tr> 
   <td>Modules</td> 
   <td>lower_with_under</td> 
   <td>_lower_with_under</td> 
  </tr> 
  <tr> 
   <td>Packages</td> 
   <td>lower_with_under</td> 
   <td></td> 
  </tr> 
  <tr> 
   <td>Classes</td> 
   <td>CapWords</td> 
   <td>_CapWords</td> 
  </tr> 
  <tr> 
   <td>Exceptions</td> 
   <td>CapWords</td> 
   <td></td> 
  </tr> 
  <tr> 
   <td>Functions</td> 
   <td>lower_with_under()</td> 
   <td>_lower_with_under()</td> 
  </tr> 
  <tr> 
   <td>Global/Class Constants</td> 
   <td>CAPS_WITH_UNDER</td> 
   <td>_CAPS_WITH_UNDER</td> 
  </tr> 
  <tr> 
   <td>Global/Class Variables</td> 
   <td>lower_with_under</td> 
   <td>_lower_with_under</td> 
  </tr> 
  <tr> 
   <td>Instance Variables</td> 
   <td>lower_with_under</td> 
   <td>_lower_with_under (protected) or __lower_with_under (private)</td> 
  </tr> 
  <tr> 
   <td>Method Names</td> 
   <td>lower_with_under()</td> 
   <td>_lower_with_under() (protected) or __lower_with_under() (private)</td> 
  </tr> 
  <tr> 
   <td>Function/Method Parameters</td> 
   <td>lower_with_under</td> 
   <td></td> 
  </tr> 
  <tr> 
   <td>Local Variables</td> 
   <td>lower_with_under</td> 
   <td></td> 
  </tr> 
 </tbody> 
</table>

--------------------

### Main ###

即使是一个打算被用作脚本的文件, 也应该是可导入的. 并且简单的导入不应该导致这个脚本的主功能(main functionality)被执行, 这是一种副作用. 主功能应该放在一个main()函数中.

在Python中, pydoc以及单元测试要求模块必须是可导入的. 你的代码应该在执行主程序前总是检查 `if __name__ == '__main__'` , 这样当模块被导入时主程序就不会被执行.

def main():
          ...
    
    if __name__ == '__main__':
        main()

所有的顶级代码在模块导入时都会被执行. 要小心不要去调用函数, 创建对象, 或者执行那些不应该在使用pydoc时执行的操作.

[Google Style Guide]: https://google.github.io/styleguide/pyguide.html
[Link 1]: http://docs.python.org/2/reference/lexical_analysis.html#implicit-line-joining