寫 Python 腳本時,一定要加上這個

我發(fā)現(xiàn)有不少朋友寫 Python 腳本非常隨意留量,要么不用函數(shù)窄赋,要么函數(shù)隨處定義,反正第一眼看不出要執(zhí)行的第一行代碼位于何處楼熄,這樣的腳本可讀性很差忆绰,而且容易隱藏 bug,解決這個問題很簡單可岂,當(dāng)我們寫 Python 腳本時错敢,一定要加上這個:

def main():
    # do something
    print("do something.")


if __name__ == "__main__":
    main()

你可能要反對了:我怎么爽就怎么寫,憑什么聽你的缕粹,多寫個 if name...?

別急稚茅,讓我說三個原因。

第一平斩,它讓 Python 文件的作用更加明確

首先需要明白 name 的作用亚享,當(dāng)腳本直接被 Python 解釋器執(zhí)行時,其值就是 "main"绘面,當(dāng)其被其他 Python 程序 import 的時候欺税,其值就是對應(yīng)的 Python 腳本文件名,可以在 Python 解釋器驗證下揭璃,假定有個 some_script.py 其內(nèi)容如下:

print("some_script.py")
print(__name__)

在 Python 解釋器導(dǎo)入一下:

? vim some_script.py
? python
Python 3.8.5 (v3.8.5:580fbb018f, Jul 20 2020, 12:11:27)
[Clang 6.0 (clang-600.0.57)] on darwin
Type "help", "copyright", "credits" or "license" for more information.
>>> import some_script
some_script.py
some_script
>>>

可以看到晚凿,name 的值就是 Python 腳本的文件名 some_script。

也就是說 if name == "main": 后面的代碼在 import 的時候是不會運(yùn)行的瘦馍。

明白了這一點歼秽,if name == "main": 就可以做為區(qū)分腳本和庫的一個標(biāo)志,當(dāng)我們看到 if name == "main": 時情组,就認(rèn)為這一個可以直接運(yùn)行的腳本哲银,當(dāng)沒有看到這行代碼時,就認(rèn)為這是一個庫呻惕,可以被其他程序引用荆责,Explicit is better than implicit.,不是嗎亚脆?

再舉個例子:

假如你寫了一個不帶if name == "main": 的腳本做院,叫 bad_script.py,內(nèi)容如下:

def useful_function(x):
    return x * x


class UsefulClass:
    def __init__(self, x):
        self.x = x

#你自己測試了一吧,沒毛病
for i in range(7):
    print(useful_function(i))
    

別人寫了個 useful.py键耕,引用了你的 useful_function:

from bad_script import useful_function


def main():
    print(f'{useful_function(3)=}')


if __name__ == '__main__':
    main()
    

一運(yùn)行寺滚,發(fā)現(xiàn)打印了不可預(yù)期的內(nèi)容,見下圖紅色部分:

image.png

查了半天原因屈雄,發(fā)現(xiàn)是你的腳本輸出的村视,你說別人會不會罵你?

假如你在自己腳本里定義了全局變量酒奶,別人如果在不合適的位置導(dǎo)入了 *蚁孔,就會把你這個全局變量也導(dǎo)入,導(dǎo)致變量覆蓋惋嚎,很容易會出現(xiàn) bug杠氢。

第二,它讓 Python 文件更加易讀另伍,對 IDE 友好

有了 if name == "main": 相當(dāng)于 Python 程序也有了一個入口函數(shù)鼻百,所有的變量都從這里開始定義和使用,我們可以清晰的知道程序的邏輯開始于何處(當(dāng)然還需要我們自覺的把程序的開始邏輯都放在這里)

其實摆尝,這也是 PyCharm 推薦的做法温艇,當(dāng)你新建一個項目的時候,它默認(rèn)創(chuàng)建的 main.py 就是長這樣的:


image.png

在if name == "main": 的那一行的最左邊也有一個綠色的運(yùn)行按鈕堕汞,點擊一下中贝,程序就從這一行開始運(yùn)行了。

