PEP8 规范(python)

个人笔记

特别的

• python3 严格遵循缩进

1 . 变量

1) 常量 : 大写

GOOD_CONSTANT

2) 内置变量 : 小写 , 两个前导下划线和两个后置下划线

__name__

禁止外部访问

3) 私有变量 : 小写 , 前导下划线

_private_value

特别的 : python 没有私有变量,这只是程序员之间的一个约定，用于警告说明这是一个私有变量，外部类不要去访问它。但实际上，外部类还是可以访问到这个变量

2 . 函数和方法

1) 一般 : 小写

def get()
def _get()

当使用 _get() 时,即一个前导下划线 ,
告知这是我i自己随便定的方法,其他人可以无视

2) 私有方法 : 小写,两个前导下划线

def __get()

外部禁止调用

3) 特殊方法(魔法方法) : 小写,两个前导下划线和两个后置下划线

def __new__()

4) 函数参数 : 小写,缺省值等号左右无空格

不要滥用 *args 和 **kwargs
*args 和 **kwargs 参数可能会破坏函数的健壮性。
它们使签名变得模糊

3 . 类

1) 命名 : 驼峰命名法(大驼峰)

class Duck()

所有单词首字母大写其余字母小写。
类名应该简明，精确，并足以从中理解类所完成的工作

2) 特别的:对于自定义基类

class BaseModel()

为其增加 Base 前缀

4 . 模块和包

1) 命名 : 小写且不加前导下划线

import os

除了 __ init__ 包,其他都使用 小写
且一般不建议用下划线

2) 命名 : + lib 后缀

import smtplib 

当实现一个协议时,使用 lib 后缀

6 . 其他