86

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

我使用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 而不是这个模块。

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

4

4 回答 4

101

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+。

UPDATE 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'>
于 2013-09-25T17:17:13.800 回答
30

为 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 对其进行了测试。

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

于 2017-01-11T16:09:58.207 回答
13

与@falsetru 类似，但适用于Python 3.5+并说明文档importlib在使用importlib.util.module_from_specover 时的说明types.ModuleType：

此函数 [ importlib.util.module_from_spec] 优于types.ModuleType用于创建新模块，因为 spec 用于在模块上设置尽可能多的导入控制属性。

我们可以importlib通过修改importlib.machinery.SOURCE_SUFFIXES列表单独导入任何文件。

import importlib

importlib.machinery.SOURCE_SUFFIXES.append('') # empty string to allow any file
spec = importlib.util.spec_from_file_location(module_name, file_path)
module = importlib.util.module_from_spec(spec)
spec.loader.exec_module(module)
# if desired: importlib.machinery.SOURCE_SUFFIXES.pop()
于 2018-07-28T23:14:49.440 回答
6

importlib辅助函数

这是一个方便的、即用型的替换助手imp，并带有一个示例。该技术与https://stackoverflow.com/a/19011259/895245的技术相同，只是提供了一个更方便的功能。

主文件

#!/usr/bin/env python3

import os
import importlib

def import_path(path):
    module_name = os.path.basename(path).replace('-', '_')
    spec = importlib.util.spec_from_loader(
        module_name,
        importlib.machinery.SourceFileLoader(module_name, path)
    )
    module = importlib.util.module_from_spec(spec)
    spec.loader.exec_module(module)
    sys.modules[module_name] = module
    return module

notmain = import_path('not-main')
print(notmain)
print(notmain.x)

非主要

x = 1

跑：

python3 main.py

输出：

<module 'not_main' from 'not-main'>
1

我替换-为，_因为我的可导入 Python 可执行文件没有扩展名，如my-cmd. 这不是强制性的，但会产生更好的模块名称，例如my_cmd.

文档中也提到了这种模式：https ://docs.python.org/3.7/library/importlib.html#importing-a-source-file-directly

我最终转向它，因为在更新到 Python 3.7 后，import imp打印：

DeprecationWarning: the imp module is deprecated in favour of importlib; see the module's documentation for alternative uses

而且我不知道如何关闭它，这是在以下位置询问的：

在 Python 3.7.3 中测试。

于 2020-10-22T14:07:10.353 回答