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) :使用三个双引号 """......"""。
©著作权归作者所有,转载或内容合作请联系作者
  • 序言:七十年代末,一起剥皮案震惊了整个滨河市,随后出现的几起案子,更是在滨河造成了极大的恐慌,老刑警刘岩,带你破解...
    沈念sama阅读 211,884评论 6 492
  • 序言:滨河连续发生了三起死亡事件,死亡现场离奇诡异,居然都是意外死亡,警方通过查阅死者的电脑和手机,发现死者居然都...
    沈念sama阅读 90,347评论 3 385
  • 文/潘晓璐 我一进店门,熙熙楼的掌柜王于贵愁眉苦脸地迎上来,“玉大人,你说我怎么就摊上这事。” “怎么了?”我有些...
    开封第一讲书人阅读 157,435评论 0 348
  • 文/不坏的土叔 我叫张陵,是天一观的道长。 经常有香客问我,道长,这世上最难降的妖魔是什么? 我笑而不...
    开封第一讲书人阅读 56,509评论 1 284
  • 正文 为了忘掉前任,我火速办了婚礼,结果婚礼上,老公的妹妹穿的比我还像新娘。我一直安慰自己,他们只是感情好,可当我...
    茶点故事阅读 65,611评论 6 386
  • 文/花漫 我一把揭开白布。 她就那样静静地躺着,像睡着了一般。 火红的嫁衣衬着肌肤如雪。 梳的纹丝不乱的头发上,一...
    开封第一讲书人阅读 49,837评论 1 290
  • 那天,我揣着相机与录音,去河边找鬼。 笑死,一个胖子当着我的面吹牛,可吹牛的内容都是我干的。 我是一名探鬼主播,决...
    沈念sama阅读 38,987评论 3 408
  • 文/苍兰香墨 我猛地睁开眼,长吁一口气:“原来是场噩梦啊……” “哼!你这毒妇竟也来了?” 一声冷哼从身侧响起,我...
    开封第一讲书人阅读 37,730评论 0 267
  • 序言:老挝万荣一对情侣失踪,失踪者是张志新(化名)和其女友刘颖,没想到半个月后,有当地人在树林里发现了一具尸体,经...
    沈念sama阅读 44,194评论 1 303
  • 正文 独居荒郊野岭守林人离奇死亡,尸身上长有42处带血的脓包…… 初始之章·张勋 以下内容为张勋视角 年9月15日...
    茶点故事阅读 36,525评论 2 327
  • 正文 我和宋清朗相恋三年,在试婚纱的时候发现自己被绿了。 大学时的朋友给我发了我未婚夫和他白月光在一起吃饭的照片。...
    茶点故事阅读 38,664评论 1 340
  • 序言:一个原本活蹦乱跳的男人离奇死亡,死状恐怖,灵堂内的尸体忽然破棺而出,到底是诈尸还是另有隐情,我是刑警宁泽,带...
    沈念sama阅读 34,334评论 4 330
  • 正文 年R本政府宣布,位于F岛的核电站,受9级特大地震影响,放射性物质发生泄漏。R本人自食恶果不足惜,却给世界环境...
    茶点故事阅读 39,944评论 3 313
  • 文/蒙蒙 一、第九天 我趴在偏房一处隐蔽的房顶上张望。 院中可真热闹,春花似锦、人声如沸。这庄子的主人今日做“春日...
    开封第一讲书人阅读 30,764评论 0 21
  • 文/苍兰香墨 我抬头看了看天上的太阳。三九已至,却和暖如春,着一层夹袄步出监牢的瞬间,已是汗流浃背。 一阵脚步声响...
    开封第一讲书人阅读 31,997评论 1 266
  • 我被黑心中介骗来泰国打工, 没想到刚下飞机就差点儿被人妖公主榨干…… 1. 我叫王不留,地道东北人。 一个月前我还...
    沈念sama阅读 46,389评论 2 360
  • 正文 我出身青楼,却偏偏与公主长得像,于是被迫代替她去往敌国和亲。 传闻我的和亲对象是个残疾皇子,可洞房花烛夜当晚...
    茶点故事阅读 43,554评论 2 349

推荐阅读更多精彩内容