在 Python 3 中发布导入钩子

Question

我希望在导入特定模块时运行一些回调。例如（使用一个实际上并不存在的假 @imp.when_imported 函数）：

@imp.when_imported('numpy')
def set_linewidth(numpy):
    import shutil
    numpy.set_printoptions(linewidth=shutil.get_terminal_size()[0])

此功能是在PEP 369: Post import hooks 中设计的，但由于以下原因被撤回：

此 PEP 已被其作者撤回，因为在 Python 3.3 中迁移到 importlib 后，大部分详细设计不再有效。

但是importlib 没有明确的解决方案。如何使用importlib 实现导入后挂钩？

Answer 1

wrapt 模块提供了一个实现。

• https://pypi.python.org/pypi/wrapt

观看有关wrapt 的视频，包括此功能：

• https://www.youtube.com/watch?v=u7oj-ghfhUk

不要认为wrapt 的文档提到它。

一些博文在文末：

• http://blog.dscpl.com.au/p/decorators-and-monkey-patching.html

尽管谈论它。

wrapt 有一个名为 autowrapt 的配套模块，它允许您使用此机制进行猴子修补，而无需更改应用程序代码本身来触发它。

• https://pypi.python.org/pypi/autowrapt

Answer 2

我会震惊地发现这是执行此操作的最佳方法......但是，从早期的 python2.x 版本开始，猴子修补 __import__ 就得到了支持。我们可以在这里利用它：

try:
    import builtins  # python3.x
except ImportError:
    import __builtin__ as builtins  # python2.x
import sys
import collections

_builtin_import = builtins.__import__

def _my_import(name, globals=None, locals=None, fromlist=(), level=0):
    already_imported = name in sys.modules

    mod = _builtin_import(
        name,
        globals=globals,
        locals=locals,
        fromlist=fromlist,
        level=level)

    if not already_imported and name in _post_import_hooks:
        for hook in _post_import_hooks[name]:
            hook()
    return mod

builtins.__import__ = _my_import

_post_import_hooks = collections.defaultdict(list)

def on_import(name):
    def decorator(func):
        _post_import_hooks[name].append(func)
        return func
    return decorator

@on_import('numpy')
def print_hi():
    print('Hello Numpy')

print('before numpy')
import numpy
print('after numpy')

这个答案使一个 super 简单的注册表用于注册回调。装饰器只是注册函数然后返回它。它不会做任何花哨的检查（例如，模块是否已经加载），但可以很容易地扩展来做到这一点。

显然，不利的一面是，如果某个其他模块决定对 __import__ 进行猴子补丁，那么您就不走运了——这个模块或另一个模块可能最终会损坏。

我已经对此进行了测试，它似乎适用于 python2.x 和 python3.x。

Answer 3

这行得通吗？

import importlib

class ImportHook:

    def __init__(self, func):
        self.func = func
        self.module = None

    def __enter__(self):
        return self

    def get_module(self, module_name):
        self.module = importlib.import_module(module_name)
        return self.module

    def __exit__(self, exc_type, exc_val, exc_tb):
        if self.module is not None:
            self.func(self.module)

def set_linewidth(module):
    import shutil
    module.set_printoptions(linewidth=shutil.get_terminal_size()[0])

with ImportHook(set_linewidth) as hook:
    numpy = hook.get_module('numpy')