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

程序入口

對(duì)于很多編程語(yǔ)言來(lái)說(shuō)，程序都必須要有一個(gè)入口，比如 C，C++，以及完全面向?qū)ο蟮木幊陶Z(yǔ)言 Java，C# 等。如果你接觸過這些語(yǔ)言，對(duì)于程序入口這個(gè)概念應(yīng)該很好理解，C 和 C++ 都需要有一個(gè) main 函數(shù)來(lái)作為程序的入口，也就是程序的運(yùn)行會(huì)從 main 函數(shù)開始。同樣，Java 和 C# 必須要有一個(gè)包含 Main 方法的主類來(lái)作為程序入口。

而 Python 則有不同，它屬于腳本語(yǔ)言，不像編譯型語(yǔ)言那樣先將程序編譯成二進(jìn)制再運(yùn)行，而是動(dòng)態(tài)的逐行解釋運(yùn)行。也就是從腳本第一行開始運(yùn)行，沒有統(tǒng)一的入口。

一個(gè) Python 源碼文件除了可以被直接運(yùn)行外，還可以作為模塊（也就是庫(kù)）被導(dǎo)入。不管是導(dǎo)入還是直接運(yùn)行，最頂層的代碼都會(huì)被運(yùn)行（Python 用縮進(jìn)來(lái)區(qū)分代碼層次）。而實(shí)際上在導(dǎo)入的時(shí)候，有一部分代碼我們是不希望被運(yùn)行的。

舉一個(gè)例子來(lái)說(shuō)明一下，假設(shè)我們有一個(gè) const.py 文件，內(nèi)容如下：

PI = 3.14def main():print "PI:", PImain()

我們?cè)谶@個(gè)文件里邊定義了一些常量，然后又寫了一個(gè) main 函數(shù)來(lái)輸出定義的常量，最后運(yùn)行 main 函數(shù)就相當(dāng)于對(duì)定義做一遍人工檢查，看看值設(shè)置的都對(duì)不對(duì)。然后我們直接執(zhí)行該文件(python const.py),輸出：

PI: 3.14

現(xiàn)在，我們有一個(gè) area.py 文件，用于計(jì)算圓的面積，該文件里邊需要用到 const.py 文件中的 PI 變量，那么我們從 const.py 中把 PI 變量導(dǎo)入到 area.py 中：

from const import PIdef calc_round_area(radius):return PI * (radius ** 2)def main():print "round area: ", calc_round_area(2)main()

運(yùn)行 area.py，輸出結(jié)果：

PI: 3.14 round area: 12.56

可以看到，const 中的 main 函數(shù)也被運(yùn)行了，實(shí)際上我們是不希望它被運(yùn)行，提供 main 也只是為了對(duì)常量定義進(jìn)行下測(cè)試。這時(shí)，if __name__ == '__main__'?就派上了用場(chǎng)。把 const.py 改一下：

PI = 3.14def main():print "PI:", PIif __name__ == "__main__":main()

然后再運(yùn)行 area.py，輸出如下：

round area: 12.56

再運(yùn)行下 const.py，輸出如下：

PI: 3.14

這才是我們想要的效果。

if __name__ == '__main__'?就相當(dāng)于是 Python?模擬的程序入口。Python 本身并沒有規(guī)定這么寫，這只是一種編碼習(xí)慣。由于模塊之間相互引用，不同模塊可能都有這樣的定義，而入口程序只能有一個(gè)。到底哪個(gè)入口程序被選中，這取決于?__name__?的值。

__name__

__name__?是內(nèi)置變量，用于表示當(dāng)前模塊的名字，同時(shí)還能反映一個(gè)包的結(jié)構(gòu)。來(lái)舉個(gè)例子，假設(shè)有如下一個(gè)包：

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

目錄中所有 py 文件的內(nèi)容都為：

print __name__

我們執(zhí)行?python -c "import a.b.c"，輸出結(jié)果：

a a.b a.b.c

由此可見，__name__?可以清晰的反映一個(gè)模塊在包中的層次。其實(shí)，所謂模塊名就是 import 時(shí)需要用到的名字，例如：

import tornado import tornado.web

這里的 tornado 和 tornado.web 就被稱為模塊的模塊名。

如果一個(gè)模塊被直接運(yùn)行，則其沒有包結(jié)構(gòu)，其?__name__?值為?__main__。例如在上例中，我們直接運(yùn)行 c.py 文件（python a/b/c.py），輸出結(jié)果如下：

__main__

所以，if __name__ == '__main__'?我們簡(jiǎn)單的理解就是：?如果模塊是被直接運(yùn)行的，則代碼塊被運(yùn)行，如果模塊是被導(dǎo)入的，則代碼塊不被運(yùn)行。

實(shí)際上，這個(gè)問題還可以衍生出其他的一些知識(shí)點(diǎn)，例如?__main__.py?文件與 Python 的?-m?參數(shù)。

