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

Question

В 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. Полагаю, мне нужно сменить парадигму.

Answer 1

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

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

Answer 2

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

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

Answer 3

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

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

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

Answer 4

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

Ознакомьтесь с документацией класса .

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

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__ и собственные члены.

Answer 5

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

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

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

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

Очень умный.

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

Answer 6

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

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

Вот еще пара примеров, основанных на других ответах, включая то, как наследование влияет на вещи в 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, callable и @decorate_if используются для того, чтобы декоратор не сломался, если метод foo() не существует в декорируемом классе.