可调用模块

Question

为什么 Python 不允许模块有 __call__< /a> 方法？ （显然，直接导入并不容易。）具体来说，为什么不使用 a(b) 语法找到 __call__ 属性，就像它那样函数、类和对象？ （模块的查找是否只是不兼容的不同？）

>>> print(open("mod_call.py").read())
def __call__():
    return 42

>>> import mod_call
>>> mod_call()
Traceback (most recent call last):
  File "<stdin>", line 1, in <module>
TypeError: 'module' object is not callable
>>> mod_call.__call__()
42

Answer 1

Python 不允许模块重写或添加任何魔术方法，因为考虑到可以使用魔术方法的强用例很少出现，保持模块对象简单、常规和轻量级是非常有利的。

当出现此类用例时，解决方案是将类实例伪装成模块。 具体来说，对 mod_call.py 进行如下编码：

import sys

class mod_call:
    def __call__(self):
        return 42

sys.modules[__name__] = mod_call()

现在，您的代码导入和调用 mod_call 工作正常。

Answer 2

特殊方法只有在类型上定义时才能保证被隐式调用，而不是在实例上定义。 （__call__ 是模块实例 mod_call 的属性，而不是 的属性。）您无法添加方法到内置类型。

https://docs.python.org/reference/datamodel.html#special-lookup

Answer 3

正如迈尔斯所说，您需要在类级别定义调用。
因此，Alex post 的替代方法是将 sys.modules[__name__] 类更改为 sys.modules[__name__] 类型的子类（应该是 <代码>类型.ModuleType）。

这样做的优点是模块是可调用的，同时保留模块的所有其他属性（例如访问函数、变量……）。

import sys

class MyModule(sys.modules[__name__].__class__):
    def __call__(self):  # module callable
        return 42

sys.modules[__name__].__class__ = MyModule

注：使用python3.6测试。

Answer 4

Christoph Böddeker 的答案似乎是创建可调用模块的最佳方法，但评论说，它仅适用于Python 3.5及更高版本。

好处是您可以像平常一样编写模块，只需在最后添加类重新分配即可，即

# coolmodule.py
import stuff

var = 33
class MyClass:
   ...
def function(x, y):
   ...

class CoolModule(types.ModuleType):
    def __call__(self):
        return 42
sys.modules[__name__].__class__ = CoolModule

一切正常，包括定义所有预期的模块属性，例如 __file__ 。 （这是因为您实际上根本没有更改导入产生的模块对象，只是使用 __call__ 方法将其“转换”到子类，这正是我们想要的。

）这在低于 3.5 的 Python 版本中工作类似，您可以调整 Alex Martelli 的答案 使您的新类成为 ModuleType 的子类，并将所有模块的属性复制到新的模块实例中：

#(all your module stuff here)

class CoolModule(types.ModuleType):
    def __init__(self):
        types.ModuleType.__init__(self, __name__)
        # or super().__init__(__name__) for Python 3
        self.__dict__.update(sys.modules[__name__].__dict__)
    def __call__(self):
        return 42

sys.modules[__name__] = CoolModule()

现在定义了 __file__、__name__ 和其他模块属性（如果仅遵循 Alex 的答案，则这些属性不存在），并且您导入的模块对象仍然“是一个”模块。

Answer 5

所有答案仅适用于 import mod_call。 为了让它同时工作 from mod_call import *，@Alex Martelli 的解决方案可以如下增强：

import sys

class mod_call:
    def __call__(self):
        return 42
    mod_call = __call__
    __all__ = list(set(vars().keys()) - {'__qualname__'})   # for python 2 and 3

sys.modules[__name__] = mod_call()

该解决方案是通过 类似问题的答案。

Answer 6

要将解决方案转变为方便的可重用函数：

def set_module(cls, __name__):
    import sys

    class cls2(sys.modules[__name__].__class__, cls):
        pass

    sys.modules[__name__].__class__ = cls2

将其保存到，例如，util.py。 然后在你的模块中，

import util

class MyModule:
    def __call__(self):  # module callable
        return 42

util.set_module(MyModule, __name__)

万岁！

我写这篇文章是因为我需要用这个技巧增强很多模块。

---

PS 在我写完这个答案几天后，我从代码中删除了这个技巧，因为像 Pylint 这样的工具很难理解它。

Answer 7

使用 Python 版本 3.10.8，按如下方式格式化我的代码使我能够：

• 使我的模块可调用（谢谢 Alex）
• 保留所有模块可访问的属性（例如方法）（谢谢 Nick）
• 允许模块在用作 CallableModule 中的 时工作import x, y, z，尽管不是 from CallableModule import * （我尝试使用 弗里德里希的解决方案）

    from types import ModuleType
    
    class CallableModule(ModuleType):
        def __init__(self):
            ModuleType.__init__(self, __name__)
            self.__dict__.update(modules[__name__].__dict__)
    
        def __call__(self):
            print("You just called a module UwU")
      
        mod_call= __call__
        __all__= list(set(vars().keys()) - {'__qualname__'})
    modules[__name__]= CallableModule()