[轉]如何簡單地理解Python中的if __name__ == '__main__'

1. 摘要

通俗的理解__name__ == '__main__':假如你叫小明.py厕鹃,在朋友眼中,你是小明(__name__ == '小明')掏熬;在你自己眼中捻浦,你是你自己(__name__ == '__main__')粗卜。

if __name__ == '__main__'的意思是:當.py文件被直接運行時屋确,if __name__ == '__main__'之下的代碼塊將被運行;當.py文件以模塊形式被導入時续扔,if __name__ == '__main__'之下的代碼塊不被運行攻臀。

2. 程序入口

對于很多編程語言來說,程序都必須要有一個入口纱昧,比如C刨啸,C++,以及完全面向對象的編程語言Java识脆,C#等设联。如果你接觸過這些語言,對于程序入口這個概念應該很好理解灼捂,C离例,C++都需要有一個main函數(shù)作為程序的入口,也就是程序的運行會從main函數(shù)開始悉稠。同樣宫蛆,Java,C#必須要有一個包含Main方法的主類的猛,作為程序入口耀盗。

而Python則不同想虎,它屬于腳本語言,不像編譯型語言那樣先將程序編譯成二進制再運行叛拷,而是動態(tài)的逐行解釋運行舌厨。也就是從腳本第一行開始運行,沒有統(tǒng)一的入口胡诗。

一個Python源碼文件(.py)除了可以被直接運行外邓线,還可以作為模塊(也就是庫),被其他.py文件導入煌恢。不管是直接運行還是被導入骇陈,.py文件的最頂層代碼都會被運行(Python用縮進來區(qū)分代碼層次),而當一個.py文件作為模塊被導入時瑰抵,我們可能不希望一部分代碼被運行你雌。

2.1 一個.py文件被其他.py文件引用

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

PI =3.14defmain():print("PI:", PI)main()# 運行結果:PI: 3.14

1

2

3

4

5

6

7

8

現(xiàn)在二汛,我們寫一個用于計算圓面積的area.py文件婿崭,area.py文件需要用到const.py文件中的PI變量。從const.py中肴颊,我們把PI變量導入area.py:

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

