Python代码规范

发表于 | 更新于 | 分类于 | 阅读次数：

函数规范

1
2
3
4
5
6
7
8
#声明函数的作用以及各个参数的用法
def func(a,b,c):
    '''
    :param a: 
    :param b: 
    :param c: 
    :return: 
    '''

缩进

1
四个空格或者直接使用tab符号

行最大长度

1
每行代码最大字符不超过80个

类

1
2
3
类与类之间空两行
类中方法与方法空1行,类与方法空一行
类命名使用驼峰命名法

注释

1
2
3
单行注释：若注释独占一行，#号顶头，空1格后写注释；若是行尾注释，空2格后#号再空1格写注释
多行注释：三对双引号（推荐使用）和三对单引号
复杂逻辑一定要写注释

引号

1
2
3
自然语言使用双引号,机器标识使用单引号,代码里多数使用单引号
正则表达式使用双引号
解释说明文档使用三引号(三单或三双)

空行

1
2
3
模块级函数和类定义之间空两行
类成员函数之间空一行
函数中可以使用空行分隔出逻辑相关的代码

开头规范

1
2
3
4
5
6
#!/usr/bin/env python3
# -*- coding: utf-8 -*-
"""
Created on 2019-11-26  代码简化  多进程
@author: lxy
"""

import语句

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
import语句应该分开写不推荐一下写两个
import语句应该按照顺序排列,每组之间用一个空行分隔
模块尽量使用小写命名，首字母保持小写，尽量不要用下划线(除非多个单词，且数量不多的情况)
# 正确的模块名
import decoder
import html_parser

# 不推荐的模块名
import Decoder

# 正确的写法
import os
import sys

# 不推荐的写法
import sys,os

# 正确的写法
from subprocess import Popen, PIPE

函数

1
2
函数名一律小写,如有多个单词,用下划线隔开
私有函数在函数前加一个下划线

变量名命名规则

1
2
3
4
5
变量严格区分大小写
变量不能以数字开头
变量不能含有特殊符号
变量不能含有中文
变量命名要有实际意义

编码建议

1
2
3
4
5
6
1.编码中要考虑其他Python实现的效率问题,比如运算符‘+’在CPython（Python）中效率很高，都是Jython中却非常低，所以应该采用.join()的方式。
2.尽可能使用is is not 取代 == 
3.异常中try的代码尽可能少
4.startswith()和endswith()优于切片前缀或后缀查看
5.字符串不要以空格结尾
6.二进制数据判断,使用if boolvalue的方式

1576560854824