1. 程式人生 > >Python PEP8 PEP257 編碼規範中文版 學習筆記

Python PEP8 PEP257 編碼規範中文版 學習筆記

原文連結:http://legacy.python.org/dev/peps/pep-0008/

A Foolish Consistency is the Hobgoblin of little Minds.
盡信書不如無書

與PEP8一致的目錄

PEP8

1.縮排用4個空格,儘量不用TAB鍵
2.行最大字元79,註釋字元最大72
3.推薦在二元操作符之前換行

# 推薦:運算子和運算元很容易進行匹配
income = (gross_wages
         + taxable_interest
         +
(dividends - qualified_dividends) - ira_deduction - student_loan_interest)

4.import匯入通常在分開的行,

# 推薦這樣
import os
import sys
# 不推薦:  
import sys, os
# 但是可以這樣:
from subprocess import Popen, PIPE

5.程式頂部順序

# 1.模組註釋和文件字串
"""
模組註釋和文件字串在最上面
"""
# 1.1 __future__這個特例
from __future__ import
barry_as_FLUFL # 2 模組級的呆名 __author__ = 'junqiao' __version__ = '0.1' # 3.1標準庫的匯入 # 3.2相關第三方庫的匯入 # 3.3本地庫的匯入 import os import operate import numpy import xadmin import mylibrary # 4 變數的定義 myList = []

6.python中單引號和雙引號等價
7.避免在尾部新增空格
8.考慮在二元運算子兩邊加空格,例如 = , + , - , += , ==, and
但是在使用不同優先順序的運算子時,考慮在最低優先順序的運算子周圍新增空格

# 推薦:
i = i + 1
submitted += 1
x = x*2 - 1
hypot2 = x*x + y*y
c = (a+b) * (a-b)5
#不推薦:
i=i+1
submitted +=1
x = x * 2 - 1
hypot2 = x * x + y * y
c = (a + b) * (a - b)

在制定關鍵字引數或者預設引數值時,不要在=附近加上空格

#推薦:
def complex(real, imag=0.0):
    return magic(r=real, i=imag)
#不推薦:
def complex(real, imag = 0.0):
    return magic(r = real, i = imag)

9.插曲 函式引數註解

# 引數x y return 為int型,但只是註釋,
#如果用錯,定義時不報錯,執行時才會報錯
def accumlate(x:int, y:int) -> int:
    return x*y

PEP257 規範書寫文件