gh-94597: Add asyncio.EventLoop (#110723)

graingert · web-flow · commit 8c6c14b91bf9 · 2023-10-12T07:13:57.000-07:00
This is needed to pave the way for deprecating and eventually killing the event loop policy system (which is over-engineered and rarely used).
diff --git a/Doc/library/asyncio-eventloop.rst b/Doc/library/asyncio-eventloop.rst
@@ -1686,13 +1686,13 @@ Event Loop Implementations
 asyncio ships with two different event loop implementations:
 :class:`SelectorEventLoop` and :class:`ProactorEventLoop`.
 
-By default asyncio is configured to use :class:`SelectorEventLoop`
-on Unix and :class:`ProactorEventLoop` on Windows.
+By default asyncio is configured to use :class:`EventLoop`.
 
 
 .. class:: SelectorEventLoop
 
-   An event loop based on the :mod:`selectors` module.
+   A subclass of :class:`AbstractEventLoop` based on the
+   :mod:`selectors` module.
 
    Uses the most efficient *selector* available for the given
    platform.  It is also possible to manually configure the
@@ -1714,7 +1714,7 @@ on Unix and :class:`ProactorEventLoop` on Windows.
 
 .. class:: ProactorEventLoop
 
-   An event loop for Windows that uses "I/O Completion Ports" (IOCP).
+   A subclass of :class:`AbstractEventLoop` for Windows that uses "I/O Completion Ports" (IOCP).
 
    .. availability:: Windows.
 
@@ -1723,6 +1723,14 @@ on Unix and :class:`ProactorEventLoop` on Windows.
       `MSDN documentation on I/O Completion Ports
       <https://docs.microsoft.com/en-ca/windows/desktop/FileIO/i-o-completion-ports>`_.
 
+.. class:: EventLoop
+
+    An alias to the most efficient available subclass of :class:`AbstractEventLoop` for the given
+    platform.
+
+    It is an alias to :class:`SelectorEventLoop` on Unix and :class:`ProactorEventLoop` on Windows.
+
+   .. versionadded:: 3.13
 
 .. class:: AbstractEventLoop
 
diff --git a/Doc/library/asyncio-runner.rst b/Doc/library/asyncio-runner.rst
@@ -42,6 +42,8 @@ Running an asyncio Program
    This function should be used as a main entry point for asyncio programs,
    and should ideally only be called once. It is recommended to use
    *loop_factory* to configure the event loop instead of policies.
+   Passing :class:`asyncio.EventLoop` allows running asyncio without the
+   policy system.
 
    The executor is given a timeout duration of 5 minutes to shutdown.
    If the executor hasn't finished within that duration, a warning is
diff --git a/Lib/asyncio/unix_events.py b/Lib/asyncio/unix_events.py
@@ -32,6 +32,7 @@
     'FastChildWatcher', 'PidfdChildWatcher',
     'MultiLoopChildWatcher', 'ThreadedChildWatcher',
     'DefaultEventLoopPolicy',
+    'EventLoop',
 )
 
 
@@ -1510,3 +1511,4 @@ def set_child_watcher(self, watcher):
 
 SelectorEventLoop = _UnixSelectorEventLoop
 DefaultEventLoopPolicy = _UnixDefaultEventLoopPolicy
+EventLoop = SelectorEventLoop
diff --git a/Lib/asyncio/windows_events.py b/Lib/asyncio/windows_events.py
@@ -29,7 +29,7 @@
 __all__ = (
     'SelectorEventLoop', 'ProactorEventLoop', 'IocpProactor',
     'DefaultEventLoopPolicy', 'WindowsSelectorEventLoopPolicy',
-    'WindowsProactorEventLoopPolicy',
+    'WindowsProactorEventLoopPolicy', 'EventLoop',
 )
 
 
@@ -894,3 +894,4 @@ class WindowsProactorEventLoopPolicy(events.BaseDefaultEventLoopPolicy):
 
 
 DefaultEventLoopPolicy = WindowsProactorEventLoopPolicy
+EventLoop = ProactorEventLoop
diff --git a/Lib/test/test_asyncio/test_runners.py b/Lib/test/test_asyncio/test_runners.py
@@ -3,6 +3,7 @@
 import contextvars
 import re
 import signal
+import sys
 import threading
 import unittest
 from test.test_asyncio import utils as test_utils
@@ -272,6 +273,16 @@ async def main():
         asyncio.run(main(), loop_factory=factory)
         factory.assert_called_once_with()
 
+    def test_loop_factory_default_event_loop(self):
+        async def main():
+            if sys.platform == "win32":
+                self.assertIsInstance(asyncio.get_running_loop(), asyncio.ProactorEventLoop)
+            else:
+                self.assertIsInstance(asyncio.get_running_loop(), asyncio.SelectorEventLoop)
+
+
+        asyncio.run(main(), loop_factory=asyncio.EventLoop)
+
 
 class RunnerTests(BaseTest):
 
diff --git a/Misc/NEWS.d/next/Library/2023-10-11-15-07-21.gh-issue-94597.NbPC8t.rst b/Misc/NEWS.d/next/Library/2023-10-11-15-07-21.gh-issue-94597.NbPC8t.rst
@@ -0,0 +1 @@
+Added :class:`asyncio.EventLoop` for use with the :func:`asyncio.run` *loop_factory* kwarg to avoid calling the asyncio policy system.

Original file line number	Diff line number	Diff line change
`@@ -32,6 +32,7 @@`
`32`	`32`	`'FastChildWatcher', 'PidfdChildWatcher',`
`33`	`33`	`'MultiLoopChildWatcher', 'ThreadedChildWatcher',`
`34`	`34`	`'DefaultEventLoopPolicy',`
	`35`	`+ 'EventLoop',`
`35`	`36`	`)`
`36`	`37`
`37`	`38`
`@@ -1510,3 +1511,4 @@ def set_child_watcher(self, watcher):`
`1510`	`1511`
`1511`	`1512`	`SelectorEventLoop = _UnixSelectorEventLoop`
`1512`	`1513`	`DefaultEventLoopPolicy = _UnixDefaultEventLoopPolicy`
	`1514`	`+EventLoop = SelectorEventLoop`
Original file line number	Diff line number	Diff line change
`@@ -29,7 +29,7 @@`
`29`	`29`	`__all__ = (`
`30`	`30`	`'SelectorEventLoop', 'ProactorEventLoop', 'IocpProactor',`
`31`	`31`	`'DefaultEventLoopPolicy', 'WindowsSelectorEventLoopPolicy',`
`32`		`- 'WindowsProactorEventLoopPolicy',`
	`32`	`+ 'WindowsProactorEventLoopPolicy', 'EventLoop',`
`33`	`33`	`)`
`34`	`34`
`35`	`35`
`@@ -894,3 +894,4 @@ class WindowsProactorEventLoopPolicy(events.BaseDefaultEventLoopPolicy):`
`894`	`894`
`895`	`895`
`896`	`896`	`DefaultEventLoopPolicy = WindowsProactorEventLoopPolicy`
	`897`	`+EventLoop = ProactorEventLoop`
Original file line number	Diff line number	Diff line change
`@@ -0,0 +1 @@`
	`1`	+Added :class:`asyncio.EventLoop` for use with the :func:`asyncio.run` loop_factory kwarg to avoid calling the asyncio policy system.