python代码格式规范

对于python而言，官方的PEP8规范是使用最广泛，认可度最高的代码规范，具体可访问：PEP 8
在线Python代码规范

1 代码布局

1.1 缩进：多行代码的缩进与对齐

我的个人习惯是用制表符(4个空格）
多行结构上的闭大括号/尖括号/圆括号可以对齐到列表最后一行的第一个非空白字符下

my_list = [
    1, 2, 3,
    4, 5, 6,
    ]
result = some_function_that_takes_arguments(
    'a', 'b', 'c',
    'd', 'e', 'f',
    )

或者：

my_list = [
    1, 2, 3,
    4, 5, 6,
]
result = some_function_that_takes_arguments(
    'a', 'b', 'c',
    'd', 'e', 'f',
)

1.2 最大的行宽：79

官方建议：限制行最大字符数为 79 。如何过长需要通过 "" 或者括号（圆括号，中括号，花括号）进行换行
使用括号进行换行，第二行第一个字符需要与括号里的第一个字符对齐

x = ('This is  a test '
     'for python style')

无法使用括号的，则通过“\" 进行换行

with open('/path/to/some/file/you/want/to/read') as file_1, \
       open('/path/to/some/file/being/written', 'w') as file_2:
    file_2.write(file_1.read())

1.3 二元操作符的连接与换行

错误的写法

# Wrong:
# operators sit far away from their operands
income = (gross_wages +
          taxable_interest +
          (dividends - qualified_dividends) -
          ira_deduction -
          student_loan_interest)

正确的写法：视线不用跨越两行，能够直观的看出对变量进行的操作

income = (gross_wages
          + taxable_interest
          + (dividends - qualified_dividends)
          - ira_deduction
          - student_loan_interest)

1.4 空行的使用

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

class A:

    def __init__(self):
        pass

    def hello(self):
        pass


def main():
    pass

1.5 编码

python3 默认编码 UTF-8，python2 默认编码 ASCII 。使用默认编码不需要声明
若 python2 中需要使用UTF-8编码，需要在文件头部加入 #--conding:utf-8--

1.6 import模块导入

import语句应该放在文件头部，置于模块说明及docstring之后，于全局变量之前；

模块导入顺序：不同类型的模块之间最好用空行进行分割
1.标准模块
2.第三方模块
3.自编模块
import 语句应该分行来写

# Correct:
import os
import sys

# Wrong: 也不是不能用，是不推荐
import sys, os

推荐使用绝对路径导入：

# Correct:
from subprocess import Popen, PIPE复制代码
import语句应该使用 absolute import
# Correct:
from foo.bar import Bar

# Wrong
from ..bar import Bar

当从包含类的模块中导入一个类时

from myclass import MyClass
from foo.bar.yourclass import YourClass

如果发生命名冲突，则可使用命名空间

import bar
import foo.bar

bar.Bar()
foo.bar.Bar()

1.7 书写顺序

文档说明：docstring在最前面，接着是下划线开头或者结尾的模块及变量，然后是标准模块导入等的

"""This is the example module.

This module does stuff.
"""

from __future__ import barry_as_FLUFL

__all__ = ['a', 'b', 'c']
__version__ = '0.1'
__author__ = 'Cardinal Biggles'

import os
import sys

2 字符串引号

单引号或者双引号都是可以的，根据自己的习惯。当字符串中本身包含单引号或者双引号时，可以选择另外一个，避免使用 \l来进行转义

3 表达式和语句中的空格

3.1 以下情况不需要出现空格

方括号、中括号、大括号内不需要空格

# Correct:
spam(ham[1], {eggs: 2})
# Wrong:
spam( ham[ 1 ], { eggs: 2 } )

末尾，和）之间不需要空格

# Correct:
foo = (0,)
# Wrong:
bar = (0, )

逗号、分号、冒号前不需要空格

# Correct:
if x == 4: print x, y; x, y = y, x
# Wrong:
if x == 4 : print x , y ; x , y = y , x

切片左右的空格可以被省略

# Correct:
ham[1:9], ham[1:9:3], ham[:9:3], ham[1::3], ham[1:9:]
ham[lower:upper], ham[lower:upper:], ham[lower::step]
ham[lower+offset : upper+offset]
ham[: upper_fn(x) : step_fn(x)], ham[:: step_fn(x)]
ham[lower + offset : upper + offset]
# Wrong:
ham[lower + offset:upper + offset]
ham[1: 9], ham[1 :9], ham[1:9 :3]
ham[lower : : upper]
ham[ : upper]

函数调用 ( 前不需要空格

# Correct:
spam(1)
# Wrong:
spam (1)

不要为了对齐而增加多余的空格

# Correct:
x = 1
y = 2
long_variable = 3
# Wrong:
x             = 1
y             = 2
long_variable = 3

*其他建议：

不要存在拖尾空格
反斜杠后面不要存在空格或者空行
二次运算符左右两边各需要一个空格： =,+=, -= ,==, <, >, !=, <>, <=, >=, in, not in, is, is not,and, or, not

# Correct:
i = i + 1
submitted += 1
x = x*2 - 1
hypot2 = x*x + y*y
c = (a+b) * (a-b)
# Wrong:
i=i+1
submitted +=1
x = x * 2 - 1
hypot2 = x * x + y * y
c = (a + b) * (a - b)

当用于指示关键字参数或用于指示未带注释的函数形参的默认值时，不要在=符号周围使用空格

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

不建议使用复合语句

# Correct:
if foo == 'blah':
    do_blah_thing()
do_one()
do_two()
do_three()
Rather not:

# Wrong:
if foo == 'blah': do_blah_thing()
do_one(); do_two(); do_three()

# Wrong:
if foo == 'blah': do_blah_thing()
for x in lst: total += x
while t < 10: t = delay()

4 末尾逗号的使用

一般末尾不需要加逗号

# Correct:
FILES = ('setup.cfg',)
# Wrong:
FILES = 'setup.cfg',

多行时可以加逗号，一行时就不需要加逗号了

# Correct:
FILES = [
    'setup.cfg',
    'tox.ini',
    ]
initialize(FILES,
           error=True,
           )
# Wrong:
FILES = ['setup.cfg', 'tox.ini',]
initialize(FILES, error=True,)

5 注释

5.1 块注释： # 号后空一格，段落件用空行分开（同样需要“#”号）

# something
# something
#
# something
# something

5.2 行注释：至少使用两个空格和语句分开，注意不要使用无意义的注释

x = x + 1                 # Compensate for border

5.3 文档注释：

作为文档的Docstring一般出现在模块头部、函数和类的头部，python中可以通过对象的doc对象获取文档.

文档注释以 """ 开头和结尾, 首行不换行, 如有多行, 末行必需换行, 以下是Google的docstring风格示例
不要在文档注释复制函数定义原型, 而是具体描述其具体内容, 解释具体参数和返回值等

6 命名规范

不要使用 'l' , 'O', 'I'
模块（或函数）的命名应该全部都是小写，多个单词之间用下划线分割即可，不过尽量简短
类的命名可使用用驼峰(ClassAbc)，首字母大写，私有类可用一个下划线开头
函数的命名最好小写，如有多个单词，用下划线隔开
变量名尽量小写, 如有多个单词，用下划线隔开
常量使用以下划线分隔的大写命名