Python中標准模塊importlib詳解

模塊簡介

Python提供了importlib包作為標准庫的一部分。目的就是提供Python中import語句的實現（以及__import__函數）。另外，importlib允許程序員創建他們自定義的對象，可用於引入過程（也稱為importer）。

什么是imp？
另外有一個叫做imp的模塊，它提供給Python import語句機制的接口。這個模塊在Python 3.4中被否決，目的就是為了只使用importlib。

這個模塊有些復雜，因此我們在這篇博文中主要討論以下幾個主題：

• 動態引入
• 檢查模塊是否可以被引入
• 引入源文件自身
• 第三方模塊 import_from_github_com

模塊使用

1 動態引入

importlib模塊支持傳入字符串來引入一個模塊。我們創建兩個簡單的模塊來驗證這個功能。我們將會給予兩個模塊相同的接口，讓它們打印名字以便我們能夠區分它們。創建兩個模塊，分別為foo.py和bar.py，代碼如下所示，

def main():
   print(__name__)12

現在我們使用importlib來引入它們。讓我們看看這段代碼如何去做的。確保你已經把這段代碼放在與上面創建的兩個模塊相同的目錄下。

import importlib

def dynamic_import(module):
    return importlib.import_module(module)

if __name__ == "__main__":
    module = dynamic_import('foo')
    module.main()

    module_two = dynamic_import('bar')
    module_two.main()1234567891011

在這段代碼中，我們手動引入importlib模塊，並創建一個簡單的函數dynamic_import。這個函數所做的就是調用importlib模塊中的import_module函數，入參就是我們傳入的字符串，然后返回調用結果。在代碼段的下面，我們調用每個模塊的main方法，將會打印出每個模塊的名稱。

在你的代碼中，你可能不會大量這樣做。當你只有一個字符串時，如果你想引入這個模塊，importlib就允許你可以這么做。

2 模塊引入檢查

Python有一個編碼規范就是EAPP：Easier to ask for forgiveness than permision。意思就是經常假設一些事情是存在的（例如，key在詞典中），如果出錯了，那么就捕獲異常。你可以看 Python標准模塊–import 文章中我們嘗試引入模塊，當它不存在時，我們就會捕獲到ImportError。如果我們想檢查並觀察一個模塊是否可以引入而不是僅僅是猜測，該如何去做？你可以使用importlib。代碼如下：

import importlib.util
import importlib


def check_module(module_name):
    module_spec = importlib.util.find_spec(module_name)
    if module_spec is None:
        print("Module :{} not found".format(module_name))
        return None
    else:
        print("Module:{} can be imported!".format(module_name))
        return module_spec


def import_module_from_spec(module_spec):
    module = importlib.util.module_from_spec(module_spec)
    module_spec.loader.exec_module(module)
    return module


if __name__ == "__main__":
    module_spec = check_module("fake_module")
    module_spec = check_module("collections")
    if (module_spec):
        module = import_module_from_spec(module_spec)
        print(dir(module))1234567891011121314151617181920212223242526

這里我們引入importlib模塊的子模塊util。在check_module函數中，我們調用find_spec函數來檢查傳入的字符串作為模塊是否存在。首先，我們傳入一個假的名稱，然后我們傳入一個Python模塊的真實名稱。如果你運行這段代碼，你將會看到你傳入一個沒有安裝的模塊的名稱，find_spec函數將會返回None，我們的代碼將會打印出這個模塊沒有找到。如果找到了，我們就會返回模塊的說明。

我們可以獲取到模塊的說明，然后使用它來真正的引入模塊。或者你可以將字符串傳入到import_module函數中，正如我們在2.1節中所學習到的一樣。但是我們已經學習到如何使用模塊的說明。讓我們看一下上述代碼中的import_module_from_spec函數。它接受由check_module函數返回的模塊說明。我們將其傳入到module_from_spec函數，它將會返回引入的模塊。Python的官方文檔推薦，在引入模塊后執行它，所以我們下一步做的就是調用exec_module函數。最后我們返回這個模塊，並且運行Python的dir函數來確認這個我們就是我們所期望的。

3 從源文件中引入

在這一節中，我想說明importlib的子模塊util還有另外一個技巧。你可以使用util通過模塊名和文件路徑來引入一個模塊。示例如下所示，

import importlib.util

def import_source(module_name):
    module_file_path = module_name.__file__
    module_name = module_name.__name__

    module_spec = importlib.util.spec_from_file_location(module_name ,module_file_path)
    module = importlib.util.module_from_spec(module_spec)
    module_spec.loader.exec_module(module)
    print(dir(module))

    msg = "The {module_name} module has the following methods:{methods}"
    print(msg.format(module_name = module_name ,methods = dir(module)))

if __name__ == "__main__":
    import logging
    import_source(logging)1234567891011121314151617

上述代碼中，我們實際引入了logging模塊，並將它傳入到import_source函數。在這個函數中，我們首先獲取到模塊的實際路徑和名稱。然后我們將這些信息傳入到util的spec_from_file_location函數中，這個將會返回模塊的說明。一旦我們獲取到模塊的說明，我們就可以使用與2.2節相同的importlib機制來實際引入模塊。
現在讓我們來看一個精巧的第三方庫，Python的__import__()函數直接引入github中的包。

4 import_from_github_com

這個精巧的包叫做import_from_github_com，它可以用於發現和下載github上的包。為了安裝他，你需要做的就是按照如下命令使用pip，

pip install import_from_github_com1

這個包使用了PEP 302中新的引入鈎子，允許你可以從github上引入包。這個包實際做的就是安裝這個包並將它添加到本地。你需要Python 3.2或者更高的版本，git和pip才能使用這個包。

一旦這些已經安裝，你可以在Python shell中輸入如下命令，

>>> from github_com.zzzeek import sqlalchemy
Collecting git+https://github.com/zzzeek/sqlalchemy
Cloning https://github.com/zzzeek/sqlalchemy to /tmp/pip-acfv7t06-build
Installing collected packages: SQLAlchemy
Running setup.py install for SQLAlchemy ... done
Successfully installed SQLAlchemy-1.1.0b1.dev0
>>> locals()
{'__builtins__': <module 'builtins' (built-in)>, '__spec__': None,
'__package__': None, '__doc__': None, '__name__': '__main__',
'sqlalchemy': <module 'sqlalchemy' from '/usr/local/lib/python3.5/site-packages/\
sqlalchemy/__init__.py'>,
'__loader__': <class '_frozen_importlib.BuiltinImporter'>}123456789101112

你如果看了import_from_github_com的源碼，你將會注意到它並沒有使用importlib。實際上，它使用了pip來安裝那些沒有安裝的包，然后使用Python的import()函數來引入新安裝的模塊。這段代碼非常值得學習。

總結

到這里，你已經了解到在你的代碼中如何使用importlib和引入鈎子。當然還有很多超出本文所覆蓋的知識，如果你需要寫一個自定義的引入器或者下載器，你需要花費很多時間來閱讀官方文檔和源碼。