《Python入门教程》 - 1. 编码规范

编码

使用UTF-8编码，在文档头加上注释

#-*-coding:utf-8-*-

缩进

4个空格

代码行宽 80~120个字符。

引号

• 普通文字 - 双引号 "..." u"中文"
• 变量 - 单引号 '...'
• 正则表达式 - 双引号 r"..."
• 文档字符串 - 三个双引号 """......"""

空行

class A:

    def __init__(self):
        pass
    
    # 函数 - 1行
    def hello(self):
        pass


# 类模块 - 2行
def main():
    pass 

import

• 分行写

import numpy
import pandas
from subprocess import Popen, PIPE

• 绝对路径

from a.b import B

• 置于头部，docstring之后

• 命名空间

import bar
import foo.bar

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

空格

• 在二元运算符两边各空一格[=,-,+=,==,>,in,is not, and]
• 函数的参数列表中，,之后要有空格
• 函数的参数列表中，默认值等号两边不要添加空格

换行

• 第二行缩进到括号的起始处

foo = long_function_name(var_one, var_two,
                         var_three, var_four)

• 第二行缩进 4 个空格，适用于起始括号就换行的情形

def long_function_name(
        var_one, var_two, var_three,
        var_four):
    print(var_one)

• 使用反斜杠\换行，二元运算符+ .等应出现在行末

• if/for/while一定要换行

docstring

• 所有的公共模块、函数、类、方法，都应该写 docstring 。私有方法不一定需要，但应该在 def 后提供一个块注释来说明。
• docstring 的结束"""应该独占一行，除非此 docstring 只有一行。

###
test
###