1 變量
1)前帶 _ 的變量: 標(biāo)明是一個(gè)私有變量, 只用于標(biāo)明, 外部類還是可以訪問到這個(gè)變量
2)前帶兩個(gè) _ ,后帶兩個(gè) _ 的變量:標(biāo)明是內(nèi)置變量,
3)大寫加下劃線的變量: 標(biāo)明是不會(huì)發(fā)生改變的全局變量
常量 : 大寫加下劃線
USER_CONSTANT
對(duì)于不會(huì)發(fā)生改變的全局變量聚磺,使用大寫加下劃線败京。
私有變量 : 小寫和一個(gè)前導(dǎo)下劃線
_private_value
Python 中不存在私有變量一說葛家,若是遇到需要保護(hù)的變量毕泌,使用小寫和一個(gè)前導(dǎo)下劃線惯裕。但這只是程序員之間的一個(gè)約定玄叠,用于警告說明這是一個(gè)私有變量欣尼,外部類不要去訪問它祸穷。但實(shí)際上性穿,外部類還是可以訪問到這個(gè)變量。
內(nèi)置變量 : 小寫雷滚,兩個(gè)前導(dǎo)下劃線和兩個(gè)后置下劃線
__class__
兩個(gè)前導(dǎo)下劃線會(huì)導(dǎo)致變量在解釋期間被更名需曾。這是為了避免內(nèi)置變量和其他變量產(chǎn)生沖突。用戶定義的變量要嚴(yán)格避免這種風(fēng)格祈远。以免導(dǎo)致混亂呆万。
2 函數(shù)和方法
1)前帶 _ 的變量: 標(biāo)明是一個(gè)私有函數(shù), 只用于標(biāo)明,
2)前帶兩個(gè) _ ,后帶兩個(gè) _ 的函數(shù): 標(biāo)明是特殊函數(shù)
總體而言應(yīng)該使用,小寫和下劃線车份。但有些比較老的庫(kù)使用的是混合大小寫谋减,即首單詞小寫,之后每個(gè)單詞第一個(gè)字母大寫扫沼,其余小寫出爹。但現(xiàn)在庄吼,小寫和下劃線已成為規(guī)范。
私有方法 : 小寫和一個(gè)前導(dǎo)下劃線
def _secrete(self):
print "don't test me."
這里和私有變量一樣严就,并不是真正的私有訪問權(quán)限总寻。同時(shí)也應(yīng)該注意一般函數(shù)不要使用兩個(gè)前導(dǎo)下劃線(當(dāng)遇到兩個(gè)前導(dǎo)下劃線時(shí),Python 的名稱改編特性將發(fā)揮作用)梢为。
特殊函數(shù)后面會(huì)提及渐行。
特殊方法 : 小寫和兩個(gè)前導(dǎo)下劃線,兩個(gè)后置下劃線
def __add__(self, other):
return int.__add__(other)
這種風(fēng)格只應(yīng)用于特殊函數(shù)铸董,比如操作符重載等祟印。
函數(shù)參數(shù) : 小寫和下劃線,缺省值等號(hào)兩邊無空格
def connect(self, user=None):
self._user = user
3 類
類總是使用駝峰格式命名粟害,即所有單詞首字母大寫其余字母小寫旁理。類名應(yīng)該簡(jiǎn)明,精確我磁,并足以從中理解類所完成的工作孽文。常見的一個(gè)方法是使用表示其類型或者特性的后綴,例如:
SQLEngine
MimeTypes
對(duì)于基類而言夺艰,可以使用一個(gè) Base 或者 Abstract 前綴
BaseCookie
AbstractGroup
class UserProfile(object):
def __init__(self, profile):
return self._profile = profile
def profile(self):
return self._profile
4 模塊和包
除特殊模塊 __init__
之外芋哭,模塊名稱都使用不帶下劃線的小寫字母。
若是它們實(shí)現(xiàn)一個(gè)協(xié)議郁副,那么通常使用lib為后綴减牺,例如:
import smtplib
import os
import sys
5 關(guān)于參數(shù)
5.1 不要用斷言來實(shí)現(xiàn)靜態(tài)類型檢測(cè)
斷言可以用于檢查參數(shù),但不應(yīng)僅僅是進(jìn)行靜態(tài)類型檢測(cè)存谎。 Python 是動(dòng)態(tài)類型語言拔疚,靜態(tài)類型檢測(cè)違背了其設(shè)計(jì)思想。斷言應(yīng)該用于避免函數(shù)不被毫無意義的調(diào)用既荚。
5.2 不要濫用 *args
和 **kwargs
*args
和**kwargs
參數(shù)可能會(huì)破壞函數(shù)的健壯性稚失。它們使簽名變得模糊,而且代碼常常開始在不應(yīng)該的地方構(gòu)建小的參數(shù)解析器恰聘。
6 其他
6.1 使用 has 或 is 前綴命名布爾元素
is_connect = True
has_member = False
6.2 用復(fù)數(shù)形式命名序列
members = ['user_1', 'user_2']
6.3 用顯式名稱命名字典
person_address = {'user_1':'10 road WD', 'user_2' : '20 street huafu'}
6.4 避免通用名稱
諸如 list, dict, sequence 或者 element 這樣的名稱應(yīng)該避免句各。
6.5 避免現(xiàn)有名稱
諸如 os, sys 這種系統(tǒng)已經(jīng)存在的名稱應(yīng)該避免。
7 一些數(shù)字
一行列數(shù) : PEP 8 規(guī)定為 79 列晴叨,這有些苛刻了凿宾。根據(jù)自己的情況,比如不要超過滿屏?xí)r編輯器的顯示列數(shù)兼蕊。這樣就可以在不動(dòng)水平游標(biāo)的情況下初厚,方便的查看代碼。
一個(gè)函數(shù) : 不要超過 30 行代碼, 即可顯示在一個(gè)屏幕類孙技,可以不使用垂直游標(biāo)即可看到整個(gè)函數(shù)产禾。
一個(gè)類 : 不要超過 200 行代碼排作,不要有超過 10 個(gè)方法。
一個(gè)模塊 不要超過 500 行下愈。
Python 的代碼風(fēng)格由 PEP 8 描述纽绍。這個(gè)文檔描述了 Python 編程風(fēng)格的方方面面蕾久。在遵守這個(gè)文檔的條件下势似,不同程序員編寫的 Python 代碼可以保持最大程度的相似風(fēng)格。這樣就易于閱讀僧著,易于在程序員之間交流履因。