Python代码编写规范

部分资料来源于网络，个人学习用

---

一、空行

1、类内+方法间：1行

class A(object):
    # 空1行
    def __init__(self):
        a = 1

2、类间：2行

class A(object):
    # 空1行
    def __init__(self):
        a = 1
# 空1行
# 空1行
class B(object):
    # 空1行
    def __init__(self):
        a = 1

二、空格

1、缩进：4格

2、运算符两边均空1格，但若使用具有不同优先级的运算符，只在最低优先级的运算符周围两边添加空格，其它的就不用加了。

i = i + 1
sum += 1
x = x*2 - 1
max = x*x + y*y
c = (a+b) * (a-b)

3、给函数参数赋值，=周围不空格；但其他时候要加空格

def complex(real, imag=0.0):
    return magic(r=real, i=imag)

a = 1

4、各种右括号前不要加空格

5、冒号前不要加空格，后面要加空格，但在切片时冒号前后都不加空格

spam(ham[1], {eggs: 2})
if x == 4: print x, y; x, y = y, x
ham[1:9], ham[1:9:3], ham[:9:3], ham[1::3], ham[1:9:]

6、井号和分号后加空格

7、逗号后加空格，但若后面是小括号，则不

#　逗号
func = (0,)
x, y = y, x
print x, y

三、命名

1、类命名
大驼峰命名：所有单词的首字母都大写，并且不使用特殊字符、下划线和数字

class CodeStandard(object):

2、方法命名
全小写字符或者下划线，多单词用下划线连接，但下划线不能做首字母

def code_standard(): 

3、常量命名
以大写字母开头，全部大写字母或下划线或数字，多见于项目的settings文件中

MAX_SIZE = 100

四、注释

1、单行注释：若注释独占一行，#号顶头，空1格后写注释；若是行尾注释，空2格后#号再空1格写注释

# 代码注释
def code_standard():  # 代码注释

2、多行注释：三对双引号

"""
A...
B...
"""

五、导入

先导入python包，再导入第三方包，最后导入自定义的包

import sys, os  # python包，可导入多个
import pytz  # 第三方包
from datetime import datetime  # python包
from django.http import request, response  # 第三方包
from mysite.test import Test  # 自定义包