python: 下劃線變量和方法的意義

Python 的代碼風格由 PEP 8 描述。這個文檔描述了 Python 編程風格的方方面面。在遵守這個文檔的條件下,不同程序員編寫的 Python 代碼可以保持最大程度的相似風格。這樣就易于閱讀,易于在程序員之間交流。

1.變量

  • _xxx,單下劃線開頭的變量,標明是一個受保護(protected)的變量,原則上不允許直接訪問,但外部類還是可以訪問到這個變量。這只是程序員之間的一個約定,用于警告說明這是一個私有變量,外部類不要去訪問它。
class Student(object):
def __init__(self, name):
    self._name = name
>>> sd = Student('Tom')
>>> sd._name
'Tom'
  • __xxx,雙下劃線開頭的,表示的是私有類型(private)的變量。只能是允許這個類本身進行訪問了, 連子類也不可以,用于命名一個類屬性(類變量),調用時名字被改變(在類Student內部,__name變成_Student__name,如 self._Student__name)
    雙下劃線開頭的實例變量是不是一定不能從外部訪問呢?其實也不是。仍然可以通過_Student__name來訪問__name變量:
class Student(object):
    def __init__(self, name):
        self.__name = name
>>> sd = Student('Tom')
>>> sd.__name
Traceback (most recent call last):
  File "<stdin>", line 1, in <module>
AttributeError: 'Student' object has no attribute '__name'
>>> sd._Student__name
'Tom'
  • __xxx__,以雙下劃線開頭,并且以雙下劃線結尾的,是內置變量,內置變量是可以直接訪問的,不是 private 變量,如__init__,__import__或是__file__。所以,不要自己定義這類變量。
  • xxx_,單下劃線結尾的變量一般只是為了避免與 Python 關鍵字的命名沖突。
  • USER_CONSTANT,大寫加下劃線,對于不會發生改變的全局變量,使用大寫加下劃線。

2.函數和方法

總體而言應該使用,小寫和下劃線。但有些比較老的庫使用的是混合大小寫,即首單詞小寫,之后每個單詞第一個字母大寫,其余小寫。但現在,小寫和下劃線已成為規范。

  • 私有方法 : 小寫和一個前導下劃線
def _secrete(self):
print "don't test me."

這里和私有變量一樣,并不是真正的私有訪問權限。同時也應該注意一般函數不要使用兩個前導下劃線(當遇到兩個前導下劃線時,Python 的名稱改編特性將發揮作用)。特殊函數后面會提及。

  • 特殊方法 : 小寫和兩個前導下劃線,兩個后置下劃線
def __add__(self, other):
return int.__add__(other)

這種風格只應用于特殊函數,比如操作符重載等。

  • 函數參數 : 小寫和下劃線,缺省值等號兩邊無空格
def connect(self, user=None):
self._user = user

3.類

類總是使用駝峰格式命名,即所有單詞首字母大寫其余字母小寫。類名應該簡明,精確,并足以從中理解類所完成的工作。常見的一個方法是使用表示其類型或者特性的后綴,例如:
SQLEngine
MimeTypes
對于基類而言,可以使用一個 Base 或者 Abstract 前綴

BaseCookie
AbstractGroup
class UserProfile(object):
    def __init__(self, profile):
        return self._profile = profile

    def profile(self):
        return self._profile

4.模塊和包

除特殊模塊 init 之外,模塊名稱都使用不帶下劃線的小寫字母。
若是它們實現一個協議,那么通常使用lib為后綴,例如:

import smtplib
import os
import sys

5.關于參數

5.1 不要用斷言來實現靜態類型檢測

斷言可以用于檢查參數,但不應僅僅是進行靜態類型檢測。 Python 是動態類型語言,靜態類型檢測違背了其設計思想。斷言應該用于避免函數不被毫無意義的調用。

5.2 不要濫用 *args 和 **kwargs

*args 和 **kwargs 參數可能會破壞函數的健壯性。它們使簽名變得模糊,而且代碼常常開始在不應該的地方構建小的參數解析器。

6.其他

6.1 使用 has 或 is 前綴命名布爾元素

is_connect = True
has_member = False

6.2 用復數形式命名序列

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 這樣的名稱應該避免。

6.5 避免現有名稱

諸如 os, sys 這種系統已經存在的名稱應該避免。

7.一些數字

  • 一行列數 : PEP 8 規定為 79 列,這有些苛刻了。根據自己的情況,比如不要超過滿屏時編輯器的顯示列數。這樣就可以在不動水平游標的情況下,方便的查看代碼。
  • 一個函數 : 不要超過 30 行代碼, 即可顯示在一個屏幕類,可以不使用垂直游標即可看到整個函數。
  • 一個類 : 不要超過 200 行代碼,不要有超過 10 個方法。
  • 一個模塊 不要超過 500 行。
