毫無疑問 Python 中沒有所謂的 main 入口函數,但是網上經常看到一些文章提“Python 的 main 函數”、“建議寫 main 函數”…… 有些人是知情的,他的意圖可能是模仿那些正宗的 main 函數,但還有不少人明顯是被誤導了(或自己誤解了),就寫出來很累贅的代碼。 本期“Pytho ...
毫無疑問 Python 中沒有所謂的 main 入口函數,但是網上經常看到一些文章提“Python 的 main 函數”、“建議寫 main 函數”……
有些人是知情的,他的意圖可能是模仿那些正宗的 main 函數,但還有不少人明顯是被誤導了(或自己誤解了),就寫出來很累贅的代碼。
本期“Python 為什麼”欄目來聊聊 Python 為什麼沒有 main 函數?
在開始正題之前,先要來回答這兩個問題:所謂的 “main 函數”是指什麼?為什麼有些編程語言需要強制寫一個 main 函數?
某些編程語言以 main 函數作為程式的執行入口,例如 C/C++、C#、 Java、Go 和 Rust 等,它們具有特定的含義:
- main 函數名是強制的,也就是要求必須有一個 main 函數
- main 函數最多只能有一個,也就是說程式的入口是唯一的
- 語法格式有一定的要求,具有相對固定的模板
為什麼要強制一個 main 入口函數呢?
這些語言是編譯型語言,需要把代碼編譯成可執行的二進位文件,為了讓操作系統/啟動器找到程式的起點,所以要約定這一個函數。簡單地說,就是在一大堆代碼里,需要定義一個顯著的可用於執行的開頭。
不難看出,main 函數是那些語言中重要而不可缺的有機組成部分。
然而,我們再來看看 Python,情況就大不相同了。
- Python 是解釋型語言,即腳本語言,運行過程是從上往下,逐行解析運行,也就是說它的起點是可知的
- 每個 .py 文件就是一個可執行文件,都可作為整個程式的入口文件,也就是說程式的入口是靈活可變的,沒有必須遵守的約定
- 有時候運行 Python 項目,並沒有指定入口文件(命令行中較常見,例如"python -m http.server 8000"), 那可能是存在
__main__.py
文件,它所在的包被當成一個“文件”來執行了
歸結起來,意思是說 Python 這種腳本語言跟編譯型語言不同,它不管是在單個模塊層面(即一個 .py 文件),還是在由多個模塊組成的包層面,都可選擇靈活的執行方式,不像其它語言缺了約定好的入口就沒法執行。
也就是說,Python 沒有必要在語法層面規定程式員必須定義出一個統一的入口(不管是函數還是類還是什麼東西)。
有些同學可能會有疑惑,因為他們經常看到或者自己寫出下麵這樣的代碼:
# main 里是某些主體代碼
def main():
……
if __name__ == '__main__':
main()
難道這不就是 Python 的 main 函數麽?相信有不少同學會這麼想!
非也!非也!
除了函數名是“main”以外,它跟我們前面介紹的正統的 main 函數沒有半毛錢關係,既沒有強制性,也沒有必然決定程式執行順序的作用。缺少它,也不會導致什麼語法問題。
之所以有些知情人要命名出一個”main“函數,其實是想強調它的”主要“地位,想要人為地安排它作為第一個執行的函數。他們可能認為這樣命名的函數,比較容易記憶。
之所以有些知情人要寫if __name__ == '__main__'
,可能想表明 main() 只有在當前腳本被直接執行時才運行,不希望被導入其它模塊時運行。
對於這些“知情人”,他們有一定的道理。
但是,我個人並不推薦這種寫法,甚至有時候會非常反感!
最明顯的例子:明明只有幾十行代碼,或者僅有一個腳本文件,實現一個簡單的功能(一小段爬蟲、用 turtle 畫張圖等等),但是它們都按前面的樣式寫了。
我每次看到這種不假思索的累贅代碼,就覺得難受。為什麼要寫那行 if 語句呢?可能的話,應該拆分 main 函數,甚至不必封裝成一個函數啊!
我個人總結出以下的經驗:
- 打破慣性思維,寫出地道的代碼。main 入口函數是某些語言特有的,不該在 Python 中“照貓畫虎”,應該瞭解腳本語言的特點,寫出簡潔優雅的風格
- 使用 main.py 而非 main()。因為 Python 的程式執行單位其實是腳本文件,而非某個函數或者類,所以建議把入口文件命名為 main.py,內部的函數按需求而定
- 可以的話,使用
__main__.py
作為入口文件。這個文件結合命令行的“-m”參數使用,非常好用。推薦閱讀:Python 中 -m 的典型用法、原理解析與發展演變 - 不推薦寫
if __name__ == '__main__'
。首先,如果只有一個文件的話,因為不存在導出的可能,不建議寫。其次,存在多文件時,入口文件(main.py)中極不推薦寫這一句,此文件的代碼邏輯應該精煉,理論上其內容不該被導出到其它模塊使用,因為它是起點!最後,多文件的非入口文件也不建議寫,因為在非入口文件中寫這個判斷,最大的作用就是寫一些測試代碼,但是測試代碼應該分離出來,寫到專門的目錄或文件中。
小結:本文首先解釋了什麼是 main 入口函數,以及為什麼某些語言會強制要求寫 main 函數;接著,解釋了為什麼 Python 不需要寫 main 函數;最後則是針對某些人存在的慣性誤區,分享了我個人的四點編程經驗。
本文屬於“Python為什麼”系列文章(Python貓出品),該系列主要關註 Python 的語法、設計和發展等話題,以一個個“為什麼”式的問題為切入點,試著展現 Python 的迷人魅力。部分話題會推出視頻版,請在 B 站收看,觀看地址:視頻地址
公眾號【Python貓】, 本號連載優質的系列文章,有Python為什麼系列、喵星哲學貓系列、Python進階系列、好書推薦系列、技術寫作、優質英文推薦與翻譯等等,歡迎關註哦。