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

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

1.變量

  • _xxx,單下劃線開(kāi)頭的變量占哟,標(biāo)明是一個(gè)受保護(hù)(protected)的變量心墅,原則上不允許直接訪問(wèn),但外部類還是可以訪問(wèn)到這個(gè)變量榨乎。這只是程序員之間的一個(gè)約定怎燥,用于警告說(shuō)明這是一個(gè)私有變量,外部類不要去訪問(wèn)它蜜暑。
class Student(object):
def __init__(self, name):
    self._name = name
>>> sd = Student('Tom')
>>> sd._name
'Tom'
  • __xxx,雙下劃線開(kāi)頭的刺覆,表示的是私有類型(private)的變量。只能是允許這個(gè)類本身進(jìn)行訪問(wèn)了, 連子類也不可以,用于命名一個(gè)類屬性(類變量)史煎,調(diào)用時(shí)名字被改變(在類Student內(nèi)部谦屑,__name變成_Student__name,如 self._Student__name)
    雙下劃線開(kāi)頭的實(shí)例變量是不是一定不能從外部訪問(wèn)呢?其實(shí)也不是篇梭。仍然可以通過(guò)_Student__name來(lái)訪問(wèn)__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__,以雙下劃線開(kāi)頭氢橙,并且以雙下劃線結(jié)尾的,是內(nèi)置變量恬偷,內(nèi)置變量是可以直接訪問(wèn)的悍手,不是 private 變量,如__init__袍患,__import__或是__file__坦康。所以,不要自己定義這類變量诡延。
  • xxx_,單下劃線結(jié)尾的變量一般只是為了避免與 Python 關(guān)鍵字的命名沖突滞欠。
  • USER_CONSTANT,大寫加下劃線,對(duì)于不會(huì)發(fā)生改變的全局變量肆良,使用大寫加下劃線筛璧。

2.函數(shù)和方法

總體而言應(yīng)該使用逸绎,小寫和下劃線。但有些比較老的庫(kù)使用的是混合大小寫夭谤,即首單詞小寫棺牧,之后每個(gè)單詞第一個(gè)字母大寫,其余小寫朗儒。但現(xiàn)在颊乘,小寫和下劃線已成為規(guī)范。

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

這里和私有變量一樣醉锄,并不是真正的私有訪問(wèn)權(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)兩邊無(wú)空格
def connect(self, user=None):
self._user = user

3.類

類總是使用駝峰格式命名神妹,即所有單詞首字母大寫其余字母小寫颓哮。類名應(yīng)該簡(jiǎn)明,精確鸵荠,并足以從中理解類所完成的工作冕茅。常見(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 不要用斷言來(lái)實(shí)現(xiàn)靜態(tài)類型檢測(cè)

斷言可以用于檢查參數(shù),但不應(yīng)僅僅是進(jìn)行靜態(tài)類型檢測(cè)届慈。 Python 是動(dòng)態(tài)類型語(yǔ)言徒溪,靜態(tài)類型檢測(cè)違背了其設(shè)計(jì)思想。斷言應(yīng)該用于避免函數(shù)不被毫無(wú)意義的調(diào)用金顿。

5.2 不要濫用 *args 和 **kwargs

*args 和 **kwargs 參數(shù)可能會(huì)破壞函數(shù)的健壯性臊泌。它們使簽名變得模糊,而且代碼常常開(kāi)始在不應(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ù)自己的情況慧妄,比如不要超過(guò)滿屏?xí)r編輯器的顯示列數(shù)顷牌。這樣就可以在不動(dòng)水平游標(biāo)的情況下剪芍,方便的查看代碼。
  • 一個(gè)函數(shù) : 不要超過(guò) 30 行代碼, 即可顯示在一個(gè)屏幕類窟蓝,可以不使用垂直游標(biāo)即可看到整個(gè)函數(shù)罪裹。
  • 一個(gè)類 : 不要超過(guò) 200 行代碼,不要有超過(guò) 10 個(gè)方法运挫。
  • 一個(gè)模塊 不要超過(guò) 500 行状共。
