Python 中的 if __name__ == 'main' 的作用和原理


一句話,秒懂

__name__ 是當前模塊名,當模塊被直接運行時模塊名為 __main__ 。這句話的意思就是,當模塊被直接運行時,以下代碼塊將被運行,當模塊是被導入時,代碼塊不被運行。

 

簡而言之就是:__name__ 是當前模塊名,當模塊被直接運行時模塊名為 __main__ 。當模塊被直接運行時,代碼將被運行,當模塊是被導入時,代碼不被運行。

 

由於每個Python模塊(Python文件)都包含內置的變量__name__,當運行模塊被執行的時候,__name__等於文件名(包含了后綴.py)。如果import到其他模塊中,則__name__等於模塊名稱(不包含后綴.py)。而“__main__”等於當前執行文件的名稱(包含了后綴.py)。所以當模塊被直接執行時,__name__ == '__main__'結果為真;而當模塊被import到其他模塊中時,__name__ == '__main__'結果為假,就是不調用對應的方法。

原文鏈接:https://blog.csdn.net/wrh_csdn/article/details/80534654#:~:text=%E7%99%BB%E5%BD%95%2F%E6%B3%A8%E5%86%8C-,%E7%A7%92%E6%87%82Python%E7%BC%96%E7%A8%8B%E4%B8%AD%E7%9A%84if%20__name__,main'%20%E7%9A%84%E4%BD%9C%E7%94%A8%E5%92%8C%E5%8E%9F%E7%90%86&text=__name__%20%E6%98%AF%E5%BD%93%E5%89%8D,%E4%BB%A3%E7%A0%81%E5%9D%97%E4%B8%8D%E8%A2%AB%E8%BF%90%E8%A1%8C%E3%80%82

 

實例:

本回答(包括z示例代碼代碼)節選和總結自Huoty的博客:

Python 中的 if __name__ == '__main__' 該如何理解

對於很多編程語言來說,程序都必須要有一個入口,比如 C,C++,以及完全面向對象的編程語言 Java,C# 等。如果你接觸過這些語言,對於程序入口這個概念應該很好理解,C 和 C++ 都需要有一個 main 函數來作為程序的入口,也就是程序的運行會從 main 函數開始。同樣,Java 和 C# 必須要有一個包含 Main 方法的主類來作為程序入口。
而 Python 則有不同,它屬於腳本語言,不像編譯型語言那樣先將程序編譯成二進制再運行,而是動態的逐行解釋運行。也就是從腳本第一行開始運行,沒有統一的入口。

 

一段好的示例代碼勝過一切

這里有倆個程序

const.py用來定義常數PI

area.py需要PI這個常數來計算圓的面積

 

const.py 代碼如下:

PI = 3.14

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

main()

當運行python const.py,輸出

PI: 3.14

 

area.py (導入PI的值來計算圓面積)代碼如下

from const import PI

def calc_round_area(radius):
return PI * (radius ** 2)

def main():
print "round area: ", calc_round_area(2)

main()

當運行python area.py,因為導入了const,輸出

PI: 3.14
round area: 12.56

 

可以看到

const.py里面的main()也被執行了

但這是我們所不希望的

 

怎么辦?

只需在const.py中加入一句:

PI = 3.14

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

if __name__ == "__main__":
main()

 

_name_代表當前模塊的名字

當我們再次運行“python area.py”時

對於const.py來說

_name_不再是_main_

因此其中的main()不再被執行

最終得到我們想要的輸出

round area: 12.56

 

以上示例代碼及注釋部分取自博文(非常好的總結文章,還詳細解釋了_name_):

__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', ...]

然后我們來總結一下:

  • 1、 加上 -m 參數時會把當前工作目錄添加到 sys.path 中,而不加時則會把腳本所在目錄添加到 sys.path 中
  • 2、 加上 -m 參數時 Python 會先將模塊或者包導入,然后再執行
  • 3、 __main__.py 文件是一個包或者目錄的入口程序。不管是用 python package 還是用 python -m package 運行時,__main__.py 文件總是被執行。

后序

我試圖使用長篇大論來闡述,在 Python 中如何理解 if __name__ == '__main__' 這個問題,不知道我有沒有描述得足夠的明白。Python 的確是簡單的,優雅的,但也有很多問題是不太容易理解的,例如很多高級的特性,像元類、生成器表達式、描述符、協程等。Python 並沒有在太多的地方規定要如何如何,很多的用法只是慣用法,例如 self 和本文討論的內容。這些用法或是為了讓代碼看起來更優雅,或是前人的經驗。使用 Python 是有無限可能的,你可以寫出很多簡潔優雅的代碼。

 

原文鏈接:https://blog.konghy.cn/2017/04/24/python-entry-program/


免責聲明!

本站轉載的文章為個人學習借鑒使用,本站對版權不負任何法律責任。如果侵犯了您的隱私權益,請聯系本站郵箱yoyou2525@163.com刪除。



 
粵ICP備18138465號   © 2018-2025 CODEPRJ.COM