Skip to content
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

add type for pool.acquire() #521

Open
wants to merge 3 commits into
base: master
Choose a base branch
from
Open
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
2 changes: 1 addition & 1 deletion asyncpg/pool.py
Original file line number Diff line number Diff line change
Expand Up @@ -566,7 +566,7 @@ async def fetchrow(self, query, *args, timeout=None):
async with self.acquire() as con:
return await con.fetchrow(query, *args, timeout=timeout)

def acquire(self, *, timeout=None):
def acquire(self, *, timeout=None) -> connection.Connection:
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This type hint only covers usual await case:

con = await pool.acquire()

But won't work properly for context manager case:

async with pool.acquire() as con:
    await con.execute(...)

The more correct return type could be something like PoolAcquireContext but we should check if mypy understands it first.

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

#577 contains more precise types

"""Acquire a database connection from the pool.

:param float timeout: A timeout for acquiring a Connection.
Expand Down