轉載一篇寫的非常好的部落格

原文地址:

以下為原文

通俗的理解__name__ == '__main__':假如你叫小明.py,在朋友眼中,你是小明(__name__ == '小明');在你自己眼中,你是你自己(__name__ == '__main__')

if __name__ == '__main__'的意思是:當.py檔案被直接執行時,if __name__ == '__main__'之下的程式碼塊將被執行;當.py檔案以模組形式被匯入時,if __name__ == '__main__'之下的程式碼塊不被執行。

2. 程式入口

對於很多程式語言來說,程式都必須要有一個入口,比如C,C++,以及完全面向物件的程式語言Java,C#等。如果你接觸過這些語言,對於程式入口這個概念應該很好理解,C,C++都需要有一個main函式作為程式的入口,也就是程式的執行會從main函式開始。同樣,Java,C#必須要有一個包含Main方法的主類,作為程式入口。

而Python則不同,它屬於指令碼語言,不像編譯型語言那樣先將程式編譯成二進位制再執行,而是動態的逐行解釋執行。也就是從指令碼第一行開始執行,沒有統一的入口。

一個Python原始碼檔案(.py)除了可以被直接執行外,還可以作為模組(也就是庫),被其他.py檔案匯入。不管是直接執行還是被匯入,.py檔案的最頂層程式碼都會被執行(Python用縮排來區分程式碼層次),而當一個.py檔案作為模組被匯入時,我們可能不希望一部分程式碼被執行。

2.1 一個.py檔案被其他.py檔案引用

假設我們有一個const.py檔案,內容如下:

PI = 3.14

def main():
    print("PI:", PI)

main()

# 執行結果:PI: 3.14

現在,我們寫一個用於計算圓面積的area.py檔案,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()

'''
執行結果:
PI: 3.14
round area:  12.56
'''

2.2 修改const.py,新增if __name__ == "__main__"

我們看到const.py中的main函式也被運行了,實際上我們不希望它被執行,因為const.py提供的main函式只是為了測試常量定義。這時if __name__ == '__main__'派上了用場,我們把const.py改一下,新增if __name__ == "__main__"

PI = 3.14

def main():
    print("PI:", PI)

if __name__ == "__main__":
    main()

執行const.py,輸出如下:

PI: 3.14

執行area.py,輸出如下:

round area:  12.56

如上,我們可以看到if __name__ == '__main__'相當於Python模擬的程式入口,Python本身並沒有這麼規定,這只是一種編碼習慣。由於模組之間相互引用,不同模組可能有這樣的定義,而程式入口只有一個。到底哪個程式入口被選中,這取決於__name__的值。

3. __name__

3.1 __name__反映一個包的結構

__name__是內建變數,可用於反映一個包的結構。假設我們有一個包a,包的結構如下:

a
├── b
│   ├── c.py
│   └── __init__.py
└── __init__.py

在包a中,檔案c.py,__init__.py,__init__.py的內容都為:

print(__name__)

當一個.py檔案(模組)被其他.py檔案(模組)匯入時,我們在命令列執行

python -c "import a.b.c"

輸出結果:

a
a.b
a.b.c

由此可見,__name__可以清晰地反映一個模組在包中的層次。

3.2 __name__表示當前模組的名字

__name__是內建變數,可用於表示當前模組的名字。我們直接執行一個.py檔案(模組)

python a/b/c.py

輸出結果:

__main__

由此我們可知:如果一個.py檔案(模組)被直接執行時,則其沒有包結構,其__name__值為__main__,即模組名為__main__

所以,if __name__ == '__main__'的意思是:當.py檔案被直接執行時,if __name__ == '__main__'之下的程式碼塊將被執行;當.py檔案以模組形式被匯入時,if __name__ == '__main__'之下的程式碼塊不被執行。

4. __main__.py檔案與python -m

Python的-m引數用於將一個模組或者包作為一個指令碼執行,而__main__.py檔案相當於是一個包的“入口程式“。

4.1 執行Python程式的兩種方式

  • python xxx.py,直接執行xxx.py檔案
  • python -m xxx.py,把xxx.py當做模組執行

假設我們有一個檔案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

4.2 __main__.py的作用

仍然先看例子,假設我們有如下一個包package:

package
├── __init__.py
└── __main__.py

其中,檔案__init__.py的內容

import sys

print("__init__")
print(sys.path)

其中,檔案__main__.py的內容

import sys

print("__main__")
print(sys.path)

接下來,我們執行這個package,使用python -m package執行,輸出結果:

__init__
['', ...]

__main__
['', ...]

使用python package執行,輸出結果:

__main__
['package', ...]

總結一下

  • 當加上-m引數時,Python會把當前工作目錄新增到sys.path中;而不加-m時,Python則會把指令碼所在目錄新增到sys.path中。

  • 當加上-m引數時,Python會先將模組或者包匯入,然後再執行。

  • __main__.py檔案是一個包或者目錄的入口程式。不管是用python package還是用python -m package執行,__main__.py檔案總是被執行。

5. 參考文章