Как украсить класс?

В 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()

Я думаю, что мне действительно нужен способ сделать что-то вроде интерфейса C # в Python. Полагаю, мне нужно сменить парадигму.

Я бы поддержал идею о том, что вы, возможно, пожелаете рассмотреть подкласс вместо описанного вами подхода. Однако, не зная вашего конкретного сценария, 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

Замена конструктора, возможно, немного драматична, но язык действительно обеспечивает поддержку такого рода глубокого самоанализа и динамической модификации.

Помимо вопроса о том, являются ли декораторы классов правильным решением вашей проблемы:

В Python 2.6 и выше есть декораторы классов с @ -синтаксисом, поэтому вы можете написать:

@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__.

Никто не объяснил, что вы можете определять классы динамически. Таким образом, у вас может быть декоратор, который определяет (и возвращает) подкласс:

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

Так что можете получить свой торт и съесть его - наследство и декораторы!

Это не очень хорошая практика, и из-за этого нет механизма для этого. Правильный способ добиться желаемого - это наследование.

Загляните в документацию класса .

Небольшой пример:

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)

Таким образом, у Босса есть все Employee, в том числе его собственный __init__метод и собственные участники.

Я согласен с тем, что наследование лучше подходит для поставленной проблемы.

Я нашел этот вопрос действительно удобным при декорировании классов, спасибо всем.

Вот еще пара примеров, основанных на других ответах, в том числе о том, как наследование влияет на вещи в 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применяется только decoratorесли имеет conditionзначение True.

Используются getattr, callabletest и @decorate_if, чтобы декоратор не сломался, если foo()метод не существует в декорируемом классе.

На самом деле здесь есть довольно хорошая реализация декоратора классов:

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

Я считаю, что это довольно интересная реализация. Поскольку он является подклассом класса, который он украшает, он будет вести себя точно так же, как этот класс, в таких вещах, как isinstanceпроверки.

У этого есть дополнительное преимущество: это не редкость, когда __init__оператор в пользовательской форме django вносит изменения или дополнения, self.fieldsпоэтому лучше, чтобы изменения self.fieldsпроизошли после того, как все они __init__были выполнены для рассматриваемого класса.

Очень умный.

Однако в вашем классе вы действительно хотите, чтобы украшение изменяло конструктор, что я не думаю, что это хороший вариант использования декоратора класса.

Вот пример, который отвечает на вопрос о возврате параметров класса. Более того, он по-прежнему соблюдает цепочку наследования, т.е. возвращаются только параметры самого класса. Функция get_paramsдобавлена ​​в качестве простого примера, но другие функции могут быть добавлены благодаря модулю inspect.

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']

В 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