if name == main 應(yīng)該如何去理解呢蝴悉?
前言:
朋友眼中你是小明(name == '小明'),
你自己眼中你是你自己(name == 'main'),
你編程很好, 朋友調(diào)你去幫他寫程序(import 小明, 這時你在朋友眼中: name == '小明'),
但你晚上也會打開xx網(wǎng)站, 做一些自己的事情(直接運行小明.py, name == 'main')
程序入口
對于很多編程語言來說眼刃,程序都必須要有一個入口淘衙,比如 C,C++,以及完全面向?qū)ο蟮木幊陶Z言 Java消玄,C# 等薯演。如果你接觸過這些語言撞芍,對于程序入口這個概念應(yīng)該很好理解,C 和 C++ 都需要有一個 main 函數(shù)來作為程序的入口跨扮,也就是程序的運行會從 main 函數(shù)開始序无。同樣,Java 和 C# 必須要有一個包含 Main 方法的主類來作為程序入口衡创。
而 Python 則有不同愉镰,它屬于腳本語言,不像編譯型語言那樣先將程序編譯成二進(jìn)制再運行钧汹,而是動態(tài)的逐行解釋運行丈探。也就是從腳本第一行開始運行,沒有統(tǒng)一的入口拔莱。
一個 Python 源碼文件除了可以被直接運行外碗降,還可以作為模塊(也就是庫)被導(dǎo)入隘竭。不管是導(dǎo)入還是直接運行,最頂層的代碼都會被運行(Python 用縮進(jìn)來區(qū)分代碼層次)讼渊。而實際上在導(dǎo)入的時候动看,有一部分代碼我們是不希望被運行的。
舉一個例子來說明一下爪幻,假設(shè)我們有一個 const.py 文件菱皆,內(nèi)容如下:
PI = 3.14
def main():
print("PI:",PI)
main()
我們在這個文件里邊定義了一些常量,然后又寫了一個 main 函數(shù)來輸出定義的常量挨稿,最后運行 main 函數(shù)就相當(dāng)于對定義做一遍人工檢查仇轻,看看值設(shè)置的都對不對。然后我們直接執(zhí)行該文件(python const.py),輸出:
PI:3.14
現(xiàn)在奶甘,我們有一個 area.py 文件篷店,用于計算圓的面積,該文件里邊需要用到 const.py 文件中的 PI 變量臭家,那么我們從 const.py 中把 PI 變量導(dǎo)入到 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()
運行 area.py疲陕,輸出結(jié)果:
PI:3.14
round area: 12.56
可以看到,const 中的 main 函數(shù)也被運行了钉赁,實際上我們是不希望它被運行蹄殃,提供 main 也只是為了對常量定義進(jìn)行下測試。這時你踩,if name == 'main' 就派上了用場窃爷。把 const.py 改一下:
PI = 3.14
def main():
print("PI:",PI)
if __name__ == __main__:
main()
然后再運行 area.py,輸出如下:
round area: 12.56
再運行下 const.py姓蜂,輸出如下:
PI: 3.14
這才是我們想要的效果按厘。
if name == 'main' 就相當(dāng)于是 Python 模擬的程序入口。Python 本身并沒有規(guī)定這么寫钱慢,這只是一種編碼習(xí)慣逮京。由于模塊之間相互引用,不同模塊可能都有這樣的定義束莫,而入口程序只能有一個懒棉。到底哪個入口程序被選中,這取決于 name 的值览绿。
name
name 是內(nèi)置變量策严,用于表示當(dāng)前模塊的名字,同時還能反映一個包的結(jié)構(gòu)饿敲。來舉個例子妻导,假設(shè)有如下一個包:
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 可以清晰的反映一個模塊在包中的層次倔韭。其實术浪,所謂模塊名就是 import 時需要用到的名字,例如:
import tornado
import tornado.web
這里的 tornado 和 tornado.web 就被稱為模塊的模塊名寿酌。
如果一個模塊被直接運行胰苏,則其沒有包結(jié)構(gòu),其 name 值為 main醇疼。例如在上例中硕并,我們直接運行 c.py 文件(python a/b/c.py),輸出結(jié)果如下:
main
所以秧荆,if name == 'main' 我們簡單的理解就是: 如果模塊是被直接運行的倔毙,則代碼塊被運行,如果模塊是被導(dǎo)入的辰如,則代碼塊不被運行。
實際上贵试,這個問題還可以衍生出其他的一些知識點琉兜,例如 main.py 文件與 Python 的 -m 參數(shù)。
main.py 文件與 python -m
Python 的 -m 參數(shù)用于將一個模塊或者包作為一個腳本運行毙玻,而 main.py 文件則相當(dāng)于是一個包的”入口程序“豌蟋。
首先我們需要來看看 python xxx.py 與 python -m xxx.py 的區(qū)別。兩種運行 Python 程序的方式的不同點在于桑滩,一種是直接運行梧疲,一種是當(dāng)做模塊來運行。
先來看一個簡單的例子运准,假設(shè)有一個 Python 文件 run.py幌氮,其內(nèi)容如下:
#!/user/bin/python
#coding=utf-8
import sys
print __name__
print sys.path
我們用直接運行的方式啟動(python run.py),輸出結(jié)果(為了說明問題胁澳,輸出結(jié)果只截取了重要部分该互,下同):
__main__
['/yh1', '/usr/lib/python27.zip', '/usr/lib64/python2.7', '/usr/lib64/python2.7/plat-linux2', '/usr/lib64/python2.7/lib-tk', '/usr/lib64/python2.7/lib-old', '/usr/lib64/python2.7/lib-dynload', '/usr/lib64/python2.7/site-packages', '/usr/local/lib64/python2.7/site-packages', '/usr/local/lib/python2.7/site-packages', '/usr/lib/python2.7/site-packages']
然后以模塊的方式運行(python -m run.py):
run
['', '/usr/lib/python27.zip', '/usr/lib64/python2.7', '/usr/lib64/python2.7/plat-linux2', '/usr/lib64/python2.7/lib-tk', '/usr/lib64/python2.7/lib-old', '/usr/lib64/python2.7/lib-dynload', '/usr/lib64/python2.7/site-packages', '/usr/local/lib64/python2.7/site-packages', '/usr/local/lib/python2.7/site-packages', '/usr/lib/python2.7/site-packages']
/usr/bin/python: No module named run.py
然后我們來總結(jié)一下:
1、 加上 -m 參數(shù)時會把當(dāng)前工作目錄添加到 sys.path 中韭畸,而不加時則會把腳本所在目錄添加到 sys.path 中宇智。
2、 加上 -m 參數(shù)時 Python 會先將模塊或者包導(dǎo)入胰丁,然后再執(zhí)行
3随橘、 main.py 文件是一個包或者目錄的入口程序。不管是用 python package 還是用 python -m package 運行時锦庸,main.py 文件總是被執(zhí)行机蔗。
感謝博主的分享 先貼上原文地址: