Python编程代码规范（Google Style）

原文：https://www.jianshu.com/p/8b6c425b65a6

在编程过程中，要遵循一定的规则，包括函数命名、变量命名、代码注释等，虽然不遵循也能使代码运行成功，但优秀的、整洁的代码必定是遵循潜移默化的一些规则，这样别人阅读起来也会很轻松，否则将来甚至自己也看不懂。为了能及时发现问题，可使用python的IDLE来编写，如pycharm等工具遵循PEP 8规则，会自动发现并提示代码存在的问题

本文目录如下

目录

一、简明概述

1 编码

2 代码格式

2.1 缩进

2.2 行宽

2.3 引号

2.4 空行

3 import语句

4 空格

5 换行

二 注释

1 文件注释

2 块注释

3 行注释

4 Docstring

三 命名规范

1 模块

2 类名

3 函数

4 变量名

5 常量

一、简明概述

1 编码

• 如无特殊情况, 文件一律使用 UTF-8 编码
• 如无特殊情况, 文件头部需加入python翻译器的位置信息

# -*- coding: utf-8 -*-
#! /usr/bin/env python3

2 代码格式

2.1 缩进

• 统一使用4个空格进行缩进

2.2 行宽

每行代码尽量不超过 80 个字符(在特殊情况下可以略微超过 80 ，但最长不得超过 120)。理由：

• 这在查看 side-by-side 的 diff 时很有帮助
• 方便在控制台下查看代码
• 太长可能是设计有缺陷

2.3 引号

• 自然语言使用双引号 "..."，例如错误信息；很多情况还是 unicode，使用u"你好世界"
• 机器标识使用单引号 '...'，例如 dict 里的 key
• 正则表达式使用原生的双引号 r"..."
• 文档字符串 (docstring) 使用三个双引号 """......"""

2.4 空行

• 顶级定义之间空两行, 比如函数或者类定义
• 方法定义, 类定义与第一个方法之间, 都应该空一行

class A:

    def __init__(self):
        pass

    def hello(self):
        pass


def main():
    pass   

• 可以使用多个空行分隔多组相关的函数
• 函数中可以使用空行分隔出逻辑相关的代码

3 import语句

• import 语句应该分行书写

# 正确的写法
import os
import sys

# 不推荐的写法
import sys,os

# 正确的写法
from subprocess import Popen, PIPE

• import语句应该使用 absolute import

# 正确的写法
from foo.bar import Bar

# 不推荐的写法
from ..bar import Bar

• import语句应该放在文件头部，置于模块说明及docstring之后，于全局变量之前；
• import语句应该按照顺序排列，每组之间用一个空行分隔
• 导入顺序为：python标准库、第三方库、自己的库

import os
import sys

import msgpack
import zmq

import foo

• 导入其他模块的类定义时，可以使用相对导入

from myclass import MyClass

• 如果发生命名冲突，则可使用命名空间

import bar
import foo.bar

bar.Bar()
foo.bar.Bar()

4 空格

• 在二元运算符两边各空一格[=,-,+=,==,>,in,is not, and]:

# 正确的写法
i = i + 1
submitted += 1
x = x * 2 - 1
hypot2 = x * x + y * y
c = (a + b) * (a - b)

# 不推荐的写法
i=i+1
submitted +=1
x = x*2 - 1
hypot2 = x*x + y*y
c = (a+b) * (a-b)

• 函数的参数列表中，,之后要有空格

# 正确的写法
def complex(real, imag):
    pass

# 不推荐的写法
def complex(real,imag):
    pass

• 函数的参数列表中，默认值等号两边不要添加空格

# 正确的写法
def complex(real, imag=0.0):
    pass

# 不推荐的写法
def complex(real, imag = 0.0):
    pass

• 左括号之后，右括号之前不要加多余的空格

# 正确的写法
spam(ham[1], {eggs: 2})

# 不推荐的写法
spam( ham[1], { eggs : 2 } )

• 字典对象的左括号之前不要多余的空格

# 正确的写法
dict['key'] = list[index]

# 不推荐的写法
dict ['key'] = list [index]

