這個問題來自于知乎用戶的提問,當時看到這個問題,我只是做了下簡單的回答。后來我發現,對于很多人來說,更準確的說應該是大部分的 Python 初學者,對這個問題理解的不是很深刻。所以這里我來做下總結,并試圖把這個問題說明白。
程序入口
對于很多編程語言來說,程序都必須要有一個入口,比如 C,C++,以及完全面向對象的編程語言 Java,C# 等。如果你接觸過這些語言,對于程序入口這個概念應該很好理解,C 和 C++ 都需要有一個 main 函數來作為程序的入口,也就是程序的運行會從 main 函數開始。同樣,Java 和 C# 必須要有一個包含 Main 方法的主類來作為程序入口。
而 Python 則有不同,它屬于腳本語言,不像編譯型語言那樣先將程序編譯成二進制再運行,而是動態的逐行解釋運行。也就是從腳本第一行開始運行,沒有統一的入口。
一個 Python 源碼文件除了可以被直接運行外,還可以作為模塊(也就是庫)被導入。不管是導入還是直接運行,最頂層的代碼都會被運行(Python 用縮進來區分代碼層次)。而實際上在導入的時候,有一部分代碼我們是不希望被運行的。
舉一個例子來說明一下,假設我們有一個 const.py 文件,內容如下:
PI = 3.14def main():print "PI:", PImain()
我們在這個文件里邊定義了一些常量,然后又寫了一個 main 函數來輸出定義的常量,最后運行 main 函數就相當于對定義做一遍人工檢查,看看值設置的都對不對。然后我們直接執行該文件(python const.py),輸出:
PI: 3.14
現在,我們有一個 area.py 文件,用于計算圓的面積,該文件里邊需要用到 const.py 文件中的 PI 變量,那么我們從 const.py 中把 PI 變量導入到 area.py 中:
from const import PIdef calc_round_area(radius):return PI * (radius ** 2)def main():print "round area: ", calc_round_area(2)main()
運行 area.py,輸出結果:
PI: 3.14
round area: 12.56
可以看到,const 中的 main 函數也被運行了,實際上我們是不希望它被運行,提供 main 也只是為了對常量定義進行下測試。這時,if __name__ == '__main__'
?就派上了用場。把 const.py 改一下:
PI = 3.14def main():print "PI:", PIif __name__ == "__main__":main()
然后再運行 area.py,輸出如下:
round area: 12.56
再運行下 const.py,輸出如下:
PI: 3.14
這才是我們想要的效果。
if __name__ == '__main__'
?就相當于是 Python?模擬的程序入口。Python 本身并沒有規定這么寫,這只是一種編碼習慣。由于模塊之間相互引用,不同模塊可能都有這樣的定義,而入口程序只能有一個。到底哪個入口程序被選中,這取決于?__name__
?的值。
__name__
__name__
?是內置變量,用于表示當前模塊的名字,同時還能反映一個包的結構。來舉個例子,假設有如下一個包:
a
├── b
│ ├── c.py
│ └── __init__.py
└── __init__.py
目錄中所有 py 文件的內容都為:
print __name__
我們執行?python -c "import a.b.c"
,輸出結果:
a
a.b
a.b.c
由此可見,__name__
?可以清晰的反映一個模塊在包中的層次。其實,所謂模塊名就是 import 時需要用到的名字,例如:
import tornado
import tornado.web
這里的 tornado 和 tornado.web 就被稱為模塊的模塊名。
如果一個模塊被直接運行,則其沒有包結構,其?__name__
?值為?__main__
。例如在上例中,我們直接運行 c.py 文件(python a/b/c.py),輸出結果如下:
__main__
所以,if __name__ == '__main__'
?我們簡單的理解就是:?如果模塊是被直接運行的,則代碼塊被運行,如果模塊是被導入的,則代碼塊不被運行。
實際上,這個問題還可以衍生出其他的一些知識點,例如?__main__.py
?文件與 Python 的?-m
?參數。
__main__.py 文件與 python -m
Python 的?-m
?參數用于將一個模塊或者包作為一個腳本運行,而?__main__.py
?文件則相當于是一個包的”入口程序“。
首先我們需要來看看?python xxx.py
?與?python -m xxx.py
?的區別。兩種運行 Python 程序的方式的不同點在于,一種是直接運行,一種是當做模塊來運行。
先來看一個簡單的例子,假設有一個 Python 文件 run.py,其內容如下:
import sys
print sys.path
我們用直接運行的方式啟動(python run.py),輸出結果(為了說明問題,輸出結果只截取了重要部分,下同):
['/home/huoty/aboutme/pythonstudy/main', ...]
然后以模塊的方式運行(python -m run.py):
['', ...]
/usr/bin/python: No module named run.py
由于輸出結果只列出了關鍵的部分,應該很容易看出他們之間的差異。直接運行是把 run.py 文件所在的目錄放到了 sys.path 屬性中。以模塊方式運行是把你輸入命令的目錄(也就是當前工作路徑),放到了 sys.path 屬性中。以模塊方式運行還有一個不同的地方是,多出了一行?No module named run.py
?的錯誤。實際上以模塊方式運行時,Python 先對 run.py 執行一遍 import,所以?print sys.path
?被成功執行,然后 Python 才嘗試運行 run.py 模塊,但是,在 path 變量中并沒有 run.py 這個模塊,所以報錯。而正確的運行方式,應該是?python -m run
.
這個例子并不能明顯的說明問題。接著我們來看看?__main__.py
?的作用。
仍然先看例子,有如下一個包:
package
├── __init__.py
└── __main__.py
- __init__.py
import sys
print "__init__"
print sys.path
- __main__.py
import sys
print "__main__"
print sys.path
用?python -m package
?運行結果:
__init__
['', ...]
__main__
['', ...]
用?python package
?運行結果:
__main__
['package', ...]
然后我們來總結一下:
- 1、?加上 -m 參數時會把當前工作目錄添加到 sys.path 中,而不加時則會把腳本所在目錄添加到 sys.path 中。
- 2、?加上 -m 參數時 Python 會先將模塊或者包導入,然后再執行
- 3、?__main__.py 文件是一個包或者目錄的入口程序。不管是用?
python package
?還是用?python -m package
?運行時,__main__.py 文件總是被執行。
后序
我試圖使用長篇大論來闡述,在 Python 中如何理解?if __name__ == '__main__'
?這個問題,不知道我有沒有描述得足夠的明白。Python 的確是簡單的,優雅的,但也有很多問題是不太容易理解的,例如很多高級的特性,像元類、生成器表達式、描述符、協程等。Python 并沒有在太多的地方規定要如何如何,很多的用法只是慣用法,例如 self 和本文討論的內容。這些用法或是為了讓代碼看起來更優雅,或是前人的經驗。使用 Python 是有無限可能的,你可以寫出很多簡潔優雅的代碼。
參考資料
- http://www.tuicool.com/articles/jMzqYzF
- http://stackoverflow.com/questions/4042905/what-is-main-py