python -m是拿來干啥用的?

最近看一個project(FCOS)的時候看到一個命令行參數:python -m。就報著好奇心,想要把它搞明白。
其中很多博客都轉載這一篇:[python]自問自答:python -m參數?,但是經過測試后,只適用于python2.x的環境下,對于現在大家都用python3了,里面有點不太正確(但不否定全部)。這里總結一下自己的試驗:

實驗環境

Ubuntu 18.04.1 LTS + python3.7

例子

我有這么一個文件結構:

├── try_demo
│   ├── package1
│   │   ├── __init__.py
│   │   ├── module1.py
│   ├── package2
│   │   ├── __init__.py
│   │   ├── module2.py

里面的內容是:

  • 兩個init.py都是空的
  • module1.py:
import sys
print("module1 is running!")
print("module1 __name__ is:", __name__)
print("now sys.path is:")
print('\n'.join(sys.path))
  • module2.py:
import sys
print("module2 is running!")
print("module2 __name__ is:", __name__)
print("now sys.path is:")
print('\n'.join(sys.path))

從下面這句話可以看出,-m這個命令行參數就是像運行一個腳本一樣運行模塊:
-m mod : run library module as a script (terminates option list)
所以我們試驗一下(注意,既然是運行模塊,就不要有.py后綴):

  1. 沒有-m參數
(base) lsm@lsm:~/文檔/try_demo$ python package2/module2.py
module2 is running!
module2 __name__ is: __main__
now sys.path is:
/home/lsm/文檔/try_demo/package2
/home/lsm/miniconda3/lib/python37.zip
/home/lsm/miniconda3/lib/python3.7
/home/lsm/miniconda3/lib/python3.7/lib-dynload
/home/lsm/miniconda3/lib/python3.7/site-packages
/home/lsm/文檔/FCOS
  1. 帶-m參數
(base) lsm@lsm:~/文檔/try_demo$ python -m package2.module2
module2 is running!
module2 __name__ is: __main__
now sys.path is:
/home/lsm/文檔/try_demo
/home/lsm/miniconda3/lib/python37.zip
/home/lsm/miniconda3/lib/python3.7
/home/lsm/miniconda3/lib/python3.7/lib-dynload
/home/lsm/miniconda3/lib/python3.7/site-packages
/home/lsm/文檔/FCOS

可以看到,除了調用方式不一樣之外,sys.path也不一樣:

  • try_demo目錄下調用python package2/module2.py時得到:/home/lsm/文檔/try_demo/package2
  • try_demo目錄下調用python -m package2.module2時得到:/home/lsm/文檔/try_demo

可以看到,不帶-m參數時是把當前模塊module2.py目錄.../try_demo/package2添加到sys.path中,而-m參數時是把當前包package2目錄.../try_demo添加到sys.path
<font face="微軟雅黑" color=#FF8C00 size=6> 然鵝這有什么用呢 </font>

改進例子

我在module2.py的第二行加一句話,就能體會出作用:

import sys
from package1 import module1
print("module2 is running!")
print("module2 __name__ is:", __name__)
print("now sys.path is:")
print('\n'.join(sys.path))

再來看一下兩種情況下的輸出:

  1. 沒有-m參數
(base) lsm@lsm:~/文檔/try_demo$ python package2/module2.py
Traceback (most recent call last):
  File "package2/module2.py", line 2, in <module>
    from package1 import module1
ModuleNotFoundError: No module named 'package1'
  1. 帶-m參數
(base) lsm@lsm:~/文檔/try_demo$ python -m package2.module2
module1 is running!
module1 __name__ is: package1.module1
now sys.path is:
/home/lsm/文檔/try_demo
/home/lsm/miniconda3/lib/python37.zip
/home/lsm/miniconda3/lib/python3.7
/home/lsm/miniconda3/lib/python3.7/lib-dynload
/home/lsm/miniconda3/lib/python3.7/site-packages
/home/lsm/文檔/FCOS
module2 is running!
module2 __name__ is: __main__
now sys.path is:
/home/lsm/文檔/try_demo
/home/lsm/miniconda3/lib/python37.zip
/home/lsm/miniconda3/lib/python3.7
/home/lsm/miniconda3/lib/python3.7/lib-dynload
/home/lsm/miniconda3/lib/python3.7/site-packages
/home/lsm/文檔/FCOS

其實這個結果也是我們意料之內的,因為python解釋器在導入import的時候會去搜索sys.path下的模塊,當不帶-m參數時,sys.path只包括到/home/lsm/文檔/try_demo/package2,當然不知道還有一個package1,而當-m參數時,sys.path能包括到/home/lsm/文檔/try_demo,此時package1就在/home/lsm/文檔/try_demo下呀

至此可以總結出-m能給我們的好處是:已知一個模塊的名字,但不知道它的文件路徑,那么使用“-m”就意味著交給解釋器自行查找,在所有模塊命名空間中查找,定位到腳本的路徑,則當成腳本執行。

拓展(expansion)

“-m”之后也可以直接接一個包的名字,那么解釋器經過前面提到的查找過程,先定位到該包,但是會去執行它的__main__子模塊,也就是說,在包目錄下必須要實現一個__main__.py文件。
換句話說,假設有個包的名稱是“packname”,那么,“python -m packname”,其實就等效于python -m packname.__main__

