-
Notifications
You must be signed in to change notification settings - Fork 4.9k
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
task: added warning when none is called in intervention handler #4149
Open
goyalpramod
wants to merge
1
commit into
microsoft:main
Choose a base branch
from
goyalpramod:return-warning-for-none
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.
+28
−4
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 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 |
---|---|---|
@@ -1,5 +1,5 @@ | ||
import warnings | ||
from typing import Any, Awaitable, Callable, Protocol, final | ||
|
||
from autogen_core.base import AgentId | ||
|
||
__all__ = [ | ||
|
@@ -14,6 +14,27 @@ | |
class DropMessage: ... | ||
|
||
|
||
def warn_if_none(result: Any, handler_name: str) -> Any: | ||
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. IMO there's no reason to return the value, and by doing so you're stripping the type away from it since you're using |
||
""" | ||
Utility function to check if the intervention handler returned None and issue a warning. | ||
|
||
Args: | ||
result: The return value from the intervention handler | ||
handler_name: Name of the intervention handler method for the warning message | ||
|
||
Returns: | ||
The original result value | ||
""" | ||
if result is None: | ||
warnings.warn( | ||
f"Intervention handler {handler_name} returned None. This might be unintentional. " | ||
"Consider returning the original message or DropMessage explicitly.", | ||
RuntimeWarning, | ||
stacklevel=2 | ||
) | ||
return result | ||
|
||
|
||
InterventionFunction = Callable[[Any], Any | Awaitable[type[DropMessage]]] | ||
|
||
|
||
|
@@ -27,10 +48,13 @@ async def on_response( | |
|
||
class DefaultInterventionHandler(InterventionHandler): | ||
async def on_send(self, message: Any, *, sender: AgentId | None, recipient: AgentId) -> Any | type[DropMessage]: | ||
return message | ||
result = message | ||
return warn_if_none(result, "on_send") | ||
|
||
async def on_publish(self, message: Any, *, sender: AgentId | None) -> Any | type[DropMessage]: | ||
return message | ||
result = message | ||
return warn_if_none(result, "on_publish") | ||
|
||
async def on_response(self, message: Any, *, sender: AgentId, recipient: AgentId | None) -> Any | type[DropMessage]: | ||
return message | ||
result = message | ||
return warn_if_none(result, "on_response") |
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.
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.
Please name this with a leading underscore to indicate private