Python编码规范10-命名规范--命名规范

一、模块

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

# 正确的模块名
import decoder
import html_parser

# 不推荐的模块名
import Decoder

二、类名

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

2、 将相关的类和顶级函数放在同一个模块里. 不像Java, 没必要限制一个类一个模块。

class Farm():
    pass

class AnimalFarm(Farm):
    pass

class _PrivateFarm(Farm):
    pass

三、函数

1、 函数名一律小写，如有多个单词，用下划线隔开。

def run():
    pass

def run_with_env():
    pass

2、 私有函数在函数前加一个下划线_。

class Person():

    def _private_func():
        pass

四、变量名

1、 变量名尽量小写, 如有多个单词，用下划线隔开。

if __name__ == '__main__':
    count = 0
    school_name = ''

2、 常量采用全大写，如有多个单词，使用下划线隔开。

MAX_CLIENT = 100
MAX_CONNECTION = 1000
CONNECTION_TIMEOUT = 600

五、避免名称

1、 单字符名称, 除了计数器和迭代器。

2、 包/模块名中的连字符(-)。

3、 双下划线开头并结尾的名称(Python保留, 例如__init__)。