[3.12] gh-116143: Fix race condition in pydoc _start_server (GH-116144) (#116415)

gh-116143: Fix race condition in pydoc _start_server (GH-116144)
(cherry picked from commit 02ee475ee3ce9468d44758df2cd79df9f0926303)

Co-authored-by: Itamar Oren <itamarost@gmail.com>

diff --git a/Lib/pydoc.py b/Lib/pydoc.py
index bf855b45134631b382c7af7d47274f57cb22ad20..9a8812392af49361de5cdf1c82ed49f110ed0fd1 100755 (executable)
--- a/Lib/pydoc.py
+++ b/Lib/pydoc.py
@@ -2493,6 +2493,7 @@ def _start_server(urlhandler, hostname, port):
             threading.Thread.__init__(self)
             self.serving = False
             self.error = None
+            self.docserver = None
 
         def run(self):
             """Start the server."""
@@ -2525,9 +2526,9 @@ def _start_server(urlhandler, hostname, port):
 
     thread = ServerThread(urlhandler, hostname, port)
     thread.start()
-    # Wait until thread.serving is True to make sure we are
-    # really up before returning.
-    while not thread.error and not thread.serving:
+    # Wait until thread.serving is True and thread.docserver is set
+    # to make sure we are really up before returning.
+    while not thread.error and not (thread.serving and thread.docserver):
         time.sleep(.01)
     return thread
 

diff --git a/Misc/NEWS.d/next/Library/2024-03-05-20-53-34.gh-issue-116143.sww6Zl.rst b/Misc/NEWS.d/next/Library/2024-03-05-20-53-34.gh-issue-116143.sww6Zl.rst
new file mode 100644 (file)
index 0000000..07aa312
--- /dev/null
+++ b/Misc/NEWS.d/next/Library/2024-03-05-20-53-34.gh-issue-116143.sww6Zl.rst
@@ -0,0 +1,3 @@
+Fix a race in pydoc ``_start_server``, eliminating a window in which
+``_start_server`` can return a thread that is "serving" but without a
+``docserver`` set.