python3 代码开发规范

python3 代码开发规范

1、编码

>如无特殊情况, 文件一律使用 UTF-8 编码，放在代码第一行。
```
# -*- coding:utf-8 -*-
或者
#coding=utf-8

```

2、缩进

统一使用 4 个空格进行缩进 
严格执行，否则报错

3、导入库或者模块

import 语句

import re   
from PIL import Image, ImageFilter

4、单行注释

# 后面空一格

5、多行注释

'''
Copyright 2017 by Satya Mallick ( Big Vision LLC )
http://www.learnopencv.com
'''

# 或者，不推荐
# Copyright 2017 by Satya Mallick ( Big Vision LLC )
# http://www.learnopencv.com

# 重要注释建议这样格式
# =====================================
# 这条注释很重要 !!!
# =====================================

6、文档注释

一般出现在模块头部、函数和类的头部。
#  正确的写法
def pingjunzhi(x, y):
    """计算并返回x到y范围内数据的平均值"""

7、命名

1 变量名：尽量小写, 如有多个单词，用下划线隔开。 good_girl=a
2 常量名：采用全大写，如有多个单词，使用下划线隔开。 GOOD_GIRL=100
3 函数名：一律小写，如有多个单词，用下划线隔开。 def qiu_ping_jun_zhi():
  私有函数在函数前加一个下划线_。 def _private_good():
4 类名：使用驼峰(CamelCase)命名风格，首字母大写。 class BadBoy(name):
5 模块名：尽量使用小写命名，首字母保持小写，尽量不要用下划线。

8、空行

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

类成员函数之间空一行。

9、空格

1 在二元运算符两边各空一格[ =,-,+=,==,>,in,is not, and ]。 a = a + 1
2 函数的参数列表中，逗号（,）之后，是需要有空格。 def plus_a_b(a, b):
3 函数的参数列表中，默认值等号两边不要添加空格。 def plus_a_b(a, b=1.2):
4 左括号之后，右括号之前不要加多余的空格。print(a)
5 不要为对齐赋值语句而使用的额外空格。

10、换行

1 使用反斜杠\换行，长字符串多选用此法换行；二元运算符+ 和.等应该出现在行末。
2 Python 支持括号内的换行，注意整齐和整洁。
3 禁止复合语句，即一行中包含多个语句。

11、引号

1 自然语言：使用双引号 "..."。 a = "a good girl"、
2 机器标识：使用单引号 '...'。 dict = {'a': 1, '张三': 22, '天津': '300'} 
3 正则表达式：使用原生的双引号 "..."。
4 文档字符串 (docstring) ：使用三个双引号 """......"""。