Python 中 if __name__ == '__main__' 的正確理解
程序入口
對於很多編程語言來說，程序都必須要有一個入口，比如 C，C++，以及完全面向對象的編程語言 Java，C# 等。如果你接觸過這些語言，對於程序入口這個概念應該很好理解，C 和 C++ 都需要有一個 main 函數來作為程序的入口，也就是程序的運行會從 main 函數開始。同樣，Java 和 C# 必須要有一個包含 Main 方法的主類來作為程序入口。
而 Python 則有不同，它屬於腳本語言，不像編譯型語言那樣先將程序編譯成二進制再運行，而是動態的逐行解釋運行。也就是從腳本第一行開始運行，沒有統一的入口。
一個 Python 源碼文件除了可以被直接運行外，還可以作為模塊（也就是庫）被導入。不管是導入還是直接運行，最頂層的代碼都會被運行（Python 用縮進來區分代碼層次）。而實際上在導入的時候，有一部分代碼我們是不希望被運行的。
舉一個例子來說明一下，假設我們有一個 const.py 文件，內容如下：
| 1 2 3 4 5 6 |
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 中：
| 1 2 3 4 5 6 7 8 9 |
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__‘
| 1 2 3 4 5 6 7 |
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__ 是內置變量，用於表示當前模塊的名字，同時還能反映一個包的結構。來舉個例子，假設有如下一個包：
| 1 2 3 4 5 |
a
├── b
│ ├── c.py
│ └── __init__.py
└── __init__.py
|
目錄中所有 py 文件的內容都為：
print __name__
我們執行 python -c "import a.b.c"，輸出結果：
| 1 2 3 |
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，其內容如下：
| 1 2 3 4 5 6 7 |
#!/user/bin/python
#coding=utf-8
import sys
print __name__
print sys.path
|
我們用直接運行的方式啟動（python run.py），輸出結果(為了說明問題，輸出結果只截取了重要部分，下同)：
| 1 2 |
__main__
[‘/yh1‘, ‘/usr/lib/python27.zip‘, ‘/usr/lib64/python2.7‘, ‘/usr/lib64/python2.7/plat-linux2‘, ‘/usr/lib64/python2.7/lib-tk‘, ‘/usr/lib64/python2.7/lib-old‘, ‘/usr/lib64/python2.7/lib-dynload‘, ‘/usr/lib64/python2.7/site-packages‘, ‘/usr/local/lib64/python2.7/site-packages‘, ‘/usr/local/lib/python2.7/site-packages‘, ‘/usr/lib/python2.7/site-packages‘]
|
然後以模塊的方式運行（python -m run.py）:
| 1 2 3 |
run
[‘‘, ‘/usr/lib/python27.zip‘, ‘/usr/lib64/python2.7‘, ‘/usr/lib64/python2.7/plat-linux2‘, ‘/usr/lib64/python2.7/lib-tk‘, ‘/usr/lib64/python2.7/lib-old‘, ‘/usr/lib64/python2.7/lib-dynload‘, ‘/usr/lib64/python2.7/site-packages‘, ‘/usr/local/lib64/python2.7/site-packages‘, ‘/usr/local/lib/python2.7/site-packages‘, ‘/usr/lib/python2.7/site-packages‘]
/usr/bin/python: No module named run.py
|
然後我們來總結一下：
- 1、 加上 -m 參數時會把當前工作目錄添加到 sys.path 中，而不加時則會把腳本所在目錄添加到 sys.path 中。
- 2、 加上 -m 參數時 Python 會先將模塊或者包導入，然後再執行
- 3、 __main__.py 文件是一個包或者目錄的入口程序。不管是用
python package還是用python -m package運行時，__main__.py 文件總是被執行。
Python 中 if __name__ == '__main__' 的正確理解