簡明概述

簡潔概述

1、編碼

• 如無特殊情況, 文件一律使用UTF-8 編碼

• 如無特殊情況, 檔案頭部必須加入#-*-coding:utf-8-*-標識

2、程式碼格式

2.1、縮排

• 統一使用4 個空格進行縮排

2.2、行寬

每行程式碼盡量不超過80 個字元(在特殊情況下可以略微超過80 ，但最長不得超過120)

原因：

• 這在查看side-by-side 的diff 時很有幫助

• 方便在控制台下方查看程式碼

• 太長可能是設計有缺陷

2.3、引號

簡單說，自然語言使用雙引號，機器標示使用單引號，因此代碼裡多數應該使用單引號

• ##自然語言使用雙引號"..."

• 機器標識使用單引號'...' 例如dict 裡的key

• 正規表示式使用原生的雙引號r"..."

• #文檔字串(docstring) 使用三個雙引號"""......"""

#2.4、空白行

• #模組級函數和類別定義之間空兩行；

• #類別成員函數之間空一行；

class A:
    def __init__(self):
        pass
    def hello(self):
        pass
def main():
    pass

• 可以使用多個空行分隔多組相關的函數

• #函數中可以使用空白行分隔出邏輯相關的程式碼

2.5、編碼

• #檔案使用UTF-8 編碼

• 檔案頭部加入#-*-conding:utf-8-*-標識

#3、import 語句

#

# 正确的写法
import os
import sys
# 不推荐的写法
import sys,os
# 正确的写法
from subprocess import Popen, PIPE
import语句应该使用 absolute import
# 正确的写法
from foo.bar import Bar
# 不推荐的写法
from ..bar import Bar

• import語句應該放在檔案頭部，置於模組說明及docstring之後，於全域變數之前；

• import語句應該依照順序排列，每組之間以一個空白行分隔

  
  

import os
import sys
import msgpack
import zmq
import foo

• #導入其他模組的類別定義時，可以使用相對導入

from myclass import MyClass

• 如果發生命名衝突，則可使用命名空間

#

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

4、空格

• 在二元運算子兩邊各空一格[=,-, =,==,>,in,is not, and]:

#

# 正确的写法
i = i + 1
submitted += 1
x = x * 2 - 1
hypot2 = x * x + y * y
c = (a + b) * (a - b)
# 不推荐的写法
i=i+1
submitted +=1
x = x*2 - 1
hypot2 = x*x + y*y
c = (a+b) * (a-b)

• 函數的參數清單中，,之後要有空格

# 正确的写法
def complex(real, imag):
    pass
# 不推荐的写法
def complex(real,imag):
    pass

• 函數的參數清單中，預設值等號兩邊不要添加空格

# 正确的写法
def complex(real, imag=0.0):
    pass
# 不推荐的写法
def complex(real, imag = 0.0):
    pass

• 左括號之後，右括號之前不要加多餘的空格

# 正确的写法
spam(ham[1], {eggs: 2})
# 不推荐的写法
spam( ham[1], { eggs : 2 } )

• #字典物件的左括號之前不要多餘的空格

# 正确的写法
dict['key'] = list[index]
# 不推荐的写法
dict ['key'] = list [index]

• 不要為對齊賦值語句而使用的額外空格

# 正确的写法
x = 1
y = 2
long_variable = 3
# 不推荐的写法
x             = 1
y             = 2
long_variable = 3

5、換行

Python 支援括號內的換行。這時有兩種情況。

1.第二行縮排到括號的起始處

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

2.第二行縮排4 個空格，適用於起始括號就換行的情形

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

使用反斜線\換行，二元運算子.等應出現在行末；長字串也可以用此法換行

session.query(MyTable).\
        filter_by(id=1).\
        one()
print 'Hello, '\
      '%s %s!' %\
      ('Harry', 'Potter')

禁止複合語句，即一行中包含多個語句：

# 正确的写法
do_first()
do_second()
do_third()
# 不推荐的写法
do_first();do_second();do_third();

if/for/while一定要換行：

# 正确的写法
if foo == 'blah':
    do_blah_thing()
# 不推荐的写法
if foo == 'blah': do_blash_thing()

#6、docstring

docstring 的規範中最其本的兩點：

1.所有的公共模組、函數、類別、方法，都應該寫docstring 。私有方法不一定需要，但應該在 def 之後提供一個區塊註解來說明。

2.docstring 的結束"""應該獨佔一行，除非此 docstring 只有一行。

"""Return a foobar
Optional plotz says to frobnicate the bizbaz first.
"""
"""Oneline docstring"""