Repository navigation
Conversation
Previously, ending iteration early, failing mid-stream, or encountering an error during single-row lookups left the underlying response stream open until garbage collection. As a result, streaming resources could linger and operation completion metrics would not be recorded right away. This change adds an internal close helper to streamed result sets and ensures iteration, single-row lookups, and dictionary conversion always clean up the underlying stream when finished, closed early, or interrupted by an error. Result set metadata and statistics remain accessible after closing, and no new public API is introduced.
Contributor
There was a problem hiding this comment.
Code Review
This pull request implements idempotent closing of the underlying response iterator in both synchronous and asynchronous StreamedResultSet classes. It introduces a private _close method and ensures it is called within finally blocks during stream consumption (__iter__/__aiter__), one_or_none(), and to_dict_list(). Corresponding unit and mock server tests have been added to verify this behavior and ensure metrics are correctly recorded upon closing. The review feedback recommends explicitly catching asyncio.CancelledError alongside Exception in the async _close method to prevent unhandled cancellation exceptions, since CancelledError inherits from BaseException.
This branch has not been deployed
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.
Previously, ending iteration early, failing mid-stream, or encountering an error during single-row lookups left the underlying response stream open until garbage collection. As a result, streaming resources could linger and operation completion metrics would not be recorded right away.
This change adds an internal close helper to streamed result sets and ensures iteration, single-row lookups, and dictionary conversion always clean up the underlying stream when finished, closed early, or interrupted by an error. Result set metadata and statistics remain accessible after closing, and no new public API is introduced.