PEP8规范总结

缩进

• 不要使用 tab 缩进
• 使用任何编辑器写 Python，请把一个 tab 展开为 4 个空格
• 绝对不要混用 tab 和空格，否则容易出现 IndentationError

空格

• 在 list, dict, tuple, set, 参数列表的 , 后面加一个空格
• 在 dict 的 : 后面加一个空格
• 在注释符号 # 后面加一个空格，但是 #!/usr/bin/python 的 # 后不能有空格
• 操作符两端加一个空格，如 +, -, *, /, |, &, =
• 接上一条，在参数列表里的 = 两端不需要空格
• 括号（(), {}, []）内的两端不需要空格

空行

• function 和 class 顶上两个空行
• class 的 method 之间一个空行
• 函数内逻辑无关的段落之间空一行，不要过度使用空行
• 不要把多个语句写在一行，然后用 ; 隔开
• if/for/while 语句中，即使执行语句只有一句，也要另起一行

换行

每一行代码控制在 80 字符以内
使用 \ 或 () 控制换行，举例：

def foo(first, second, third, fourth, fifth,
        sixth, and_some_other_very_long_param):
    user = User.objects.filter_by(first=first, second=second, third=third) \
        .skip(100).limit(100) \
        .all()

text = ('Long strings can be made up '
        'of several shorter strings.')

import

• 所有 import 尽量放在文件开头，在 docstring 下面，其他变量定义的上面
• 不要使用 from foo imort *
• import 需要分组，每组之间一个空行，每个分组内的顺序尽量采用字典序，分组顺序是：
• 标准库
• 第三方库
• 本项目的 package 和 module

# bad
import sys, os, time

# good
import os
import sys
import time

# ok
from flask import Flask, render_template, jsonify

注释

文档字符串 docstring, 是 package, module, class, method, function 级别的注释，可以通过 doc 成员访问到，注释内容在一对 “”" 符号之间
function, method 的文档字符串应当描述其功能、输入参数、返回值，如果有复杂的算法和实现，也需要写清楚
不要写错误的注释，不要无谓的注释

# bad 无谓的注释
x = x + 1       # increase x by 1

# bad 错误的注释
x = x - 1       # increase x by 1 
1
2
3
4
5
优先使用英文写注释，英文不好全部写中文，否则更加看不懂