對於不少編程語言來講,程序都必需要有一個入口,好比 C,C++,以及徹底面向對象的編程語言 Java,C# 等。若是你接觸過這些語言,對於程序入口這個概念應該很好理解,C 和 C++ 都須要有一個 main 函數來做爲程序的入口,也就是程序的運行會從 main 函數開始。一樣,Java 和 C# 必需要有一個包含 Main 方法的主類來做爲程序入口。python
而 Python 則有不一樣,它屬於腳本語言,不像編譯型語言那樣先將程序編譯成二進制再運行,而是動態的逐行解釋運行。也就是從腳本第一行開始運行,沒有統一的入口。web
一個 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 中:tornado
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,輸出結果:post
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,輸出以下:ui
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', ...]
而後咱們來總結一下:
- 一、 加上 -m 參數時會把當前工做目錄添加到 sys.path 中,而不加時則會把腳本所在目錄添加到 sys.path 中。
- 二、 加上 -m 參數時 Python 會先將模塊或者包導入,而後再執行
- 三、 __main__.py 文件是一個包或者目錄的入口程序。不論是用
python package
仍是用python -m package
運行時,__main__.py 文件老是被執行。
後序
我試圖使用長篇大論來闡述,在 Python 中如何理解 if __name__ == '__main__'
這個問題,不知道我有沒有描述得足夠的明白。Python 的確是簡單的,優雅的,但也有不少問題是不太容易理解的,例如不少高級的特性,像元類、生成器表達式、描述符、協程等。Python 並無在太多的地方規定要如何如何,不少的用法只是慣用法,例如 self 和本文討論的內容。這些用法或是爲了讓代碼看起來更優雅,或是前人的經驗。使用 Python 是有無限可能的,你能夠寫出不少簡潔優雅的代碼。