docs: clarify Runner.run_sync usage in async contexts and remove invalid type hint#68
Open
abdul-ahad-26 wants to merge 1 commit intopanaversity:mainfrom
Open
docs: clarify Runner.run_sync usage in async contexts and remove invalid type hint#68abdul-ahad-26 wants to merge 1 commit intopanaversity:mainfrom
abdul-ahad-26 wants to merge 1 commit intopanaversity:mainfrom
Conversation
add async to weather_agent_fun() tool and change Runner.run_sync() to Runner,run() because in an asynchronous environment Runner.run_sync() may cause issue. Removed invalid type hint Runner from RunResult object returned from Runner.run()
abdul-ahad-26
changed the title
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
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
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.
Summary
This PR improves async compatibility and fixes type annotations in the example code.
Changes Made
weather_agent_fun()async to properly support asynchronous execution.Runner.run_sync()withawait Runner.run()to avoid potential issues in asynchronous environments (e.g., FastAPI, Jupyter).Runner) from the object returned byRunner.run()(now correctly treated asRunResult).Why
Using
Runner.run_sync()inside an async context can block the event loop and cause deadlocks or runtime errors.This change ensures:
Checklist