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
現在,我們寫一個用於計算圓面積的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__
的值。
下面是在Linux上使用時的解釋
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
文件總是先被執行。
轉自:https://blog.csdn.net/yjk13703623757/article/details/77918633