Expose get_db_connection publicly#32
Merged
Merged
Conversation
Prior to this change, a Psycopack user interfacing with the Python API
would have to call Psycopack in such way:
with _conn.get_db_connection(DATABASE_URL) as conn:
with conn.cursor() as cur:
repack = Repack(
conn=conn,
cur=cur,
...
)
repack.full()
This isn't ideal because the _conn module is private.
There is also no option for the user to directly get their connection
and cursor from psycopg2 or psycopg (3), unless they don't care about
type annotations (in which case they already can).
This commit exposes get_db_connection publicly so that users can get
type-annotated cursors and connections.
Coverage Report Results
1 empty file skipped. |
timb07
approved these changes
May 15, 2025
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.
Prior to this change, a Psycopack user interfacing with the Python API would have to call Psycopack in such way:
This isn't ideal because the _conn module is private.
There is also no option for the user to directly get their connection and cursor from psycopg2 or psycopg (3), unless they don't care about type annotations (in which case they already can).
This commit exposes get_db_connection publicly so that users can get type-annotated cursors and connections.