From: Miss Islington (bot) <31488909+miss-islington@users.noreply.github.com> Date: Thu, 4 Jan 2024 20:39:52 +0000 (+0100) Subject: [3.11] gh-113538: Don't error in stream reader protocol callback when task is cancell... X-Git-Tag: v3.11.8~192 X-Git-Url: http://git.ipfire.org/gitweb.cgi?a=commitdiff_plain;h=456e2ecdd24f372bffd3083b9e4e51ca973f81f6;p=thirdparty%2FPython%2Fcpython.git [3.11] gh-113538: Don't error in stream reader protocol callback when task is cancelled (GH-113690) (#113714) (cherry picked from commit 4681a5271a8598b46021cbc556ac8098ab8a1d81) Co-authored-by: Guido van Rossum --- diff --git a/Lib/asyncio/streams.py b/Lib/asyncio/streams.py index 23b6e4c32f7c..26ffc86584e3 100644 --- a/Lib/asyncio/streams.py +++ b/Lib/asyncio/streams.py @@ -246,6 +246,9 @@ class StreamReaderProtocol(FlowControlMixin, protocols.Protocol): self._stream_writer) if coroutines.iscoroutine(res): def callback(task): + if task.cancelled(): + transport.close() + return exc = task.exception() if exc is not None: self._loop.call_exception_handler({ diff --git a/Lib/test/test_asyncio/test_streams.py b/Lib/test/test_asyncio/test_streams.py index f5decbe53dac..59ff89e7734d 100644 --- a/Lib/test/test_asyncio/test_streams.py +++ b/Lib/test/test_asyncio/test_streams.py @@ -1123,7 +1123,7 @@ os.close(fd) self.assertEqual(messages, []) - def test_unhandled_exceptions(self) -> None: + def _basetest_unhandled_exceptions(self, handle_echo): port = socket_helper.find_unused_port() messages = [] @@ -1137,9 +1137,6 @@ os.close(fd) await wr.wait_closed() async def main(): - async def handle_echo(reader, writer): - raise Exception('test') - server = await asyncio.start_server( handle_echo, 'localhost', port) await server.start_serving() @@ -1148,11 +1145,20 @@ os.close(fd) await server.wait_closed() self.loop.run_until_complete(main()) + return messages + def test_unhandled_exception(self): + async def handle_echo(reader, writer): + raise Exception('test') + messages = self._basetest_unhandled_exceptions(handle_echo) self.assertEqual(messages[0]['message'], - 'Unhandled exception in client_connected_cb') - # Break explicitly reference cycle - messages = None + 'Unhandled exception in client_connected_cb') + + def test_unhandled_cancel(self): + async def handle_echo(reader, writer): + asyncio.current_task().cancel() + messages = self._basetest_unhandled_exceptions(handle_echo) + self.assertEqual(messages, []) if __name__ == '__main__': diff --git a/Misc/NEWS.d/next/Library/2024-01-03-14-19-26.gh-issue-113538.ahuBCo.rst b/Misc/NEWS.d/next/Library/2024-01-03-14-19-26.gh-issue-113538.ahuBCo.rst new file mode 100644 index 000000000000..a52076501b7b --- /dev/null +++ b/Misc/NEWS.d/next/Library/2024-01-03-14-19-26.gh-issue-113538.ahuBCo.rst @@ -0,0 +1,5 @@ +In :meth:`asyncio.StreamReaderProtocol.connection_made`, there is callback +that logs an error if the task wrapping the "connected callback" fails. This +callback would itself fail if the task was cancelled. Prevent this by +checking whether the task was cancelled first. If so, close the transport +but don't log an error.