[Python-checkins] GH-79033: Fix asyncio.Server.wait_closed() (#98582)

Thu Nov 24 10:33:31 EST 2022

https://github.com/python/cpython/commit/5d09d11aa0b89aeba187f4f520728ccaf4fc5ac1
commit: 5d09d11aa0b89aeba187f4f520728ccaf4fc5ac1
branch: main
author: Guido van Rossum <guido at python.org>
committer: gvanrossum <gvanrossum at gmail.com>
date: 2022年11月24日T08:32:58-07:00
summary:
GH-79033: Fix asyncio.Server.wait_closed() (#98582)
It was a no-op when used as recommended (after close()).
I had to debug one test (test__sock_sendfile_native_failure) --
the cleanup sequence for the test fixture was botched.
Hopefully that's not a portend of problems in user code --
this has never worked so people may well be doing this wrong. :-(
Co-authored-by: kumar aditya
files:
A Misc/NEWS.d/next/Library/2022-11-22-19-31-26.gh-issue-79033.MW6kHq.rst
M Lib/asyncio/base_events.py
M Lib/test/test_asyncio/test_base_events.py
M Lib/test/test_asyncio/test_server.py

diff --git a/Lib/asyncio/base_events.py b/Lib/asyncio/base_events.py
index 91d32e3939dc..f2f93758c3a8 100644
--- a/Lib/asyncio/base_events.py
+++ b/Lib/asyncio/base_events.py
@@ -377,7 +377,7 @@ async def serve_forever(self):
 self._serving_forever_fut = None
 
 async def wait_closed(self):
- if self._sockets is None or self._waiters is None:
+ if self._waiters is None or self._active_count == 0:
 return
 waiter = self._loop.create_future()
 self._waiters.append(waiter)
diff --git a/Lib/test/test_asyncio/test_base_events.py b/Lib/test/test_asyncio/test_base_events.py
index 2dcb20c1cec7..7421d18dc636 100644
--- a/Lib/test/test_asyncio/test_base_events.py
+++ b/Lib/test/test_asyncio/test_base_events.py
@@ -2052,11 +2052,11 @@ def prepare(self):
 
 def cleanup():
 server.close()
- self.run_loop(server.wait_closed())
 sock.close()
 if proto.transport is not None:
 proto.transport.close()
 self.run_loop(proto.wait_closed())
+ self.run_loop(server.wait_closed())
 
 self.addCleanup(cleanup)
 
diff --git a/Lib/test/test_asyncio/test_server.py b/Lib/test/test_asyncio/test_server.py
index 860d62d52ef1..06d8b60f219f 100644
--- a/Lib/test/test_asyncio/test_server.py
+++ b/Lib/test/test_asyncio/test_server.py
@@ -120,6 +120,33 @@ async def main(srv):
 self.loop.run_until_complete(srv.serve_forever())
 
 
+class TestServer2(unittest.IsolatedAsyncioTestCase):
+
+ async def test_wait_closed(self):
+ async def serve(*args):
+ pass
+
+ srv = await asyncio.start_server(serve, socket_helper.HOSTv4, 0)
+
+ # active count = 0
+ task1 = asyncio.create_task(srv.wait_closed())
+ await asyncio.sleep(0)
+ self.assertTrue(task1.done())
+
+ # active count != 0
+ srv._attach()
+ task2 = asyncio.create_task(srv.wait_closed())
+ await asyncio.sleep(0)
+ self.assertFalse(task2.done())
+
+ srv.close()
+ await asyncio.sleep(0)
+ self.assertFalse(task2.done())
+
+ srv._detach()
+ await task2
+
+
 @unittest.skipUnless(hasattr(asyncio, 'ProactorEventLoop'), 'Windows only')
 class ProactorStartServerTests(BaseStartServer, unittest.TestCase):
 
diff --git a/Misc/NEWS.d/next/Library/2022-11-22-19-31-26.gh-issue-79033.MW6kHq.rst b/Misc/NEWS.d/next/Library/2022-11-22-19-31-26.gh-issue-79033.MW6kHq.rst
new file mode 100644
index 000000000000..4b12fd9c8d79
--- /dev/null
+++ b/Misc/NEWS.d/next/Library/2022-11-22-19-31-26.gh-issue-79033.MW6kHq.rst
@@ -0,0 +1 @@
+Fix :func:`asyncio.Server.wait_closed` to actually do what the docs promise -- wait for all existing connections to complete, after closing the server.
