Skip to content

Remove the weak ref for tracking update listeners #95798

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
bdraco merged 1 commit into from
Jul 3, 2023
Merged

Remove the weak ref for tracking update listeners #95798

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
30 changes: 9 additions & 21 deletions homeassistant/config_entries.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -10,9 +10,8 @@
import functools
import logging
from random import randint
from types import MappingProxyType, MethodType
from types import MappingProxyType
from typing import TYPE_CHECKING, Any, TypeVar, cast
import weakref

from typing_extensions import Self

Expand Down Expand Up @@ -303,9 +302,7 @@ def __init__(
self.supports_remove_device: bool | None = None

# Listeners to call on update
self.update_listeners: list[
weakref.ReferenceType[UpdateListenerType] | weakref.WeakMethod
] = []
self.update_listeners: list[UpdateListenerType] = []

# Reason why config entry is in a failed state
self.reason: str | None = None
Expand Down Expand Up @@ -653,16 +650,8 @@ def add_update_listener(self, listener: UpdateListenerType) -> CALLBACK_TYPE:

Returns function to unlisten.
"""
weak_listener: Any
# weakref.ref is not applicable to a bound method, e.g.,
# method of a class instance, as reference will die immediately.
if hasattr(listener, "__self__"):
weak_listener = weakref.WeakMethod(cast(MethodType, listener))
else:
weak_listener = weakref.ref(listener)
self.update_listeners.append(weak_listener)

return lambda: self.update_listeners.remove(weak_listener)
self.update_listeners.append(listener)
return lambda: self.update_listeners.remove(listener)

def as_dict(self) -> dict[str, Any]:
"""Return dictionary version of this entry."""
Expand Down Expand Up @@ -1348,12 +1337,11 @@ def async_update_entry(
if not changed:
return False

for listener_ref in entry.update_listeners:
if (listener := listener_ref()) is not None:
self.hass.async_create_task(
listener(self.hass, entry),
f"config entry update listener {entry.title} {entry.domain} {entry.domain}",
)
for listener in entry.update_listeners:
self.hass.async_create_task(
listener(self.hass, entry),
f"config entry update listener {entry.title} {entry.domain} {entry.domain}",
)

self._async_schedule_save()
self._async_dispatch(ConfigEntryChange.UPDATED, entry)
Expand Down