[轉(zhuǎn)]如何簡單地理解Python中的if __name__ == '__main__'

1. 摘要

通俗的理解__name__ == '__main__':假如你叫小明.py,在朋友眼中,你是小明(__name__ == '小明');在你自己眼中,你是你自己(__name__ == '__main__')。

if __name__ == '__main__'的意思是:當(dāng).py文件被直接運(yùn)行時(shí),if __name__ == '__main__'之下的代碼塊將被運(yùn)行;當(dāng).py文件以模塊形式被導(dǎo)入時(shí),if __name__ == '__main__'之下的代碼塊不被運(yùn)行。

2. 程序入口

對于很多編程語言來說,程序都必須要有一個(gè)入口,比如C,C++,以及完全面向?qū)ο蟮木幊陶Z言Java,C#等。如果你接觸過這些語言,對于程序入口這個(gè)概念應(yīng)該很好理解,C,C++都需要有一個(gè)main函數(shù)作為程序的入口,也就是程序的運(yùn)行會從main函數(shù)開始。同樣,Java,C#必須要有一個(gè)包含Main方法的主類,作為程序入口。

而Python則不同,它屬于腳本語言,不像編譯型語言那樣先將程序編譯成二進(jìn)制再運(yùn)行,而是動(dòng)態(tài)的逐行解釋運(yùn)行。也就是從腳本第一行開始運(yùn)行,沒有統(tǒng)一的入口。

一個(gè)Python源碼文件(.py)除了可以被直接運(yùn)行外,還可以作為模塊(也就是庫),被其他.py文件導(dǎo)入。不管是直接運(yùn)行還是被導(dǎo)入,.py文件的最頂層代碼都會被運(yùn)行(Python用縮進(jìn)來區(qū)分代碼層次),而當(dāng)一個(gè).py文件作為模塊被導(dǎo)入時(shí),我們可能不希望一部分代碼被運(yùn)行。

2.1 一個(gè).py文件被其他.py文件引用

假設(shè)我們有一個(gè)const.py文件,內(nèi)容如下:

PI =3.14defmain():print("PI:", PI)main()# 運(yùn)行結(jié)果:PI: 3.14

1

2

3

4

5

6

7

8

現(xiàn)在,我們寫一個(gè)用于計(jì)算圓面積的area.py文件,area.py文件需要用到const.py文件中的PI變量。從const.py中,我們把PI變量導(dǎo)入area.py:

fromconstimportPIdefcalc_round_area(radius):returnPI * (radius **2)defmain():print("round area: ", calc_round_area(2))main()'''

運(yùn)行結(jié)果:

PI: 3.14

round area:? 12.56

'''

1

2

3

4

5

6

7

8

9

10

11

12

13

14

15

2.2 修改const.py,添加if __name__ == "__main__"

我們看到const.py中的main函數(shù)也被運(yùn)行了,實(shí)際上我們不希望它被運(yùn)行,因?yàn)閏onst.py提供的main函數(shù)只是為了測試常量定義。這時(shí)if __name__ == '__main__'派上了用場,我們把const.py改一下,添加if __name__ == "__main__":

PI =3.14defmain():print("PI:", PI)if__name__ =="__main__":? ? main()

1

2

3

4

5

6

7

運(yùn)行const.py,輸出如下:

PI:3.14

1

運(yùn)行area.py,輸出如下:

round area:12.56

1

如上,我們可以看到if __name__ == '__main__'相當(dāng)于Python模擬的程序入口,Python本身并沒有這么規(guī)定,這只是一種編碼習(xí)慣。由于模塊之間相互引用,不同模塊可能有這樣的定義,而程序入口只有一個(gè)。到底哪個(gè)程序入口被選中,這取決于__name__的值。?

3.?__name__

3.1?__name__反映一個(gè)包的結(jié)構(gòu)

__name__是內(nèi)置變量,可用于反映一個(gè)包的結(jié)構(gòu)。假設(shè)我們有一個(gè)包a,包的結(jié)構(gòu)如下:

a├── b│? ├── c.py│? └── __init__.py└── __init__.py

1

2

3

4

5

在包a中,文件c.py,__init__.py,__init__.py的內(nèi)容都為:

print(__name__)

1

當(dāng)一個(gè).py文件(模塊)被其他.py文件(模塊)導(dǎo)入時(shí),我們在命令行執(zhí)行

python-c"import a.b.c"

1

輸出結(jié)果:

aa.ba.b.c

1

2

3

