152

在 Python 2.5 中，有没有办法创建装饰类的装饰器？具体来说，我想使用装饰器将成员添加到类并更改构造函数以获取该成员的值。

寻找类似以下的内容（在 'class Foo:' 上有语法错误：

def getId(self): return self.__id

class addID(original_class):
    def __init__(self, id, *args, **kws):
        self.__id = id
        self.getId = getId
        original_class.__init__(self, *args, **kws)

@addID
class Foo:
    def __init__(self, value1):
        self.value1 = value1

if __name__ == '__main__':
    foo1 = Foo(5,1)
    print foo1.value1, foo1.getId()
    foo2 = Foo(15,2)
    print foo2.value1, foo2.getId()

我想我真正追求的是一种在 Python 中执行类似 C# 接口的方法。我想我需要改变我的范式。

4

8 回答 8

220

除了类装饰器是否是您问题的正确解决方案的问题之外：

在 Python 2.6 及更高版本中，有带有 @-syntax 的类装饰器，因此您可以编写：

@addID
class Foo:
    pass

在旧版本中，您可以采用另一种方式：

class Foo:
    pass

Foo = addID(Foo)

但是请注意，这与函数装饰器的工作方式相同，并且装饰器应该返回新的（或修改后的原始）类，这不是您在示例中所做的。addID 装饰器看起来像这样：

def addID(original_class):
    orig_init = original_class.__init__
    # Make copy of original __init__, so we can call it without recursion

    def __init__(self, id, *args, **kws):
        self.__id = id
        self.getId = getId
        orig_init(self, *args, **kws) # Call the original __init__

    original_class.__init__ = __init__ # Set the class' __init__ to the new one
    return original_class

然后，您可以如上所述为您的 Python 版本使用适当的语法。

但我同意其他人的观点，如果你想覆盖继承更适合__init__。

于 2009-03-25T15:58:22.050 回答
86

我会支持您可能希望考虑子类而不是您概述的方法的概念。但是，不知道您的具体情况，YMMV :-)

你在想的是一个元类。元类中的__new__函数被传递给类的完整提议定义，然后它可以在创建类之前对其进行重写。那时，您可以将构造函数替换为新的构造函数。

例子：

def substitute_init(self, id, *args, **kwargs):
    pass

class FooMeta(type):

    def __new__(cls, name, bases, attrs):
        attrs['__init__'] = substitute_init
        return super(FooMeta, cls).__new__(cls, name, bases, attrs)

class Foo(object):

    __metaclass__ = FooMeta

    def __init__(self, value1):
        pass

替换构造函数可能有点戏剧性，但该语言确实为这种深度自省和动态修改提供了支持。

于 2009-03-25T15:14:34.433 回答
28

没有人解释过您可以动态定义类。因此，您可以拥有一个定义（并返回）子类的装饰器：

def addId(cls):

    class AddId(cls):

        def __init__(self, id, *args, **kargs):
            super(AddId, self).__init__(*args, **kargs)
            self.__id = id

        def getId(self):
            return self.__id

    return AddId

可以在 Python 2 中使用（来自 Blckknght 的评论解释了为什么您应该在 2.6+ 中继续这样做），如下所示：

class Foo:
    pass

FooId = addId(Foo)

在这样的 Python 3 中（但要小心super()在你的类中使用）：

@addId
class Foo:
    pass

所以你可以吃你的蛋糕- 继承和装饰！

于 2013-09-21T21:47:44.297 回答
14

这不是一个好的做法，因此没有机制可以做到这一点。实现你想要的正确方法是继承。

查看类文档。

一个小例子：

class Employee(object):

    def __init__(self, age, sex, siblings=0):
        self.age = age
        self.sex = sex    
        self.siblings = siblings

    def born_on(self):    
        today = datetime.date.today()

        return today - datetime.timedelta(days=self.age*365)


class Boss(Employee):    
    def __init__(self, age, sex, siblings=0, bonus=0):
        self.bonus = bonus
        Employee.__init__(self, age, sex, siblings)

这样Boss就拥有了一切Employee，还有他自己的__init__方法和自己的成员。

于 2009-03-25T15:01:38.100 回答
11

我同意继承更适合所提出的问题。

虽然在装饰课上，我发现这个问题真的很方便，谢谢大家。

这是基于其他答案的另外几个示例，包括继承如何影响 Python 2.7 中的事物（以及@wraps，它维护原始函数的文档字符串等）：

def dec(klass):
    old_foo = klass.foo
    @wraps(klass.foo)
    def decorated_foo(self, *args ,**kwargs):
        print('@decorator pre %s' % msg)
        old_foo(self, *args, **kwargs)
        print('@decorator post %s' % msg)
    klass.foo = decorated_foo
    return klass

@dec  # No parentheses
class Foo...

