From 0f0a30f4da4b529e0f7df857b9f575b231b32758 Mon Sep 17 00:00:00 2001 From: Victor Stinner Date: Mon, 3 Jun 2019 23:31:04 +0200 Subject: [PATCH] bpo-34037, asyncio: add BaseEventLoop.wait_executor_on_close (GH-13786) Add BaseEventLoop.wait_executor_on_close attribute: true by default. loop.close() now waits for the default executor to finish by default. Set loop.wait_executor_on_close attribute to False to not wait for the executor. --- Doc/library/asyncio-eventloop.rst | 10 ++++++++-- Lib/asyncio/base_events.py | 4 +++- .../Library/2019-06-03-22-54-15.bpo-34037.fKNAbH.rst | 4 ++++ 3 files changed, 15 insertions(+), 3 deletions(-) create mode 100644 Misc/NEWS.d/next/Library/2019-06-03-22-54-15.bpo-34037.fKNAbH.rst diff --git a/Doc/library/asyncio-eventloop.rst b/Doc/library/asyncio-eventloop.rst index 8673f84e963..f75ca9a966b 100644 --- a/Doc/library/asyncio-eventloop.rst +++ b/Doc/library/asyncio-eventloop.rst @@ -140,12 +140,18 @@ Running and stopping the loop The loop must not be running when this function is called. Any pending callbacks will be discarded. - This method clears all queues and shuts down the executor, but does - not wait for the executor to finish. + This method clears all queues and shuts down the default executor. By + default, it waits for the default executor to finish. Set + *loop.wait_executor_on_close* to ``False`` to not wait for the executor. This method is idempotent and irreversible. No other methods should be called after the event loop is closed. + .. versionchanged:: 3.8 + The method now waits for the default executor to finish by default. + Added *loop.wait_executor_on_close* attribute. + + .. coroutinemethod:: loop.shutdown_asyncgens() Schedule all currently open :term:`asynchronous generator` objects to diff --git a/Lib/asyncio/base_events.py b/Lib/asyncio/base_events.py index e0025397fa8..b1a7f88f411 100644 --- a/Lib/asyncio/base_events.py +++ b/Lib/asyncio/base_events.py @@ -380,6 +380,8 @@ class Server(events.AbstractServer): class BaseEventLoop(events.AbstractEventLoop): def __init__(self): + # If true, close() waits for the default executor to finish + self.wait_executor_on_close = True self._timer_cancelled_count = 0 self._closed = False self._stopping = False @@ -635,7 +637,7 @@ class BaseEventLoop(events.AbstractEventLoop): executor = self._default_executor if executor is not None: self._default_executor = None - executor.shutdown(wait=False) + executor.shutdown(wait=self.wait_executor_on_close) def is_closed(self): """Returns True if the event loop was closed.""" diff --git a/Misc/NEWS.d/next/Library/2019-06-03-22-54-15.bpo-34037.fKNAbH.rst b/Misc/NEWS.d/next/Library/2019-06-03-22-54-15.bpo-34037.fKNAbH.rst new file mode 100644 index 00000000000..fb2f7a5fa36 --- /dev/null +++ b/Misc/NEWS.d/next/Library/2019-06-03-22-54-15.bpo-34037.fKNAbH.rst @@ -0,0 +1,4 @@ +:mod:`asyncio`: ``loop.close()`` now waits for the default executor to +finish by default. Set ``loop.wait_executor_on_close`` attribute to +``False`` to opt-in for Python 3.7 behavior (not wait for the executor to +finish).