举例python常量命名规范_Python命名规范

1 命名规范

模块名 尽量使用小写，尽量使用下换线

import myclass

类名 使用骆驼写法，单词首字母大写，私有类可以下划线开头

class MyClass()：

pass

class YouClass()：

pass

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

私有函数下划线开头

def my_func(var1, var2):

pass

def _private_func(var1, var2):

pass

变量名最好小写，若有多个使用下划线分开

num = 20

var1 = 'string'

常量使用全大写，多个单词使用下划线隔开

DATE = '2019-01-01'

MAX_CLIENT = 50

2 格式

缩进

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

行宽

每行代码不超过120个字符，

空行

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

类成员之间空一行

class A:

def __init__(self):

pass

def hello(self):

pass

def main():

pass

函数中使用空行隔离逻辑不同代码

3 Import 语句

不同模块分开导入，相同模块一起导入

#推荐

import os

import json

#不推荐

import os, json

#推荐

from subprocess import run， call， check_all()

import 应放在docstring和模块说明之后，全局变量之前

import 语句按顺序排列组，每组之间空行

import os

import json

from fabirc.api import *

import foo

使用相对引入

from unity import cmd_call

4 空格

使用二元运算符两边各空一格(=,-,+=,==,>,in,is not, and)

i = i + 1

submitted += 1

x = x * 2 - 1

hypot2 = x * x + y * y

c = (a + b) * (a - b)

函数的参数列表中需要有空格

#推荐

def func1(var1, var2):

pass

函数的参数列表中，默认值等号两边不要添加空格

def func2(var1, var2=100):

pass

5 docstring

公共的模块，类，都需要使用docstring来进行注释

'''Form a complex number.

Keyword arguments:

real -- the real part (default 0.0)

imag -- the imaginary part (default 0.0)

'''

块注释

'#'后空一格

# 注释1

# 注释2

行注释

注释和语句使用两个及以上空格分开

x = 1 + 2 # 注释1

文档注释

一般出现在模块头部、函数和类的头部，这样可以通过对象的doc获取文档

文档注释以 ''' 开头和结尾, 首行不换行, 如有多行, 末行必需换行

"""docstring example

.....................

"""

注释主要写明函数，模块的功能，输入参数和输出返回值

func(arg1, arg2):

"""在这里写函数的一句话总结(如: 计算平均值).

这里是具体描述.

参数

----------

arg1 : int

arg1的具体描述

arg2 : int

arg2的具体描述

返回值

-------

int

返回值的具体描述

pass

文档注释不限于中英文, 但不要中英文混用