Python标准库importlib动态导入与模块检查详解
本文详解Python标准库importlib的核心功能，涵盖动态字符串导入、模块存在性检查、基于文件路径的源码导入以及利用第三方库从GitHub直接引入包的方法。通过具体代码示例，展示如何利用import_module、find_spec及spec_from_file_location实现灵活的模块加载策略，适用于需要运行时动态加载组件或简化依赖管理的开发场景。
1 模块简介
Python将importlib作为标准库的一部分提供，其核心目的是实现Python中的import语句及__import__函数。此外，importlib还允许开发者创建自定义对象（即importer），以参与或定制模块的引入过程。
什么是imp？
此前存在一个名为imp的模块，用于提供Python import语句机制的底层接口。该模块已在Python 3.4版本中被标记为废弃，官方建议全面转向使用importlib。
鉴于该模块机制较为复杂，本文主要聚焦于以下几个核心主题：
• 动态引入模块 • 检查模块是否可被引入 • 从源文件直接引入模块 • 第三方模块 import_from_github_com 的使用
2 模块使用
2.1 动态引入
importlib模块支持通过传入字符串参数来动态引入模块。为了验证这一功能，我们创建两个接口相同但打印内容不同的简单模块。分别创建foo.py和bar.py，代码如下所示：
def main(): print(__name__)
接下来，我们使用importlib来引入上述模块。请确保执行代码与之前创建的两个模块位于同一目录下。
#importer.py
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()
在此代码中，我们手动导入importlib模块，并定义了一个名为dynamic_import的简单函数。该函数调用importlib模块中的import_module函数，传入字符串参数并返回结果。在代码后续部分，我们调用每个模块的main方法，从而打印出各自的名称标识。
在实际代码中，你可能不会频繁使用这种方式。但当仅持有模块名字符串且需要动态加载该模块时，importlib提供了便捷的实现途径。
2.2 模块引入检查
Python遵循EAFP编码规范（Easier to ask for forgiveness than permission，即“请求原谅比请求许可更容易”）。这意味着通常假设对象存在（如字典中的键），若出错则捕获异常。在尝试引入不存在的模块时，我们会捕获到ImportError。如果希望先检查模块是否可引入而非盲目尝试，可以使用importlib。代码如下：
#coding:utf-8
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))
此处引入了importlib模块的子模块util。在check_module函数中，我们调用find_spec函数来检查传入字符串对应的模块是否存在。首先传入一个虚构的名称，随后传入Python中真实存在的模块名称。运行代码可见，若传入未安装的模块名，find_spec将返回None，代码会打印“模块未找到”；若找到模块，则返回模块的说明（spec）。
获取模块说明后，可据此真正引入模块。或者，如2.1节所示，直接将字符串传入import_module函数。但我们已学习如何利用模块说明进行操作。下面介绍上述代码中的import_module_from_spec函数，它接受由check_module返回的模块说明。将其传入module_from_spec函数可返回已引入的模块。Python官方文档建议在引入模块后执行它，因此下一步调用exec_module函数。最后返回该模块，并运行Python的dir函数以确认其符合预期。
2.3 从源文件中引入
本节展示importlib子模块util的另一个技巧：通过模块名和文件路径引入模块。示例如下：
#coding:utf-8
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)
上述代码实际引入了logging模块，并将其传入import_source函数。该函数首先获取模块的实际路径和名称，然后将这些信息传入util的spec_from_file_location函数，以返回模块说明。获取模块说明后，即可使用与2.2节相同的importlib机制来实际引入模块。
接下来介绍一个精巧的第三方库，可直接通过Python的__import__()函数从GitHub引入包。
2.4 import_from_github_com
这个名为import_from_github_com的精巧包可用于发现和下载GitHub上的包。安装方法如下，使用pip命令：
pip install import_from_github_com
该包利用了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'>}
查看import_from_github_com的源码会发现，它并未直接使用importlib。实际上，它利用pip安装未安装的包，随后使用Python的__import__()函数引入新安装的模块。这段代码非常值得学习参考。
2.5 总结
至此，你已经了解了如何在代码中使用importlib及引入钩子。当然，本文未涵盖所有知识，若需编写自定义引入器或下载器，需花费大量时间阅读官方文档和源码。
免责声明：本文内容仅供参考，不代表本站观点。转载或引用请注明出处。
