Skip to content
Merged
Show file tree
Hide file tree
Changes from 1 commit
Commits
Show all changes
23 commits
Select commit Hold shift + click to select a range
3006d6e
fix proactor error hang
graingert Aug 31, 2026
60187dd
Merge branch 'main' into fix-proactor-error-hang
graingert Sep 4, 2026
d57cb23
fix DatagramTransport when errror_recieved calls sendto
graingert Sep 4, 2026
f843371
gh-156920: fix ProactorEventLoop datagram transports drop buffered da…
graingert Sep 4, 2026
bb80478
Merge branch 'main' of github.com:python/cpython into fix-proactor-er…
graingert Sep 5, 2026
0db5dd3
Merge branch 'fix-proactor-error-hang' into fix-proactor-close-flush
graingert Sep 5, 2026
37a9b5b
Update Lib/asyncio/proactor_events.py
graingert Sep 5, 2026
d8f9aae
Merge branch 'main' into fix-proactor-error-hang
graingert Sep 6, 2026
9eda8d0
don't resume a closed transport
graingert Sep 6, 2026
9fcd45c
Merge branch 'main' into fix-proactor-error-hang
graingert Sep 7, 2026
4822ab7
add test for close called in error_recieved
graingert Sep 7, 2026
ce2168b
Merge branch 'fix-proactor-error-hang' into fix-proactor-close-flush
graingert Sep 7, 2026
b52b945
Revert "add test for close called in error_recieved"
graingert Sep 7, 2026
d4ee8a9
add test_datagram_write_error_close_from_callback
graingert Sep 7, 2026
b74ffb3
use SHORT_TIMEOUT instead of hardcoded 10
graingert Sep 11, 2026
01b328a
Merge branch 'main' into fix-proactor-error-hang
graingert Sep 11, 2026
b43d1fc
Merge branch 'fix-proactor-error-hang' into fix-proactor-close-flush
graingert Sep 11, 2026
55706b8
drop datagram write-error tests that pass without the fix
graingert Sep 11, 2026
92d347c
Merge branch 'main' into fix-proactor-close-flush
graingert Sep 11, 2026
757a9fb
check self._closing in Datagram _loop_reading
graingert Sep 11, 2026
386268a
Apply suggestion from @kumaraditya303
graingert Sep 12, 2026
5d6ac18
Merge branch 'main' into fix-proactor-close-flush
graingert Sep 12, 2026
1adb870
replace arm with schedule
graingert Sep 12, 2026
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
Prev Previous commit
Next Next commit
gh-156920: fix ProactorEventLoop datagram transports drop buffered da…
…tagrams on close() and never call connection_lost()
  • Loading branch information
graingert committed Sep 4, 2026
commit f843371eff4f1ccdac9008ed47ae0bf49bdb2dc1
39 changes: 29 additions & 10 deletions Lib/asyncio/proactor_events.py
Original file line number Diff line number Diff line change
Expand Up @@ -105,8 +105,9 @@ def close(self):
if self._closing:
return
self._closing = True
self._conn_lost += 1
if not self._buffer and self._write_fut is None:
# Nothing left to flush: no more data will be sent.
self._conn_lost += 1
self._loop.call_soon(self._call_connection_lost, None)
if self._read_fut is not None:
self._read_fut.cancel()
Expand Down Expand Up @@ -386,6 +387,7 @@ def _loop_writing(self, f=None, data=None):
self._buffer = None
if not data:
if self._closing:
self._conn_lost += 1
self._loop.call_soon(self._call_connection_lost, None)
if self._eof_written:
self._sock.shutdown(socket.SHUT_WR)
Expand Down Expand Up @@ -480,6 +482,11 @@ def get_write_buffer_size(self):
def abort(self):
self._force_close(None)

def _force_close(self, exc):
# The base class drops the buffer; the size is tracked separately.
self._buffer_size = 0
super()._force_close(exc)

def sendto(self, data, addr=None):
if not isinstance(data, (bytes, bytearray, memoryview)):
raise TypeError('data argument must be bytes-like object (%r)',
Expand Down Expand Up @@ -509,6 +516,8 @@ def sendto(self, data, addr=None):
def _loop_writing(self, fut=None):
try:
if self._conn_lost:
# No more data will be sent: either everything buffered has
# already been flushed, or _force_close() dropped it.
return

assert fut is self._write_fut
Expand All @@ -517,9 +526,10 @@ def _loop_writing(self, fut=None):
# We are in a _loop_writing() done callback, get the result
fut.result()

if not self._buffer or (self._conn_lost and self._address):
# The connection has been closed
if not self._buffer:
# Everything buffered has been sent
if self._closing:
self._conn_lost += 1
self._loop.call_soon(self._call_connection_lost, None)
return

Expand All @@ -534,17 +544,26 @@ def _loop_writing(self, fut=None):
addr=addr)
except OSError as exc:
self._protocol.error_received(exc)
if self._buffer:
# Re-arm the write loop so buffered data isn't stranded and
# a paused protocol is eventually resumed (gh-156698).
def resume_writing():
# a sendto() may have armed a write in the meantime;
# its own callback will drain the rest of the buffer.
# error_received() is arbitrary protocol code: it may have sent
# (arming a write of its own, directly or via call_soon()),
Comment thread
graingert marked this conversation as resolved.
Outdated
# closed, or aborted the transport.
if self._buffer or self._closing:
# Either data is still queued, or a close() is waiting on
# the write loop to drain it and call connection_lost().
# This write failed, so there is no completion callback
# pending to re-enter the loop -- schedule one (gh-156698).
def write_next():
# error_received() may have armed a write of its own,
Comment thread
graingert marked this conversation as resolved.
Outdated
# directly or with call_soon(); its completion callback
# will drain the rest of the buffer.
if self._write_fut is None:
self._loop_writing()