由此可見,__name__可以清晰地反映一個(gè)模塊在包中的層次。

3.2?__name__表示當(dāng)前模塊的名字

__name__是內(nèi)置變量,可用于表示當(dāng)前模塊的名字。我們直接運(yùn)行一個(gè).py文件(模塊)

pythona/b/c.py

1

輸出結(jié)果:

__main__

1

由此我們可知:如果一個(gè).py文件(模塊)被直接運(yùn)行時(shí),則其沒有包結(jié)構(gòu),其__name__值為__main__,即模塊名為__main__。

所以,if __name__ == '__main__'的意思是:當(dāng).py文件被直接運(yùn)行時(shí),if __name__ == '__main__'之下的代碼塊將被運(yùn)行;當(dāng).py文件以模塊形式被導(dǎo)入時(shí),if __name__ == '__main__'之下的代碼塊不被運(yùn)行。

4.?__main__.py文件與python -m

Python的-m參數(shù)用于將一個(gè)模塊或者包作為一個(gè)腳本運(yùn)行,而__main__.py文件相當(dāng)于是一個(gè)包的“入口程序“。

4.1 運(yùn)行Python程序的兩種方式

python xxx.py,直接運(yùn)行xxx.py文件

python -m xxx.py,把xxx.py當(dāng)做模塊運(yùn)行

假設(shè)我們有一個(gè)文件run.py,內(nèi)容如下:

importsysprint(sys.path)

1

2

3

我們用直接運(yùn)行的方式啟動(dòng)

python run.py

1

輸出結(jié)果(為了說明問題,輸出結(jié)果只截取了重要部分,下同):

['/home/huoty/aboutme/pythonstudy/main',...]

1

然后以模塊的方式運(yùn)行:

python -m run.py

1

輸出內(nèi)容

['',...]/usr/bin/python: No module named run.py

1

2

由于輸出結(jié)果只列出了關(guān)鍵的部分,應(yīng)該很容易看出他們之間的差異:

直接運(yùn)行方式是把run.py文件所在的目錄放到了sys.path屬性中

以模塊方式運(yùn)行是把你輸入命令的目錄(也就是當(dāng)前工作路徑),放到了 sys.path 屬性中。

以模塊方式運(yùn)行還有一個(gè)不同的地方:多出了一行No module named run.py的錯(cuò)誤。實(shí)際上以模塊方式運(yùn)行時(shí),Python先對run.py執(zhí)行一遍 import,所以print(sys.path)被成功執(zhí)行,然后Python才嘗試運(yùn)行run.py模塊,但是在path變量中并沒有run.py這個(gè)模塊,所以報(bào)錯(cuò)。正確的運(yùn)行方式,應(yīng)該是python -m run。

4.2?__main__.py的作用

仍然先看例子,假設(shè)我們有如下一個(gè)包package:

package├──__init__.py└──__main__.py

1

2

3

其中,文件__init__.py的內(nèi)容

importsysprint("__init__")print(sys.path)

1

2

3

4

其中,文件__main__.py的內(nèi)容

importsysprint("__main__")print(sys.path)

1

2

3

4

接下來,我們運(yùn)行這個(gè)package,使用python -m package運(yùn)行,輸出結(jié)果:

__init__['',...]__main__['',...]

1

2

3

4

5

使用python package運(yùn)行,輸出結(jié)果:

__main__['package',...]

1

2

總結(jié)一下

當(dāng)加上-m參數(shù)時(shí),Python會把當(dāng)前工作目錄添加到sys.path中;而不加-m時(shí),Python則會把腳本所在目錄添加到sys.path中。

當(dāng)加上-m參數(shù)時(shí),Python會先將模塊或者包導(dǎo)入,然后再執(zhí)行。

__main__.py文件是一個(gè)包或者目錄的入口程序。不管是用python package還是用python -m package運(yùn)行,__main__.py文件總是被執(zhí)行。?

