Python 中的 if __name__ == '__main__' 該如何理解
這個問題來自於知乎使用者的提問,當時看到這個問題,我只是做了下簡單的回答。後來我發現,對於很多人來說,更準確的說應該是大部分的 Python 初學者,對這個問題理解的不是很深刻。所以這裡我來做下總結,並試圖把這個問題說明白。
程式入口
對於很多程式語言來說,程式都必須要有一個入口,比如 C,C++,以及完全面向物件的程式語言 Java,C# 等。如果你接觸過這些語言,對於程式入口這個概念應該很好理解,C 和 C++ 都需要有一個 main 函式來作為程式的入口,也就是程式的執行會從 main 函式開始。同樣,Java 和 C# 必須要有一個包含 Main 方法的主類來作為程式入口。
而 Python 則有不同,它屬於指令碼語言,不像編譯型語言那樣先將程式編譯成二進位制再執行,而是動態的逐行解釋執行。也就是從指令碼第一行開始執行,沒有統一的入口。
一個 Python 原始碼檔案除了可以被直接執行外,還可以作為模組(也就是庫)被匯入。不管是匯入還是直接執行,最頂層的程式碼都會被執行(Python 用縮排來區分程式碼層次)。而實際上在匯入的時候,有一部分程式碼我們是不希望被執行的。
舉一個例子來說明一下,假設我們有一個 const.py 檔案,內容如下:
PI = 3.14
def main():
print "PI:", PI
main()
我們在這個檔案裡邊定義了一些常量,然後又寫了一個 main 函式來輸出定義的常量,最後執行 main 函式就相當於對定義做一遍人工檢查,看看值設定的都對不對。然後我們直接執行該檔案(python const.py),輸出:
PI: 3.14
現在,我們有一個 area.py 檔案,用於計算圓的面積,該檔案裡邊需要用到 const.py 檔案中的 PI 變數,那麼我們從 const.py 中把 PI 變數匯入到 area.py 中:
from const import PI
def 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.14
def main():
print "PI:", PI
if __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 是有無限可能的,你可以寫出很多簡潔優雅的程式碼。