通常你想给你的装饰器添加参数：

from functools import wraps

def dec(msg='default'):
    def decorator(klass):
        old_foo = klass.foo
        @wraps(klass.foo)
        def decorated_foo(self, *args ,**kwargs):
            print('@decorator pre %s' % msg)
            old_foo(self, *args, **kwargs)
            print('@decorator post %s' % msg)
        klass.foo = decorated_foo
        return klass
    return decorator

@dec('foo decorator')  # You must add parentheses now, even if they're empty
class Foo(object):
    def foo(self, *args, **kwargs):
        print('foo.foo()')

@dec('subfoo decorator')
class SubFoo(Foo):
    def foo(self, *args, **kwargs):
        print('subfoo.foo() pre')
        super(SubFoo, self).foo(*args, **kwargs)
        print('subfoo.foo() post')

@dec('subsubfoo decorator')
class SubSubFoo(SubFoo):
    def foo(self, *args, **kwargs):
        print('subsubfoo.foo() pre')
        super(SubSubFoo, self).foo(*args, **kwargs)
        print('subsubfoo.foo() post')

SubSubFoo().foo()

输出：

@decorator pre subsubfoo decorator
subsubfoo.foo() pre
@decorator pre subfoo decorator
subfoo.foo() pre
@decorator pre foo decorator
foo.foo()
@decorator post foo decorator
subfoo.foo() post
@decorator post subfoo decorator
subsubfoo.foo() post
@decorator post subsubfoo decorator

我使用了函数装饰器，因为我发现它们更简洁。这是一个装饰类的类：

class Dec(object):

    def __init__(self, msg):
        self.msg = msg

    def __call__(self, klass):
        old_foo = klass.foo
        msg = self.msg
        def decorated_foo(self, *args, **kwargs):
            print('@decorator pre %s' % msg)
            old_foo(self, *args, **kwargs)
            print('@decorator post %s' % msg)
        klass.foo = decorated_foo
        return klass

一个更健壮的版本，可以检查这些括号，如果装饰类上不存在方法，则可以工作：

from inspect import isclass

def decorate_if(condition, decorator):
    return decorator if condition else lambda x: x

def dec(msg):
    # Only use if your decorator's first parameter is never a class
    assert not isclass(msg)

    def decorator(klass):
        old_foo = getattr(klass, 'foo', None)

        @decorate_if(old_foo, wraps(klass.foo))
        def decorated_foo(self, *args ,**kwargs):
            print('@decorator pre %s' % msg)
            if callable(old_foo):
                old_foo(self, *args, **kwargs)
            print('@decorator post %s' % msg)

        klass.foo = decorated_foo
        return klass

    return decorator

assert检查装饰器在没有括号的情况下未被使用。如果有，那么被装饰的类被传msg​​递给装饰器的参数，这会引发一个AssertionError.

@decorate_if仅适用于decoratorif的condition评估结果True。

,测试, 和getattr用于使装饰器在被装饰的类上不存在该方法时不会中断。callable@decorate_iffoo()

于 2017-06-15T00:16:03.753 回答
5

这里实际上有一个非常好的类装饰器实现：

https://github.com/agiliq/Django-parsley/blob/master/parsley/decorators.py

我实际上认为这是一个非常有趣的实现。isinstance因为它继承了它所装饰的类，所以它在检查等方面的行为与这个类完全一样。

它还有一个额外的好处：__init__自定义 django 表单中的语句进行修改或添加的情况并不少见，self.fields因此最好在所有相关类self.fields都运行后进行更改。__init__

非常聪明。

但是，在您的类中，您实际上希望装饰来改变构造函数，我认为这对于类装饰器来说不是一个好的用例。

于 2013-01-28T15:05:42.810 回答
0

这是一个示例，它回答了返回类参数的问题。而且，它仍然尊重继承链，即只返回类本身的参数。该功能get_params是作为一个简单的示例添加的，但由于检查模块，可以添加其他功能。

import inspect 

class Parent:
    @classmethod
    def get_params(my_class):
        return list(inspect.signature(my_class).parameters.keys())

class OtherParent:
    def __init__(self, a, b, c):
        pass

class Child(Parent, OtherParent):
    def __init__(self, x, y, z):
        pass

print(Child.get_params())
>>['x', 'y', 'z']
于 2019-12-20T10:16:09.477 回答
0

Django 有method_decorator一个装饰器，可以将任何装饰器变成方法装饰器，你可以看到它是如何实现的django.utils.decorators：

https://github.com/django/django/blob/50cf183d219face91822c75fa0a15fe2fe3cb32d/django/utils/decorators.py#L53

https://docs.djangoproject.com/en/3.0/topics/class-based-views/intro/#decorating-the-class

于 2020-01-27T16:33:34.950 回答