refactor: refactor CLI to properly await async logic via a synchronous Click command #136
Conversation
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
- Change main() to a synchronous Click command - Introduce _async_main() for async ingest logic - Use asyncio.run(...) to properly await the async function
cyclotruc
approved these changes
Jan 17, 2025
RyanL2004
pushed a commit
to RyanL2004/gitingest
that referenced
this pull request
Jan 18, 2025
…ruc#136) - Change main() to a synchronous Click command - Introduce _async_main() for async ingest logic - Use asyncio.run(...) to properly await the async function
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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 fixes the
coroutine 'main' was never awaitedRuntimeWarningby introducing a synchronous Click command (main) that wraps an async function (_async_main) withasyncio.run(). This approach ensures that Click’s command decorators see a normal sync function, while the actual logic runs asynchronously (and is properly awaited).Key Changes
_async_main(...)function for the actual async logic.main(...)to be synchronous, which calls_async_main(...)viaasyncio.run().async defusage under Click’s command decorator.Benefits
RuntimeWarningabout un-awaited coroutines.May be related to #125.