?著作權(quán)歸作者所有,轉(zhuǎn)載或內(nèi)容合作請聯(lián)系作者
平臺聲明:文章內(nèi)容(如有圖片或視頻亦包括在內(nèi))由作者上傳并發(fā)布,文章內(nèi)容僅代表作者本人觀點(diǎn),簡書系信息發(fā)布平臺,僅提供信息存儲服務(wù)。
  • 序言:七十年代末,一起剝皮案震驚了整個(gè)濱河市,隨后出現(xiàn)的幾起案子,更是在濱河造成了極大的恐慌,老刑警劉巖,帶你破解...
    沈念sama閱讀 228,835評論 6 534
  • 序言:濱河連續(xù)發(fā)生了三起死亡事件,死亡現(xiàn)場離奇詭異,居然都是意外死亡,警方通過查閱死者的電腦和手機(jī),發(fā)現(xiàn)死者居然都...
    沈念sama閱讀 98,676評論 3 419
  • 文/潘曉璐 我一進(jìn)店門,熙熙樓的掌柜王于貴愁眉苦臉地迎上來,“玉大人,你說我怎么就攤上這事。” “怎么了?”我有些...
    開封第一講書人閱讀 176,730評論 0 380
  • 文/不壞的土叔 我叫張陵,是天一觀的道長。 經(jīng)常有香客問我,道長,這世上最難降的妖魔是什么? 我笑而不...
    開封第一講書人閱讀 63,118評論 1 314
  • 正文 為了忘掉前任,我火速辦了婚禮,結(jié)果婚禮上,老公的妹妹穿的比我還像新娘。我一直安慰自己,他們只是感情好,可當(dāng)我...
    茶點(diǎn)故事閱讀 71,873評論 6 410
  • 文/花漫 我一把揭開白布。 她就那樣靜靜地躺著,像睡著了一般。 火紅的嫁衣襯著肌膚如雪。 梳的紋絲不亂的頭發(fā)上,一...
    開封第一講書人閱讀 55,266評論 1 324
  • 那天,我揣著相機(jī)與錄音,去河邊找鬼。 笑死,一個(gè)胖子當(dāng)著我的面吹牛,可吹牛的內(nèi)容都是我干的。 我是一名探鬼主播,決...
    沈念sama閱讀 43,330評論 3 443
  • 文/蒼蘭香墨 我猛地睜開眼,長吁一口氣:“原來是場噩夢啊……” “哼!你這毒婦竟也來了?” 一聲冷哼從身側(cè)響起,我...
    開封第一講書人閱讀 42,482評論 0 289
  • 序言:老撾萬榮一對情侶失蹤,失蹤者是張志新(化名)和其女友劉穎,沒想到半個(gè)月后,有當(dāng)?shù)厝嗽跇淞掷锇l(fā)現(xiàn)了一具尸體,經(jīng)...
    沈念sama閱讀 49,036評論 1 335
  • 正文 獨(dú)居荒郊野嶺守林人離奇死亡,尸身上長有42處帶血的膿包…… 初始之章·張勛 以下內(nèi)容為張勛視角 年9月15日...
    茶點(diǎn)故事閱讀 40,846評論 3 356
  • 正文 我和宋清朗相戀三年,在試婚紗的時(shí)候發(fā)現(xiàn)自己被綠了。 大學(xué)時(shí)的朋友給我發(fā)了我未婚夫和他白月光在一起吃飯的照片。...
    茶點(diǎn)故事閱讀 43,025評論 1 371
  • 序言:一個(gè)原本活蹦亂跳的男人離奇死亡,死狀恐怖,靈堂內(nèi)的尸體忽然破棺而出,到底是詐尸還是另有隱情,我是刑警寧澤,帶...
    沈念sama閱讀 38,575評論 5 362
  • 正文 年R本政府宣布,位于F島的核電站,受9級特大地震影響,放射性物質(zhì)發(fā)生泄漏。R本人自食惡果不足惜,卻給世界環(huán)境...
    茶點(diǎn)故事閱讀 44,279評論 3 347
  • 文/蒙蒙 一、第九天 我趴在偏房一處隱蔽的房頂上張望。 院中可真熱鬧,春花似錦、人聲如沸。這莊子的主人今日做“春日...
    開封第一講書人閱讀 34,684評論 0 26
  • 文/蒼蘭香墨 我抬頭看了看天上的太陽。三九已至,卻和暖如春,著一層夾襖步出監(jiān)牢的瞬間,已是汗流浹背。 一陣腳步聲響...
    開封第一講書人閱讀 35,953評論 1 289
  • 我被黑心中介騙來泰國打工, 沒想到剛下飛機(jī)就差點(diǎn)兒被人妖公主榨干…… 1. 我叫王不留,地道東北人。 一個(gè)月前我還...
    沈念sama閱讀 51,751評論 3 394
  • 正文 我出身青樓,卻偏偏與公主長得像,于是被迫代替她去往敵國和親。 傳聞我的和親對象是個(gè)殘疾皇子,可洞房花燭夜當(dāng)晚...
    茶點(diǎn)故事閱讀 48,016評論 2 375

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