bpo-31238: pydoc ServerThread.stop() now joins itself (#3151)

vstinner · web-flow · commit 4cab2cd0c05f · 2017-08-21T23:24:40.000+02:00
* bpo-31238: pydoc ServerThread.stop() now joins itself ServerThread.stop() now joins itself to wait until DocServer.serve_until_quit() completes and then explicitly sets its docserver attribute to None to break a reference cycle. * Add NEWS.d entry
diff --git a/Lib/pydoc.py b/Lib/pydoc.py
@@ -2297,6 +2297,10 @@ def ready(self, server):
         def stop(self):
             """Stop the server and this thread nicely"""
             self.docserver.quit = True
+            self.join()
+            # explicitly break a reference cycle: DocServer.callback
+            # has indirectly a reference to ServerThread.
+            self.docserver = None
             self.serving = False
             self.url = None
 
diff --git a/Misc/NEWS.d/next/Library/2017-08-21-12-31-53.bpo-31238.Gg0LRH.rst b/Misc/NEWS.d/next/Library/2017-08-21-12-31-53.bpo-31238.Gg0LRH.rst
@@ -0,0 +1,3 @@
+pydoc: the stop() method of the private ServerThread class now waits until
+DocServer.serve_until_quit() completes and then explicitly sets its
+docserver attribute to None to break a reference cycle.

Original file line number	Diff line number	Diff line change
`@@ -0,0 +1,3 @@`
	`1`	`+pydoc: the stop() method of the private ServerThread class now waits until`
	`2`	`+DocServer.serve_until_quit() completes and then explicitly sets its`
	`3`	`+docserver attribute to None to break a reference cycle.`