寫 Python 腳本時(shí)，一定要加上這個(gè)
我發(fā)現(xiàn)有不少朋友寫 Python 腳本非常隨意，要么不用函數(shù)，要么函數(shù)隨處定義，反正第一眼看不出要執(zhí)行的第一行代碼位于何處，這樣的腳本可讀性很差，而且容易隱藏 bug，解決這個(gè)問(wèn)題很簡(jiǎn)單，當(dāng)我們寫 Python 腳本時(shí)，一定要加上這個(gè)：
- def main():
- # do something
- print("do something.")
- if __name__ == "__main__":
- main()
你可能要反對(duì)了：我怎么爽就怎么寫，憑什么聽(tīng)你的，多寫個(gè) if __name__...?
別急，讓我說(shuō)三個(gè)原因。
第一，它讓 Python 文件的作用更加明確
首先需要明白 __name__ 的作用，當(dāng)腳本直接被 Python 解釋器執(zhí)行時(shí)，其值就是 "__main__"，當(dāng)其被其他 Python 程序 import 的時(shí)候，其值就是對(duì)應(yīng)的 Python 腳本文件名，可以在 Python 解釋器驗(yàn)證下，假定有個(gè) some_script.py 其內(nèi)容如下：
- print("some_script.py")
- print(__name__)
在 Python 解釋器導(dǎo)入一下：
- ❯ vim some_script.py
- ❯ python
- Python 3.8.5 (v3.8.5:580fbb018f, Jul 20 2020, 12:11:27)
- [Clang 6.0 (clang-600.0.57)] on darwin
- Type "help", "copyright", "credits" or "license" for more information.
- >>> import some_script
- some_script.py
- some_script
- >>>
可以看到，__name__ 的值就是 Python 腳本的文件名 some_script。
也就是說(shuō) if __name__ == "__main__": 后面的代碼在 import 的時(shí)候是不會(huì)運(yùn)行的。
明白了這一點(diǎn)，if __name__ == "__main__": 就可以做為區(qū)分腳本和庫(kù)的一個(gè)標(biāo)志，當(dāng)我們看到 if __name__ == "__main__": 時(shí)，就認(rèn)為這一個(gè)可以直接運(yùn)行的腳本，當(dāng)沒(méi)有看到這行代碼時(shí)，就認(rèn)為這是一個(gè)庫(kù)，可以被其他程序引用，Explicit is better than implicit.，不是嗎?
再舉個(gè)例子：
假如你寫了一個(gè)不帶if __name__ == "__main__": 的腳本，叫 bad_script.py，內(nèi)容如下：
- def useful_function(x):
- return x * x
- class UsefulClass:
- def __init__(self, x):
- self.x = x
- #你自己測(cè)試了一吧，沒(méi)毛病
- for i in range(7):
- print(useful_function(i))
別人寫了個(gè) useful.py，引用了你的 useful_function：
- from bad_script import useful_function
- def main():
- print(f'{useful_function(3)=}')
- if __name__ == '__main__':
- main()
一運(yùn)行，發(fā)現(xiàn)打印了不可預(yù)期的內(nèi)容，見(jiàn)下圖紅色部分：
查了半天原因，發(fā)現(xiàn)是你的腳本輸出的，你說(shuō)別人會(huì)不會(huì)罵你?
假如你在自己腳本里定義了全局變量，別人如果在不合適的位置導(dǎo)入了 *，就會(huì)把你這個(gè)全局變量也導(dǎo)入，導(dǎo)致變量覆蓋，很容易會(huì)出現(xiàn) bug。
第二，它讓 Python 文件更加易讀，對(duì) IDE 友好
有了 if __name__ == "__main__": 相當(dāng)于 Python 程序也有了一個(gè)入口函數(shù)，所有的變量都從這里開(kāi)始定義和使用，我們可以清晰的知道程序的邏輯開(kāi)始于何處(當(dāng)然還需要我們自覺(jué)的把程序的開(kāi)始邏輯都放在這里)
其實(shí)，這也是 PyCharm 推薦的做法，當(dāng)你新建一個(gè)項(xiàng)目的時(shí)候，它默認(rèn)創(chuàng)建的 main.py 就是長(zhǎng)這樣的：
在if __name__ == "__main__": 的那一行的最左邊也有一個(gè)綠色的運(yùn)行按鈕，點(diǎn)擊一下，程序就從這一行開(kāi)始運(yùn)行了。
為什么很多優(yōu)秀的編程語(yǔ)言，比如 C、Java、Golang、C++ 都有一個(gè) main 入口函數(shù)呢?我想很重要的一個(gè)原因就是就是程序入口統(tǒng)一，容易閱讀。
第三、多進(jìn)程場(chǎng)景下，必須用 if main
比如說(shuō)你用多進(jìn)程搞并行計(jì)算，寫了這樣的代碼：
- import multiprocessing as mp
- def useful_function(x):
- return x * x
- print("processing in parallel")
- with mp.Pool() as p:
- results = p.map(useful_function, [1, 2, 3, 4])
- print(results)
當(dāng)你運(yùn)行的時(shí)候，會(huì)發(fā)現(xiàn)程序不停的在創(chuàng)建進(jìn)程，同時(shí)也在不停的報(bào)錯(cuò) RuntimeError，即使你 Ctrl C 也無(wú)法終止程序。而加上了 if __name__ == "__main__": 程序就會(huì)按照預(yù)期的進(jìn)行：
- import multiprocessing as mp
- def useful_function(x):
- return x * x
- if __name__ == '__main__':
- print("processing in parallel")
- with mp.Pool() as p:
- results = p.map(useful_function, [1, 2, 3, 4])
- print(results)
這是為什么呢?
其實(shí)我是這樣理解的，Python 的多程序就是啟動(dòng)了多個(gè) Python 解釋器，每個(gè) Python 解釋器都會(huì)導(dǎo)入你這個(gè)腳本，復(fù)制一份全局變量和函數(shù)給子進(jìn)程用，如果有了if __name__ == "__main__":，那它后面的代碼就不會(huì)被 import，也就不會(huì)被重復(fù)執(zhí)行。否則，這個(gè)創(chuàng)建多進(jìn)程的代碼就會(huì)被 import，就會(huì)被執(zhí)行，從而無(wú)限遞歸的去創(chuàng)建子進(jìn)程，Python3 會(huì)報(bào) RuntimeError，順序是先創(chuàng)建進(jìn)程，然后報(bào)錯(cuò)的，因此就會(huì)出現(xiàn)不停的創(chuàng)建進(jìn)程，不停的報(bào)錯(cuò)，Ctrl C 也無(wú)法終止的現(xiàn)象，只能 kill 掉整個(gè)終端。這里有個(gè)官方解釋[1]
最后的話
if __name__ == "__main__": 雖然不是強(qiáng)制的，但是基于上述三點(diǎn)原因，我強(qiáng)烈推薦你這么做，它是 Python 社區(qū)的約定，對(duì)應(yīng)Python 之禪：明確優(yōu)于隱晦。正如 _ 作為變量名的意思就是告訴讀代碼的人：這個(gè)變量不重要，后面也不會(huì)用到它。當(dāng)你看到 Python 腳本有 if __name__ == "__main__": 時(shí)，就會(huì)意識(shí)到，這是一個(gè)可執(zhí)行的腳本，當(dāng)被其他程序?qū)霑r(shí)，這部分代碼不會(huì)被執(zhí)行，而多進(jìn)程的程序中，這是必須的。
本文轉(zhuǎn)載自微信公眾號(hào)「Python七號(hào)」，可以通過(guò)以下二維碼關(guān)注。轉(zhuǎn)載本文請(qǐng)聯(lián)系Python七號(hào)公眾號(hào)。