為什么很多優(yōu)秀的編程語言臼朗,比如 C邻寿、Java、Golang视哑、C++ 都有一個 main 入口函數(shù)呢绣否?我想很重要的一個原因就是就是程序入口統(tǒng)一,容易閱讀挡毅。

第三蒜撮、多進(jìn)程場景下,必須用 if main

比如說你用多進(jìn)程搞并行計算跪呈,寫了這樣的代碼:

import multiprocessing as mp


def useful_function(x):
    return x * x

print("processing in parallel")
with mp.Pool() as p:
    results = p.map(useful_function, [1, 2, 3, 4])
    print(results)

當(dāng)你運(yùn)行的時候段磨,會發(fā)現(xiàn)程序不停的在創(chuàng)建進(jìn)程,同時也在不停的報錯 RuntimeError耗绿,即使你 Ctrl C 也無法終止程序苹支。而加上了 if name == "main": 程序就會按照預(yù)期的進(jìn)行:

import multiprocessing as mp


def useful_function(x):
    return x * x

if __name__ == '__main__':
    print("processing in parallel")
    with mp.Pool() as p:
        results = p.map(useful_function, [1, 2, 3, 4])
        print(results)

這是為什么呢?

其實我是這樣理解的误阻,Python 的多程序就是啟動了多個 Python 解釋器债蜜,每個 Python 解釋器都會導(dǎo)入你這個腳本晴埂,復(fù)制一份全局變量和函數(shù)給子進(jìn)程用,如果有了if name == "main":寻定,那它后面的代碼就不會被 import儒洛,也就不會被重復(fù)執(zhí)行。否則狼速,這個創(chuàng)建多進(jìn)程的代碼就會被 import琅锻,就會被執(zhí)行,從而無限遞歸的去創(chuàng)建子進(jìn)程向胡,Python3 會報 RuntimeError恼蓬,順序是先創(chuàng)建進(jìn)程,然后報錯的捷枯,因此就會出現(xiàn)不停的創(chuàng)建進(jìn)程,不停的報錯专执,Ctrl C 也無法終止的現(xiàn)象淮捆,只能 kill 掉整個終端。這里有個官方解釋

最后的話

if name == "main": 雖然不是強(qiáng)制的本股,但是基于上述三點原因攀痊,我強(qiáng)烈推薦你這么做,它是 Python 社區(qū)的約定拄显,對應(yīng)Python 之禪:明確優(yōu)于隱晦苟径。正如 _ 作為變量名的意思就是告訴讀代碼的人:這個變量不重要,后面也不會用到它躬审。當(dāng)你看到 Python 腳本有 if name == "main": 時棘街,就會意識到,這是一個可執(zhí)行的腳本承边,當(dāng)被其他程序?qū)霑r遭殉,這部分代碼不會被執(zhí)行,而多進(jìn)程的程序中博助,這是必須的险污。

