fix: prevent task GC in AsyncTeleBot by tracking background tasks#2574
Open
gilangjavier wants to merge 1 commit intoeternnoir:masterfrom
Open
fix: prevent task GC in AsyncTeleBot by tracking background tasks#2574gilangjavier wants to merge 1 commit intoeternnoir:masterfrom
gilangjavier wants to merge 1 commit intoeternnoir:masterfrom
Conversation
…event premature GC
Author
|
I checked this PR and currently no CI checks are being reported on the branch ( Could a maintainer confirm how CI should be triggered for external contributor PRs in this repo? If there is a label/command/manual trigger needed, I can follow it. |
Collaborator
|
Triggered. |
Contributor
There was a problem hiding this comment.
Pull request overview
This PR fixes a potential asyncio garbage-collection issue in AsyncTeleBot polling by retaining strong references to “fire-and-forget” tasks created for update processing, aligning with Python’s asyncio.create_task() guidance.
Changes:
- Add an instance-level
_background_tasksset to retain createdasyncio.Taskobjects. - Track each
process_new_updates()task and discard it from the set when it completes.
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
You can also share your feedback on Copilot code review. Take the survey.
Comment on lines
+457
to
+459
| task = asyncio.create_task(self.process_new_updates(updates)) | ||
| self._background_tasks.add(task) | ||
| task.add_done_callback(self._background_tasks.discard) |
Comment on lines
+457
to
+459
| task = asyncio.create_task(self.process_new_updates(updates)) | ||
| self._background_tasks.add(task) | ||
| task.add_done_callback(self._background_tasks.discard) |
| self.middlewares = [] | ||
|
|
||
| self._user = None # set during polling | ||
| self._background_tasks = set() |
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
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.
This fix addresses the issue where was called without storing a strong reference to the task, leading to potential premature garbage collection. We now maintain a set of background tasks and add a done callback to discard them upon completion.Fixes #2572