装饰器上的装饰器可以访问类及其祖先

时间:2016-09-26 08:32:16

标签: python class reflection decorator python-decorators

当我在Python类中修饰绑定方法时,我需要在外部类的装饰器中获取一些信息。这可能吗?

例如:

def modifier(func):
    import sys
    cls_namespace = sys._getframe(1).f_locals
    cls_namespace['data']  # dictonary has no key 'data'
    ...
    return func

class Parent:
    data = "Hi!"

class Child(Parent):

    @modifier
    def method(self):
        pass

cls_namespace只是当前类的不完整命名空间,而我需要获取data字段。

有没有办法在装饰师中获得它?

3 个答案:

答案 0 :(得分:9)

函数修饰在执行类主体时发生,此时对类本身或其基类一无所知。这意味着modifier修饰未绑定的函数对象,并且只有在实例上实际调用func时才会绑定它。

您可以返回一个包装函数来替换已修饰的函数,它将被绑定,您将可以访问self

from functools import wraps

def modifier(func):
    @wraps(func)
    def wrapper(self, *args, **kwargs):
        # self is an instance of the class
        self.data
        return func(self, *args, **kwargs)
    return wrapper

每次在实例上调用method时,都会调用包装器。

如果您必须在创建类时有权访问基类,则必须等到class Child语句已完成执行。在Python 3.6之前,这只能来自类装饰器或元类;每个在创建类主体后调用,您将可以访问(至少)基类。

使用类装饰器,例如:

def modifier(cls):
    # cls is the newly created class object, including class attributes
    cls.data
    return cls

@modifier
class Child(Parent):
    def method(self):
        pass

现在注意装饰者的位置。

Python 3.6添加了一个__init_subclass__ method,它也可以为您提供访问权限;每次为当前类创建子类时都会调用(class)方法:

class Parent:
    def __init_subclass__(cls, **kwargs):
        # cls is a subclass of Parent
        super().__init_subclass__(**kwargs)
        cls.data

    data = "Hi!"

class Child(Parent):
    def method(self):
        pass

答案 1 :(得分:0)

这是一个特别均匀的解决方案:

def wrap_class(cls):
    """Wrap a class to allow binding all decorated methods."""
    for func in cls.__dict__.values():
        if hasattr(func, '__wrapped__'):
            func.__wrapped__.im_class = cls

    return cls

要求您使用@functools.wraps(func),然后用@wraps_class装饰类。

装饰器示例:

def decorator(func):
    @wraps(func)
    def inner(self, *args, **kwargs):
        cls = self.__class__  # bound and straight-forward
        ...

    def extra(*args, **kwargs):
        cls = func.im_class  # Not bound
        ...

    inner.extra = extra

    return inner

用法示例:

@wrap_class
class Badger:
    @decorator
    def stoat(self, mushroom, snake):
        pass

Badger().stoat()
Badger.stoat.extra()

答案 2 :(得分:-1)

并非传递给装饰器包装器的第一个arg将是一个对象实例(self)。多亏了它,你可以访问w =你需要的一切。

见Raphaels的回复: Related issue

def wrapped(self, *f_args, **f_kwargs):

自我是第一个论点