充分理解 python -m mod

Allen 發(fā)布于2019-07-30 15:17 / 801人閱讀

摘要：最近在看的官方文檔，提到一個的用法，很是不理解，所以查找了很多文檔，并進(jìn)行了如下總結(jié)。的用途定位并執(zhí)行該模塊。可讀取包內(nèi)任何文件內(nèi)容。如果沒有，則從查找，找到后載入內(nèi)存，并加入到字典，名稱也將導(dǎo)入到當(dāng)前模塊的命名空間。

最近在看 __main__ 的官方文檔 —— https://docs.python.org/3/library/__main__.html#module-__main__，提到一個 python -m 的用法，很是不理解，所以查找了很多文檔，并進(jìn)行了如下總結(jié)。

查看 Python 的 help 內(nèi)容

$ python --help
...
-m mod : run library module as a script (terminates option list)
#　直譯就是按照腳本的方式執(zhí)行模塊
...

有無 -m 參數(shù)的比較

1. python script.py # 直接執(zhí)行腳本
2. python -m script.py # 當(dāng)做模塊的方式執(zhí)行，相當(dāng)于 import

一般情況下，我們會想當(dāng)然的認(rèn)為，有無參數(shù) -m 對程序會有不同的影響，但是很可惜，第二種寫法是會在程序執(zhí)行之后報錯的。其正確的寫法是：丟掉 .py 后綴。

首先直觀的觀察執(zhí)行結(jié)果，Python 的版本是 3.6.3。
編寫 script.py 腳本，內(nèi)容如下：

import sys
print(sys.path)
print(sys.modules)

直接執(zhí)行腳本

$ python script.py
["/home/ossifrage/workspaces/python-m", "/usr/lib/python36.zip", "/usr/lib/python3.6", ...]
{..., "__main__": , ...}

當(dāng)做模塊方式執(zhí)行

$ python -m script
["", "/usr/lib/python36.zip", "/usr/lib/python3.6", ...]
{..., "__main__": , ..., "runpy": , "pkgutil": }

顯示的內(nèi)容還有很多，只突出顯示出了不同的地方。

通過比較不同的地方，我們發(fā)現(xiàn):

第一種方法——直接運行腳本，當(dāng)前腳本所在的路徑會加入到 sys.path 列表中，但是 sys.modules 字典中的 __main__ 的路徑不是絕對路徑，只是腳本名稱。

第二種方法——當(dāng)做模塊方式運行，當(dāng)前腳本所在的路徑不會加入到 sys.path 列表中，但是 sys.modules 字典中的 __main__ 的路徑是絕對路徑，同時，還引入了 runpy 和 pkgutil 兩個模塊。

runpy 的用途：定位并執(zhí)行該模塊。主要用途在于實現(xiàn)命令行 -m 執(zhí)行 python 模塊的效果。

pkgutil 的用途：獲取包里面的所有模塊列表。pkgutil.get_data() 可讀取包內(nèi)任何文件內(nèi)容。

模塊的導(dǎo)入機制

其實，上面的內(nèi)容涉及到了 Python 包模塊的導(dǎo)入機制。

要理解模塊的導(dǎo)入機制，得理解幾個關(guān)鍵的名詞。sys.path -> sys.modules -> < module >.__dict__。

sys.path：是一個列表。保存著模塊的搜索路徑。如果路徑?jīng)]有存在與該列表中，可使用 sys.path.append() 導(dǎo)入。

sys.modules: 是一個字典。所有加載到內(nèi)存中的模塊都存放在該字典中。當(dāng) import 一個模塊的時候，首先會在這個字典中查找是否已經(jīng)加載了目標(biāo)模塊。如果已加載，則將模塊的名字加入到正在調(diào)用 import 的模塊的 Local 命名空間（也就是< module >.__dict__)中。如果沒有，則從 sys.path 查找，找到后載入內(nèi)存，并加入到 sys.modules 字典，名稱也將導(dǎo)入到當(dāng)前模塊的 Local 命名空間。

reference

[[python]自問自答：python -m參數(shù)？](https://www.cnblogs.com/xuewe...

Python的-m參數(shù)

python中的import（涉及pkgutil和inspect包）

import 迷宮