Oct 13, 2023 · Oct 12, 2023 · Oct 13, 2023 · Oct 13, 2023 · Oct 13, 2023 · Oct 13, 2023
diff --git a/Doc/library/asyncio-eventloop.rst b/Doc/library/asyncio-eventloop.rst
   .. versionchanged:: 3.12
      Added the *timeout* parameter.

 .. method:: loop.run_forever_setup()

   Set up an event loop so that it is ready to start actively looping and
   processing events.

   .. note::

      End users should not use this method directly. This method is only needed
      if you are writing your own ``EventLoop`` subclass, with a customized
      event processing loop. For example, if you are integrating Python's
      asyncio event loop with a GUI library's event loop, you may need to write
      a customized :meth:`loop.run_forever` implementation that accommodates
      both CPython's event loop and the GUI library's event loop. You can use
      this method to ensure that Python's event loop is correctly configured and
      ready to start processing events.

      The specific details of a customized ``EventLoop`` subclass will depend
      on the GUI library you are integrating with. However, the broad structure
      of a custom ``EventLoop`` would look something like::

         class CustomGUIEventLoop(EventLoop):
            def run_forever(self):
               try:
                  self.run_forever_setup()
                  gui_library.setup()
                  while True:
                     self._run_once()
                     gui_library.process_events()
                     if self._stopping:
                        break
               finally:
                  self.run_forever_cleanup()
                  gui_library.cleanup()

   .. versionadded:: 3.13

 .. method:: loop.run_forever_cleanup()

   Perform any cleanup necessary at the conclusion of event processing to ensure
   that the event loop has been fully shut down.

   .. note::

      End users should not use this method directly. This method is only needed
      if you are writing your own ``EventLoop`` subclass, with a customized
      inner event processing loop. See :meth:`loop.run_forever_setup()` for
      details on why and how to use this method.

   .. versionadded:: 3.13

 Scheduling callbacks
 ^^^^^^^^^^^^^^^^^^^^

