if __name__=="__main__"

1. 摘要

通俗的理解__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

• 1
• 2
• 3
• 4
• 5
• 6
• 7
• 8

如今，咱們寫一個用於計算圓面積的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
'''

• 1
• 2
• 3
• 4
• 5
• 6
• 7
• 8
• 9
• 10
• 11
• 12
• 13
• 14
• 15

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()

• 1
• 2
• 3
• 4
• 5
• 6
• 7

運行const.py，輸出以下：

PI: 3.14

• 1

運行area.py，輸出以下：

round area:  12.56

• 1

如上，咱們能夠看到if __name__ == '__main__'至關於Python模擬的程序入口，Python自己並無這麼規定，這只是一種編碼習慣。因爲模塊之間相互引用，不一樣模塊可能有這樣的定義，而程序入口只有一個。到底哪一個程序入口被選中，這取決於__name__的值。
 

3. __name__

3.1 __name__反映一個包的結構

__name__是內置變量，可用於反映一個包的結構。假設咱們有一個包a，包的結構以下：

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

• 1
• 2
• 3
• 4
• 5

在包a中，文件c.py，__init__.py，__init__.py的內容都爲：

print(__name__)

• 1

當一個.py文件（模塊）被其餘.py文件（模塊）導入時，咱們在命令行執行

python -c "import a.b.c"

• 1

輸出結果：

a
a.b
a.b.c

• 1
• 2
• 3

因而可知，__name__能夠清晰地反映一個模塊在包中的層次。

3.2 __name__表示當前模塊的名字

__name__是內置變量，可用於表示當前模塊的名字。咱們直接運行一個.py文件（模塊）

python a/b/c.py

• 1

輸出結果：

__main__

• 1

由此咱們可知：若是一個.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)

• 1
• 2
• 3

咱們用直接運行的方式啓動

python run.py

• 1

輸出結果(爲了說明問題，輸出結果只截取了重要部分，下同)：

['/home/huoty/aboutme/pythonstudy/main', ...]

• 1

而後以模塊的方式運行:

python -m run.py

• 1

輸出內容

['', ...]
/usr/bin/python: No module named run.py

• 1
• 2

因爲輸出結果只列出了關鍵的部分，應該很容易看出他們之間的差別：

• 直接運行方式是把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

• 1
• 2
• 3

其中，文件__init__.py的內容

import sys

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

• 1
• 2
• 3
• 4

其中，文件__main__.py的內容

import sys

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

• 1
• 2
• 3
• 4

接下來，咱們運行這個package，使用python -m package運行，輸出結果：

__init__
['', ...]

__main__
['', ...]

• 1
• 2
• 3
• 4
• 5

使用python package運行，輸出結果：

__main__
['package', ...]

• 1
• 2

總結一下

• 當加上-m參數時，Python會把當前工做目錄添加到sys.path中；而不加-m時，Python則會把腳本所在目錄添加到sys.path中。

• 當加上-m參數時，Python會先將模塊或者包導入，而後再執行。

• __main__.py文件是一個包或者目錄的入口程序。無論是用python package仍是用python -m package運行，__main__.py文件老是被執行。