最后編輯于
?著作權(quán)歸作者所有,轉(zhuǎn)載或內(nèi)容合作請聯(lián)系作者
  • 序言:七十年代末,一起剝皮案震驚了整個濱河市富岳,隨后出現(xiàn)的幾起案子蛔糯,更是在濱河造成了極大的恐慌,老刑警劉巖窖式,帶你破解...
    沈念sama閱讀 206,839評論 6 482
  • 序言:濱河連續(xù)發(fā)生了三起死亡事件蚁飒,死亡現(xiàn)場離奇詭異,居然都是意外死亡萝喘,警方通過查閱死者的電腦和手機(jī)飒箭,發(fā)現(xiàn)死者居然都...
    沈念sama閱讀 88,543評論 2 382
  • 文/潘曉璐 我一進(jìn)店門狼电,熙熙樓的掌柜王于貴愁眉苦臉地迎上來,“玉大人弦蹂,你說我怎么就攤上這事肩碟。” “怎么了凸椿?”我有些...
    開封第一講書人閱讀 153,116評論 0 344
  • 文/不壞的土叔 我叫張陵削祈,是天一觀的道長。 經(jīng)常有香客問我脑漫,道長髓抑,這世上最難降的妖魔是什么? 我笑而不...
    開封第一講書人閱讀 55,371評論 1 279
  • 正文 為了忘掉前任优幸,我火速辦了婚禮吨拍,結(jié)果婚禮上,老公的妹妹穿的比我還像新娘网杆。我一直安慰自己羹饰,他們只是感情好,可當(dāng)我...
    茶點故事閱讀 64,384評論 5 374
  • 文/花漫 我一把揭開白布碳却。 她就那樣靜靜地躺著队秩,像睡著了一般。 火紅的嫁衣襯著肌膚如雪昼浦。 梳的紋絲不亂的頭發(fā)上馍资,一...
    開封第一講書人閱讀 49,111評論 1 285
  • 那天,我揣著相機(jī)與錄音关噪,去河邊找鬼鸟蟹。 笑死,一個胖子當(dāng)著我的面吹牛使兔,可吹牛的內(nèi)容都是我干的戏锹。 我是一名探鬼主播,決...
    沈念sama閱讀 38,416評論 3 400
  • 文/蒼蘭香墨 我猛地睜開眼火诸,長吁一口氣:“原來是場噩夢啊……” “哼锦针!你這毒婦竟也來了?” 一聲冷哼從身側(cè)響起置蜀,我...
    開封第一講書人閱讀 37,053評論 0 259
  • 序言:老撾萬榮一對情侶失蹤奈搜,失蹤者是張志新(化名)和其女友劉穎,沒想到半個月后盯荤,有當(dāng)?shù)厝嗽跇淞掷锇l(fā)現(xiàn)了一具尸體馋吗,經(jīng)...
    沈念sama閱讀 43,558評論 1 300
  • 正文 獨居荒郊野嶺守林人離奇死亡,尸身上長有42處帶血的膿包…… 初始之章·張勛 以下內(nèi)容為張勛視角 年9月15日...
    茶點故事閱讀 36,007評論 2 325
  • 正文 我和宋清朗相戀三年秋秤,在試婚紗的時候發(fā)現(xiàn)自己被綠了宏粤。 大學(xué)時的朋友給我發(fā)了我未婚夫和他白月光在一起吃飯的照片脚翘。...
    茶點故事閱讀 38,117評論 1 334
  • 序言:一個原本活蹦亂跳的男人離奇死亡,死狀恐怖绍哎,靈堂內(nèi)的尸體忽然破棺而出来农,到底是詐尸還是另有隱情,我是刑警寧澤崇堰,帶...
    沈念sama閱讀 33,756評論 4 324
  • 正文 年R本政府宣布沃于,位于F島的核電站,受9級特大地震影響海诲,放射性物質(zhì)發(fā)生泄漏繁莹。R本人自食惡果不足惜,卻給世界環(huán)境...
    茶點故事閱讀 39,324評論 3 307
  • 文/蒙蒙 一特幔、第九天 我趴在偏房一處隱蔽的房頂上張望咨演。 院中可真熱鬧,春花似錦蚯斯、人聲如沸薄风。這莊子的主人今日做“春日...
    開封第一講書人閱讀 30,315評論 0 19
  • 文/蒼蘭香墨 我抬頭看了看天上的太陽村刨。三九已至告抄,卻和暖如春撰茎,著一層夾襖步出監(jiān)牢的瞬間,已是汗流浹背打洼。 一陣腳步聲響...
    開封第一講書人閱讀 31,539評論 1 262
  • 我被黑心中介騙來泰國打工龄糊, 沒想到剛下飛機(jī)就差點兒被人妖公主榨干…… 1. 我叫王不留,地道東北人募疮。 一個月前我還...
    沈念sama閱讀 45,578評論 2 355
  • 正文 我出身青樓炫惩,卻偏偏與公主長得像,于是被迫代替她去往敵國和親阿浓。 傳聞我的和親對象是個殘疾皇子他嚷,可洞房花燭夜當(dāng)晚...
    茶點故事閱讀 42,877評論 2 345

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