• 三、命名规范
    • 1、模块
    • 2、类名
    • 3、函数
    • 4、变量名
    • 5、常量

    三、命名规范

    1、模块

    • 模块尽量使用小写命名,首字母保持小写,尽量不要用下划线(除非多个单词,且数量不多的情况)
    1. # 正确的模块名
    2. import decoder
    3. import html_parser
    4. # 不推荐的模块名
    5. import Decoder

    2、类名

    • 类名使用驼峰(CamelCase)命名风格,首字母大写,私有类可用一个下划线开头
    1. class Farm():
    2. pass
    3. class AnimalFarm(Farm):
    4. pass
    5. class _PrivateFarm(Farm):
    6. pass
    • 将相关的类和顶级函数放在同一个模块里. 不像Java, 没必要限制一个类一个模块.

    3、函数

    • 函数名一律小写,如有多个单词,用下划线隔开
    1. def run():
    2. pass
    3. def run_with_env():
    4. pass
    • 私有函数在函数前加一个下划线_
    1. class Person():
    2. def _private_func():
    3. pass

    4、变量名

    • 变量名尽量小写, 如有多个单词,用下划线隔开
    1. if __name__ == '__main__':
    2. count = 0
    3. school_name = ''
    • 常量采用全大写,如有多个单词,使用下划线隔开
    1. MAX_CLIENT = 100
    2. MAX_CONNECTION = 1000
    3. CONNECTION_TIMEOUT = 600

    5、常量

    • 常量使用以下划线分隔的大写命名
    1. MAX_OVERFLOW = 100
    2. Class FooBar:
    3. def foo_bar(self, print_):
    4. print(print_)