bpo-34075: Deprecate non-ThreadPoolExecutor in loop.set_default_executor() (GH-8533)

Various asyncio internals expect that the default executor is a
`ThreadPoolExecutor`, so deprecate passing anything else to
`loop.set_default_executor()`.
This commit is contained in:
Elvis Pranskevichus 2018-07-30 11:42:43 +01:00 committed by Victor Stinner
parent 4e11c461ed
commit 22d25085db
5 changed files with 35 additions and 2 deletions

View file

@ -906,7 +906,14 @@ pool of processes). By default, an event loop uses a thread pool executor
.. method:: AbstractEventLoop.set_default_executor(executor)
Set the default executor used by :meth:`run_in_executor`.
Set *executor* as the default executor used by :meth:`run_in_executor`.
*executor* should be an instance of
:class:`~concurrent.futures.ThreadPoolExecutor`.
.. deprecated:: 3.8
Using an executor that is not an instance of
:class:`~concurrent.futures.ThreadPoolExecutor` is deprecated and
will trigger an error in Python 3.9.
Error Handling API

View file

@ -164,6 +164,12 @@ Deprecated
They will be removed in Python 3.9.
(Contributed by Serhiy Storchaka in :issue:`29209`.)
* Passing an object that is not an instance of
:class:`concurrent.futures.ThreadPoolExecutor` to
:meth:`asyncio.AbstractEventLoop.set_default_executor()` is
deprecated and will be prohibited in Python 3.9.
(Contributed by Elvis Pranskevichus in :issue:`34075`.)
Removed
=======

View file

@ -741,6 +741,12 @@ def run_in_executor(self, executor, func, *args):
executor.submit(func, *args), loop=self)
def set_default_executor(self, executor):
if not isinstance(executor, concurrent.futures.ThreadPoolExecutor):
warnings.warn(
'Using the default executor that is not an instance of '
'ThreadPoolExecutor is deprecated and will be prohibited '
'in Python 3.9',
DeprecationWarning, 2)
self._default_executor = executor
def _getaddrinfo_debug(self, host, port, family, type, proto, flags):

View file

@ -1,5 +1,6 @@
"""Tests for base_events.py"""
import concurrent.futures
import errno
import logging
import math
@ -211,10 +212,21 @@ def test__add_callback_cancelled_handle(self):
self.assertFalse(self.loop._ready)
def test_set_default_executor(self):
executor = mock.Mock()
class DummyExecutor(concurrent.futures.ThreadPoolExecutor):
def submit(self, fn, *args, **kwargs):
raise NotImplementedError(
'cannot submit into a dummy executor')
executor = DummyExecutor()
self.loop.set_default_executor(executor)
self.assertIs(executor, self.loop._default_executor)
def test_set_default_executor_deprecation_warnings(self):
executor = mock.Mock()
with self.assertWarns(DeprecationWarning):
self.loop.set_default_executor(executor)
def test_call_soon(self):
def cb():
pass

View file

@ -0,0 +1,2 @@
Deprecate passing non-ThreadPoolExecutor instances to
:meth:`AbstractEventLoop.set_default_executor`.