Python 编码规范(Google Python Style Guide)

Python 编码规范是 Google 编写的用于 Python 代码风格规范化的指南，以下是它的完整攻略：

1. 基本规则

1. 代码采用 4 个空格的缩进方式。
2. 每行代码尽量不要超过 80 个字符，超过时可以使用续行符 \ 来实现换行。
3. 使用 Unix 风格的行尾分隔符 \n，避免使用 Windows 的 \r\n。
4. 文件名必须以 .py 结尾，全部使用小写字母，多单词时用下划线 _ 连接。
5. 使用 ASCII 或者 UTF-8 编码。

2. 命名规范

1. 函数、变量、方法和模块名使用小写字母，多单词时用下划线 _ 连接。
2. 类名使用帕斯卡命名法（PascalCase）。
3. 常量名全部大写，多单词时用下划线 _ 连接。

示例1：变量命名

# bad
some_name = 1
SomeName = 2

# good
some_name = 1
some_name_2 = 2

示例2：类名命名

# bad
class some_class:
    pass

class SomeClass:
    pass

# good
class SomeClassName:
    pass

3. 注释规范

1. 每个函数、方法、类应该有注释，定义注释应该以三个双引号 """ 开始和结束。
2. 行内注释使用 # 开始。
3. 注释中避免使用无意义的信息，注释应该简明扼要地说明代码的意义和作用。
4. 注释应该使用英文书写，避免使用中文。

示例3：注释规范

def add(a, b):
    """
    Adds two numbers.

    Args:
        a: An integer, the first number to add.
        b: An integer, the second number to add.

    Returns:
        The sum of a and b.
    """
    return a + b

4. 代码块规范

1. 函数和类定义的一组行最后应该留一个空行。
2. 复合语句的首行应该用括号包含，括号和其包含的第一个语句应该放在同一行。

示例4：代码块规范

def add(a, b):
    """
    Adds two numbers.

    Args:
        a: An integer, the first number to add.
        b: An integer, the second number to add.

    Returns:
        The sum of a and b.
    """

    result = (
        a + b
    )
    return result

5. 其他规范

1. 导入应该总是放在文件开头。
2. 异常捕捉应该具体到错误类型。
3. 尽量避免复杂的推导式和嵌套式。
4. 不要使用单字符的变量名，除非只使用一次。

示例5：异常捕捉规范

try:
    do_something()
except ValueError:
    raise CustomValueError('An error occurred.')
except Exception as exc:
    logger.exception('An error occurred: %s', exc)

总的来说，了解 Python 编码规范对于编写高质量的代码和卓越的代码风格具有至关重要的作用，也是社区公认的好习惯。因此，在写代码的时候应该尽量贴合这些规范，养成良好的编码习惯。