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

'await connection.close()' returns once connection thread has also forwarded _STOP_RUNNING_SENTINEL #305

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

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
21 changes: 13 additions & 8 deletions aiosqlite/core.py
Original file line number Diff line number Diff line change
@@ -62,10 +62,15 @@ def __init__(
DeprecationWarning,
)

def _stop_running(self):
async def _stop_running(self):
self._running = False
# PEP 661 is not accepted yet, so we cannot type a sentinel
self._tx.put_nowait(_STOP_RUNNING_SENTINEL) # type: ignore[arg-type]

function = partial(lambda: _STOP_RUNNING_SENTINEL)
future = asyncio.get_event_loop().create_future()

self._tx.put_nowait((future, function))

return await future

@property
def _conn(self) -> sqlite3.Connection:
@@ -95,16 +100,16 @@ def run(self) -> None:
# futures)

tx_item = self._tx.get()
if tx_item is _STOP_RUNNING_SENTINEL:
break

future, function = tx_item

try:
LOG.debug("executing %s", function)
result = function()
LOG.debug("operation %s completed", function)
future.get_loop().call_soon_threadsafe(set_result, future, result)

if result is _STOP_RUNNING_SENTINEL:
break
except BaseException as e: # noqa B036
LOG.debug("returning exception %s", e)
future.get_loop().call_soon_threadsafe(set_exception, future, e)
@@ -129,7 +134,7 @@ async def _connect(self) -> "Connection":
self._tx.put_nowait((future, self._connector))
self._connection = await future
except BaseException:
self._stop_running()
await self._stop_running()
self._connection = None
raise

@@ -170,7 +175,7 @@ async def close(self) -> None:
LOG.info("exception occurred while closing connection")
raise
finally:
self._stop_running()
await self._stop_running()
self._connection = None

@contextmanager
11 changes: 11 additions & 0 deletions aiosqlite/tests/smoke.py
Original file line number Diff line number Diff line change
@@ -413,6 +413,17 @@ async def test_cursor_on_closed_connection_loop(self):
except sqlite3.ProgrammingError:
pass

async def test_close_blocking_until_transaction_queue_empty(self):
db = await aiosqlite.connect(self.db)
# Insert transactions into the
# transaction queue '_tx'
for i in range(1000):
await db.execute(f"select 1, {i}")
# Wait for all transactions to complete
await db.close()
# Check no more transaction pending
self.assertEqual(db._tx.empty(), True)

async def test_close_twice(self):
db = await aiosqlite.connect(self.db)