weakref.md
1> **Источник:** https://python-all.ru/3.10/library/weakref.html2>3> «Документация Python на русском» – неофициальный перевод официальной документации Python: версии от 2.6 до 3.16, полнотекстовый поиск, английский оригинал рядом с переводом. Эта Markdown-версия страницы предназначена для работы с LLM: вставьте её в ChatGPT, Claude или Cursor.45---67# [`weakref`](https://python-all.ru/3.10/library/weakref.html#module-weakref) – Слабые ссылки89**Исходный код:** [Lib/weakref.py](https://python-all.ru/src/3.10/Lib/weakref.py)1011---1213Модуль [`weakref`](https://python-all.ru/3.10/library/weakref.html#module-weakref) позволяет программисту Python создавать *слабые ссылки* на объекты.1415В дальнейшем под термином *referent* понимается объект, на который указывает слабая ссылка.1617Слабой ссылки на объект недостаточно, чтобы сохранить объект живым: когда единственные оставшиеся ссылки на референт являются слабыми ссылками, [сборщик мусора](https://python-all.ru/3.10/glossary.html#term-garbage-collection) может уничтожить референт и использовать его память для других целей. Однако, пока объект фактически не уничтожен, слабая ссылка может вернуть объект, даже если на него нет сильных ссылок.1819Основное применение слабых ссылок – реализация кэшей или отображений, содержащих большие объекты, когда требуется, чтобы большой объект не оставался в живых только потому, что он присутствует в кэше или отображении.2021Например, если у вас есть несколько больших бинарных объектов-изображений, вы можете захотеть связать имя с каждым. Если вы используете словарь Python для отображения имён на изображения или изображений на имена, объекты-изображения будут оставаться живыми только потому, что они присутствуют как значения или ключи в словарях. Классы [`WeakKeyDictionary`](https://python-all.ru/3.10/library/weakref.html#weakref.WeakKeyDictionary) и [`WeakValueDictionary`](https://python-all.ru/3.10/library/weakref.html#weakref.WeakValueDictionary), предоставляемые модулем [`weakref`](https://python-all.ru/3.10/library/weakref.html#module-weakref), являются альтернативой: они используют слабые ссылки для построения отображений, которые не сохраняют объекты живыми только из-за их присутствия в объектах-отображениях. Если, например, объект-изображение является значением в [`WeakValueDictionary`](https://python-all.ru/3.10/library/weakref.html#weakref.WeakValueDictionary), то, когда последние оставшиеся ссылки на этот объект-изображение являются слабыми ссылками, хранящимися в слабых отображениях, сборщик мусора может переработать объект, и соответствующие записи в слабых отображениях просто удаляются.2223[`WeakKeyDictionary`](https://python-all.ru/3.10/library/weakref.html#weakref.WeakKeyDictionary) и [`WeakValueDictionary`](https://python-all.ru/3.10/library/weakref.html#weakref.WeakValueDictionary) используют слабые ссылки в своей реализации, устанавливая функции обратного вызова на слабые ссылки, которые уведомляют слабые словари, когда ключ или значение были переработаны сборщиком мусора. [`WeakSet`](https://python-all.ru/3.10/library/weakref.html#weakref.WeakSet) реализует интерфейс [`set`](https://python-all.ru/3.10/library/stdtypes.html#set), но хранит слабые ссылки на свои элементы, подобно тому, как это делает [`WeakKeyDictionary`](https://python-all.ru/3.10/library/weakref.html#weakref.WeakKeyDictionary).2425[`finalize`](https://python-all.ru/3.10/library/weakref.html#weakref.finalize) предоставляет простой способ зарегистрировать функцию очистки, которая будет вызвана, когда объект будет собран сборщиком мусора. Это проще в использовании, чем установка функции обратного вызова на необработанную слабую ссылку, поскольку модуль автоматически гарантирует, что финализатор остаётся живым до тех пор, пока объект не будет собран.2627Большинству программ должно быть достаточно использования одного из этих типов слабых контейнеров или [`finalize`](https://python-all.ru/3.10/library/weakref.html#weakref.finalize) – обычно нет необходимости создавать собственные слабые ссылки напрямую. Низкоуровневые механизмы предоставляются модулем [`weakref`](https://python-all.ru/3.10/library/weakref.html#module-weakref) для продвинутого использования.2829Не все объекты могут использоваться в слабых ссылках; к объектам, которые могут, относятся экземпляры классов, функции, написанные на Python (но не на C), методы экземпляров, множества, замороженные множества, некоторые [файловые объекты](https://python-all.ru/3.10/glossary.html#term-file-object), [генераторы](https://python-all.ru/3.10/glossary.html#term-generator), объекты типов, сокеты, массивы, двусторонние очереди, объекты шаблонов регулярных выражений и объекты кода.3031Изменено в версии 3.2: Добавлена поддержка thread.lock, threading.Lock и объектов кода.3233Некоторые встроенные типы, такие как [`list`](https://python-all.ru/3.10/library/stdtypes.html#list) и [`dict`](https://python-all.ru/3.10/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.10/library/stdtypes.html#tuple) и [`int`](https://python-all.ru/3.10/library/functions.html#int), не поддерживают слабые ссылки даже при наследовании.4344Расширяемые типы можно легко научить поддерживать слабые ссылки; см. [Поддержка слабых ссылок](https://python-all.ru/3.10/extending/newtypes.html#weakref-support).4546Когда для данного типа определены `__slots__`, поддержка слабых ссылок отключается, если в последовательности строк в объявлении `__slots__` также не присутствует строка `'__weakref__'`. Подробнее см. [документацию \_\_slots\_\_](https://python-all.ru/3.10/reference/datamodel.html#slots).4748#### `class weakref.ref(object[, callback])`4950Возвращает слабую ссылку на *object*. Исходный объект можно получить, вызвав объект ссылки, если референт ещё жив; если референт больше не жив, вызов объекта ссылки приведёт к возврату [`None`](https://python-all.ru/3.10/library/constants.html#None). Если *колбэк* указан и не равен [`None`](https://python-all.ru/3.10/library/constants.html#None), и возвращённый объект weakref всё ещё жив, колбэк будет вызван, когда объект будет близок к финализации; объект слабой ссылки будет передан как единственный параметр колбэку; референт больше не будет доступен.5152Допускается создание нескольких слабых ссылок на один и тот же объект. Колбэки, зарегистрированные для каждой слабой ссылки, будут вызываться от самого недавно зарегистрированного колбэка до самого старого.5354Исключения, возбуждаемые колбэком, будут отмечены в стандартном потоке ошибок, но не могут быть распространены; они обрабатываются точно так же, как исключения, возбуждаемые методом `__del__()` объекта.5556Слабые ссылки являются [хешируемыми](https://python-all.ru/3.10/glossary.html#term-hashable), если *object* хешируем. Они сохраняют своё хеш-значение даже после удаления *object*. Если [`hash()`](https://python-all.ru/3.10/library/functions.html#hash) вызывается впервые только после удаления *object*, вызов возбудит [`TypeError`](https://python-all.ru/3.10/library/exceptions.html#TypeError).5758Слабые ссылки поддерживают проверку на равенство, но не на упорядочивание. Если референты ещё живы, две ссылки имеют то же отношение равенства, что и их референты (независимо от *колбэк*). Если любой из референтов был удалён, ссылки равны только в том случае, если объекты ссылок являются одним и тем же объектом.5960Это тип, который можно наследовать, а не фабричная функция.6162#### `__callback__`6364Этот атрибут только для чтения возвращает колбэк, в данный момент связанный с weakref. Если колбэка нет или референт weakref больше не жив, то этот атрибут будет иметь значение `None`.6566Изменено в версии 3.4: Добавлен атрибут [`__callback__`](https://python-all.ru/3.10/library/weakref.html#weakref.ref.__callback__).6768#### `weakref.proxy(object[, callback])`6970Возвращает прокси для *объекта*, который использует слабую ссылку. Это позволяет использовать прокси в большинстве контекстов без необходимости явного разыменования, как в случае с объектами слабых ссылок. Возвращаемый объект будет иметь тип `ProxyType` или `CallableProxyType` в зависимости от того, является ли *объект* вызываемым. Прокси-объекты не являются [хешируемыми](https://python-all.ru/3.10/glossary.html#term-hashable) независимо от референта; это позволяет избежать ряда проблем, связанных с их принципиально изменчивой природой, и предотвращает их использование в качестве ключей словаря. *колбэк* – это тот же параметр с таким же именем, что и у функции [`ref()`](https://python-all.ru/3.10/library/weakref.html#weakref.ref).7172Доступ к атрибуту прокси-объекта после того, как референт был собран сборщиком мусора, возбуждает [`ReferenceError`](https://python-all.ru/3.10/library/exceptions.html#ReferenceError).7374Изменено в версии 3.8: Расширена поддержка операторов для прокси-объектов, включены операторы матричного умножения `@` и `@=`.7576#### `weakref.getweakrefcount(object)`7778Возвращает количество слабых ссылок и прокси, которые ссылаются на *object*.7980#### `weakref.getweakrefs(object)`8182Возвращает список всех объектов слабых ссылок и прокси, которые ссылаются на *object*.8384#### `class weakref.WeakKeyDictionary([dict])`8586Класс отображения, который хранит слабые ссылки на ключи. Записи словаря будут удалены, когда на ключ больше не останется сильных ссылок. Это можно использовать для связывания дополнительных данных с объектом, принадлежащим другим частям приложения, без добавления атрибутов к этим объектам. Это особенно полезно для объектов, которые переопределяют доступ к атрибутам.8788Обратите внимание, что когда в словарь вставляется ключ, равный по значению существующему ключу (но не совпадающий по идентичности), он заменяет значение, но не заменяет существующий ключ. Из-за этого, когда удаляется ссылка на исходный ключ, также удаляется и запись в словаре:8990```python91>>> class T(str): pass92...93>>> k1, k2 = T(), T()94>>> d = weakref.WeakKeyDictionary()95>>> d[k1] = 1 # d = {k1: 1}96>>> d[k2] = 2 # d = {k1: 2}97>>> del k1 # d = {}98```99100Обходной путь – удалить ключ перед переназначением:101102```python103>>> class T(str): pass104...105>>> k1, k2 = T(), T()106>>> d = weakref.WeakKeyDictionary()107>>> d[k1] = 1 # d = {k1: 1}108>>> del d[k1]109>>> d[k2] = 2 # d = {k2: 2}110>>> del k1 # d = {k2: 2}111```112113Changed in version 3.9: Added support for `|` and `|=` operators, specified in [**PEP 584**](https://python-all.ru/3.10/library/weakref.html).114115[`WeakKeyDictionary`](https://python-all.ru/3.10/library/weakref.html#weakref.WeakKeyDictionary) объекты имеют дополнительный метод, который напрямую раскрывает внутренние ссылки. Эти ссылки не гарантированно являются «живыми» на момент использования, поэтому результат вызова ссылок необходимо проверять перед использованием. Это можно использовать, чтобы избежать создания ссылок, которые заставят сборщик мусора удерживать ключи дольше, чем необходимо.116117#### `WeakKeyDictionary.keyrefs()`118119Возвращает итератор по слабым ссылкам на ключи.120121#### `class weakref.WeakValueDictionary([dict])`122123Класс отображения, который хранит слабые ссылки на значения. Записи словаря будут удалены, когда на значение больше не будет сильных ссылок.124125Изменено в версии 3.9: Добавлена поддержка операторов `|` и `|=`, как указано в [**PEP 584**](https://python-all.ru/3.10/library/weakref.html).126127Объекты [`WeakValueDictionary`](https://python-all.ru/3.10/library/weakref.html#weakref.WeakValueDictionary) имеют дополнительный метод, который имеет те же проблемы, что и метод `keyrefs()` объектов [`WeakKeyDictionary`](https://python-all.ru/3.10/library/weakref.html#weakref.WeakKeyDictionary).128129#### `WeakValueDictionary.valuerefs()`130131Возвращает итератор по слабым ссылкам на значения.132133#### `class weakref.WeakSet([elements])`134135Класс множества, который хранит слабые ссылки на свои элементы. Элемент будет удален, когда на него больше не останется сильных ссылок.136137#### `class weakref.WeakMethod(method)`138139Пользовательский подкласс [`ref`](https://python-all.ru/3.10/library/weakref.html#weakref.ref), который имитирует слабую ссылку на привязанный метод (т.е. метод, определенный в классе и полученный через экземпляр). Поскольку привязанный метод является эфемерным, обычная слабая ссылка не может его удержать. [`WeakMethod`](https://python-all.ru/3.10/library/weakref.html#weakref.WeakMethod) содержит специальный код для воссоздания привязанного метода до тех пор, пока не будут удалены объект или исходная функция:140141```python142>>> class C:143... def method(self):144... print("method called!")145...146>>> c = C()147>>> r = weakref.ref(c.method)148>>> r()149>>> r = weakref.WeakMethod(c.method)150>>> r()151<bound method C.method of <__main__.C object at 0x7fc859830220>>152>>> r()()153method called!154>>> del c155>>> gc.collect()1560157>>> r()158>>>159```160161Новое в версии 3.4.162163#### `class weakref.finalize(obj, func, /, *args, **kwargs)`164165Возвращает вызываемый объект финализатора, который будет вызван, когда *obj* будет собран сборщиком мусора. В отличие от обычной слабой ссылки, финализатор всегда будет существовать до тех пор, пока не будет собран сам объект ссылки, что значительно упрощает управление жизненным циклом.166167Финализатор считается *живым*, пока он не вызван (явно или при сборке мусора), после чего он считается *мертвым*. Вызов живого финализатора возвращает результат вычисления `func(*arg, **kwargs)`, а вызов мертвого финализатора возвращает [`None`](https://python-all.ru/3.10/library/constants.html#None).168169Исключения, возбуждаемые колбэками финализатора во время сборки мусора, будут показаны в стандартный поток ошибок, но не могут быть распространены. Они обрабатываются так же, как исключения, возбуждаемые методом `__del__()` объекта или колбэком слабой ссылки.170171При завершении программы вызывается каждый оставшийся живой финализатор, если только его атрибут [`atexit`](https://python-all.ru/3.10/library/atexit.html#module-atexit) не установлен в false. Они вызываются в порядке, обратном порядку создания.172173Финализатор никогда не вызовет свой колбэк на позднем этапе [завершения интерпретатора](https://python-all.ru/3.10/glossary.html#term-interpreter-shutdown), когда глобальные переменные модуля могут быть заменены на [`None`](https://python-all.ru/3.10/library/constants.html#None).174175#### `__call__()`176177Если *self* жив, то пометить его как мертвый и вернуть результат вызова `func(*args, **kwargs)`. Если *self* мертв, то вернуть [`None`](https://python-all.ru/3.10/library/constants.html#None).178179#### `detach()`180181Если *self* жив, то пометить его как мёртвый и вернуть кортеж `(obj, func, args, kwargs)`. Если *self* мёртв, то вернуть [`None`](https://python-all.ru/3.10/library/constants.html#None).182183#### `peek()`184185Если *self* жив, то вернуть кортеж `(obj, func, args, kwargs)`. Если *self* мёртв, то вернуть [`None`](https://python-all.ru/3.10/library/constants.html#None).186187#### `alive`188189Свойство, которое истинно, если финализатор жив, и ложно в противном случае.190191#### `atexit`192193Записываемое логическое свойство, по умолчанию истинное. При завершении программы вызываются все оставшиеся живые финализаторы, для которых [`atexit`](https://python-all.ru/3.10/library/weakref.html#weakref.finalize.atexit) истинно. Они вызываются в порядке, обратном порядку создания.194195> **Примечание**196>197> Важно убедиться, что *func*, *args* и *kwargs* не содержат ссылок на *obj*, ни прямых, ни косвенных, иначе *obj* никогда не будет собран сборщиком мусора. В частности, *func* не должен быть привязанным методом *obj*.198199Новое в версии 3.4.200201#### `weakref.ReferenceType`202203Объект типа для объектов слабых ссылок.204205#### `weakref.ProxyType`206207Объект типа для прокси-объектов, которые не являются вызываемыми.208209#### `weakref.CallableProxyType`210211Объект типа для прокси вызываемых объектов.212213#### `weakref.ProxyTypes`214215Последовательность, содержащая все объекты типа для прокси. Это упрощает проверку, является ли объект прокси, без необходимости называть оба типа прокси.216217> **См. также**218>219> **[**PEP 205**](https://python-all.ru/3.10/library/weakref.html) – слабые ссылки**220>221> Предложение и обоснование этой возможности, включая ссылки на более ранние реализации и информацию о подобных возможностях в других языках.222223## Объекты слабых ссылок224225Объекты слабых ссылок не имеют методов и атрибутов, кроме [`ref.__callback__`](https://python-all.ru/3.10/library/weakref.html#weakref.ref.__callback__). Объект слабой ссылки позволяет получить объект ссылки (referent), если он ещё существует, путём вызова:226227```python228>>> import weakref229>>> class Object:230... pass231...232>>> o = Object()233>>> r = weakref.ref(o)234>>> o2 = r()235>>> o is o2236True237```238239Если объект ссылки больше не существует, вызов объекта ссылки возвращает [`None`](https://python-all.ru/3.10/library/constants.html#None):240241```python242>>> del o, o2243>>> print(r())244None245```246247Проверка того, что объект слабой ссылки всё ещё жив, должна выполняться с помощью выражения `ref() is not None`. Обычно код приложения, которому нужно использовать объект ссылки, должен следовать следующему шаблону:248249```python250# r – объект слабой ссылки251o = r()252if o is None:253 # объект был собран сборщиком мусора254 print("Object has been deallocated; can't frobnicate.")255else:256 print("Object is still live!")257 o.do_something_useful()258```259260Использование отдельной проверки «живучести» создаёт состояния гонки в многопоточных приложениях; другой поток может привести к инвалидации слабой ссылки до того, как она будет вызвана; идиома, показанная выше, безопасна как в многопоточных, так и в однопоточных приложениях.261262Специализированные версии объектов [`ref`](https://python-all.ru/3.10/library/weakref.html#weakref.ref) можно создавать через наследование. Это используется в реализации [`WeakValueDictionary`](https://python-all.ru/3.10/library/weakref.html#weakref.WeakValueDictionary) для уменьшения накладных расходов памяти на каждую запись в отображении. Это может быть особенно полезно для связывания дополнительной информации со ссылкой, но также может использоваться для добавления дополнительной обработки при вызовах для получения объекта ссылки.263264Этот пример показывает, как подкласс [`ref`](https://python-all.ru/3.10/library/weakref.html#weakref.ref) можно использовать для хранения дополнительной информации об объекте и влиять на значение, возвращаемое при обращении к объекту ссылки:265266```python267import weakref268269class ExtendedRef(weakref.ref):270 def __init__(self, ob, callback=None, /, **annotations):271 super().__init__(ob, callback)272 self.__counter = 0273 for k, v in annotations.items():274 setattr(self, k, v)275276 def __call__(self):277 """Возвращает пару, содержащую объект и количество278 вызовов ссылки.279 """280 ob = super().__call__()281 if ob is not None:282 self.__counter += 1283 ob = (ob, self.__counter)284 return ob285```286287## Пример288289Этот простой пример показывает, как приложение может использовать идентификаторы объектов для получения объектов, которые оно уже видело. Идентификаторы объектов затем можно использовать в других структурах данных, не заставляя объекты оставаться живыми, но объекты всё ещё можно получить по идентификатору, если они живы.290291```python292import weakref293294_id2obj_dict = weakref.WeakValueDictionary()295296def remember(obj):297 oid = id(obj)298 _id2obj_dict[oid] = obj299 return oid300301def id2obj(oid):302 return _id2obj_dict[oid]303```304305## Объекты финализаторов306307Основное преимущество использования [`finalize`](https://python-all.ru/3.10/library/weakref.html#weakref.finalize) заключается в том, что оно упрощает регистрацию колбэка без необходимости сохранять возвращаемый объект финализатора. Например308309```python310>>> import weakref311>>> class Object:312... pass313...314>>> kenny = Object()315>>> weakref.finalize(kenny, print, "You killed Kenny!") 316<finalize object at ...; for 'Object' at ...>317>>> del kenny318You killed Kenny!319```320321Финализатор также можно вызывать напрямую. Однако финализатор вызовет колбэк не более одного раза.322323```python324>>> def callback(x, y, z):325... print("CALLBACK")326... return x + y + z327...328>>> obj = Object()329>>> f = weakref.finalize(obj, callback, 1, 2, z=3)330>>> assert f.alive331>>> assert f() == 6332CALLBACK333>>> assert not f.alive334>>> f() # колбэк не вызван, так как финализатор неактивен335>>> del obj # колбэк не вызван, так как финализатор неактивен336```337338Можно отменить регистрацию финализатора с помощью его метода [`detach()`](https://python-all.ru/3.10/library/weakref.html#weakref.finalize.detach). Это уничтожает финализатор и возвращает аргументы, переданные конструктору при его создании.339340```python341>>> obj = Object()342>>> f = weakref.finalize(obj, callback, 1, 2, z=3)343>>> f.detach() 344(<...Object object ...>, <function callback ...>, (1, 2), {'z': 3})345>>> newobj, func, args, kwargs = _346>>> assert not f.alive347>>> assert newobj is obj348>>> assert func(*args, **kwargs) == 6349CALLBACK350```351352Если не установить атрибут [`atexit`](https://python-all.ru/3.10/library/weakref.html#weakref.finalize.atexit) в значение [`False`](https://python-all.ru/3.10/library/constants.html#False), финализатор будет вызван при завершении программы, если он всё ещё жив. Например353354```pycon355>>> obj = Object()356>>> weakref.finalize(obj, print, "obj dead or exiting")357<finalize object at ...; for 'Object' at ...>358>>> exit()359obj dead or exiting360```361362## Сравнение финализаторов с методами `__del__()`363364Предположим, мы хотим создать класс, экземпляры которого представляют временные каталоги. Каталоги должны удаляться вместе с их содержимым при наступлении первого из следующих событий:365366- объект удаляется сборщиком мусора,367- вызывается метод `remove()` объекта, или368- программа завершается.369370Можно попробовать реализовать класс с помощью метода `__del__()` следующим образом:371372```python373class TempDir:374 def __init__(self):375 self.name = tempfile.mkdtemp()376377 def remove(self):378 if self.name is not None:379 shutil.rmtree(self.name)380 self.name = None381382 @property383 def removed(self):384 return self.name is None385386 def __del__(self):387 self.remove()388```389390Начиная с Python 3.4, методы `__del__()` больше не препятствуют сборке мусора циклических ссылок, и глобальные переменные модуля больше не принуждаются к [`None`](https://python-all.ru/3.10/library/constants.html#None) во время [завершения интерпретатора](https://python-all.ru/3.10/glossary.html#term-interpreter-shutdown). Поэтому этот код должен без проблем работать в CPython.391392Однако обработка методов `__del__()`, как известно, зависит от реализации, поскольку она опирается на внутренние детали реализации сборщика мусора интерпретатора.393394Более надёжная альтернатива – определить финализатор, который ссылается только на нужные ему функции и объекты, а не имеет доступ ко всему состоянию объекта:395396```python397class TempDir:398 def __init__(self):399 self.name = tempfile.mkdtemp()400 self._finalizer = weakref.finalize(self, shutil.rmtree, self.name)401402 def remove(self):403 self._finalizer()404405 @property406 def removed(self):407 return not self._finalizer.alive408```409410Определённый таким образом, наш финализатор получает только ссылку на те детали, которые нужны для корректной очистки каталога. Если объект никогда не будет удалён сборщиком мусора, финализатор всё равно будет вызван при завершении программы.411412Ещё одно преимущество финализаторов на основе weakref в том, что их можно использовать для регистрации финализаторов у классов, определение которых контролируется сторонними разработчиками, например, для выполнения кода при выгрузке модуля:413414```python415import weakref, sys416def unloading_module():417 # неявная ссылка на глобальные переменные модуля из тела функции418weakref.finalize(sys.modules[__name__], unloading_module)419```420421> **Примечание**422>423> Если создать объект финализатора в фоновом потоке в момент завершения программы, то есть вероятность, что финализатор не будет вызван при выходе. Однако в фоновом потоке [`atexit.register()`](https://python-all.ru/3.10/library/atexit.html#atexit.register), `try: ... finally: ...` и `with: ...` также не гарантируют очистку.424