self._loop.call_soon(resume_writing)
self._loop.call_soon(write_next)
else:
# Nothing left to write, so a paused protocol has to be
# resumed here: the next entry into _loop_writing() returns
# early on an empty buffer without doing it.
self._maybe_resume_protocol()
except Exception as exc:
self._fatal_error(exc, 'Fatal write error on datagram transport')
Expand Down
97 changes: 97 additions & 0 deletions Lib/test/test_asyncio/test_events.py
Original file line number Diff line number Diff line change
Expand Up @@ -1712,6 +1712,103 @@ def error_received(self, exc):
unhandled,
f'unhandled exception in the write loop: {unhandled}')

def test_datagram_close_flushes_queued_data(self):
# See https://github.com/python/cpython/issues/156920: _conn_lost
# used to mean "close() was requested" rather than "no more data
# will be sent". Since add_done_callback() always defers an
# already-completed write's callback with call_soon(), a sendto()
# immediately followed by close() -- with no await in between --
# leaves a write genuinely outstanding at close() time on every
# platform, not just a slow one. Closing must let that write (and
# anything queued behind it) drain and still call connection_lost(),
# instead of tripping the "no more data will be sent" guard before
# the drain has actually happened and hanging forever.
loop = self.loop

class Receiver(asyncio.DatagramProtocol):
def connection_made(self, transport):
self.received = []

def datagram_received(self, data, addr):
self.received.append(data)

recv_sock = socket.socket(socket.AF_INET, socket.SOCK_DGRAM)
recv_sock.setblocking(False)
recv_sock.bind(('127.0.0.1', 0))
recv_transport, receiver = loop.run_until_complete(
loop.create_datagram_endpoint(Receiver, sock=recv_sock))
addr = recv_sock.getsockname()

class Protocol(asyncio.DatagramProtocol):
def connection_made(self, transport):
self.lost = loop.create_future()

def connection_lost(self, exc):
if not self.lost.done():
self.lost.set_result(exc)

sock = socket.socket(socket.AF_INET, socket.SOCK_DGRAM)
sock.setblocking(False)
sock.bind(('127.0.0.1', 0))
transport, protocol = loop.run_until_complete(
loop.create_datagram_endpoint(Protocol, sock=sock))

# 'first' is still in flight (its completion callback hasn't run
# yet) and 'second' is queued behind it when close() is called.
transport.sendto(b'first', addr)
transport.sendto(b'second', addr)
transport.close()

loop.run_until_complete(asyncio.wait_for(protocol.lost, 10))

test_utils.run_until(
loop, lambda: len(receiver.received) >= 2)
self.assertEqual(sorted(receiver.received), [b'first', b'second'])

recv_transport.close()
test_utils.run_briefly(loop)

def test_datagram_close_during_write_error_calls_connection_lost(self):
# See https://github.com/python/cpython/issues/156920: if the
# write that's outstanding when close() is called goes on to fail
# (rather than succeed), the failure handler used to only re-arm
Comment thread
graingert marked this conversation as resolved.
Outdated
# the write loop when data was still queued behind it. If that
# failing write was the last thing in the buffer, nothing re-armed
Comment thread
graingert marked this conversation as resolved.
Outdated
# the loop, so the close() in progress never got to call
# connection_lost() -- it hung forever instead of finishing once
# the buffer was actually empty.
loop = self.loop

class Protocol(asyncio.DatagramProtocol):
def connection_made(self, transport):
self.lost = loop.create_future()
self.errors = []

def error_received(self, exc):
self.errors.append(exc)

def connection_lost(self, exc):
if not self.lost.done():
self.lost.set_result(exc)

sock = socket.socket(socket.AF_INET, socket.SOCK_DGRAM)
sock.setblocking(False)
sock.bind(('127.0.0.1', 0))
transport, protocol = loop.run_until_complete(
loop.create_datagram_endpoint(Protocol, sock=sock))
addr = sock.getsockname()

# 'ok' is still in flight when close() is called; 'oversized' is
# queued behind it and fails once it reaches the front of the
# buffer, leaving the buffer empty right as the error is handled.
oversized = b'\x00' * 70000
transport.sendto(b'ok', addr)
transport.sendto(oversized, addr)
transport.close()

loop.run_until_complete(asyncio.wait_for(protocol.lost, 10))
self.assertTrue(protocol.errors)

def test_internal_fds(self):
loop = self.create_event_loop()
if not isinstance(loop, selector_events.BaseSelectorEventLoop):
Expand Down
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
Fix :mod:`asyncio` on Windows: closing a :class:`~asyncio.DatagramTransport`
under :class:`~asyncio.ProactorEventLoop` while datagrams were still queued,
or while an in-flight write failed right as ``close()`` was draining the
buffer, could strand the queued data and never call ``connection_lost()``,
hanging the close indefinitely.
Loading