python命名规范

 

• 1、模块

模块尽量使用小写命名，首字母保持小写，尽量不要用下划线(除非多个单词，且数量不多的情况)
# 正确的模块名
import decoder
import html_parser

# 不推荐的模块名
import Decoder

• 2、类名

类名使用驼峰(CamelCase)命名风格，首字母大写，私有类可用一个下划线开头
class Farm():
    pass

class AnimalFarm(Farm):
    pass

class _PrivateFarm(Farm):
    pass
将相关的类和顶级函数放在同一个模块里. 不像Java, 没必要限制一个类一个模块.

• 3、函数

函数名一律小写，如有多个单词，用下划线隔开
def run():
    pass

def run_with_env():
    pass
私有函数在函数前加一个下划线_
class Person():

    def _private_func():
        pass

4、常量

常量使用以下划线分隔的大写命名
MAX_OVERFLOW = 100

5、类里面的函数和方法参数

始终要以self作为实例方法的第一个参数
始终要以cls作为静态方法的第一个参数