天天看點

if __name__ == '__main__' 如何正确了解

前言:

朋友眼中你是小明(__name__ == '小明'),

你自己眼中你是你自己(__name__ == '__main__'),

你程式設計很好, 朋友調你去幫他寫程式(import 小明, 這時你在朋友眼中: __name__ == '小明'),

但你晚上也會打開xx網站, 做一些自己的事情(直接運作小明.py, __name__ == '__main__')

程式入口

對于很多程式設計語言來說,程式都必須要有一個入口,比如 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,其内容如下:

#!/user/bin/python
#coding=utf-8

import sys

print __name__
print sys.path
      

我們用直接運作的方式啟動(python run.py),輸出結果(為了說明問題,輸出結果隻截取了重要部分,下同):

__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):

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 檔案總是被執行。