python命名规范

命名规范

模块

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

# 正确的模块名
import decoder
import html_parser

类名

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

函数

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

变量

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

注释

1. 注释块：注释块的上下放最好有一行空行包裹
2. 行内注释：与代码在同一行，应该谨慎使用，如果意思明了就不需要了
3. 文档注释紧接着开头的版本注释
   

代码的布局

1. 布局顺序

• 版本注释
• 文档注释
• 模块的全局变量和常量
• 导入包： 首先，标准库的导入，其次，第三方包的导入与标注库空行隔开，最后，导入内部的包，使用绝对路径。

3. 行的最大长度设置79
4. 模块开头的版本注释

# Author: Ben Gertzfield, Barry Warsaw
# Contact: [email protected]

4. 空行