-
Notifications
You must be signed in to change notification settings - Fork 412
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
fix(psycopg): support async iteration [backport 2.9] #10000
Merged
Merged
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
Motivation: Previously, using async iteration with `psycopg` (`async for`) would throw an exception. Example: ``` def connect_to_db(): # db connection logic... async def testfunc(): connectstr = get_conn_str() async with AsyncConnectionPool( conninfo=connectstr, min_size=4, max_size=30 ) as async_pool: async with async_pool.connection() as conn: async with conn.cursor() as cur: await cur.execute( sql.SQL( """ SELECT * FROM table1 LIMIT 5 """ ) ) async for row in cur: print(row) ``` Running `ddtrace-run python test.py` would return `TypeError: 'async for' requires an object with __aiter__ method, got Psycopg3TracedAsyncCursor`. This fix implements the `__aiter__` method for the `TracedAsyncCursor` parent class, and has `Psycopg3TracedAsyncCursor` inherit from it. ## Checklist - [x] PR author has checked that all the criteria below are met - The PR description includes an overview of the change - The PR description articulates the motivation for the change - The change includes tests OR the PR description describes a testing strategy - The PR description notes risks associated with the change, if any - Newly-added code is easy to change - The change follows the [library release note guidelines](https://ddtrace.readthedocs.io/en/stable/releasenotes.html) - The change includes or references documentation updates if necessary - Backport labels are set (if [applicable](https://ddtrace.readthedocs.io/en/latest/contributing.html#backporting)) ## Reviewer Checklist - [x] Reviewer has checked that all the criteria below are met - Title is accurate - All changes are related to the pull request's stated goal - Avoids breaking [API](https://ddtrace.readthedocs.io/en/stable/versioning.html#interfaces) changes - Testing strategy adequately addresses listed risks - Newly-added code is easy to change - Release note makes sense to a user of the library - If necessary, author has acknowledged and discussed the performance implications of this PR as reported in the benchmarks PR comment - Backport labels are set in a manner that is consistent with the [release branch maintenance policy](https://ddtrace.readthedocs.io/en/latest/contributing.html#backporting) --------- Co-authored-by: Munir Abdinur <[email protected]> (cherry picked from commit d51fa8d)
Datadog ReportBranch report: ✅ 0 Failed, 2876 Passed, 1666 Skipped, 34m 13.3s Total duration (21m 35.03s time saved) |
taegyunkim
approved these changes
Jul 31, 2024
quinna-h
approved these changes
Jul 31, 2024
emmettbutler
approved these changes
Jul 31, 2024
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.
Backport d51fa8d from #9940 to 2.9.
Motivation:
Previously, using async iteration with
psycopg
(async for
) would throw an exception.Example:
Running
ddtrace-run python test.py
would returnTypeError: 'async for' requires an object with __aiter__ method, got Psycopg3TracedAsyncCursor
.This fix implements the
__aiter__
method for theTracedAsyncCursor
parent class, and hasPsycopg3TracedAsyncCursor
inherit from it.Checklist
Reviewer Checklist