PEP8
《8 號 Python 增強規范》(Python Enhacement Proposal #8),簡稱PEP8
通俗的來講 PEP8 是針對 python 代碼格式而編訂的風格指南,令代碼更加易讀易懂。像谷歌這樣的大公司是有自己內部的風格規范Google Style,目的就是為了提高開發效率。
據傳聞,Google 馬桶前面的門上,都貼著 Python 編碼規范。小數先生今天就分享一些常用的PEP8編碼規范。
縮進
a.每一級縮進使用4個空格。
b.續行應該與其包裹元素對其。
例
# 推薦
# 與左括號對齊
fo = dict(name='小數先生', age=18,
gender='男',city='hangzhou')
# 用更多的縮進來與其他行區分
def long_function_name(
var_noe, var_two,
var_three, var_four):
print(var_one)
不推薦
# 不推薦
fo = dict(name='小數先生', age=18,
gender='男',city='hangzhou')
def long_function_name(
var_noe, var_two,
var_three, var_four):
print(var_one)
行的最大長度
a.所有行限制的最大字符串數為79。
b.沒有結構化限制的大塊文本(文檔字符或者注釋),每行最大字符數限制在72。
空行
a.頂層函數和類的定義,前后用兩個空行隔開。
b.類里的方法定義用一個空行隔開。
imports導入
a.導入通常在分開的行。
# 推薦
import os
import sys
# 不推薦
import sys, os
b.導入總是位于文件的頂部,在模塊注釋和文檔字符串之后,在模塊的全局變量與常量之前。
c.導入應該按照以下順序分組標準庫導入
相關第三方庫導入
本地應用/庫特定導入(應該在每一組導入之間加入空行)
d.推薦使用絕對路徑導入,如果導入系統沒有正確的配置,使用絕對路徑會更加可讀并且性能更好。
Comments注釋
a.代碼更改時,優先更新對應的注釋。
b.注釋應該是完整的句子。
c.如果注釋很短,結尾的句號可以省略。
d.在句尾結束的時候應該使用兩個空格
Block Comments 塊注釋
a.塊注釋通常適用于跟隨它們的某些(或全部)代碼,并縮進到與代碼相同的級別。塊注釋的每一行開通使用一個 # 和一個空格(除非塊注釋內部縮進文本)
b.塊注釋內部的段落通過只有一個 # 的空行分隔
Inline Comments 行內注釋
a.有節制地使用行內注釋
b.行內注釋是與代碼語句同行的注釋,行內注釋和代碼至少要有兩個空格分隔。
Documentation Strings文檔字符串
a.要為所有的公共模塊,函數,類已經方法編寫文檔說明
b.多行文檔說明使用的結尾三引號自成一行
# 推薦
"""Return a foobang
Optional plotz says to frobnicate the bizbaz first.
"""
命名規范
a.永遠不要使用字母'l'(小寫的L),'O'(大寫的o),或者'I'(大寫的i)作為單字符變量名
b.函數名要小寫,如果想提高可讀性可以用下劃線分離
c.類名首字母要大寫
更多內容PEP 8 -- Style Guide for Python Code?legacy.python.orgb.Python PEP8 編碼規范中文版?blog.csdn.netstyleguide?google.github.io
作者:小數先生