weakref.md

1> **Источник:** https://python-all.ru/3.7/library/weakref.html2>3> «Документация Python на русском» – неофициальный перевод официальной документации Python: версии от 2.6 до 3.16, полнотекстовый поиск, английский оригинал рядом с переводом. Эта Markdown-версия страницы предназначена для работы с LLM: вставьте её в ChatGPT, Claude или Cursor.45---67# [`weakref`](https://python-all.ru/3.7/library/weakref.html#module-weakref) – Слабые ссылки89**Исходный код:** [Lib/weakref.py](https://python-all.ru/src/3.7/Lib/weakref.py)1011---1213Модуль [`weakref`](https://python-all.ru/3.7/library/weakref.html#module-weakref) позволяет программисту Python создавать *слабые ссылки* на объекты.1415В дальнейшем под термином *referent* понимается объект, на который указывает слабая ссылка.1617Слабой ссылки на объект недостаточно, чтобы сохранить объект живым: когда единственные оставшиеся ссылки на референт являются слабыми ссылками, [сборщик мусора](https://python-all.ru/3.7/glossary.html#term-garbage-collection) может уничтожить референт и использовать его память для других целей. Однако, пока объект фактически не уничтожен, слабая ссылка может вернуть объект, даже если на него нет сильных ссылок.1819Основное применение слабых ссылок – реализация кэшей или отображений, содержащих большие объекты, когда требуется, чтобы большой объект не оставался в живых только потому, что он присутствует в кэше или отображении.2021Например, если у вас есть несколько больших бинарных объектов-изображений, вы можете захотеть связать имя с каждым. Если вы используете словарь Python для отображения имён на изображения или изображений на имена, объекты-изображения будут оставаться живыми только потому, что они присутствуют как значения или ключи в словарях. Классы [`WeakKeyDictionary`](https://python-all.ru/3.7/library/weakref.html#weakref.WeakKeyDictionary) и [`WeakValueDictionary`](https://python-all.ru/3.7/library/weakref.html#weakref.WeakValueDictionary), предоставляемые модулем [`weakref`](https://python-all.ru/3.7/library/weakref.html#module-weakref), являются альтернативой: они используют слабые ссылки для построения отображений, которые не сохраняют объекты живыми только из-за их присутствия в объектах-отображениях. Если, например, объект-изображение является значением в [`WeakValueDictionary`](https://python-all.ru/3.7/library/weakref.html#weakref.WeakValueDictionary), то, когда последние оставшиеся ссылки на этот объект-изображение являются слабыми ссылками, хранящимися в слабых отображениях, сборщик мусора может переработать объект, и соответствующие записи в слабых отображениях просто удаляются.2223[`WeakKeyDictionary`](https://python-all.ru/3.7/library/weakref.html#weakref.WeakKeyDictionary) и [`WeakValueDictionary`](https://python-all.ru/3.7/library/weakref.html#weakref.WeakValueDictionary) используют слабые ссылки в своей реализации, устанавливая функции обратного вызова на слабые ссылки, которые уведомляют слабые словари, когда ключ или значение были переработаны сборщиком мусора. [`WeakSet`](https://python-all.ru/3.7/library/weakref.html#weakref.WeakSet) реализует интерфейс [`set`](https://python-all.ru/3.7/library/stdtypes.html#set), но хранит слабые ссылки на свои элементы, подобно тому, как это делает [`WeakKeyDictionary`](https://python-all.ru/3.7/library/weakref.html#weakref.WeakKeyDictionary).2425[`finalize`](https://python-all.ru/3.7/library/weakref.html#weakref.finalize) предоставляет простой способ зарегистрировать функцию очистки, которая будет вызвана, когда объект будет собран сборщиком мусора. Это проще в использовании, чем установка функции обратного вызова на необработанную слабую ссылку, поскольку модуль автоматически гарантирует, что финализатор остаётся живым до тех пор, пока объект не будет собран.2627Большинству программ должно быть достаточно использования одного из этих типов слабых контейнеров или [`finalize`](https://python-all.ru/3.7/library/weakref.html#weakref.finalize) – обычно нет необходимости создавать собственные слабые ссылки напрямую. Низкоуровневые механизмы предоставляются модулем [`weakref`](https://python-all.ru/3.7/library/weakref.html#module-weakref) для продвинутого использования.2829Не все объекты могут использоваться в слабых ссылках; к объектам, которые могут, относятся экземпляры классов, функции, написанные на Python (но не на C), методы экземпляров, множества, замороженные множества, некоторые [файловые объекты](https://python-all.ru/3.7/glossary.html#term-file-object), [генераторы](https://python-all.ru/3.7/glossary.html#term-generator), объекты типов, сокеты, массивы, двусторонние очереди, объекты шаблонов регулярных выражений и объекты кода.3031Изменено в версии 3.2: Добавлена поддержка thread.lock, threading.Lock и объектов кода.3233Некоторые встроенные типы, такие как [`list`](https://python-all.ru/3.7/library/stdtypes.html#list) и [`dict`](https://python-all.ru/3.7/library/stdtypes.html#dict), не поддерживают напрямую слабые ссылки, но могут добавить поддержку через наследование:3435```python36class Dict(dict):37    pass3839obj = Dict(red=1, green=2, blue=3)   # этот объект поддерживает слабые ссылки40```4142**Особенность реализации CPython:** Другие встроенные типы, такие как [`tuple`](https://python-all.ru/3.7/library/stdtypes.html#tuple) и [`int`](https://python-all.ru/3.7/library/functions.html#int), не поддерживают слабые ссылки даже при наследовании.4344Расширяемые типы можно легко научить поддерживать слабые ссылки; см. [Поддержка слабых ссылок](https://python-all.ru/3.7/extending/newtypes.html#weakref-support).4546#### `class weakref.ref(object[, callback])`4748Возвращает слабую ссылку на *object*. Исходный объект можно получить, вызвав объект ссылки, если референт ещё жив; если референт больше не жив, вызов объекта ссылки приведёт к возврату [`None`](https://python-all.ru/3.7/library/constants.html#None). Если *колбэк* указан и не равен [`None`](https://python-all.ru/3.7/library/constants.html#None), и возвращённый объект weakref всё ещё жив, колбэк будет вызван, когда объект будет близок к финализации; объект слабой ссылки будет передан как единственный параметр колбэку; референт больше не будет доступен.4950Допускается создание нескольких слабых ссылок на один и тот же объект. Колбэки, зарегистрированные для каждой слабой ссылки, будут вызываться от самого недавно зарегистрированного колбэка до самого старого.5152Исключения, возбуждаемые колбэком, будут отмечены в стандартном потоке ошибок, но не могут быть распространены; они обрабатываются точно так же, как исключения, возбуждаемые методом [`__del__()`](https://python-all.ru/3.7/reference/datamodel.html#object.__del__) объекта.5354Слабые ссылки являются [хешируемыми](https://python-all.ru/3.7/glossary.html#term-hashable), если *object* хешируем. Они сохраняют своё хеш-значение даже после удаления *object*. Если [`hash()`](https://python-all.ru/3.7/library/functions.html#hash) вызывается впервые только после удаления *object*, вызов возбудит [`TypeError`](https://python-all.ru/3.7/library/exceptions.html#TypeError).5556Слабые ссылки поддерживают проверку на равенство, но не на упорядочивание. Если референты ещё живы, две ссылки имеют то же отношение равенства, что и их референты (независимо от *колбэк*). Если любой из референтов был удалён, ссылки равны только в том случае, если объекты ссылок являются одним и тем же объектом.5758Это тип, который можно наследовать, а не фабричная функция.5960#### `__callback__`6162Этот атрибут только для чтения возвращает колбэк, в данный момент связанный с weakref. Если колбэка нет или референт weakref больше не жив, то этот атрибут будет иметь значение `None`.6364Изменено в версии 3.4: Добавлен атрибут [`__callback__`](https://python-all.ru/3.7/library/weakref.html#weakref.ref.__callback__).6566#### `weakref.proxy(object[, callback])`6768Возвращает прокси для *объекта*, который использует слабую ссылку. Это позволяет использовать прокси в большинстве контекстов без необходимости явного разыменования, как в случае с объектами слабых ссылок. Возвращаемый объект будет иметь тип `ProxyType` или `CallableProxyType` в зависимости от того, является ли *объект* вызываемым. Прокси-объекты не являются [хешируемыми](https://python-all.ru/3.7/glossary.html#term-hashable) независимо от референта; это позволяет избежать ряда проблем, связанных с их принципиально изменчивой природой, и предотвращает их использование в качестве ключей словаря. *колбэк* – это тот же параметр с таким же именем, что и у функции [`ref()`](https://python-all.ru/3.7/library/weakref.html#weakref.ref).6970#### `weakref.getweakrefcount(object)`7172Возвращает количество слабых ссылок и прокси, которые ссылаются на *object*.7374#### `weakref.getweakrefs(object)`7576Возвращает список всех объектов слабых ссылок и прокси, которые ссылаются на *object*.7778#### `class weakref.WeakKeyDictionary([dict])`7980Класс отображения, который хранит слабые ссылки на ключи. Записи словаря будут удалены, когда на ключ больше не останется сильных ссылок. Это можно использовать для связывания дополнительных данных с объектом, принадлежащим другим частям приложения, без добавления атрибутов к этим объектам. Это особенно полезно для объектов, которые переопределяют доступ к атрибутам.8182[`WeakKeyDictionary`](https://python-all.ru/3.7/library/weakref.html#weakref.WeakKeyDictionary) объекты имеют дополнительный метод, который напрямую раскрывает внутренние ссылки. Эти ссылки не гарантированно являются «живыми» на момент использования, поэтому результат вызова ссылок необходимо проверять перед использованием. Это можно использовать, чтобы избежать создания ссылок, которые заставят сборщик мусора удерживать ключи дольше, чем необходимо.8384#### `WeakKeyDictionary.keyrefs()`8586Возвращает итератор по слабым ссылкам на ключи.8788#### `class weakref.WeakValueDictionary([dict])`8990Класс отображения, который хранит слабые ссылки на значения. Записи словаря будут удалены, когда на значение больше не будет сильных ссылок.9192Объекты [`WeakValueDictionary`](https://python-all.ru/3.7/library/weakref.html#weakref.WeakValueDictionary) имеют дополнительный метод, который имеет те же проблемы, что и метод `keyrefs()` объектов [`WeakKeyDictionary`](https://python-all.ru/3.7/library/weakref.html#weakref.WeakKeyDictionary).9394#### `WeakValueDictionary.valuerefs()`9596Возвращает итератор по слабым ссылкам на значения.9798#### `class weakref.WeakSet([elements])`99100Класс множества, который хранит слабые ссылки на свои элементы. Элемент будет удален, когда на него больше не останется сильных ссылок.101102#### `class weakref.WeakMethod(method)`103104Пользовательский подкласс [`ref`](https://python-all.ru/3.7/library/weakref.html#weakref.ref), который имитирует слабую ссылку на привязанный метод (т.е. метод, определенный в классе и полученный через экземпляр). Поскольку привязанный метод является эфемерным, обычная слабая ссылка не может его удержать. [`WeakMethod`](https://python-all.ru/3.7/library/weakref.html#weakref.WeakMethod) содержит специальный код для воссоздания привязанного метода до тех пор, пока не будут удалены объект или исходная функция:105106```python107>>> class C:108...     def method(self):109...         print("method called!")110...111>>> c = C()112>>> r = weakref.ref(c.method)113>>> r()114>>> r = weakref.WeakMethod(c.method)115>>> r()116<bound method C.method of <__main__.C object at 0x7fc859830220>>117>>> r()()118method called!119>>> del c120>>> gc.collect()1210122>>> r()123>>>124```125126Новое в версии 3.4.127128#### `class weakref.finalize(obj, func, *args, **kwargs)`129130Возвращает вызываемый объект финализатора, который будет вызван, когда *obj* будет собран сборщиком мусора. В отличие от обычной слабой ссылки, финализатор всегда будет существовать до тех пор, пока не будет собран сам объект ссылки, что значительно упрощает управление жизненным циклом.131132Финализатор считается *живым*, пока он не вызван (явно или при сборке мусора), после чего он считается *мертвым*. Вызов живого финализатора возвращает результат вычисления `func(*arg, **kwargs)`, а вызов мертвого финализатора возвращает [`None`](https://python-all.ru/3.7/library/constants.html#None).133134Исключения, возбуждаемые колбэками финализатора во время сборки мусора, будут показаны в стандартный поток ошибок, но не могут быть распространены. Они обрабатываются так же, как исключения, возбуждаемые методом [`__del__()`](https://python-all.ru/3.7/reference/datamodel.html#object.__del__) объекта или колбэком слабой ссылки.135136При завершении программы вызывается каждый оставшийся живой финализатор, если только его атрибут [`atexit`](https://python-all.ru/3.7/library/atexit.html#module-atexit) не установлен в false. Они вызываются в порядке, обратном порядку создания.137138Финализатор никогда не вызовет свой колбэк на позднем этапе [завершения интерпретатора](https://python-all.ru/3.7/glossary.html#term-interpreter-shutdown), когда глобальные переменные модуля могут быть заменены на [`None`](https://python-all.ru/3.7/library/constants.html#None).139140#### `__call__()`141142Если *self* жив, то пометить его как мертвый и вернуть результат вызова `func(*args, **kwargs)`. Если *self* мертв, то вернуть [`None`](https://python-all.ru/3.7/library/constants.html#None).143144#### `detach()`145146Если *self* жив, то пометить его как мёртвый и вернуть кортеж `(obj, func, args, kwargs)`. Если *self* мёртв, то вернуть [`None`](https://python-all.ru/3.7/library/constants.html#None).147148#### `peek()`149150Если *self* жив, то вернуть кортеж `(obj, func, args, kwargs)`. Если *self* мёртв, то вернуть [`None`](https://python-all.ru/3.7/library/constants.html#None).151152#### `alive`153154Свойство, которое истинно, если финализатор жив, и ложно в противном случае.155156#### `atexit`157158Записываемое логическое свойство, по умолчанию истинное. При завершении программы вызываются все оставшиеся живые финализаторы, для которых [`atexit`](https://python-all.ru/3.7/library/weakref.html#weakref.finalize.atexit) истинно. Они вызываются в порядке, обратном порядку создания.159160> **Примечание**161>162> Важно убедиться, что *func*, *args* и *kwargs* не содержат ссылок на *obj*, ни прямых, ни косвенных, иначе *obj* никогда не будет собран сборщиком мусора. В частности, *func* не должен быть привязанным методом *obj*.163164Новое в версии 3.4.165166#### `weakref.ReferenceType`167168Объект типа для объектов слабых ссылок.169170#### `weakref.ProxyType`171172Объект типа для прокси-объектов, которые не являются вызываемыми.173174#### `weakref.CallableProxyType`175176Объект типа для прокси вызываемых объектов.177178#### `weakref.ProxyTypes`179180Последовательность, содержащая все объекты типа для прокси. Это упрощает проверку, является ли объект прокси, без необходимости называть оба типа прокси.181182> **См. также**183>184> **[**PEP 205**](https://python-all.ru/3.7/library/weakref.html) – слабые ссылки**185>186> Предложение и обоснование этой возможности, включая ссылки на более ранние реализации и информацию о подобных возможностях в других языках.187188## Объекты слабых ссылок189190Объекты слабых ссылок не имеют методов и атрибутов, кроме [`ref.__callback__`](https://python-all.ru/3.7/library/weakref.html#weakref.ref.__callback__). Объект слабой ссылки позволяет получить объект ссылки (referent), если он ещё существует, путём вызова:191192```python193>>> import weakref194>>> class Object:195...     pass196...197>>> o = Object()198>>> r = weakref.ref(o)199>>> o2 = r()200>>> o is o2201True202```203204Если объект ссылки больше не существует, вызов объекта ссылки возвращает [`None`](https://python-all.ru/3.7/library/constants.html#None):205206```python207>>> del o, o2208>>> print(r())209None210```211212Проверка того, что объект слабой ссылки всё ещё жив, должна выполняться с помощью выражения `ref() is not None`. Обычно код приложения, которому нужно использовать объект ссылки, должен следовать следующему шаблону:213214```python215# r – объект слабой ссылки216o = r()217if o is None:218    # объект был собран сборщиком мусора219    print("Object has been deallocated; can't frobnicate.")220else:221    print("Object is still live!")222    o.do_something_useful()223```224225Использование отдельной проверки «живучести» создаёт состояния гонки в многопоточных приложениях; другой поток может привести к инвалидации слабой ссылки до того, как она будет вызвана; идиома, показанная выше, безопасна как в многопоточных, так и в однопоточных приложениях.226227Специализированные версии объектов [`ref`](https://python-all.ru/3.7/library/weakref.html#weakref.ref) можно создавать через наследование. Это используется в реализации [`WeakValueDictionary`](https://python-all.ru/3.7/library/weakref.html#weakref.WeakValueDictionary) для уменьшения накладных расходов памяти на каждую запись в отображении. Это может быть особенно полезно для связывания дополнительной информации со ссылкой, но также может использоваться для добавления дополнительной обработки при вызовах для получения объекта ссылки.228229Этот пример показывает, как подкласс [`ref`](https://python-all.ru/3.7/library/weakref.html#weakref.ref) можно использовать для хранения дополнительной информации об объекте и влиять на значение, возвращаемое при обращении к объекту ссылки:230231```python232import weakref233234class ExtendedRef(weakref.ref):235    def __init__(self, ob, callback=None, **annotations):236        super(ExtendedRef, self).__init__(ob, callback)237        self.__counter = 0238        for k, v in annotations.items():239            setattr(self, k, v)240241    def __call__(self):242        """Возвращает пару, содержащую объект и количество243        вызовов ссылки.244        """245        ob = super(ExtendedRef, self).__call__()246        if ob is not None:247            self.__counter += 1248            ob = (ob, self.__counter)249        return ob250```251252## Пример253254Этот простой пример показывает, как приложение может использовать идентификаторы объектов для получения объектов, которые оно уже видело. Идентификаторы объектов затем можно использовать в других структурах данных, не заставляя объекты оставаться живыми, но объекты всё ещё можно получить по идентификатору, если они живы.255256```python257import weakref258259_id2obj_dict = weakref.WeakValueDictionary()260261def remember(obj):262    oid = id(obj)263    _id2obj_dict[oid] = obj264    return oid265266def id2obj(oid):267    return _id2obj_dict[oid]268```269270## Объекты финализаторов271272Основное преимущество использования [`finalize`](https://python-all.ru/3.7/library/weakref.html#weakref.finalize) заключается в том, что оно упрощает регистрацию колбэка без необходимости сохранять возвращаемый объект финализатора. Например273274```python275>>> import weakref276>>> class Object:277...     pass278...279>>> kenny = Object()280>>> weakref.finalize(kenny, print, "You killed Kenny!")  281<finalize object at ...; for 'Object' at ...>282>>> del kenny283You killed Kenny!284```285286Финализатор также можно вызывать напрямую. Однако финализатор вызовет колбэк не более одного раза.287288```python289>>> def callback(x, y, z):290...     print("CALLBACK")291...     return x + y + z292...293>>> obj = Object()294>>> f = weakref.finalize(obj, callback, 1, 2, z=3)295>>> assert f.alive296>>> assert f() == 6297CALLBACK298>>> assert not f.alive299>>> f()                     # колбэк не вызван, так как финализатор неактивен300>>> del obj                 # колбэк не вызван, так как финализатор неактивен301```302303Можно отменить регистрацию финализатора с помощью его метода [`detach()`](https://python-all.ru/3.7/library/weakref.html#weakref.finalize.detach). Это уничтожает финализатор и возвращает аргументы, переданные конструктору при его создании.304305```python306>>> obj = Object()307>>> f = weakref.finalize(obj, callback, 1, 2, z=3)308>>> f.detach()                                           309(<...Object object ...>, <function callback ...>, (1, 2), {'z': 3})310>>> newobj, func, args, kwargs = _311>>> assert not f.alive312>>> assert newobj is obj313>>> assert func(*args, **kwargs) == 6314CALLBACK315```316317Если не установить атрибут [`atexit`](https://python-all.ru/3.7/library/weakref.html#weakref.finalize.atexit) в значение [`False`](https://python-all.ru/3.7/library/constants.html#False), финализатор будет вызван при завершении программы, если он всё ещё жив. Например318319```pycon320>>> obj = Object()321>>> weakref.finalize(obj, print, "obj dead or exiting")322<finalize object at ...; for 'Object' at ...>323>>> exit()324obj dead or exiting325```326327## Сравнение финализаторов с методами [`__del__()`](https://python-all.ru/3.7/reference/datamodel.html#object.__del__)328329Предположим, мы хотим создать класс, экземпляры которого представляют временные каталоги. Каталоги должны удаляться вместе с их содержимым при наступлении первого из следующих событий:330331- объект удаляется сборщиком мусора,332- вызывается метод `remove()` объекта, или333- программа завершается.334335Можно попробовать реализовать класс с помощью метода [`__del__()`](https://python-all.ru/3.7/reference/datamodel.html#object.__del__) следующим образом:336337```python338class TempDir:339    def __init__(self):340        self.name = tempfile.mkdtemp()341342    def remove(self):343        if self.name is not None:344            shutil.rmtree(self.name)345            self.name = None346347    @property348    def removed(self):349        return self.name is None350351    def __del__(self):352        self.remove()353```354355Начиная с Python 3.4, методы [`__del__()`](https://python-all.ru/3.7/reference/datamodel.html#object.__del__) больше не препятствуют сборке мусора циклических ссылок, и глобальные переменные модуля больше не принуждаются к [`None`](https://python-all.ru/3.7/library/constants.html#None) во время [завершения интерпретатора](https://python-all.ru/3.7/glossary.html#term-interpreter-shutdown). Поэтому этот код должен без проблем работать в CPython.356357Однако обработка методов [`__del__()`](https://python-all.ru/3.7/reference/datamodel.html#object.__del__), как известно, зависит от реализации, поскольку она опирается на внутренние детали реализации сборщика мусора интерпретатора.358359Более надёжная альтернатива – определить финализатор, который ссылается только на нужные ему функции и объекты, а не имеет доступ ко всему состоянию объекта:360361```python362class TempDir:363    def __init__(self):364        self.name = tempfile.mkdtemp()365        self._finalizer = weakref.finalize(self, shutil.rmtree, self.name)366367    def remove(self):368        self._finalizer()369370    @property371    def removed(self):372        return not self._finalizer.alive373```374375Определённый таким образом, наш финализатор получает только ссылку на те детали, которые нужны для корректной очистки каталога. Если объект никогда не будет удалён сборщиком мусора, финализатор всё равно будет вызван при завершении программы.376377Ещё одно преимущество финализаторов на основе weakref в том, что их можно использовать для регистрации финализаторов у классов, определение которых контролируется сторонними разработчиками, например, для выполнения кода при выгрузке модуля:378379```python380import weakref, sys381def unloading_module():382    # неявная ссылка на глобальные переменные модуля из тела функции383weakref.finalize(sys.modules[__name__], unloading_module)384```385386> **Примечание**387>388> Если создать объект финализатора в фоновом потоке в момент завершения программы, то есть вероятность, что финализатор не будет вызван при выходе. Однако в фоновом потоке [`atexit.register()`](https://python-all.ru/3.7/library/atexit.html#atexit.register), `try: ... finally: ...` и `with: ...` также не гарантируют очистку.389