• 不要为对齐赋值语句而使用的额外空格

# 正确的写法
x = 1
y = 2
long_variable = 3

# 不推荐的写法
x             = 1
y             = 2
long_variable = 3

5 换行

Python 支持括号内的换行。这时有两种情况。

• 1 第二行缩进到括号的起始处

foo = long_function_name(var_one, var_two,
                         var_three, var_four)

• 2 第二行缩进 4 个空格，适用于起始括号就换行的情形

def long_function_name(
        var_one, var_two, var_three,
        var_four):
    print(var_one)

使用反斜杠\换行，二元运算符+ .等应出现在行末；长字符串也可以用此法换行

session.query(MyTable).\
        filter_by(id=1).\
        one()

print 'Hello, '\
      '%s %s!' %\
      ('Harry', 'Potter')

禁止复合语句，即一行中包含多个语句：

# 正确的写法
do_first()
do_second()
do_third()

# 不推荐的写法
do_first();do_second();do_third();

if/for/while一定要换行：

# 正确的写法
if foo == 'blah':
    do_blah_thing()

# 不推荐的写法
if foo == 'blah': do_blash_thing()

二 注释

1 文件注释

 在文件的最开头，可以添加文件的版权、许可声明、作者、日期、版本等信息，如

# **********************************************************
# * Author        : xxxxxx
# * Email         : [email protected]
# * Create time   : 2018-04-22 19:26
# * Filename      : collect-sys-msg.py
# * Description   :
# **********************************************************

2 块注释

“#”号后空一格，段落件用空行分开（同样需要“#”号）

# 块注释
# 块注释
#
# 块注释
# 块注释

3 行注释

至少使用两个空格和语句分开，注意不要使用无意义的注释

# 正确的写法
x = x + 1  # 边框加粗一个像素

# 不推荐的写法(无意义的注释)
x = x + 1 # x加1

• 在代码的关键部分(或比较复杂的地方), 能写注释的要尽量写注释
• 比较重要的注释段, 使用多个等号隔开, 可以更加醒目, 突出重要性

app = create_app(name, options)


# =====================================
# 请勿在此处添加 get post等app路由行为 !!!
# =====================================


if __name__ == '__main__':
    app.run()

4 Docstring

作为文档的Docstring一般出现在模块头部、函数和类的头部，这样在python中可以通过对象的__doc__对象获取文档。简单来说，就是出现在模块、函数、类、方法里第一个语句的，就是docstring，会自动变成属性__doc__，比如

def foo():
  """ This is function foo"""

 可通过foo.__doc__访问得到' This is function foo'.

• Docstring以 """ 开头和结尾, 首行不换行, 如有多行, 末行必须换行, 以下是Google的docstring风格示例

"""
This is a groups style docs.
 
Parameters:
  param1 - this is the first param
  param2 - this is a second param
 
Returns:
  This is a description of what is returned
 
Raises:
  KeyError - raises an exception
"""

三 命名规范

1 模块

• 模块尽量使用小写命名，首字母保持小写，尽量不要用下划线(除非多个单词，且数量不多的情况)

# 正确的模块名
import decoder
import html_parser

# 不推荐的模块名
import Decoder

2 类名

• 类名使用驼峰(CamelCase)命名风格，首字母大写，私有类可用一个下划线开头

class Farm():
    pass

class AnimalFarm(Farm):
    pass

class _PrivateFarm(Farm):
    pass

• 将相关的类和顶级函数放在同一个模块里. 不像Java, 没必要限制一个类一个模块.

3 函数

• 函数名一律小写，如有多个单词，用下划线隔开

def run():
    pass

def run_with_env():
    pass

• 私有函数在函数前加一个下划线_

class Person():

    def _private_func():
        pass

4 变量名

• 变量名尽量小写, 如有多个单词，用下划线隔开

if __name__ == '__main__':
    count = 0
    school_name = ''

5 常量

• 常量采用全大写，如有多个单词，使用下划线隔开

MAX_CLIENT = 100
MAX_CONNECTION = 1000
CONNECTION_TIMEOUT = 600