Python3编码规范

一、命名

1、模块

模块名：一般均小写，其次保证首字母小写

目录结构均小写

2、类

类名：首字母大写，如果含有多个单词，首字母均大写，即驼峰规则

私有类：可用一个下划线开头

3、函数

函数名：小写，如果有多个单词，可用下划线隔开

私有函数：在函数名前加一个下划线

4、常量

名：均大写

二、编码

使用utf-8编码

无特殊情况，在文件开头均有 -*- coding:utf-8 -*- 标识

三、代码格式

均以4个空格进行缩进

四、引号

单引号：代码用

双引号：自然语言

三引号：文档字符串

错误信息：使用u'你好世界'转义

五、空行

模块级函数和类定义之间隔两行

类成员函数之间隔一行

六、空格

1、在二元运算符两边各空一个空格

2、函数的参数列表中，逗号之后要有空格；默认值等号两边不要有空格

七、换行

1、括号内换行，第一行正常写，第二行需要缩进到括号的起始处

2、括号起始处换行，第二行缩进四个空格

3、反斜杠\和+号换行时，符号应在行尾

八、docstring（文档字符串）

用来在函数开头描述性的文字

可以一行显示，也可以多行显示

九、注释

#号用来注释，#号需要空一格