1. 摘要
通俗的理解__name__ == '__main__':假如你叫小明.py厕鹃,在朋友眼中,你是小明(__name__ == '小明')掏熬;在你自己眼中捻浦,你是你自己(__name__ == '__main__')粗卜。
if __name__ == '__main__'的意思是:當.py文件被直接運行時屋确,if __name__ == '__main__'之下的代碼塊將被運行;當.py文件以模塊形式被導入時续扔,if __name__ == '__main__'之下的代碼塊不被運行攻臀。
對于很多編程語言來說,程序都必須要有一個入口纱昧,比如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文件作為模塊被導入時瑰抵,我們可能不希望一部分代碼被運行你雌。
假設我們有一個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__的值。?
__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__可以清晰地反映一個模塊在包中的層次浇垦。
__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__'之下的代碼塊不被運行鹃操。
Python的-m參數(shù)用于將一個模塊或者包作為一個腳本運行韭寸,而__main__.py文件相當于是一個包的“入口程序“。
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。
仍然先看例子往核,假設我們有如下一個包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í)行。?