趕緊試驗一下是不是:

  1. 在package1下沒有main.py文件
(base) lsm@lsm:~/文檔/try_demo$ python -m package1
/home/lsm/miniconda3/bin/python: No module named package1.__main__; 'package1' is a package and cannot be directly executed
  1. 在package1下有main.py文件,里面只寫print("this is package1.__main__")這一句話
(base) lsm@lsm:~/文檔/try_demo$ python -m package1
this is package1.__main__

TODO

眼尖的小伙伴都已經看出來了在改進例子中的運行帶-m參數的命令時,出現了:
module1 __name__ is: package1.module1,不再是__main__,這個下次再查查為什么?我想跟大家都在用的用法:__name__ == '__main__'有關聯吧?

參考(references)

Python 中 -m 的典型用法、原理解析與發展演變
官方文檔對于-m介紹
官方文檔對于Executing modules as scripts的介紹

?著作權歸作者所有,轉載或內容合作請聯系作者
  • 序言:七十年代末,一起剝皮案震驚了整個濱河市,隨后出現的幾起案子,更是在濱河造成了極大的恐慌,老刑警劉巖,帶你破解...
    沈念sama閱讀 227,533評論 6 531
  • 序言:濱河連續發生了三起死亡事件,死亡現場離奇詭異,居然都是意外死亡,警方通過查閱死者的電腦和手機,發現死者居然都...
    沈念sama閱讀 98,055評論 3 414
  • 文/潘曉璐 我一進店門,熙熙樓的掌柜王于貴愁眉苦臉地迎上來,“玉大人,你說我怎么就攤上這事。” “怎么了?”我有些...
    開封第一講書人閱讀 175,365評論 0 373
  • 文/不壞的土叔 我叫張陵,是天一觀的道長。 經常有香客問我,道長,這世上最難降的妖魔是什么? 我笑而不...
    開封第一講書人閱讀 62,561評論 1 307
  • 正文 為了忘掉前任,我火速辦了婚禮,結果婚禮上,老公的妹妹穿的比我還像新娘。我一直安慰自己,他們只是感情好,可當我...
    茶點故事閱讀 71,346評論 6 404
  • 文/花漫 我一把揭開白布。 她就那樣靜靜地躺著,像睡著了一般。 火紅的嫁衣襯著肌膚如雪。 梳的紋絲不亂的頭發上,一...
    開封第一講書人閱讀 54,889評論 1 321
  • 那天,我揣著相機與錄音,去河邊找鬼。 笑死,一個胖子當著我的面吹牛,可吹牛的內容都是我干的。 我是一名探鬼主播,決...
    沈念sama閱讀 42,978評論 3 439
  • 文/蒼蘭香墨 我猛地睜開眼,長吁一口氣:“原來是場噩夢啊……” “哼!你這毒婦竟也來了?” 一聲冷哼從身側響起,我...
    開封第一講書人閱讀 42,118評論 0 286
  • 序言:老撾萬榮一對情侶失蹤,失蹤者是張志新(化名)和其女友劉穎,沒想到半個月后,有當地人在樹林里發現了一具尸體,經...
    沈念sama閱讀 48,637評論 1 333
  • 正文 獨居荒郊野嶺守林人離奇死亡,尸身上長有42處帶血的膿包…… 初始之章·張勛 以下內容為張勛視角 年9月15日...
    茶點故事閱讀 40,558評論 3 354
  • 正文 我和宋清朗相戀三年,在試婚紗的時候發現自己被綠了。 大學時的朋友給我發了我未婚夫和他白月光在一起吃飯的照片。...
    茶點故事閱讀 42,739評論 1 369
  • 序言:一個原本活蹦亂跳的男人離奇死亡,死狀恐怖,靈堂內的尸體忽然破棺而出,到底是詐尸還是另有隱情,我是刑警寧澤,帶...
    沈念sama閱讀 38,246評論 5 355
  • 正文 年R本政府宣布,位于F島的核電站,受9級特大地震影響,放射性物質發生泄漏。R本人自食惡果不足惜,卻給世界環境...
    茶點故事閱讀 43,980評論 3 346
  • 文/蒙蒙 一、第九天 我趴在偏房一處隱蔽的房頂上張望。 院中可真熱鬧,春花似錦、人聲如沸。這莊子的主人今日做“春日...
    開封第一講書人閱讀 34,362評論 0 25
  • 文/蒼蘭香墨 我抬頭看了看天上的太陽。三九已至,卻和暖如春,著一層夾襖步出監牢的瞬間,已是汗流浹背。 一陣腳步聲響...
    開封第一講書人閱讀 35,619評論 1 280
  • 我被黑心中介騙來泰國打工, 沒想到剛下飛機就差點兒被人妖公主榨干…… 1. 我叫王不留,地道東北人。 一個月前我還...
    沈念sama閱讀 51,347評論 3 390
  • 正文 我出身青樓,卻偏偏與公主長得像,于是被迫代替她去往敵國和親。 傳聞我的和親對象是個殘疾皇子,可洞房花燭夜當晚...
    茶點故事閱讀 47,702評論 2 370

推薦閱讀更多精彩內容