最近看一個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后綴):
- 沒有-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
- 帶-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))
再來看一下兩種情況下的輸出:
- 沒有-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'
- 帶-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__
。
趕緊試驗一下是不是:
- 在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
- 在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的介紹