个人python代码规范

1.文件头部

如无特殊情况, 文件一律使用 UTF-8 编码

如无特殊情况, 文件头部必须加入#-*-coding:utf-8-*-标识

2.引号

简单说，自然语言使用双引号，机器标示使用单引号，因此 代码里 多数应该使用 单引号

自然语言 使用双引号"..."


例如错误信息；很多情况还是 unicode，使用u"你好世界"

机器标识 使用单引号'...'


例如 dict 里的 key

正则表达式 使用原生的双引号 r"..."


文档字符串 (docstring) 使用三个双引号 """..."""


 

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

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

6. 类名称命名： 类总是使用驼峰格式命名，即所有单词首字母大写其余字母小写

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

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

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

 

10. 变量命名总结： 
- 1.单下划线开头变量：protected 
- 2.双下划线开头变量：private 
- 3.双下划线开头，双下划线结尾：系统内置变量 
11. 函数命名总结： 
- 1.私有方法：小写和一个前导下划线 
- 2.特殊方法（魔术方法）：小写和两个前导下划线，两个后置下划线 
- 3.函数参数：小写和下划线，缺省值等号两边无空格