運行結果:

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ù)也被運行了,實際上我們不希望它被運行婿着,因為const.py提供的main函數(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

運行const.py提完,輸出如下:

PI:3.14

1

運行area.py,輸出如下:

round area:12.56

1

如上丘侠,我們可以看到if __name__ == '__main__'相當于Python模擬的程序入口徒欣,Python本身并沒有這么規(guī)定,這只是一種編碼習慣蜗字。由于模塊之間相互引用打肝,不同模塊可能有這樣的定義,而程序入口只有一個挪捕。到底哪個程序入口被選中粗梭,這取決于__name__的值。?

3.?__name__

3.1?__name__反映一個包的結構

__name__是內(nèi)置變量担神,可用于反映一個包的結構楼吃。假設我們有一個包a,包的結構如下:

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

當一個.py文件(模塊)被其他.py文件(模塊)導入時,我們在命令行執(zhí)行

python-c"import a.b.c"

1

輸出結果:

aa.ba.b.c

1

2

3

由此可見躬窜,__name__可以清晰地反映一個模塊在包中的層次浇垦。

3.2?__name__表示當前模塊的名字

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

pythona/b/c.py

1

輸出結果:

__main__

1

由此我們可知:如果一個.py文件(模塊)被直接運行時男韧,則其沒有包結構,其__name__值為__main__默垄,即模塊名為__main__此虑。

所以,if __name__ == '__main__'的意思是:當.py文件被直接運行時口锭,if __name__ == '__main__'之下的代碼塊將被運行朦前;當.py文件以模塊形式被導入時,if __name__ == '__main__'之下的代碼塊不被運行鹃操。

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

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

4.1 運行Python程序的兩種方式

python xxx.py荆隘,直接運行xxx.py文件

python -m xxx.py恩伺,把xxx.py當做模塊運行

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

importsysprint(sys.path)

1

2

3

我們用直接運行的方式啟動

python run.py

1

輸出結果(為了說明問題椰拒,輸出結果只截取了重要部分晶渠,下同):

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

1

然后以模塊的方式運行:

python -m run.py

1

輸出內(nèi)容

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

1

2

由于輸出結果只列出了關鍵的部分,應該很容易看出他們之間的差異:

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

以模塊方式運行是把你輸入命令的目錄(也就是當前工作路徑)耸三,放到了 sys.path 屬性中乱陡。

以模塊方式運行還有一個不同的地方:多出了一行No module named run.py的錯誤浇揩。實際上以模塊方式運行時仪壮,Python先對run.py執(zhí)行一遍 import,所以print(sys.path)被成功執(zhí)行胳徽,然后Python才嘗試運行run.py模塊积锅,但是在path變量中并沒有run.py這個模塊,所以報錯养盗。正確的運行方式缚陷,應該是python -m run。

4.2?__main__.py的作用

仍然先看例子往核,假設我們有如下一個包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

接下來,我們運行這個package虎锚,使用python -m package運行硫痰,輸出結果:

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

1

2

3

4

5

使用python package運行,輸出結果:

__main__['package',...]

1

2

總結一下

當加上-m參數(shù)時窜护,Python會把當前工作目錄添加到sys.path中效斑;而不加-m時,Python則會把腳本所在目錄添加到sys.path中柱徙。

當加上-m參數(shù)時挣惰,Python會先將模塊或者包導入魔种,然后再執(zhí)行。

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

?著作權歸作者所有,轉載或內(nèi)容合作請聯(lián)系作者
  • 序言:七十年代末细层,一起剝皮案震驚了整個濱河市儒鹿,隨后出現(xiàn)的幾起案子,更是在濱河造成了極大的恐慌凳忙,老刑警劉巖业踏,帶你破解...
    沈念sama閱讀 206,378評論 6 481
  • 序言:濱河連續(xù)發(fā)生了三起死亡事件,死亡現(xiàn)場離奇詭異涧卵,居然都是意外死亡勤家,警方通過查閱死者的電腦和手機,發(fā)現(xiàn)死者居然都...
    沈念sama閱讀 88,356評論 2 382
  • 文/潘曉璐 我一進店門柳恐,熙熙樓的掌柜王于貴愁眉苦臉地迎上來伐脖,“玉大人,你說我怎么就攤上這事乐设∷媳樱” “怎么了?”我有些...
    開封第一講書人閱讀 152,702評論 0 342
  • 文/不壞的土叔 我叫張陵近尚,是天一觀的道長蠕啄。 經(jīng)常有香客問我,道長戈锻,這世上最難降的妖魔是什么歼跟? 我笑而不...
    開封第一講書人閱讀 55,259評論 1 279
  • 正文 為了忘掉前任,我火速辦了婚禮格遭,結果婚禮上哈街,老公的妹妹穿的比我還像新娘。我一直安慰自己拒迅,他們只是感情好骚秦,可當我...
    茶點故事閱讀 64,263評論 5 371
  • 文/花漫 我一把揭開白布她倘。 她就那樣靜靜地躺著,像睡著了一般作箍。 火紅的嫁衣襯著肌膚如雪帝牡。 梳的紋絲不亂的頭發(fā)上,一...
    開封第一講書人閱讀 49,036評論 1 285
  • 那天蒙揣,我揣著相機與錄音靶溜,去河邊找鬼。 笑死懒震,一個胖子當著我的面吹牛罩息,可吹牛的內(nèi)容都是我干的。 我是一名探鬼主播个扰,決...
    沈念sama閱讀 38,349評論 3 400
  • 文/蒼蘭香墨 我猛地睜開眼瓷炮,長吁一口氣:“原來是場噩夢啊……” “哼!你這毒婦竟也來了递宅?” 一聲冷哼從身側響起娘香,我...
    開封第一講書人閱讀 36,979評論 0 259
  • 序言:老撾萬榮一對情侶失蹤,失蹤者是張志新(化名)和其女友劉穎办龄,沒想到半個月后烘绽,有當?shù)厝嗽跇淞掷锇l(fā)現(xiàn)了一具尸體,經(jīng)...
    沈念sama閱讀 43,469評論 1 300
  • 正文 獨居荒郊野嶺守林人離奇死亡俐填,尸身上長有42處帶血的膿包…… 初始之章·張勛 以下內(nèi)容為張勛視角 年9月15日...
    茶點故事閱讀 35,938評論 2 323
  • 正文 我和宋清朗相戀三年安接,在試婚紗的時候發(fā)現(xiàn)自己被綠了。 大學時的朋友給我發(fā)了我未婚夫和他白月光在一起吃飯的照片英融。...
    茶點故事閱讀 38,059評論 1 333
  • 序言:一個原本活蹦亂跳的男人離奇死亡盏檐,死狀恐怖,靈堂內(nèi)的尸體忽然破棺而出驶悟,到底是詐尸還是另有隱情胡野,我是刑警寧澤,帶...
    沈念sama閱讀 33,703評論 4 323
  • 正文 年R本政府宣布痕鳍,位于F島的核電站硫豆,受9級特大地震影響,放射性物質發(fā)生泄漏额获。R本人自食惡果不足惜够庙,卻給世界環(huán)境...
    茶點故事閱讀 39,257評論 3 307
  • 文/蒙蒙 一恭应、第九天 我趴在偏房一處隱蔽的房頂上張望抄邀。 院中可真熱鬧,春花似錦昼榛、人聲如沸境肾。這莊子的主人今日做“春日...
    開封第一講書人閱讀 30,262評論 0 19
  • 文/蒼蘭香墨 我抬頭看了看天上的太陽奥喻。三九已至偶宫,卻和暖如春,著一層夾襖步出監(jiān)牢的瞬間环鲤,已是汗流浹背纯趋。 一陣腳步聲響...
    開封第一講書人閱讀 31,485評論 1 262
  • 我被黑心中介騙來泰國打工, 沒想到剛下飛機就差點兒被人妖公主榨干…… 1. 我叫王不留冷离,地道東北人吵冒。 一個月前我還...
    沈念sama閱讀 45,501評論 2 354
  • 正文 我出身青樓,卻偏偏與公主長得像西剥,于是被迫代替她去往敵國和親痹栖。 傳聞我的和親對象是個殘疾皇子,可洞房花燭夜當晚...
    茶點故事閱讀 42,792評論 2 345

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