__main__.py 文件與 python -m

Python 的?-m?參數(shù)用于將一個(gè)模塊或者包作為一個(gè)腳本運(yùn)行，而?__main__.py?文件則相當(dāng)于是一個(gè)包的”入口程序“。

首先我們需要來(lái)看看?python xxx.py?與?python -m xxx.py?的區(qū)別。兩種運(yùn)行 Python 程序的方式的不同點(diǎn)在于，一種是直接運(yùn)行，一種是當(dāng)做模塊來(lái)運(yùn)行。

先來(lái)看一個(gè)簡(jiǎn)單的例子，假設(shè)有一個(gè) Python 文件 run.py，其內(nèi)容如下：

import sys print sys.path

我們用直接運(yùn)行的方式啟動(dòng)（python run.py），輸出結(jié)果(為了說(shuō)明問題，輸出結(jié)果只截取了重要部分，下同)：

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

然后以模塊的方式運(yùn)行（python -m run.py）:

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

由于輸出結(jié)果只列出了關(guān)鍵的部分，應(yīng)該很容易看出他們之間的差異。直接運(yùn)行是把 run.py 文件所在的目錄放到了 sys.path 屬性中。以模塊方式運(yùn)行是把你輸入命令的目錄（也就是當(dāng)前工作路徑），放到了 sys.path 屬性中。以模塊方式運(yùn)行還有一個(gè)不同的地方是，多出了一行?No module named run.py?的錯(cuò)誤。實(shí)際上以模塊方式運(yùn)行時(shí)，Python 先對(duì) run.py 執(zhí)行一遍 import，所以?print sys.path?被成功執(zhí)行，然后 Python 才嘗試運(yùn)行 run.py 模塊，但是，在 path 變量中并沒有 run.py 這個(gè)模塊，所以報(bào)錯(cuò)。而正確的運(yùn)行方式，應(yīng)該是?python -m run.

這個(gè)例子并不能明顯的說(shuō)明問題。接著我們來(lái)看看?__main__.py?的作用。

仍然先看例子，有如下一個(gè)包：

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?運(yùn)行結(jié)果：

__init__ ['', ...] __main__ ['', ...]

用?python package?運(yùn)行結(jié)果：

__main__ ['package', ...]

然后我們來(lái)總結(jié)一下：

• 1、?加上 -m 參數(shù)時(shí)會(huì)把當(dāng)前工作目錄添加到 sys.path 中，而不加時(shí)則會(huì)把腳本所在目錄添加到 sys.path 中。
• 2、?加上 -m 參數(shù)時(shí) Python 會(huì)先將模塊或者包導(dǎo)入，然后再執(zhí)行
• 3、?__main__.py 文件是一個(gè)包或者目錄的入口程序。不管是用?python package?還是用?python -m package?運(yùn)行時(shí)，__main__.py 文件總是被執(zhí)行。

python __init__.py?該如何理解

在創(chuàng)建package的時(shí)候在文件夾下會(huì)出現(xiàn)一個(gè)__init__.py 的文件
init.py 文件的作用是將文件夾變?yōu)橐粋€(gè)Python模塊,Python 中的每個(gè)模塊的包中，都有__init__.py 文件。

通常__init__.py 文件為空，但是我們還可以為它增加其他的功能。我們?cè)趯?dǎo)入一個(gè)包時(shí)，實(shí)際上是導(dǎo)入了它的__init__.py文件。這樣我們可以在__init__.py文件中批量導(dǎo)入我們所需要的模塊，而不再需要一個(gè)一個(gè)的導(dǎo)入。
基本的目錄結(jié)構(gòu)是如上圖一所示 testB的__init__.py 與testa 的__init__.py 里面分別用兩種方法import 文件

testa 下文件內(nèi)容為：

def priA():print('this is directory of priA')

testB 下文件內(nèi)容為
testb1.py

def priB1():print ('this is B1 directory of B')

testb.py

def priB():print ('this is B directory of B')

testa 的__init__.py?

import priA

testB 的__init__.py?

__all__ = ['testb', 'testb1']

第二種的方法是利用變量來(lái)進(jìn)行import module

在調(diào)用的時(shí)候?qū)τ诘谝恢蟹椒梢灾苯?/p> import testa

第二種方法可以直接用

from testB import *

當(dāng)然還可以兩種方式都用 在如在testB 的__init__.py 文件中直接

import testb import testb1? __all__ = ?['testb', 'testb1']

參考資料

• http://www.tuicool.com/articles/jMzqYzF
• http://stackoverflow.com/questions/4042905/what-is-main-py
• https://blog.csdn.net/u011557212/article/details/79665607

總結(jié)

以上是生活随笔為你收集整理的Python中的_main_与_init_详解的全部?jī)?nèi)容，希望文章能夠幫你解決所遇到的問題。

如果覺得生活随笔網(wǎng)站內(nèi)容還不錯(cuò)，歡迎將生活随笔推薦給好友。