Skip to content

Support unhashable callbacks in CallbackRegistry #26013

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
ksunden merged 3 commits into from
Sep 19, 2024
Merged

Support unhashable callbacks in CallbackRegistry #26013

Show file tree
Hide file tree
Changes from 1 commit
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
b629ff8
Record the connected signal in CallbackRegistry weakref cleanup funct…
anntzer May 31, 2023
920a6d2
Flatten CallbackRegistry._func_cid_map.
anntzer May 31, 2023
87f194f
Support unhashable callbacks in CallbackRegistry.
anntzer May 31, 2023
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
Prev Previous commit
Next Next commit
Flatten CallbackRegistry._func_cid_map. 
It is easier to manipulate a flat (signal, proxy) -> cid map rather than
a nested signal -> (proxy -> cid) map.
  • Loading branch information
@anntzer
anntzer committed Jul 13, 2023
commit 920a6d26a9d7497bc190a416c79c86755cdffe94
44 changes: 17 additions & 27 deletions lib/matplotlib/cbook.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -171,7 +171,7 @@ class CallbackRegistry:

# We maintain two mappings:
# callbacks: signal -> {cid -> weakref-to-callback}
# _func_cid_map: signal -> {weakref-to-callback -> cid}
# _func_cid_map: {(signal, weakref-to-callback) -> cid}

def __init__(self, exception_handler=_exception_printer, *, signals=None):
self._signals = None if signals is None else list(signals) # Copy it.
Expand Down Expand Up @@ -203,23 +203,21 @@ def __setstate__(self, state):
for cid, func in d.items()}
for s, d in self.callbacks.items()}
self._func_cid_map = {
s: {proxy: cid for cid, proxy in d.items()}
for s, d in self.callbacks.items()}
(s, proxy): cid
for s, d in self.callbacks.items() for cid, proxy in d.items()}
self._cid_gen = itertools.count(cid_count)

def connect(self, signal, func):
"""Register *func* to be called when signal *signal* is generated."""
if self._signals is not None:
_api.check_in_list(self._signals, signal=signal)
self._func_cid_map.setdefault(signal, {})
proxy = _weak_or_strong_ref(func, functools.partial(self._remove_proxy, signal))
if proxy in self._func_cid_map[signal]:
return self._func_cid_map[signal][proxy]
cid = next(self._cid_gen)
self._func_cid_map[signal][proxy] = cid
self.callbacks.setdefault(signal, {})
self.callbacks[signal][cid] = proxy
return cid
try:
return self._func_cid_map[signal, proxy]
except KeyError:
cid = self._func_cid_map[signal, proxy] = next(self._cid_gen)
self.callbacks.setdefault(signal, {})[cid] = proxy
return cid

def _connect_picklable(self, signal, func):
"""
Expand All @@ -237,16 +235,14 @@ def _remove_proxy(self, signal, proxy, *, _is_finalizing=sys.is_finalizing):
if _is_finalizing():
# Weakrefs can't be properly torn down at that point anymore.
return
cid = self._func_cid_map[signal].pop(proxy, None)
cid = self._func_cid_map.pop((signal, proxy), None)
if cid is not None:
del self.callbacks[signal][cid]
self._pickled_cids.discard(cid)
else: # Not found
return
# Clean up empty dicts
if len(self.callbacks[signal]) == 0:
if len(self.callbacks[signal]) == 0: # Clean up empty dicts
del self.callbacks[signal]
del self._func_cid_map[signal]

def disconnect(self, cid):
"""
Expand All @@ -255,22 +251,16 @@ def disconnect(self, cid):
No error is raised if such a callback does not exist.
"""
self._pickled_cids.discard(cid)
# Clean up callbacks
for signal, cid_to_proxy in list(self.callbacks.items()):
proxy = cid_to_proxy.pop(cid, None)
if proxy is not None:
for signal, proxy in self._func_cid_map:
if self._func_cid_map[signal, proxy] == cid:
break
else: # Not found
return
proxy_to_cid = self._func_cid_map[signal]
for current_proxy, current_cid in list(proxy_to_cid.items()):
if current_cid == cid:
assert proxy is current_proxy
del proxy_to_cid[current_proxy]
# Clean up empty dicts
if len(self.callbacks[signal]) == 0:
assert self.callbacks[signal][cid] == proxy
del self.callbacks[signal][cid]
del self._func_cid_map[signal, proxy]
if len(self.callbacks[signal]) == 0: # Clean up empty dicts
del self.callbacks[signal]
del self._func_cid_map[signal]

def process(self, s, *args, **kwargs):
"""
Expand Down
2 changes: 1 addition & 1 deletion lib/matplotlib/tests/test_cbook.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -193,7 +193,7 @@ def disconnect(self, cid):
return self.callbacks.disconnect(cid)

def count(self):
count1 = len(self.callbacks._func_cid_map.get(self.signal, []))
count1 = sum(s == self.signal for s, p in self.callbacks._func_cid_map)
count2 = len(self.callbacks.callbacks.get(self.signal))
assert count1 == count2
return count1
Expand Down