Python PEP8编码规范

通常会听别人提到PEP8，但是具体指什么内容呢?《Python Enhancement Proposal #8》 （8号python增强提案）又叫PEP8，它是针对python而编订的代码格式指南。

编程语言不是艺术，而是工作或者工具，所以整理并遵循一套编码规范十分必要。

1. 代码布局

1.1 缩进

• 每级缩进用4个空格
• 括号中使用垂直隐式缩进或悬挂缩进
• 不使用Tap，更不能混合使用Tap和空格

正确示范

# (垂直隐式缩进)对准左括号起的第一个字符
foo = long_function_name(var_one, var_two,
                         var_three, var_four)

# (悬挂缩进) 以行首字符为基准，缩进（一般情况只需一层缩进）
foo = long_function_name(
    var_one, var_two,
    var_three, var_four)

# (悬挂缩进) 但下面情况, 需再加多一层缩进，和函数体的语句块区分开
def long_function_name(
        var_one, var_two, var_three,
        var_four):
    print(var_one)

# 右括号回退
my_list = [
    1, 2, 3,
    4, 5, 6,
]
result = some_function_that_takes_arguments(
    'a', 'b', 'c',
    'd', 'e', 'f',
)

错误示范

# 使用悬挂缩进时，第一行有参数。
foo = long_function_name(var_one, var_two,
    var_three, var_four)

# 参数的悬挂缩进和后续代码块缩进不能区别。
def long_function_name(
    var_one, var_two, var_three,
    var_four):
    print(var_one)

# 右括号不回退，不推荐
my_list = [
    1, 2, 3,
    4, 5, 6,
    ]

result = some_function_that_takes_arguments(
    'a', 'b', 'c',
    'd', 'e', 'f',
    )

1.2 最大行宽

• 每行最大行宽不超过 79 个字符
• 无括号续行，可使用反斜杠
• 括号内续行不需要使用反斜杠

# 无括号续行， 可使用反斜杠
with open('/path/to/some/file/you/want/to/read') as file_1, \
     open('/path/to/some/file/being/written', 'w') as file_2:
    file_2.write(file_1.read())

# 括号内续行，尽量在运算符后再续行
class Rectangle(Blob):
    def __init__(self, width, height,
                 color='black', emphasis=None, highlight=0):
        if (width == 0 and height == 0 and
                color == 'red' and emphasis == 'strong' or
                highlight > 100):
            raise ValueError("sorry, you lose")
        if width == 0 and height == 0 and (color == 'red' or
                                           emphasis is None):
            raise ValueError("I don't think so, values are %s,%s"%                             (width, height))

1.3 空行

• 两行空行用于分割顶层函数和类的定义
• 单个空行用于分割类定义中的方法
• 函数内逻辑无关段落之间空一行；其他地方尽量不要再空行
• 虽然可以使用‘；’，但尽量不要把多个语句写在同一行
• if/for/while语句中，即使执行语句只有一句，也必须另起一行

class A(object):     # 类的方法定义用单个空行分割
    def method1():
        pass

    def method2():
        pass


def method3():       # 两行空行分割顶层函数和类的定义
    pass

1.4 模块导入

• 导入的每个模块应该单独成行
• 导入顺序如下: 先标准库，再相关的第三方库，最后本地库。(导入不同类型的模块之间，要有空行分割，各组里面的模块顺序按首字母自上而下升序排列)

# 正确示范
import active   # 按模块首字母排序导入, 依此递推
import adidas
import create

# 错误示范
import sys, os, knife  # 错误：一行导入多模块

import create          # 错误：不按模块首字母导入
import active
import beyond

1.5 字符串

单引号和双引号作用是一样的，但必须保证成对存在，不能夹杂使用。
(建议句子使用双引号, 单词使用单引号, 但不强制。)

# 单引号和双引号效果一样

name = 'JmilkFan'
name = "Hey Guys!"

1.6 表达式和语句中的空格

括号里边避免空格

spam(ham[1], {eggs: 2})        # 正确示范

spam( ham[ 1 ], { eggs: 2 } )  # 错误示范

逗号，冒号，分号之前避免空格

if x == 4: print x, y; x, y = y, x       # 正确示范

if x == 4 : print x , y ; x , y = y , x  # 错误示范

函数调用的左括号之前不能有空格

spam(1)
dct['key'] = lst[index]     # 正确示范

spam (1)
dct ['key'] = lst [index]   # 错误示范

赋值等操作符前后不能因为对齐而添加多个空格

x = 1                # 正确示范
y = 2
long_variable = 3

x             = 1    # 错误示范
y             = 2
long_variable = 3

二元运算符两边各放置一个空格

• 涉及 = 的复合操作符 ( += , -=等)
• 比较操作符 ( == , < , > , != , <> , <= , >= , in , not in , is , is not )
• 逻辑操作符( and , or , not )

a = b
a or b

# 括号内的操作符两边不需要空格
name = get_name(age, sex=None, city=Beijing)

