summaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorKumar Aditya <kumaraditya@python.org>2023-08-05 12:18:15 (GMT)
committerGitHub <noreply@github.com>2023-08-05 12:18:15 (GMT)
commit41178e41995992bbe417f94bce158de93f9e3188 (patch)
tree9922689458e6446a82e0f2ad067a543ccf7e3ff3
parent5e2746d6e2fb0da29225ead7135f078c5f087b57 (diff)
downloadcpython-41178e41995992bbe417f94bce158de93f9e3188.zip
cpython-41178e41995992bbe417f94bce158de93f9e3188.tar.gz
cpython-41178e41995992bbe417f94bce158de93f9e3188.tar.bz2
GH-106684: raise `ResourceWarning` when `asyncio.StreamWriter` is not closed (#107650)
-rw-r--r--Lib/asyncio/streams.py6
-rw-r--r--Lib/test/test_asyncio/test_streams.py23
-rw-r--r--Misc/NEWS.d/next/Library/2023-08-05-05-10-41.gh-issue-106684.P9zRXb.rst1
3 files changed, 30 insertions, 0 deletions
diff --git a/Lib/asyncio/streams.py b/Lib/asyncio/streams.py
index bf15f51..b7ad365 100644
--- a/Lib/asyncio/streams.py
+++ b/Lib/asyncio/streams.py
@@ -5,6 +5,7 @@ __all__ = (
import collections
import socket
import sys
+import warnings
import weakref
if hasattr(socket, 'AF_UNIX'):
@@ -392,6 +393,11 @@ class StreamWriter:
self._transport = new_transport
protocol._replace_writer(self)
+ def __del__(self, warnings=warnings):
+ if not self._transport.is_closing():
+ self.close()
+ warnings.warn(f"unclosed {self!r}", ResourceWarning)
+
class StreamReader:
diff --git a/Lib/test/test_asyncio/test_streams.py b/Lib/test/test_asyncio/test_streams.py
index 7f9dc62..9c92e75 100644
--- a/Lib/test/test_asyncio/test_streams.py
+++ b/Lib/test/test_asyncio/test_streams.py
@@ -1074,6 +1074,29 @@ os.close(fd)
self.assertEqual(messages, [])
+ def test_unclosed_resource_warnings(self):
+ async def inner(httpd):
+ rd, wr = await asyncio.open_connection(*httpd.address)
+
+ wr.write(b'GET / HTTP/1.0\r\n\r\n')
+ data = await rd.readline()
+ self.assertEqual(data, b'HTTP/1.0 200 OK\r\n')
+ data = await rd.read()
+ self.assertTrue(data.endswith(b'\r\n\r\nTest message'))
+ with self.assertWarns(ResourceWarning):
+ del wr
+ gc.collect()
+
+
+ messages = []
+ self.loop.set_exception_handler(lambda loop, ctx: messages.append(ctx))
+
+ with test_utils.run_test_server() as httpd:
+ self.loop.run_until_complete(inner(httpd))
+
+ self.assertEqual(messages, [])
+
+
if __name__ == '__main__':
unittest.main()
diff --git a/Misc/NEWS.d/next/Library/2023-08-05-05-10-41.gh-issue-106684.P9zRXb.rst b/Misc/NEWS.d/next/Library/2023-08-05-05-10-41.gh-issue-106684.P9zRXb.rst
new file mode 100644
index 0000000..02c52d7
--- /dev/null
+++ b/Misc/NEWS.d/next/Library/2023-08-05-05-10-41.gh-issue-106684.P9zRXb.rst
@@ -0,0 +1 @@
+Raise :exc:`ResourceWarning` when :class:`asyncio.StreamWriter` is not closed leading to memory leaks. Patch by Kumar Aditya.