From 496eee6cbbfbae1c7155fdb5a81f557d15de4328 Mon Sep 17 00:00:00 2001 From: Kumar Aditya Date: Sun, 3 Nov 2024 15:42:35 +0530 Subject: [PATCH 01/10] remove implicit creation of loops --- Lib/asyncio/events.py | 24 ------------------- Lib/test/test_asyncio/test_events.py | 36 ---------------------------- 2 files changed, 60 deletions(-) diff --git a/Lib/asyncio/events.py b/Lib/asyncio/events.py index b63fe6aa79604b7..ca0a4f2fee5840f 100644 --- a/Lib/asyncio/events.py +++ b/Lib/asyncio/events.py @@ -668,7 +668,6 @@ class BaseDefaultEventLoopPolicy(AbstractEventLoopPolicy): class _Local(threading.local): _loop = None - _set_called = False def __init__(self): self._local = self._Local() @@ -678,28 +677,6 @@ def get_event_loop(self): Returns an instance of EventLoop or raises an exception. """ - if (self._local._loop is None and - not self._local._set_called and - threading.current_thread() is threading.main_thread()): - stacklevel = 2 - try: - f = sys._getframe(1) - except AttributeError: - pass - else: - # Move up the call stack so that the warning is attached - # to the line outside asyncio itself. - while f: - module = f.f_globals.get('__name__') - if not (module == 'asyncio' or module.startswith('asyncio.')): - break - f = f.f_back - stacklevel += 1 - import warnings - warnings.warn('There is no current event loop', - DeprecationWarning, stacklevel=stacklevel) - self.set_event_loop(self.new_event_loop()) - if self._local._loop is None: raise RuntimeError('There is no current event loop in thread %r.' % threading.current_thread().name) @@ -708,7 +685,6 @@ def get_event_loop(self): def set_event_loop(self, loop): """Set the event loop.""" - self._local._set_called = True if loop is not None and not isinstance(loop, AbstractEventLoop): raise TypeError(f"loop must be an instance of AbstractEventLoop or None, not '{type(loop).__name__}'") self._local._loop = loop diff --git a/Lib/test/test_asyncio/test_events.py b/Lib/test/test_asyncio/test_events.py index 4dcf9f0e4037b62..5ba5be4cbbf8179 100644 --- a/Lib/test/test_asyncio/test_events.py +++ b/Lib/test/test_asyncio/test_events.py @@ -2701,37 +2701,6 @@ def test_event_loop_policy(self): self.assertRaises(NotImplementedError, policy.set_event_loop, object()) self.assertRaises(NotImplementedError, policy.new_event_loop) - def test_get_event_loop(self): - policy = asyncio.DefaultEventLoopPolicy() - self.assertIsNone(policy._local._loop) - with self.assertWarns(DeprecationWarning) as cm: - loop = policy.get_event_loop() - self.assertEqual(cm.filename, __file__) - self.assertIsInstance(loop, asyncio.AbstractEventLoop) - - self.assertIs(policy._local._loop, loop) - self.assertIs(loop, policy.get_event_loop()) - loop.close() - - def test_get_event_loop_calls_set_event_loop(self): - policy = asyncio.DefaultEventLoopPolicy() - - with mock.patch.object( - policy, "set_event_loop", - wraps=policy.set_event_loop) as m_set_event_loop: - - with self.assertWarns(DeprecationWarning) as cm: - loop = policy.get_event_loop() - self.addCleanup(loop.close) - self.assertEqual(cm.filename, __file__) - - # policy._local._loop must be set through .set_event_loop() - # (the unix DefaultEventLoopPolicy needs this call to attach - # the child watcher correctly) - m_set_event_loop.assert_called_with(loop) - - loop.close() - def test_get_event_loop_after_set_none(self): policy = asyncio.DefaultEventLoopPolicy() policy.set_event_loop(None) @@ -2912,11 +2881,6 @@ def test_get_event_loop_returns_running_loop2(self): loop = asyncio.new_event_loop() self.addCleanup(loop.close) - with self.assertWarns(DeprecationWarning) as cm: - loop2 = asyncio.get_event_loop() - self.addCleanup(loop2.close) - self.assertEqual(cm.filename, __file__) - asyncio.set_event_loop(None) with self.assertRaisesRegex(RuntimeError, 'no current'): asyncio.get_event_loop() From 3c9075d9f248d5a450f2ef63c2625d28f6fe83ba Mon Sep 17 00:00:00 2001 From: "blurb-it[bot]" <43283697+blurb-it[bot]@users.noreply.github.com> Date: Sun, 3 Nov 2024 10:48:11 +0000 Subject: [PATCH 02/10] =?UTF-8?q?=F0=9F=93=9C=F0=9F=A4=96=20Added=20by=20b?= =?UTF-8?q?lurb=5Fit.?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- .../next/Library/2024-11-03-10-48-07.gh-issue-126353.ChDzot.rst | 1 + 1 file changed, 1 insertion(+) create mode 100644 Misc/NEWS.d/next/Library/2024-11-03-10-48-07.gh-issue-126353.ChDzot.rst diff --git a/Misc/NEWS.d/next/Library/2024-11-03-10-48-07.gh-issue-126353.ChDzot.rst b/Misc/NEWS.d/next/Library/2024-11-03-10-48-07.gh-issue-126353.ChDzot.rst new file mode 100644 index 000000000000000..6374421866d54ba --- /dev/null +++ b/Misc/NEWS.d/next/Library/2024-11-03-10-48-07.gh-issue-126353.ChDzot.rst @@ -0,0 +1 @@ +:func:`asyncio.get_event_loop` now does not implicitly creates an event loop if not already created, instead it raises :exc:`RuntimeError`. Patch by Kumar Aditya. From 9f79f73c7194f798e6dacafe1c4db58dd381525a Mon Sep 17 00:00:00 2001 From: Kumar Aditya Date: Sun, 3 Nov 2024 17:18:26 +0530 Subject: [PATCH 03/10] fix cmdline --- Lib/test/test_cmd_line.py | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/Lib/test/test_cmd_line.py b/Lib/test/test_cmd_line.py index 35725718152c568..eca9adf9a7dcbc5 100644 --- a/Lib/test/test_cmd_line.py +++ b/Lib/test/test_cmd_line.py @@ -924,7 +924,7 @@ def test_python_gil(self): self.assertEqual(proc.stderr, '') def test_python_asyncio_debug(self): - code = "import asyncio; print(asyncio.get_event_loop().get_debug())" + code = "import asyncio; print(asyncio.new_event_loop().get_debug())" rc, out, err = assert_python_ok('-c', code, PYTHONASYNCIODEBUG='1') self.assertIn(b'True', out) From 516f097fb6894aa74f6eaca5e9344ceed22a7fe8 Mon Sep 17 00:00:00 2001 From: Kumar Aditya Date: Sun, 3 Nov 2024 12:04:04 +0000 Subject: [PATCH 04/10] fix tests --- Lib/test/test_asyncio/test_unix_events.py | 6 ++---- 1 file changed, 2 insertions(+), 4 deletions(-) diff --git a/Lib/test/test_asyncio/test_unix_events.py b/Lib/test/test_asyncio/test_unix_events.py index 9ae54b6887010b2..021f45478d6f484 100644 --- a/Lib/test/test_asyncio/test_unix_events.py +++ b/Lib/test/test_asyncio/test_unix_events.py @@ -1195,8 +1195,7 @@ async def test_fork_not_share_event_loop(self): if pid == 0: # child try: - with self.assertWarns(DeprecationWarning): - loop = asyncio.get_event_loop_policy().get_event_loop() + loop = asyncio.get_event_loop() os.write(w, b'LOOP:' + str(id(loop)).encode()) except RuntimeError: os.write(w, b'NO LOOP') @@ -1207,8 +1206,7 @@ async def test_fork_not_share_event_loop(self): else: # parent result = os.read(r, 100) - self.assertEqual(result[:5], b'LOOP:', result) - self.assertNotEqual(int(result[5:]), id(loop)) + self.assertEqual(result, b'NO LOOP') wait_process(pid, exitcode=0) @hashlib_helper.requires_hashdigest('md5') From 1214f072f4624ae980ae4b7db1d7ca7bad03dadb Mon Sep 17 00:00:00 2001 From: Kumar Aditya Date: Sun, 3 Nov 2024 17:55:22 +0530 Subject: [PATCH 05/10] code review --- Doc/library/asyncio-eventloop.rst | 8 ++------ Doc/whatsnew/3.14.rst | 5 +++++ Lib/test/test_asyncio/test_events.py | 28 ++++++++++++++++++++++++++++ 3 files changed, 35 insertions(+), 6 deletions(-) diff --git a/Doc/library/asyncio-eventloop.rst b/Doc/library/asyncio-eventloop.rst index 14fd153f640f05d..b5befa3c067d86f 100644 --- a/Doc/library/asyncio-eventloop.rst +++ b/Doc/library/asyncio-eventloop.rst @@ -47,9 +47,6 @@ an event loop: call_soon or similar API), this function will always return the running event loop. - If there is no running event loop set, the function will return - the result of the ``get_event_loop_policy().get_event_loop()`` call. - Because this function has rather complex behavior (especially when custom event loop policies are in use), using the :func:`get_running_loop` function is preferred to :func:`get_event_loop` @@ -59,9 +56,8 @@ an event loop: instead of using these lower level functions to manually create and close an event loop. - .. deprecated:: 3.12 - Deprecation warning is emitted if there is no current event loop. - In some future Python release this will become an error. + .. versionchanged:: 3.14 + Raises a :exc:`RuntimeError` if there is no set event loop. .. function:: set_event_loop(loop) diff --git a/Doc/whatsnew/3.14.rst b/Doc/whatsnew/3.14.rst index 21bc289c2be5d81..f0f660b57a1e5b9 100644 --- a/Doc/whatsnew/3.14.rst +++ b/Doc/whatsnew/3.14.rst @@ -576,6 +576,11 @@ asyncio (Contributed by Kumar Aditya in :gh:`120804`.) +* Removed implicit creation of event loop by :func:`asyncio.get_event_loop`. + It now raises a :exc:`RuntimeError` if there is no set event loop. + (Contributed by Kumar Aditya in :gh:`126353`.) + + collections.abc --------------- diff --git a/Lib/test/test_asyncio/test_events.py b/Lib/test/test_asyncio/test_events.py index 5ba5be4cbbf8179..1bf405e50f05925 100644 --- a/Lib/test/test_asyncio/test_events.py +++ b/Lib/test/test_asyncio/test_events.py @@ -2701,6 +2701,33 @@ def test_event_loop_policy(self): self.assertRaises(NotImplementedError, policy.set_event_loop, object()) self.assertRaises(NotImplementedError, policy.new_event_loop) + def test_get_event_loop(self): + policy = asyncio.DefaultEventLoopPolicy() + self.assertIsNone(policy._local._loop) + + with self.assertRaises(RuntimeError): + loop = policy.get_event_loop() + self.assertIsNone(policy._local._loop) + + loop = policy.new_event_loop() + self.assertIsNone(policy._local._loop) + policy.set_event_loop(loop) + self.assertIs(policy._local._loop, loop) + self.assertIs(loop, policy.get_event_loop()) + loop.close() + + def test_get_event_loop_does_not_call_set_event_loop(self): + policy = asyncio.DefaultEventLoopPolicy() + + with mock.patch.object( + policy, "set_event_loop", + wraps=policy.set_event_loop) as m_set_event_loop: + + with self.assertRaises(RuntimeError): + loop = policy.get_event_loop() + + m_set_event_loop.assert_not_called() + def test_get_event_loop_after_set_none(self): policy = asyncio.DefaultEventLoopPolicy() policy.set_event_loop(None) @@ -2881,6 +2908,7 @@ def test_get_event_loop_returns_running_loop2(self): loop = asyncio.new_event_loop() self.addCleanup(loop.close) + asyncio.set_event_loop(None) with self.assertRaisesRegex(RuntimeError, 'no current'): asyncio.get_event_loop() From b84ded1b8615e511c9fb2ac50f2c3bfe275b640a Mon Sep 17 00:00:00 2001 From: Kumar Aditya Date: Sun, 3 Nov 2024 18:25:19 +0530 Subject: [PATCH 06/10] fixup --- Doc/library/asyncio-eventloop.rst | 3 +++ Doc/library/asyncio-policy.rst | 8 +++----- Lib/test/test_asyncio/test_events.py | 9 +-------- 3 files changed, 7 insertions(+), 13 deletions(-) diff --git a/Doc/library/asyncio-eventloop.rst b/Doc/library/asyncio-eventloop.rst index b5befa3c067d86f..7480ad7a773bfd5 100644 --- a/Doc/library/asyncio-eventloop.rst +++ b/Doc/library/asyncio-eventloop.rst @@ -47,6 +47,9 @@ an event loop: call_soon or similar API), this function will always return the running event loop. + If there is no running event loop set, the function will return + the result of the ``get_event_loop_policy().get_event_loop()`` call. + Because this function has rather complex behavior (especially when custom event loop policies are in use), using the :func:`get_running_loop` function is preferred to :func:`get_event_loop` diff --git a/Doc/library/asyncio-policy.rst b/Doc/library/asyncio-policy.rst index 837ccc6606786ed..09b75762ff0272c 100644 --- a/Doc/library/asyncio-policy.rst +++ b/Doc/library/asyncio-policy.rst @@ -97,11 +97,9 @@ asyncio ships with the following built-in policies: On Windows, :class:`ProactorEventLoop` is now used by default. - .. deprecated:: 3.12 - The :meth:`get_event_loop` method of the default asyncio policy now emits - a :exc:`DeprecationWarning` if there is no current event loop set and it - decides to create one. - In some future Python release this will become an error. + .. versionchanged:: 3.14 + The :meth:`get_event_loop` method of the default asyncio policy now + raises a :exc:`RuntimeError` if there is no set event loop. .. class:: WindowsSelectorEventLoopPolicy diff --git a/Lib/test/test_asyncio/test_events.py b/Lib/test/test_asyncio/test_events.py index 1bf405e50f05925..ed36e0cdac3805c 100644 --- a/Lib/test/test_asyncio/test_events.py +++ b/Lib/test/test_asyncio/test_events.py @@ -2709,13 +2709,6 @@ def test_get_event_loop(self): loop = policy.get_event_loop() self.assertIsNone(policy._local._loop) - loop = policy.new_event_loop() - self.assertIsNone(policy._local._loop) - policy.set_event_loop(loop) - self.assertIs(policy._local._loop, loop) - self.assertIs(loop, policy.get_event_loop()) - loop.close() - def test_get_event_loop_does_not_call_set_event_loop(self): policy = asyncio.DefaultEventLoopPolicy() @@ -2908,10 +2901,10 @@ def test_get_event_loop_returns_running_loop2(self): loop = asyncio.new_event_loop() self.addCleanup(loop.close) - asyncio.set_event_loop(None) with self.assertRaisesRegex(RuntimeError, 'no current'): asyncio.get_event_loop() + asyncio.set_event_loop(None) with self.assertRaisesRegex(RuntimeError, 'no running'): asyncio.get_running_loop() self.assertIs(asyncio._get_running_loop(), None) From 29caae3cd7833d888f625fec71f0f17714014ca6 Mon Sep 17 00:00:00 2001 From: Kumar Aditya Date: Sun, 3 Nov 2024 18:27:31 +0530 Subject: [PATCH 07/10] improve news --- .../Library/2024-11-03-10-48-07.gh-issue-126353.ChDzot.rst | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) diff --git a/Misc/NEWS.d/next/Library/2024-11-03-10-48-07.gh-issue-126353.ChDzot.rst b/Misc/NEWS.d/next/Library/2024-11-03-10-48-07.gh-issue-126353.ChDzot.rst index 6374421866d54ba..16d508b7ec6a204 100644 --- a/Misc/NEWS.d/next/Library/2024-11-03-10-48-07.gh-issue-126353.ChDzot.rst +++ b/Misc/NEWS.d/next/Library/2024-11-03-10-48-07.gh-issue-126353.ChDzot.rst @@ -1 +1,2 @@ -:func:`asyncio.get_event_loop` now does not implicitly creates an event loop if not already created, instead it raises :exc:`RuntimeError`. Patch by Kumar Aditya. +:func:`asyncio.get_event_loop` now does not implicitly creates an event loop. +It now raises a :exc:`RuntimeError` if there is no set event loop. Patch by Kumar Aditya. From f6c1588f448997d9a6f07c7d9ffa19ceef87b39f Mon Sep 17 00:00:00 2001 From: Kumar Aditya Date: Mon, 4 Nov 2024 12:54:54 +0530 Subject: [PATCH 08/10] final fixup --- Doc/library/asyncio-eventloop.rst | 2 +- Doc/whatsnew/3.14.rst | 2 +- Lib/test/test_asyncio/test_events.py | 6 ++---- 3 files changed, 4 insertions(+), 6 deletions(-) diff --git a/Doc/library/asyncio-eventloop.rst b/Doc/library/asyncio-eventloop.rst index 7480ad7a773bfd5..d968ddebe73837d 100644 --- a/Doc/library/asyncio-eventloop.rst +++ b/Doc/library/asyncio-eventloop.rst @@ -60,7 +60,7 @@ an event loop: event loop. .. versionchanged:: 3.14 - Raises a :exc:`RuntimeError` if there is no set event loop. + Raises a :exc:`RuntimeError` if there is no current event loop .. function:: set_event_loop(loop) diff --git a/Doc/whatsnew/3.14.rst b/Doc/whatsnew/3.14.rst index f0f660b57a1e5b9..a1cede5cea5b89a 100644 --- a/Doc/whatsnew/3.14.rst +++ b/Doc/whatsnew/3.14.rst @@ -577,7 +577,7 @@ asyncio (Contributed by Kumar Aditya in :gh:`120804`.) * Removed implicit creation of event loop by :func:`asyncio.get_event_loop`. - It now raises a :exc:`RuntimeError` if there is no set event loop. + It now raises a :exc:`RuntimeError` if there is no current event loop (Contributed by Kumar Aditya in :gh:`126353`.) diff --git a/Lib/test/test_asyncio/test_events.py b/Lib/test/test_asyncio/test_events.py index ed36e0cdac3805c..1ad91b708715331 100644 --- a/Lib/test/test_asyncio/test_events.py +++ b/Lib/test/test_asyncio/test_events.py @@ -2905,14 +2905,12 @@ def test_get_event_loop_returns_running_loop2(self): asyncio.get_event_loop() asyncio.set_event_loop(None) - with self.assertRaisesRegex(RuntimeError, 'no running'): - asyncio.get_running_loop() + with self.assertRaisesRegex(RuntimeError, 'no current'): + asyncio.get_event_loop() self.assertIs(asyncio._get_running_loop(), None) async def func(): self.assertIs(asyncio.get_event_loop(), loop) - self.assertIs(asyncio.get_running_loop(), loop) - self.assertIs(asyncio._get_running_loop(), loop) loop.run_until_complete(func()) From 04d966782bf717cda14237fc5f08be89be528e43 Mon Sep 17 00:00:00 2001 From: Kumar Aditya Date: Mon, 4 Nov 2024 13:02:45 +0530 Subject: [PATCH 09/10] Apply suggestions from code review --- Doc/library/asyncio-eventloop.rst | 2 +- Doc/whatsnew/3.14.rst | 2 +- 2 files changed, 2 insertions(+), 2 deletions(-) diff --git a/Doc/library/asyncio-eventloop.rst b/Doc/library/asyncio-eventloop.rst index d968ddebe73837d..3ace6eda4d7f291 100644 --- a/Doc/library/asyncio-eventloop.rst +++ b/Doc/library/asyncio-eventloop.rst @@ -60,7 +60,7 @@ an event loop: event loop. .. versionchanged:: 3.14 - Raises a :exc:`RuntimeError` if there is no current event loop + Raises a :exc:`RuntimeError` if there is no current event loop. .. function:: set_event_loop(loop) diff --git a/Doc/whatsnew/3.14.rst b/Doc/whatsnew/3.14.rst index a1cede5cea5b89a..deee683d7b87b1c 100644 --- a/Doc/whatsnew/3.14.rst +++ b/Doc/whatsnew/3.14.rst @@ -577,7 +577,7 @@ asyncio (Contributed by Kumar Aditya in :gh:`120804`.) * Removed implicit creation of event loop by :func:`asyncio.get_event_loop`. - It now raises a :exc:`RuntimeError` if there is no current event loop + It now raises a :exc:`RuntimeError` if there is no current event loop. (Contributed by Kumar Aditya in :gh:`126353`.) From 66879132ffc54de379f0e702f4fa77c21bc49b56 Mon Sep 17 00:00:00 2001 From: Kumar Aditya Date: Mon, 4 Nov 2024 13:39:02 +0530 Subject: [PATCH 10/10] add back get_running_loop --- Lib/test/test_asyncio/test_events.py | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) diff --git a/Lib/test/test_asyncio/test_events.py b/Lib/test/test_asyncio/test_events.py index 1ad91b708715331..2ab638dc527aec0 100644 --- a/Lib/test/test_asyncio/test_events.py +++ b/Lib/test/test_asyncio/test_events.py @@ -2907,10 +2907,11 @@ def test_get_event_loop_returns_running_loop2(self): asyncio.set_event_loop(None) with self.assertRaisesRegex(RuntimeError, 'no current'): asyncio.get_event_loop() - self.assertIs(asyncio._get_running_loop(), None) async def func(): self.assertIs(asyncio.get_event_loop(), loop) + self.assertIs(asyncio.get_running_loop(), loop) + self.assertIs(asyncio._get_running_loop(), loop) loop.run_until_complete(func())