导入任意 python 源文件。 （蟒蛇 3.3）

Question

如何在 Python 3.3+ 中导入任意 python 源文件（其文件名可以包含任何字符，并且并不总是以 .py 结尾）？

我使用 imp.load_module 如下：

 >>> import imp
>>> path = '/tmp/a-b.txt'
>>> with open(path, 'U') as f:
...     mod = imp.load_module('a_b', f, path, ('.py', 'U', imp.PY_SOURCE))
...
>>> mod
<module 'a_b' from '/tmp/a-b.txt'>

它仍然适用于 Python 3.3，但根据 imp.load_module 文档，它已被弃用：

3.3 版 后已移除：不需要，因为加载程序应该用于加载模块，并且 find_module() 已弃用。

和 imp 模块文档建议使用 importlib ：

注意 新程序应该使用 importlib 而不是这个模块。

在不使用已弃用的 imp.load_module 函数的情况下，在 Python 3.3+ 中加载任意 python 源文件的正确方法是什么？

原文由 falsetru 发布，翻译遵循 CC BY-SA 4.0 许可协议

Answer 1

从 importlib 测试代码 中找到解决方案。

使用 importlib.machinery.SourceFileLoader ：

 >>> import importlib.machinery
>>> loader = importlib.machinery.SourceFileLoader('a_b', '/tmp/a-b.txt')
>>> mod = loader.load_module()
>>> mod
<module 'a_b' from '/tmp/a-b.txt'>

注意：仅适用于 Python 3.3+ 。

更新 Loader.load_module 自 Python 3.4 起已弃用。使用 Loader.exec_module 代替：

 >>> import types
>>> import importlib.machinery
>>> loader = importlib.machinery.SourceFileLoader('a_b', '/tmp/a-b.txt')
>>> mod = types.ModuleType(loader.name)
>>> loader.exec_module(mod)
>>> mod
<module 'a_b'>

---

 >>> import importlib.machinery
>>> import importlib.util
>>> loader = importlib.machinery.SourceFileLoader('a_b', '/tmp/a-b.txt')
>>> spec = importlib.util.spec_from_loader(loader.name, loader)
>>> mod = importlib.util.module_from_spec(spec)
>>> loader.exec_module(mod)
>>> mod
<module 'a_b' from '/tmp/a-b.txt'>

原文由 falsetru 发布，翻译遵循 CC BY-SA 4.0 许可协议

Answer 2

为 Python >= 3.8 更新：

精简版：

 >>> # https://docs.python.org/3/library/importlib.html#importing-a-source-file-directly
>>> import importlib.util, sys
>>> spec = importlib.util.spec_from_file_location(modname, fname)
>>> module = importlib.util.module_from_spec(spec)
>>> sys.modules[modname] = module
>>> spec.loader.exec_module(module)

完整版本：

 >>> import importlib.util
>>> import sys
>>> from pathlib import Path
>>> from typing import TYPE_CHECKING
>>>
>>>
>>> if TYPE_CHECKING:
...     import types
...
...
>>> def import_source_file(fname: str | Path, modname: str) -> "types.ModuleType":
...     """
...     Import a Python source file and return the loaded module.

...     Args:
...         fname: The full path to the source file.  It may container characters like `.`
...             or `-`.
...         modname: The name for the loaded module.  It may contain `.` and even characters
...             that would normally not be allowed (e.g., `-`).
...     Return:
...         The imported module

...     Raises:
...         ImportError: If the file cannot be imported (e.g, if it's not a `.py` file or if
...             it does not exist).
...         Exception: Any exception that is raised while executing the module (e.g.,
...             :exc:`SyntaxError).  These are errors made by the author of the module!
...     """
...     # https://docs.python.org/3/library/importlib.html#importing-a-source-file-directly
...     spec = importlib.util.spec_from_file_location(modname, fname)
...     if spec is None:
...         raise ImportError(f"Could not load spec for module '{modname}' at: {fname}")
...     module = importlib.util.module_from_spec(spec)
...     sys.modules[modname] = module
...     try:
...         spec.loader.exec_module(module)
...     except FileNotFoundError as e:
...         raise ImportError(f"{e.strerror}: {fname}") from e
...     return module
...
>>> import_source_file(Path("/tmp/my_mod.py"), "my_mod")
<module 'my_mod' from '/tmp/my_mod.py'>

Python 3.5 和 3.6 的原始答案

@falsetru 解决方案的较短版本：

 >>> import importlib.util
>>> spec = importlib.util.spec_from_file_location('a_b', '/tmp/a-b.py')
>>> mod = importlib.util.module_from_spec(spec)
>>> spec.loader.exec_module(mod)
>>> mod
<module 'a_b' from '/tmp/a-b.txt'>

我用 Python 3.5 和 3.6 测试了它。

根据评论，它不适用于任意文件扩展名。

原文由 Stefan Scherfke 发布，翻译遵循 CC BY-SA 4.0 许可协议