在Python 3中发布导入钩子

时间:2016-11-16 04:05:09

标签: python python-3.x python-import

我想在导入特定模块时运行一些回调。例如(使用不存在的假@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实现导入后挂钩?

3 个答案:

答案 0 :(得分:3)

wrapt模块提供了此实现。

观看有关wrapt的视频,包括此功能:

不要认为wrapt的文档尚未提及。

一些博客文章末尾:

谈论它。

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

答案 1 :(得分: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。

答案 2 :(得分:-2)

这有用吗?

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