一、简介

PEP 8 是一份针对 Python 代码格式而编订的风格指南。尽管只要语法正确，代码随便怎么写都行，但采用一致的风格可以使代码更易读、更易懂。如果你的代码风格和其他 Python 程序员的相同，那么就能够更加顺利地与大家一起做项目。即便你的代码只给自己看，也应该按照这套风格来写，以便以后修改更加容易一些，而且能够避开很多常见的错误。

PEP 8 非常详细地描述了如何编写清晰的 Python 代码，而且会随着 Python 语言的发展持续更新。大家应该把完整指南阅读一遍。

官方文档：https://www.python.org/dev/peps/pep-0008/

二、注意点

2.1 与空白有关的建议

在 Python 中，空白（whitespace）在语法上相当重要。Python 程序员对空白字符的用法尤其在意，因为它们会影响代码的清晰程度。在这方面，大家应该遵循以下几条建议。

用空格（space）表示缩进，而不要用制表符（tab），Python 禁止在缩进中混合使用制表符和空格。
和语法相关的每一层缩进都用 4 个空格表示。
每行不超过 79 个字符。
对于占据多行的长表达式来说，除了首行之外的其余各行都应该在通常的缩进级别之上再加 4 个空格。

# Correct:

# Aligned with opening delimiter.
foo = long_function_name(var_one, var_two,
                         var_three, var_four)

# Add 4 spaces (an extra level of indentation) to distinguish arguments from the rest.
def long_function_name(
        var_one, var_two, var_three,
        var_four):
    print(var_one)

# Hanging indents should add a level.
foo = long_function_name(
    var_one, var_two,
    var_three, var_four)

在同一份文件中，函数与类之间用两个空行隔开。
在同一个类中，方法与方法之间用一个空行隔开。
使用字典（dict）时，键与冒号之间不加空格，写在同一行的冒号和值之间应该加一个空格。
给变量赋值时，赋值符号的左边和右边各加一个空格，并且只加一个空格就好。
给变量的类型做注解（annotation）时，不要把变量名和冒号隔开，但在类型信息前应该有一个空格。

2.2 与命名有关的建议

PEP 8 建议采用不同的方式来给 Python 代码中的各个部分命名，这样在阅读代码时，就可以根据这些名称看出它们在 Python 语言中的角色。遵循以下与命名相关的建议。

函数、变量及属性用小写字母来拼写，各单词之间用下划线相连，例如：lowercase_underscore 。
受保护的实例属性，用一个下划线开头，例如：_leading_underscore 。
私有的实例属性，用两个下划线开头，例如：__double_leading_underscore 。
类（包括异常）命名时，每个单词的首字母均大写，例如：CapitalizedWord 。
模块级别的常量，所有字母都大写，各单词之间用下划线相连，例如：ALL_CAPS 。
类中的实例方法，应该把第一个参数命名为 self，用来表示该对象本身。
类方法的第一个参数，应该命名为 cls，用来表示这个类本身。

2.3 与表达式和语句有关的建议

The Zen of Python 中提到：“每件事都应该有简单的做法，而且最好只有一种。”PEP 8 就试着运用这个理念，来规范表达式和语句的写法。

采用行内否定即把否定词直接写在要否定的内容前面，而不要放在整个表达式的前面。

# Correct:
if foo is not None:

# Wrong:
if not foo is None:

不要通过长度判断容器或序列是不是空的，例如不要通过 if len(somelist) == 0 判断 somelist 是否为 [] 或 ‘’ 等空值，而是应该采用 if not somelist 这样的写法来判断，因为 Python 会把空值自动评估为 False 。
如果要判断容器或序列里面有没有内容（比如要判断 somelist 是否为 [1] 或 'hi ’ 这样非空的值），也不应该通过长度来判断，而是应该采用 if somelist 语句，因为 Python 会把非空的值自动判定为 True 。
不要把 if 语句、for 循环、while 循环及 except 复合语句挤在一行。应该把这些语句分成多行来写，这样更加清晰。
如果表达式一行写不下，可以用括号将其括起来，而且要适当地添加换行与缩进，以便于阅读。
多行的表达式，应该用括号括起来，而不要用 \ 符号续行。

2.4 与引入有关的建议

PEP 8 对于怎样在代码中引入并使用模块，给出了下面几条建议。

import 语句（含 from x import y）总是应该放在文件开头。
导入通常应该在单独的行上。

# Correct:
import os
import sys
from subprocess import Popen, PIPE

# Wrong:
import sys, os

引入模块时，总是应该使用绝对名称，而不应该根据当前模块路径而使用相对名称。例如，要引入 bar 包中的 foo 模块，应该完整地写出 from bar import foo，即便当前路径为 bar 包里，也不应该简写为 import foo 。

import mypkg.sibling
from mypkg import sibling
from mypkg.sibling import example

如果一定要用相对名称来编写 import 语句，那就应该明确地写成：from . import foo 。

from . import sibling
from .sibling import example

文件中的 import 语句应该按顺序划分成三个部分：首先引入标准库里的模块，然后引入第三方模块，最后引入自己的模块。属于同一个部分的 import 语句按字母顺序排列。

import os
import requset
from foo import example

Python 进阶（一）PEP 8 代码风格指南

文章目录