Использование метакласса для отслеживания экземпляров в python - PullRequest
2 голосов
/ 07 июля 2019

Мне нужно отслеживать экземпляры некоторых классов (и делать другие вещи с этими классами).Я не хотел бы объявлять какой-либо дополнительный код в рассматриваемых классах, поэтому в идеале все должно обрабатываться в метаклассе.

Что я не могу понять, так это как добавить слабую ссылку к каждому новому классу.Экземпляр этих классов.Например:

class Parallelizable(type):
    def __new__(cls, name, bases, attr):
        meta = super().__new__(cls, name, bases, attr)
        # storing the instances in this WeakSet
        meta._instances = weakref.WeakSet()
        return meta

    @property
    def instances(cls):
        return [x for x in cls._instances]

class Foo(metaclass=Parallelizable)
    def __init__(self, name):
        super().__init__()
        self.name = name

        # I would like to avoid having to do that - instead have the metaclass manage it somehow
        self._instances.add(self)

Есть идеи?Я не могу найти крюк на стороне метакласса, чтобы попасть в __init__ Foo ....

Ответы [ 2 ]

2 голосов
/ 07 июля 2019

Метод в метаклассе, который вызывается, когда каждый новый экземпляр его "аффилированных" классов равен __call__.Если вы поместите в него код для записи экземпляров, это все, что вам нужно:


from weakref import WeakSet

# A convenient class-level descriptor to retrieve the instances:

class Instances:
    def __get__(self, instance, cls):
        return [x for x in cls._instances]

class Parallelizable(type):
    def __init__(cls, name, bases, attrs, **kw):
        super().__init__(name, bases, attrs, **kw)
        cls._instances = WeakSet()
        cls.instances = Instances()

    def __call__(cls, *args, **kw):
        instance = super().__call__(*args, **kw)
        cls._instances.add(instance)
        return instance

Тот же код будет работать вообще без дескриптора - это просто хороший способ получить классатрибут, который будет сообщать экземпляры.Но если WeakSet достаточно, этого кода достаточно:


from weakref import WeakSet
class Parallelizable(type):
    def __init__(cls, name, bases, attrs, **kw):
        super().__init__(name, bases, attrs, **kw)
        cls.instances = WeakSet()

    def __call__(cls, *args, **kw):
        instance = super().__call__(*args, **kw)
        cls.instances.add(instance)
        return instance

1 голос
/ 07 июля 2019

Вы можете украсить метод attrs['__init__'] в Parallizable.__new__:

import weakref
import functools
class Parallelizable(type):
    def __new__(meta, name, bases, attrs):
        attrs['__init__'] = Parallelizable.register(attrs['__init__'])
        cls = super().__new__(meta, name, bases, attrs)
        cls._instances = weakref.WeakSet()
        return cls

    @classmethod
    def register(cls, method):
        @functools.wraps(method)
        def newmethod(self, *args, **kwargs):
            method(self, *args, **kwargs)
            self._instances.add(self)
        return newmethod

    @property
    def instances(cls):
        return [x for x in cls._instances]

class Foo(metaclass=Parallelizable):
    def __init__(self, name):
        "Foo.__init__ doc string"
        super().__init__()
        self.name = name

# Notice that Foo.__init__'s docstring is preserved even though the method has been decorated
help(Foo.__init__)
# Help on function __init__ in module __main__:
#
# __init__(self, name)
#     Foo.__init__ doc string

stilton = Foo('Stilton')
gruyere = Foo('Gruyere')
print([inst.name for inst in Foo.instances])
# ['Gruyere', 'Stilton']

del stilton
print([inst.name for inst in Foo.instances])
# ['Gruyere']
...