1.7 注释

总体原则，错误的注释不如没有注释。所以当一段代码发生变化时，第一件事就是修改注释。

• 注释块
  • 注释块通常应用在代码前，并和代码有同样的缩进。每行以 ‘# ’ 开头, 而且#后面有单个空格。段落之间以只有‘#’的行间隔

# Have to define the param `args(List)`, 
# otherwise will be capture the CLI option when execute `python manage.py server`.
# oslo_config: (args if args is not None else sys.argv[1:])
CONF(args=[], default_config_files=[CONFIG_FILE])

• 单行注释(这种方式尽量少使用)

x = x + 1 # Compensate for border

• 1

• 文档字符串

# 多行文档, 首行首字母大写，结尾的 """ 应该单独成行
"""Return a foobang
Optional plotz says to frobnicate the bizbaz first.
"""

# 单行的文档， 结尾的 """ 在同一行。
"""Return a foobang"""

• 为共有的模块、函数、类、方法写docstrings；非共有的没有必要写docstrings，但是可以写注释（在def的下一行）

• 应避免无谓的注释

1.8 命名规则

• 包和模块名
  包和模块名应该简短，全部用小写字母, 多字母之间可以使用单下划线连接。

• 类名
  遵循驼峰命名。

class MyClass(object):
    pass

• 1
• 2

• 全局变量名
  全局变量名应尽量只在模块内部使用, 对可能使用语句from moduleName import variableName而被导入的模块，应采用__all__机制来防止全局变量被别的模块导入, 或者在全局变量名开头加一个前置下划线。

_name = 'name'

• 1

• 函数名
  函数名应该为全部小写的凹驼峰规则。

vcenter_connection = ''

• 1

• 常量名
  常量全部使用大写字母的凹驼峰规则来表示, 通常在模块顶格定义。

MAX_OVERFLOW = ''
TOTAL = 1

• 方法名和实例变量

  • 非公开方法和实例变量开头使用前置下划线
  • 有时候可能会为了避免与子类命名冲突，采用两个前置下划线
    需要注意的是: 若 class Foo 的属性名为 __a， 该属性是不能以 Foo.__a 的方式访问的(执著的用户还是可以通过Foo._Foo__a 来访问), 所以通常双前置下划线仅被用来避免与基类的属性发生命名冲突。

2. 编程建议

• 编码中应考虑到其他python实现的效率问题，比如运算符‘+’在CPython中效率很高，在Jython中却非常低

• None 的比较用 is 或 is not，而不要用 ==；尽可能使用‘is’‘is not’取代‘==’；用 is not 代替 not … is, 前者的可读性更好

if foo is not None     # Yes

if not foo is None     # No

if x is not None       # if x is not None 要优于if x

if x

• 使用函数定义关键字 def 代替 lambda 赋值给标识符, 这样更适合于回调和字符串表示

def f(x):              # Yes
    return 2*x

f = lambda x: 2*x      # No

• 异常类应该继承自Exception，而不是 BaseException；捕获异常时尽量指明具体异常, 尽量不用 except Exception；应该捕获出了什么问题，而不是问题发生

try:                                   # Yes (捕获具体异常)
    import platform_specific_module    
except ImportError:
    platform_specific_module = None

try:                                   # No (不要全局捕获)
    import platform_specific_module
except:
    platform_specific_module = None

• try/except 子句中的代码要尽可能的少, 以免屏蔽掉其他的错误

try:                            # Yes
    value = collection[key]
except KeyError:
    return key_not_found(key)
else:
    return handle_value(value)


try:                            # No
    return handle_value(collection[key])
except KeyError:
    # 可能会捕捉到handle_value()中的 KeyError, 而不是collection的
    return key_not_found(key)

• 函数或者方法在没有返回值时要明确返回 None

def foo():        # Yes
    return None

def foo():        # No
    return

• 使用字符串方法而不是 string 模块
  python 2.0 以后字符串方法总是更快，而且与 Unicode 字符串使用了相同的 API

• 使用使用 .startswith() 和 .endswith() 代替字符串切片来检查前缀和后缀
  startswith() 和 endswith 更简洁，利于减少错误

if foo.startswith('bar'):   # Yes

if foo[:3] == 'bar':        # No

• 使用 isinstance() 比较对象的类型

if isinstance(obj, int):   # Yes

if type(obj) is type(1):   # No

• 判断序列空或不空
  空序列类型对象的 bool 为 False:

if not seq:       # Yes
   pass
if seq:
   pass

if len(seq):      # No
   pass
if not len(seq):
   pass

• 不要使用 == 进行 bool 比较

 # Yes
if greeting:          
   pass

# No
if greeting == True
   pass
if greeting is True: # Worse
   pass

• 字符串不要以空格收尾

• 二进制数据判断使用if boolvalue的方式

• 使用Map和Reduce，不要使用循环

全文地址请点击：https://blog.csdn.net/yjk13703623757/article/details/79322172?utm_source=copy