Question

I've seen decorators允许您将函数标记为已弃用，以便在使用该函数时给出警告。我想对全局变量做同样的事情，但我想不出一种检测全局变量访问的方法。我知道globals（）函数，我可以检查它的内容，但是这只会告诉我是否定义了全局（如果该函数被弃用并且不是全部删除它仍将是它），如果它实际被使用的话。我能想到的最佳选择是这样的：

# myglobal = 3
myglobal = DEPRECATED(3)

但是除了如何让DEPRECATED完全像'3'那样的问题之外，我不确定DEPRECATED可以做什么，这样你每次访问它都会被检测到。我认为它能做的最好就是遍历所有全局的方法（因为Python中的所有东西都是一个对象，所以即使'3'也有方法，转换为字符串之类的东西）和'装饰'它们都被弃用了。但那并不理想。

有什么想法吗？还有其他人解决了这个问题吗？

Answer 1

您无法直接执行此操作，因为无法拦截模块访问权限。但是，您可以使用您选择的充当代理的对象替换该模块，以查找对某些属性的访问：

import sys, warnings

def WrapMod(mod, deprecated):
    """Return a wrapped object that warns about deprecated accesses"""
    deprecated = set(deprecated)
    class Wrapper(object):
        def __getattr__(self, attr):
            if attr in deprecated:
                warnings.warn("Property %s is deprecated" % attr)

            return getattr(mod, attr)

        def __setattr__(self, attr, value):
            if attr in deprecated:
                warnings.warn("Property %s is deprecated" % attr)
            return setattr(mod, attr, value)
    return Wrapper()

oldVal = 6*9
newVal = 42

sys.modules[__name__] = WrapMod(sys.modules[__name__], 
                         deprecated = ['oldVal'])

现在，您可以将其用作：

>>> import mod1
>>> mod1.newVal
42
>>> mod1.oldVal
mod1.py:11: UserWarning: Property oldVal is deprecated
  warnings.warn("Property %s is deprecated" % attr)
54

缺点是您在访问模块时正在执行两次查找，因此会有轻微的性能损失。

Answer 2

你可以将你的模块变成一个类（参见例如this SO question）并将不推荐使用的全局变为属性，这样你就可以在访问它时执行一些代码并提供你想要的警告。然而，这似乎有点矫枉过正。

Answer 3

看哪：

代码

from types import *

def wrapper(f, warning):
    def new(*args, **kwargs):
        if not args[0].warned:
            print "Deprecated Warning: %s" % warning
            args[0].warned = True
        return f(*args, **kwargs)
    return new

class Deprecated(object):
    def __new__(self, o, warning):
        print "Creating Deprecated Object"
        class temp(o.__class__): pass
        temp.__name__ = "Deprecated_%s" % o.__class__.__name__
        output = temp.__new__(temp, o)

        output.warned = True
        wrappable_types = (type(int.__add__), type(zip), FunctionType)
        unwrappable_names = ("__str__", "__unicode__", "__repr__", "__getattribute__", "__setattr__")

        for method_name in dir(temp):
            if not type(getattr(temp, method_name)) in wrappable_types: continue
            if method_name in unwrappable_names: continue

            setattr(temp, method_name, wrapper(getattr(temp, method_name), warning))

        output.warned = False

        return output

输出

>>> a=Deprecated(1, "Don't use 1")
Creating Deprecated Object
>>> a+9
Deprecated Warning: Don't use 1
10
>>> a*4
4
>>> 2*a
2

这显然可以改进，但要点就在那里。

Answer 4

这是PEP 562的主要理由之一（在Python 3.7中实现）：

典型的解决方法是将模块对象的__class__分配给自定义types.ModuleType的子类或替换sys.modules项使用自定义包装器实例。简化会很方便此过程通过识别模块中直接定义的__getattr__ 这将是一个普通的__getattr__方法，除了它会在模块实例上定义。例如：
# lib.py

from warnings import warn

deprecated_names = ["old_function", ...]

def _deprecated_old_function(arg, other):
    ...

def __getattr__(name):
    if name in deprecated_names:
        warn(f"{name} is deprecated", DeprecationWarning)
        return globals()[f"_deprecated_{name}"]
    raise AttributeError(f"module {__name__} has no attribute {name}")

# main.py

from lib import old_function  # Works, but emits the warning

如何在Python中将全局标记为已弃用？

4 个答案:

代码

输出