Python代码规范和命名规范

一、概述

1、如无特殊情况，文件一律使用UTF-8编码，文件头部必须加 入#-*-coding:utf-8-*-标识

2、统一使用4个空格进行缩进

3、自然语言使用双引号，机器标示使用单绰号，代码里应该使用单引号，文档字符串使用三个双引号

二、空行

4、模块级函数和类定义之间空两行

5、类成员函数之间空一行

6、可以使用多个空行分隔多组相关的函数

三、语句

7、impor语句分行书写,放在文件头部，置于模块说明及docstring之后，于全局变明之前，每组之前用一个空行分隔

　　imort os

　　import sys

 

　　from  too.bar impor Bar

8、导入其他模块的类定义时，可以使用相对导入

　　from myclass import MyClass

9、在二元运算符两边各空一格[=,-,+=,==,>,in,is not ,and]

　　i = i + 1

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

四、docstring

11、所有的公共模块、函数、类、方法都应该写docstring

五、命名规范

12、模块 尽量使用小写命名，尽量不要用下划线

13、类名着字母大写，私有类可用一个下划组开头

　　classs Farm();

　　　　pass

 

　　clase  _PrivateFarm(Farm):

　　　　pass

14、函数名一律小写，如有多个单词，用下划线隔开；私有函数在函数前加一个下划线

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

16、常量全用大写，如有多个韵语单词，用下划线隔开