最后編輯于
?著作權歸作者所有,轉載或內容合作請聯系作者
平臺聲明:文章內容(如有圖片或視頻亦包括在內)由作者上傳并發布,文章內容僅代表作者本人觀點,簡書系信息發布平臺,僅提供信息存儲服務。
  • 序言:七十年代末,一起剝皮案震驚了整個濱河市,隨后出現的幾起案子,更是在濱河造成了極大的恐慌,老刑警劉巖,帶你破解...
    沈念sama閱讀 228,156評論 6 531
  • 序言:濱河連續發生了三起死亡事件,死亡現場離奇詭異,居然都是意外死亡,警方通過查閱死者的電腦和手機,發現死者居然都...
    沈念sama閱讀 98,401評論 3 415
  • 文/潘曉璐 我一進店門,熙熙樓的掌柜王于貴愁眉苦臉地迎上來,“玉大人,你說我怎么就攤上這事。” “怎么了?”我有些...
    開封第一講書人閱讀 176,069評論 0 373
  • 文/不壞的土叔 我叫張陵,是天一觀的道長。 經常有香客問我,道長,這世上最難降的妖魔是什么? 我笑而不...
    開封第一講書人閱讀 62,873評論 1 309
  • 正文 為了忘掉前任,我火速辦了婚禮,結果婚禮上,老公的妹妹穿的比我還像新娘。我一直安慰自己,他們只是感情好,可當我...
    茶點故事閱讀 71,635評論 6 408
  • 文/花漫 我一把揭開白布。 她就那樣靜靜地躺著,像睡著了一般。 火紅的嫁衣襯著肌膚如雪。 梳的紋絲不亂的頭發上,一...
    開封第一講書人閱讀 55,128評論 1 323
  • 那天,我揣著相機與錄音,去河邊找鬼。 笑死,一個胖子當著我的面吹牛,可吹牛的內容都是我干的。 我是一名探鬼主播,決...
    沈念sama閱讀 43,203評論 3 441
  • 文/蒼蘭香墨 我猛地睜開眼,長吁一口氣:“原來是場噩夢啊……” “哼!你這毒婦竟也來了?” 一聲冷哼從身側響起,我...
    開封第一講書人閱讀 42,365評論 0 288
  • 序言:老撾萬榮一對情侶失蹤,失蹤者是張志新(化名)和其女友劉穎,沒想到半個月后,有當地人在樹林里發現了一具尸體,經...
    沈念sama閱讀 48,881評論 1 334
  • 正文 獨居荒郊野嶺守林人離奇死亡,尸身上長有42處帶血的膿包…… 初始之章·張勛 以下內容為張勛視角 年9月15日...
    茶點故事閱讀 40,733評論 3 354
  • 正文 我和宋清朗相戀三年,在試婚紗的時候發現自己被綠了。 大學時的朋友給我發了我未婚夫和他白月光在一起吃飯的照片。...
    茶點故事閱讀 42,935評論 1 369
  • 序言:一個原本活蹦亂跳的男人離奇死亡,死狀恐怖,靈堂內的尸體忽然破棺而出,到底是詐尸還是另有隱情,我是刑警寧澤,帶...
    沈念sama閱讀 38,475評論 5 358
  • 正文 年R本政府宣布,位于F島的核電站,受9級特大地震影響,放射性物質發生泄漏。R本人自食惡果不足惜,卻給世界環境...
    茶點故事閱讀 44,172評論 3 347
  • 文/蒙蒙 一、第九天 我趴在偏房一處隱蔽的房頂上張望。 院中可真熱鬧,春花似錦、人聲如沸。這莊子的主人今日做“春日...
    開封第一講書人閱讀 34,582評論 0 26
  • 文/蒼蘭香墨 我抬頭看了看天上的太陽。三九已至,卻和暖如春,著一層夾襖步出監牢的瞬間,已是汗流浹背。 一陣腳步聲響...
    開封第一講書人閱讀 35,821評論 1 282
  • 我被黑心中介騙來泰國打工, 沒想到剛下飛機就差點兒被人妖公主榨干…… 1. 我叫王不留,地道東北人。 一個月前我還...
    沈念sama閱讀 51,595評論 3 390
  • 正文 我出身青樓,卻偏偏與公主長得像,于是被迫代替她去往敵國和親。 傳聞我的和親對象是個殘疾皇子,可洞房花燭夜當晚...
    茶點故事閱讀 47,908評論 2 372

推薦閱讀更多精彩內容