-
Notifications
You must be signed in to change notification settings - Fork 10.5k
ui: add SingleCallback for safe, flexible single-callback management in UI components #36788
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.
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
Closed
+96
−21
Closed
Changes from all commits
Commits
Show all changes
3 commits
Select commit
Hold shift + click to select a range
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,68 @@ | ||
| import weakref | ||
| from collections.abc import Callable | ||
| from typing import Any | ||
|
|
||
|
|
||
| class CallbackManager: | ||
| def __init__(self): | ||
| self._callbacks: weakref.WeakSet[weakref.WeakMethod] = weakref.WeakSet() | ||
|
|
||
| def add(self, callback_method: Callable[..., Any]) -> None: | ||
| weak_cb = weakref.WeakMethod(callback_method) | ||
| self._callbacks.add(weak_cb) | ||
|
|
||
| def remove(self, callback_method: Callable[..., Any]) -> None: | ||
| weak_cb = weakref.WeakMethod(callback_method) | ||
| self._callbacks.discard(weak_cb) | ||
|
|
||
| def clear(self) -> None: | ||
| self._callbacks.clear() | ||
|
|
||
| def __call__(self, *args, **kwargs) -> None: | ||
| for weak_cb in list(self._callbacks): | ||
| callback = weak_cb() | ||
| if callback is not None: | ||
| # The listener instance is still alive, call the method | ||
| callback(*args, **kwargs) | ||
| else: | ||
| # The listener instance is gone. WeakSet handles automatic removal, | ||
| pass | ||
|
|
||
|
|
||
| class SingleCallback: | ||
| def __init__(self, callback: Callable[..., Any] | None = None): | ||
| self._callback: weakref.WeakMethod | Callable | None = None | ||
| if callback is not None: | ||
| self.set(callback) | ||
|
|
||
| def set(self, callback: Callable[..., Any] | None) -> None: | ||
| """Set the callback. Supports bound methods, functions, and lambdas.""" | ||
| if callback is None: | ||
| self._callback = None | ||
| elif hasattr(callback, '__self__'): | ||
| # Bound method - use WeakMethod to avoid keeping instance alive | ||
| self._callback = weakref.WeakMethod(callback) | ||
| elif callable(callback): | ||
| # Lambdas and regular functions - store directly (strong reference) | ||
| self._callback = callback | ||
| else: | ||
| raise TypeError(f"Expected callable, got {type(callback)}") | ||
|
|
||
| def clear(self) -> None: | ||
| self._callback = None | ||
|
|
||
| def __call__(self, *args, **kwargs) -> Any: | ||
| if self._callback is None: | ||
| return None | ||
|
|
||
| if isinstance(self._callback, weakref.WeakMethod): | ||
| callback = self._callback() | ||
| if callback is not None: | ||
| return callback(*args, **kwargs) | ||
| else: | ||
| # Instance was garbage collected | ||
| self._callback = None | ||
| return None | ||
| else: | ||
| # Direct callable reference (lambda or function) | ||
| return self._callback(*args, **kwargs) |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Uh oh!
There was an error while loading. Please reload this page.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
maybe device.py should be the one that adds this callback