-
Notifications
You must be signed in to change notification settings - Fork 25
feat: add EventBus.remove() to unsubscribe handlers #35
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
Open
HankGrimm
wants to merge
1
commit into
browser-use:main
Choose a base branch
from
HankGrimm:feat/eventbus-remove-handler
base: main
Could not load branches
Branch not found: {{ refName }}
Loading
Could not load tags
Nothing to show
Loading
Are you sure you want to change the base?
Some commits from the old base branch may be removed from the timeline,
and old review comments may become outdated.
+124
−14
Open
Changes from all commits
Commits
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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -453,17 +453,7 @@ def on( | |
| f'Invalid handler: {handler}, must be a sync or async function or method' | ||
| ) | ||
|
|
||
| # Determine event key | ||
| event_key: str | ||
| if event_pattern == '*': | ||
| event_key = '*' | ||
| elif isinstance(event_pattern, type) and issubclass(event_pattern, BaseEvent): # pyright: ignore[reportUnnecessaryIsInstance] | ||
| event_key = event_pattern.__name__ # pyright: ignore[reportUnknownMemberType, reportUnknownVariableType] | ||
| else: | ||
| event_key = str(event_pattern) | ||
|
|
||
| # Ensure event_key is definitely a string at this point | ||
| assert isinstance(event_key, str) | ||
| event_key = self._get_event_key(event_pattern) | ||
|
|
||
| # Check for duplicate handler names | ||
| new_handler_name = get_handler_name(handler) | ||
|
|
@@ -482,6 +472,38 @@ def on( | |
| self.handlers[event_key].append(handler) # type: ignore | ||
| logger.debug(f'👂 {self}.on({event_key}, {get_handler_name(handler)}) Registered event handler') | ||
|
|
||
| def _get_event_key(self, event_pattern: EventPatternType) -> str: | ||
| """Resolve an event pattern (type name string, event class, or '*') to the internal handler key.""" | ||
| if event_pattern == '*': | ||
| return '*' | ||
| elif isinstance(event_pattern, type) and issubclass(event_pattern, BaseEvent): # pyright: ignore[reportUnnecessaryIsInstance] | ||
| return event_pattern.__name__ # pyright: ignore[reportUnknownMemberType, reportUnknownVariableType] | ||
| return str(event_pattern) | ||
|
|
||
| def remove(self, event_pattern: EventPatternType, handler: ContravariantEventHandler['BaseEvent[Any]']) -> bool: | ||
|
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. P2: When a handler is typed for a concrete event, strict type checking rejects Prompt for AI agents |
||
| """ | ||
| Unsubscribe a previously registered handler from events matching a pattern. | ||
|
|
||
| Args: | ||
| event_pattern: The event type string, event model class, or '*' that was passed to `on()`. | ||
| handler: The exact handler function or method previously registered with `on()`. | ||
|
|
||
| Returns: | ||
| True if the handler was found and removed, False otherwise. | ||
|
|
||
| Example: | ||
| eventbus.on(TaskStartedEvent, handler) | ||
| ... | ||
| eventbus.remove(TaskStartedEvent, handler) | ||
| """ | ||
| event_key = self._get_event_key(event_pattern) | ||
| registered_handlers = self.handlers.get(event_key, []) | ||
| if handler in registered_handlers: | ||
| registered_handlers.remove(handler) | ||
| logger.debug(f'👂 {self}.remove({event_key}, {get_handler_name(handler)}) Unregistered event handler') | ||
| return True | ||
| return False | ||
|
|
||
| def dispatch(self, event: T_ExpectedEvent) -> T_ExpectedEvent: | ||
| """ | ||
| Enqueue an event for processing and immediately return an Event(status='pending') version (synchronous). | ||
|
|
@@ -677,9 +699,7 @@ def notify_expect_handler(event: 'BaseEvent[Any]') -> None: | |
| return await future | ||
| finally: | ||
| # Clean up handler | ||
| event_key: str = event_type.__name__ if isinstance(event_type, type) else str(event_type) # pyright: ignore[reportUnknownMemberType, reportPartialTypeErrors] | ||
| if event_key in self.handlers and notify_expect_handler in self.handlers[event_key]: | ||
| self.handlers[event_key].remove(notify_expect_handler) | ||
| self.remove(event_type, notify_expect_handler) | ||
|
|
||
| def _start(self) -> None: | ||
| """Start the event bus if not already running""" | ||
|
|
||
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,90 @@ | ||
| """Tests for EventBus.remove() handler unsubscription.""" | ||
|
|
||
| from bubus import BaseEvent, EventBus | ||
|
|
||
|
|
||
| class PingEvent(BaseEvent[str]): | ||
| """Minimal event used to verify handler removal.""" | ||
|
|
||
|
|
||
| async def test_remove_handler_by_event_class_stops_delivery(): | ||
| """Removing a handler registered by event class stops it from receiving future events.""" | ||
| bus = EventBus(name='remove_class') | ||
| calls: list[str] = [] | ||
|
|
||
| async def handler(event: PingEvent) -> str: | ||
| calls.append(event.event_type) | ||
| return 'ok' | ||
|
|
||
| bus.on(PingEvent, handler) | ||
| assert bus.remove(PingEvent, handler) is True | ||
| assert bus.remove(PingEvent, handler) is False # second removal is a no-op | ||
|
|
||
| await bus.dispatch(PingEvent()) | ||
| await bus.wait_until_idle() | ||
|
|
||
| assert calls == [] | ||
| await bus.stop() | ||
|
|
||
|
|
||
| async def test_remove_handler_by_string_name(): | ||
| """Removing a handler registered by event type string works too.""" | ||
| bus = EventBus(name='remove_string') | ||
| calls: list[str] = [] | ||
|
|
||
| async def handler(event: BaseEvent) -> str: | ||
| calls.append(event.event_type) | ||
| return 'ok' | ||
|
|
||
| bus.on('PingEvent', handler) | ||
| assert bus.remove('PingEvent', handler) is True | ||
| assert bus.remove('PingEvent', handler) is False | ||
|
|
||
| await bus.dispatch(PingEvent()) | ||
| await bus.wait_until_idle() | ||
|
|
||
| assert calls == [] | ||
| await bus.stop() | ||
|
|
||
|
|
||
| async def test_remove_only_targets_specific_handler(): | ||
| """Removing one handler leaves other handlers for the same event intact.""" | ||
| bus = EventBus(name='remove_specific') | ||
| calls: list[str] = [] | ||
|
|
||
| async def keep(event: PingEvent) -> str: | ||
| calls.append('keep') | ||
| return 'keep' | ||
|
|
||
| async def drop(event: PingEvent) -> str: | ||
| calls.append('drop') | ||
| return 'drop' | ||
|
|
||
| bus.on(PingEvent, keep) | ||
| bus.on(PingEvent, drop) | ||
| assert bus.remove(PingEvent, drop) is True | ||
|
|
||
| await bus.dispatch(PingEvent()) | ||
| await bus.wait_until_idle() | ||
|
|
||
| assert calls == ['keep'] | ||
| await bus.stop() | ||
|
|
||
|
|
||
| async def test_remove_wildcard_handler(): | ||
| """Removing a '*' wildcard handler stops it from receiving all events.""" | ||
| bus = EventBus(name='remove_wildcard') | ||
| calls: list[str] = [] | ||
|
|
||
| async def handler(event: BaseEvent) -> str: | ||
| calls.append(event.event_type) | ||
| return 'ok' | ||
|
|
||
| bus.on('*', handler) | ||
| assert bus.remove('*', handler) is True | ||
|
|
||
| await bus.dispatch(PingEvent()) | ||
| await bus.wait_until_idle() | ||
|
|
||
| assert calls == [] | ||
| await bus.stop() |
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.
P3: After removing the last handler for an event key, the key remains in
self.handlersas an empty list because the method never cleans up the entry. Sincehandlersis adefaultdict(list), repeated remove()/expect() calls leave many empty keys, which accumulates over the bus lifetime and inflateslen(self.handlers)shown in__str__. Delete the key when its list becomes empty.Prompt for AI agents