导入任意python源文件。 （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 源文件的正确方法是什么？

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

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'>

Answer 2

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

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

Answer 3

类似于 @falsetru 但对于Python 3.5+并说明importlib文档在使用importlib.util.module_from_spec over types.ModuleType ：

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

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

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()

Answer 4

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

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

• 不推荐使用 imp 模块
• 如何忽略 Python 中的弃用警告

在 Python 3.7.3 中测试。