来自装饰器的 Python 导入模块

Posted 2023-02-23

【中文标题】来自装饰器的 Python 导入模块

【英文标题】：Python Import Module from Decorator

【发布时间】：2015-05-15 03:18:56

【问题描述】：

我正在使用 Python 3 开发一个应用程序，而我正在做的事情是非常规的。

cx_Oracle 是一个难以设置的模块，对于我的应用程序来说是一个可选的依赖项。我想做的是将模块的导入包装在装饰器中，仅放置在使用它的函数之上。这将不必在我的模块顶部导入并允许它不被设置。

class Loader():
    def load_cx_oracle(func):
        def inner(*args, **kwargs):

            # Additional code before import.

            import cx_Oracle

            return func(*args, **kwargs)
        return inner

    @load_cx_oracle
    def function_using_cx_oracle(self):
        conn = cx_Oracle.connect()

但是，当我尝试上述操作时，我得到NameError: name 'cx_Oracle' is not defined

【参考方案1】：

如果您想要一个可选的导入，请在模块开头使用 try-except：

try:
    import cx_Oracle
except ImportError:
    cx_Oracle = None

【参考方案2】：

import 仅在您使用它的命名空间中绑定模块名称。如果你在函数内部使用import cx_Oracle，则名称cx_Oracle 将仅在该函数内部可用。

但是，您可以使用global 将分配设为全局。更改要使用的装饰器：

global cx_Oracle
import cx_Oracle

这种方法是否真的正确是值得商榷的。根据您的代码的使用方式，如果用户想让cx_Oracle 可用，使用尝试包装的导入，或者定义加载，则可能更简洁通过一些外部设置（例如，配置文件）。

【讨论】：

这解决了我的问题。出于几个原因，我希望为这些功能使用装饰器。我的示例中遗漏了一些配置内容。此应用程序有时只会运行这些功能之一。基本上它将传递参数来运行仅列出的一个函数。

正如@Dunes 提到的，使用global 仅在装饰器与装饰函数在同一模块中定义时才有效。

【参考方案3】：

接受的答案存在一些问题。其中最重要的是它每次调用函数时都会运行导入逻辑。第二个是装饰器必须定义在它使用的同一个模块中，否则装饰器和装饰器将具有不同的全局变量。您可以通过函数的__globals__ 属性直接访问函数的全局变量。该代码示例首先检查模块是否存在于函数的全局变量中，然后再执行导入逻辑。该示例还使用 functools.wraps 装饰器在使用 help(func) 之类的内容时保留文档字符串、函数名称和参数名称。

from functools import wraps

def load_operator(func):
    @wraps(func)
    def wrapper(*args, **kwargs):
        if "operator" not in func.__globals__:
            # setup logic -- only executed once
            import operator
            func.__globals__["operator"] = operator
        return func(*args, **kwargs)
    return wrapper

class A:
    @load_operator
    def add(self, x, y):
        return operator.add(x, y)

    def subtract(self, x, y):
        return operator.subtract(x, y)

a = A()
try:
    a.subtract(1, 2)
except NameError:
    print("operator not yet loaded")
print(a.add(1, 2))
print(A.add)

【讨论】：

这是否也会阻止来自多个函数调用的多个导入。例如，如果您确实为def subtract(self, x, y) 包含了您的装饰器，它是否仍然只加载一次，还是为每个函数单独加载？我知道当前的答案确实需要每个函数，但我特别想知道是否可以修改你的答案以防止在同一模块中的函数之间出现这种情况。

是的，它会阻止多次导入——因为在同一个模块中声明的函数共享相同的全局变量。

每次运行导入逻辑只不过是通过检查“operator”是否已经在全局变量中所做的事情——导入检查的第一件事是模块是否已经被导入，在这种情况下，这是一个简单的名称分配。但是，您的第二点是真正的问题 - 所以+1。

@EthanFurman OP 表示他正在做的不仅仅是导入。如果只是导入，那么我同意检查将毫无意义。

你说得对，它只适用于同一个模块。在 OP 的示例中，装饰器本身不仅在同一个模块中定义，而且在与装饰函数相同的 class 中定义，我认为这意味着跨模块使用不是问题（尽管这可能不切实际）。无论如何，我认为使用func.__globals__ 比使用global 更可疑，如果必须这样做，最好完全使用另一种方法。