本文为PEP: 8 Style Guide for Python Code的整理，用于规范python日常代码。
1、缩进与续航
（1）每一级缩进使用4个空格。
虽然tab键用起来很爽，但规范角度而言，python的缩进是4个空格，我们可以设置pycharm，把Tab键设置成4个空格。
（2）续行与包裹元素对齐
例如当包裹元素为括号时，续航与左括号对齐
# 正确写法
foo = long_function_name(var_one, var_two,
var_three, var_four)
----------------------------------------------------------------------
# 错误写法
foo = long_function_name(var_one, var_two,
var_three, var_four)
（3）续航与运算符位置
如果需要续航，加减乘除运算符在续航前还是续航后显示？（蛮特别的！）
# 正确写法
income = (gross_wages
+ taxable_interest
+ (dividends - qualified_dividends)
- ira_deduction
- student_loan_interest)
----------------------------------------------------------------------
# 错误写法
income = (gross_wages +
taxable_interest +
(dividends - qualified_dividends) -
ira_deduction -
student_loan_interest)
2、行的最大长度
（1）代码行长度
Python标准库比较保守，需要将行宽限制在79个字符（文档/注释限制在72），当然每次去算有没有超过79个字符之类的肯定不合理的，pycharm支持设置。
File→Settings→Code Style→Right margin (columns) 的值为79
（2）多用括号续航
- 较长的代码行选择Python在小括号，中括号以及大括号中的隐式续行方式
- 通过小括号内表达式的换行方式将长串折成多行。这种方式应该优先使用，而不是使用反斜杠续行。
# 优先使用括号续航
d = (a +
c)
----------------------------------------------------------------------
# 反斜杠续行
d = a + \
c
3、空行行数
（1）空一行
- 用于类(class)成员函数之间。在同一个类中，各个方法之间应该用一个空行进行分隔
- 或者用于区分不同逻辑块，两个逻辑无关段落间空一行
class Test(object):
"""Test class,提供通用的方法"""
def __init__(self):
"""Test的构造器:"""
pass
def function1(self):
pass
def function2(self):
pass
（2）空两行
用于类与类、类与函数、函数与函数之间
class Test(object):
"""Test class,提供通用的方法"""
def __init__(self):
"""Test的构造器:"""
pass
def function3():
pass
def function4():
pass
4、Imports 导入
（1）import位置
import 总是位于文件的顶部，在模块注释和文档字符串之后，在模块的全局变量与常量之前。
不要东一个import，西一个import
（2）导入应该按照以下顺序分组
导入应该按照以下顺序分组：
a、标准库导入(pyhon安装的时候默认自带的库：os,sys,re,math,random,datetime,...)[3]
b、相关第三方库导入(matplotlib,numpy,...)
c、本地应用/库特定导入(自建的一些库,函数...)
之间空一行
import re
import sys
import matplotlib
import numpy
import mypackage
（3）避免通配符的导入
避免通配符的导入（from import *），因为这样做会不知道命名空间中存在哪些名字，会使得读取接口和许多自动化工具之间产生混淆。
通过 from M import * 导入的模块应该使用all机制去防止内部的接口对外暴露
5、复合语句分开写
复合语句(同一行中的多个语句)通常是不允许的。
if/for/while语句中，即使执行语句只有一句，也必须另起一行。
if foo == 'blah':
do_blah_thing()
do_one()
do_two()
do_three()
----------------------------------------------------------------------
# 错误写法
if foo == 'blah': do_blah_thing()
do_one(); do_two(); do_three()
6、空格的使用
（1）切片符号 前后的空格
# （1）不用空格
ham[1:9], ham[1:9:3], ham[:9:3], ham[1::3], ham[1:9:]
# （2）冒号前后用空格，把:当做优先级最低的操作;加号前后不加空格
ham[lower+offset : upper+offset]
（2）二元运算符 前后的空格
二元运算符两边加一个空格：赋值（=），增量赋值（+=，-=），比较（==,<,>,!=,<>,<=,>=,in,not,in,is,is not），布尔（and, or, not）。
前后都要加空格
# =前后都加空格
x = 4
x > 3
----------------------------------------------------------------------
# 错误写法
x=4
x>3
不过不是所有场景的二元运算符前后都要加空格的，有时候需要考虑优先级，在具有最低优先级的运算符周围添加空格。
# 先括号内处理，然后乘法处理
c = (a+b) * (a-b)
----------------------------------------------------------------------
# 错误写法
c = (a + b) * (a - b)
关键字参数或者默认参数值时，等号前后不加空格
# 这里的=前后不用空格的
def complex(real, imag=0.0):
return magic(r=real, i=imag)
（3）逗号/分号/冒号 后面加空格
逗号/分号/冒号后面加空格，前面紧贴参数
# 前面紧贴元素，后面一个空格
if x == 4: print x, y; x, y = y, x
----------------------------------------------------------------------
# 错误写法
if x == 4 : print x , y ; x , y = y , x
7、注释
与代码相矛盾的注释比没有注释还糟，当代码更改时，优先更新对应的注释！
块注释一般由完整句子的一个或多个段落组成，并且每句话结束有个句号。
如果注释很短，结尾的句号可以省略
在句尾结束的时候应该使用两个空格
（1）块注释
块注释，在一段代码前增加的注释。在‘#’后加一空格。段落之间以只有‘#’的行间隔。如果期间有空行，要加#的
# Description : Module config.
#
# Input : None
#
# Output : None
（2）行内注释
行内注释是与代码语句同行的注释，但是这种方式尽量少使用。
行内注释和代码至少要有两个空格分隔，注释由#和一个空格开始
x = x + 1 # Increment x
（3）文档说明docstrings
要为所有的公共模块，函数，类以及方法编写文档说明。
什么是文档说明？？
非公共的方法没有必要，但是应该有一个描述方法具体作用的注释，这个注释应该在def那一行之后。
多行文档说明使用的结尾三引号应该自成一行，对于单行的文档说明，尾部的三引号应该和文档在同一行
# 多行文档说明
"""Return a foobang
Optional plotz says to frobnicate the bizbaz first.
"""
# 单行文档说明
"""Optional plotz says to frobnicate the bizbaz first."""
8、命名规范
那些暴露给用户的API接口的命名，应该遵循反映使用场景而不是实现的原则
（1）类名
类名一般使用首字母大写的约定
class Lowercase:
# 还是
class LowerCase:
（2）变量、函数和属性命名
变量、函数和属性应该使用小写字母来拼写，如果有多个单词就使用下划线进行连接
lower_case_with_underscores # 使用下划线分隔的小写字母
如果函数的参数名和已有的关键词冲突，在最后加单一下划线比缩写或随意拼写更好。因此 class_ 比 clss 更好
（3）模块名
模块与包
Python 模块(Module)，是一个 Python 文件，以 .py 结尾
模块应该用简短全小写的名字，如果为了提升可读性，下划线也是可以用的；
包可能会包含多个模块
Python包名也应该使用简短全小写的名字，但不建议用下划线
例如自建一个包，包里面有模块
from lowercase import case_with_underscores
（4）常量
常量通常定义在模块级，通过下划线分隔的全大写字母命名。
例如： MAX_OVERFLOW 和 TOTAL
PI =3.141592653
SET_PI = 3.14
9、编程建议
（1）使用 is not ，而不是 not … is
使用 is not 运算符，而不是 not … is。虽然这两种表达式在功能上完全相同，但前者更易于阅读，所以优先考虑。
正确写法：if foo is not None:
错误写法：if not foo is None:
（2）lambda不乱用
始终使用def表达式，而不是通过赋值语句将lambda表达式绑定到一个变量上
正确写法：def f(x): return 2*x
错误写法：f = lambda x: 2*x
（3）except异常
当捕获到异常时，如果可以的话写上具体的异常名，而不是只用一个except: 块
# 写出具体的异常名，例如“ImportError”
try:
import platform_specific_module
except ImportError:
platform_specific_module = None
（4）推荐使用try/except/else模式
对于所有的 try/except 语句块，在try语句中只填充必要的代码，这样能避免掩盖掉bug
try:
value = collection[key] # try中只填写必要的代码
except KeyError:
return key_not_found(key)
else:
return handle_value(value)
----------------------------------------------------------------------
# 错误写法
try:
return handle_value(collection[key])
except KeyError:
return key_not_found(key)
（5）return None
在没有值可以返回的情况下，需要用 return None 显式指明
def foo(x):
if x >= 0:
return math.sqrt(x)
else:
return None
# 或者
def bar(x):
if x < 0:
return None
return math.sqrt(x)
----------------------------------------------------------------------
# 错误写法(考虑不全面)
def foo(x):
if x >= 0:
return math.sqrt(x)
（6）startswith/endswith
使用 “.startswith() 和 ”.endswith() 代替通过字符串切割的方法去检查前缀和后缀。startswith()和endswith()更干净，出错几率更小
正确写法: if foo.startswith('bar'):
错误写法: if foo[:3] == 'bar':
（7）多用isinstance
对象类型的比较应该用isinstance()而不是直接比较type
正确写法: if isinstance(obj, int):
错误写法: if type(obj) is type(1):
（8）不是len(XX)>0
对于序列来说（strings，lists，tuples）不要用len去判断；
对于布尔型变量来说，不要用 == 去和True或者False比较
# 如果存在内容就运行
正确写法：if seq:
错误写法：if len(seq)>0:
# 如果不存在内容就运行
正确写法：if not seq:
错误写法：if len(seq)=0:
# 布尔型
正确写法：if greeting:
错误写法：if greeting == True:
错误写法：if greeting is True:
全文提到的“错误写法”是指就规范而言，是不合适的写法，并不是代码运行上的错误，很多所谓的错误写法代码还是可以运行的，只是那样写不是很规范，不够专业。
参考资料
[1] PEP: 8 Style Guide for Python Code：https://legacy.python.org/dev/peps/pep-0008/
[2] 中文版本：https://www.cnblogs.com/bymo/p/9567140.html
[3] python标准库：https://docs.python.org/zh-cn/3/library/index.html