diff --git a/Lib/asyncio/base_events.py b/Lib/asyncio/base_events.py
            raise RuntimeError(
                'Cannot run the event loop while another loop is running')

    defrun_forever_setup(self):
    def_run_forever_setup(self):
        """Prepare the run loop to process events.

        This methodshould be used as part of the ``run_forever()``
 implementation in acustom event loopsubclass (e.g., integrating a GUI
 eventloopwith Python's event loop).
        This methodexists so that custom custom event loop subclasses (e.g., event loops
 that integrate aGUI event loopwith Python's event loop) have access to all the
        loopsetup logic.
        """
        self._check_closed()
        self._check_running()

        events._set_running_loop(self)

    defrun_forever_cleanup(self):
    def_run_forever_cleanup(self):
        """Clean up after an event loop finishes the looping over events.

        This methodshould be used as part of the ``run_forever()``
 implementation in acustom event loopsubclass (e.g., integrating a GUI
 eventloopwith Python's event loop).
        This methodexists so that custom custom event loop subclasses (e.g., event loops
 that integrate aGUI event loopwith Python's event loop) have access to all the
        loopcleanup logic.
        """
        self._stopping = False
        self._thread_id = None
    def run_forever(self):
        """Run until stop() is called."""
        try:
            self.run_forever_setup()
            self._run_forever_setup()
            while True:
                self._run_once()
                if self._stopping:
                    break
        finally:
            self.run_forever_cleanup()
            self._run_forever_cleanup()

    def run_until_complete(self, future):
        """Run until the Future is done.
diff --git a/Lib/asyncio/windows_events.py b/Lib/asyncio/windows_events.py
            proactor = IocpProactor()
        super().__init__(proactor)

    defrun_forever_setup(self):
    def_run_forever_setup(self):
        assert self._self_reading_future is None
        self.call_soon(self._loop_self_reading)
        super().run_forever_setup()
        super()._run_forever_setup()

    defrun_forever_cleanup(self):
        super().run_forever_cleanup()
    def_run_forever_cleanup(self):
        super()._run_forever_cleanup()
        if self._self_reading_future is not None:
            ov = self._self_reading_future._ov
            self._self_reading_future.cancel()
diff --git a/Lib/test/test_asyncio/test_base_events.py b/Lib/test/test_asyncio/test_base_events.py
        self.loop.call_soon(callback)

        # Set up the custom event loop
        self.loop.run_forever_setup()
        self.loop._run_forever_setup()

        # Confirm the loop has been started
        self.assertEqual(asyncio.get_running_loop(), self.loop)
            self.loop._run_once()

        # Clean up the event loop
        self.loop.run_forever_cleanup()
        self.loop._run_forever_cleanup()

        # Confirm the loop has been cleaned up
        with self.assertRaises(RuntimeError):
Original file line number	Diff line number	Diff line change
Expand Up		@@ -210,56 +210,6 @@ Running and stopping the loop
		.. versionchanged:: 3.12
		Added the timeout parameter.

		.. method:: loop.run_forever_setup()

		Set up an event loop so that it is ready to start actively looping and
		processing events.

		.. note::

		End users should not use this method directly. This method is only needed
		if you are writing your own ``EventLoop`` subclass, with a customized
		event processing loop. For example, if you are integrating Python's
		asyncio event loop with a GUI library's event loop, you may need to write
		a customized :meth:`loop.run_forever` implementation that accommodates
		both CPython's event loop and the GUI library's event loop. You can use
		this method to ensure that Python's event loop is correctly configured and
		ready to start processing events.

		The specific details of a customized ``EventLoop`` subclass will depend
		on the GUI library you are integrating with. However, the broad structure
		of a custom ``EventLoop`` would look something like::

		class CustomGUIEventLoop(EventLoop):
		def run_forever(self):
		try:
		self.run_forever_setup()
		gui_library.setup()
		while True:
		self._run_once()
		gui_library.process_events()
		if self._stopping:
		break
		finally:
		self.run_forever_cleanup()
		gui_library.cleanup()

		.. versionadded:: 3.13

		.. method:: loop.run_forever_cleanup()

		Perform any cleanup necessary at the conclusion of event processing to ensure
		that the event loop has been fully shut down.

		.. note::

		End users should not use this method directly. This method is only needed
		if you are writing your own ``EventLoop`` subclass, with a customized
		inner event processing loop. See :meth:`loop.run_forever_setup()` for
		details on why and how to use this method.

		.. versionadded:: 3.13

		Scheduling callbacks
		^^^^^^^^^^^^^^^^^^^^

Expand Down
Original file line number	Diff line number	Diff line change
Expand Up		@@ -603,12 +603,12 @@ def _check_running(self):
		raise RuntimeError(
		'Cannot run the event loop while another loop is running')

		defrun_forever_setup(self):
		def_run_forever_setup(self):
		"""Prepare the run loop to process events.

		This methodshould be used as part of the ``run_forever()``
		implementation in acustom event loopsubclass (e.g., integrating a GUI
		eventloopwith Python's event loop).
		This methodexists so that custom custom event loop subclasses (e.g., event loops
		that integrate aGUI event loopwith Python's event loop) have access to all the
		loopsetup logic.
		"""
		self._check_closed()
		self._check_running()
Expand All		@@ -623,12 +623,12 @@ def run_forever_setup(self):

		events._set_running_loop(self)

		defrun_forever_cleanup(self):
		def_run_forever_cleanup(self):
		"""Clean up after an event loop finishes the looping over events.

		This methodshould be used as part of the ``run_forever()``
		implementation in acustom event loopsubclass (e.g., integrating a GUI
		eventloopwith Python's event loop).
		This methodexists so that custom custom event loop subclasses (e.g., event loops
		that integrate aGUI event loopwith Python's event loop) have access to all the
		loopcleanup logic.
		"""
		self._stopping = False
		self._thread_id = None
Expand All		@@ -642,13 +642,13 @@ def run_forever_cleanup(self):
		def run_forever(self):
		"""Run until stop() is called."""
Copy link Member gvanrossumOct 13, 2023 Choose a reason for hiding this comment The reason will be displayed to describe this comment to others.Learn more. Maybe clarify in this docstring that this is what calls setup/cleanup?
		try:
		self.run_forever_setup()
		self._run_forever_setup()
		while True:
		self._run_once()
		if self._stopping:
		break
		finally:
		self.run_forever_cleanup()
		self._run_forever_cleanup()

		def run_until_complete(self, future):
		"""Run until the Future is done.
Expand Down
Original file line number	Diff line number	Diff line change
Expand Up		@@ -314,13 +314,13 @@ def __init__(self, proactor=None):
		proactor = IocpProactor()
		super().__init__(proactor)

		defrun_forever_setup(self):
		def_run_forever_setup(self):
		assert self._self_reading_future is None
		self.call_soon(self._loop_self_reading)
		super().run_forever_setup()
		super()._run_forever_setup()

gvanrossum marked this conversation as resolved. Show resolvedHide resolved
		defrun_forever_cleanup(self):
		super().run_forever_cleanup()
		def_run_forever_cleanup(self):
		super()._run_forever_cleanup()
		if self._self_reading_future is not None:
		ov = self._self_reading_future._ov
		self._self_reading_future.cancel()
Expand Down
Original file line number	Diff line number	Diff line change
Expand Up		@@ -936,7 +936,7 @@ def callback():
		self.loop.call_soon(callback)

		# Set up the custom event loop
		self.loop.run_forever_setup()
		self.loop._run_forever_setup()

		# Confirm the loop has been started
		self.assertEqual(asyncio.get_running_loop(), self.loop)
Expand All		@@ -947,7 +947,7 @@ def callback():
		self.loop._run_once()

		# Clean up the event loop
		self.loop.run_forever_cleanup()
		self.loop._run_forever_cleanup()

		# Confirm the loop has been cleaned up
		with self.assertRaises(RuntimeError):
Expand Down