最后編輯于
?著作權(quán)歸作者所有,轉(zhuǎn)載或內(nèi)容合作請(qǐng)聯(lián)系作者
  • 序言:七十年代末,一起剝皮案震驚了整個(gè)濱河市谁帕,隨后出現(xiàn)的幾起案子峡继,更是在濱河造成了極大的恐慌,老刑警劉巖匈挖,帶你破解...
    沈念sama閱讀 212,542評(píng)論 6 493
  • 序言:濱河連續(xù)發(fā)生了三起死亡事件碾牌,死亡現(xiàn)場(chǎng)離奇詭異,居然都是意外死亡儡循,警方通過(guò)查閱死者的電腦和手機(jī)舶吗,發(fā)現(xiàn)死者居然都...
    沈念sama閱讀 90,596評(píng)論 3 385
  • 文/潘曉璐 我一進(jìn)店門,熙熙樓的掌柜王于貴愁眉苦臉地迎上來(lái)择膝,“玉大人誓琼,你說(shuō)我怎么就攤上這事‰茸剑” “怎么了腹侣?”我有些...
    開(kāi)封第一講書人閱讀 158,021評(píng)論 0 348
  • 文/不壞的土叔 我叫張陵,是天一觀的道長(zhǎng)齿穗。 經(jīng)常有香客問(wèn)我傲隶,道長(zhǎng),這世上最難降的妖魔是什么缤灵? 我笑而不...
    開(kāi)封第一講書人閱讀 56,682評(píng)論 1 284
  • 正文 為了忘掉前任伦籍,我火速辦了婚禮,結(jié)果婚禮上腮出,老公的妹妹穿的比我還像新娘帖鸦。我一直安慰自己,他們只是感情好胚嘲,可當(dāng)我...
    茶點(diǎn)故事閱讀 65,792評(píng)論 6 386
  • 文/花漫 我一把揭開(kāi)白布作儿。 她就那樣靜靜地躺著,像睡著了一般馋劈。 火紅的嫁衣襯著肌膚如雪攻锰。 梳的紋絲不亂的頭發(fā)上晾嘶,一...
    開(kāi)封第一講書人閱讀 49,985評(píng)論 1 291
  • 那天,我揣著相機(jī)與錄音娶吞,去河邊找鬼垒迂。 笑死,一個(gè)胖子當(dāng)著我的面吹牛妒蛇,可吹牛的內(nèi)容都是我干的机断。 我是一名探鬼主播,決...
    沈念sama閱讀 39,107評(píng)論 3 410
  • 文/蒼蘭香墨 我猛地睜開(kāi)眼绣夺,長(zhǎng)吁一口氣:“原來(lái)是場(chǎng)噩夢(mèng)啊……” “哼吏奸!你這毒婦竟也來(lái)了?” 一聲冷哼從身側(cè)響起陶耍,我...
    開(kāi)封第一講書人閱讀 37,845評(píng)論 0 268
  • 序言:老撾萬(wàn)榮一對(duì)情侶失蹤奋蔚,失蹤者是張志新(化名)和其女友劉穎,沒(méi)想到半個(gè)月后烈钞,有當(dāng)?shù)厝嗽跇?shù)林里發(fā)現(xiàn)了一具尸體泊碑,經(jīng)...
    沈念sama閱讀 44,299評(píng)論 1 303
  • 正文 獨(dú)居荒郊野嶺守林人離奇死亡,尸身上長(zhǎng)有42處帶血的膿包…… 初始之章·張勛 以下內(nèi)容為張勛視角 年9月15日...
    茶點(diǎn)故事閱讀 36,612評(píng)論 2 327
  • 正文 我和宋清朗相戀三年棵磷,在試婚紗的時(shí)候發(fā)現(xiàn)自己被綠了蛾狗。 大學(xué)時(shí)的朋友給我發(fā)了我未婚夫和他白月光在一起吃飯的照片。...
    茶點(diǎn)故事閱讀 38,747評(píng)論 1 341
  • 序言:一個(gè)原本活蹦亂跳的男人離奇死亡仪媒,死狀恐怖沉桌,靈堂內(nèi)的尸體忽然破棺而出,到底是詐尸還是另有隱情算吩,我是刑警寧澤留凭,帶...
    沈念sama閱讀 34,441評(píng)論 4 333
  • 正文 年R本政府宣布,位于F島的核電站偎巢,受9級(jí)特大地震影響蔼夜,放射性物質(zhì)發(fā)生泄漏。R本人自食惡果不足惜压昼,卻給世界環(huán)境...
    茶點(diǎn)故事閱讀 40,072評(píng)論 3 317
  • 文/蒙蒙 一求冷、第九天 我趴在偏房一處隱蔽的房頂上張望。 院中可真熱鬧窍霞,春花似錦匠题、人聲如沸。這莊子的主人今日做“春日...
    開(kāi)封第一講書人閱讀 30,828評(píng)論 0 21
  • 文/蒼蘭香墨 我抬頭看了看天上的太陽(yáng)。三九已至,卻和暖如春钱磅,著一層夾襖步出監(jiān)牢的瞬間梦裂,已是汗流浹背。 一陣腳步聲響...
    開(kāi)封第一講書人閱讀 32,069評(píng)論 1 267
  • 我被黑心中介騙來(lái)泰國(guó)打工盖淡, 沒(méi)想到剛下飛機(jī)就差點(diǎn)兒被人妖公主榨干…… 1. 我叫王不留年柠,地道東北人。 一個(gè)月前我還...
    沈念sama閱讀 46,545評(píng)論 2 362
  • 正文 我出身青樓禁舷,卻偏偏與公主長(zhǎng)得像彪杉,于是被迫代替她去往敵國(guó)和親毅往。 傳聞我的和親對(duì)象是個(gè)殘疾皇子牵咙,可洞房花燭夜當(dāng)晚...
    茶點(diǎn)故事閱讀 43,658評(píng)論 2 350

推薦閱讀更多精彩內(nèi)容