[Python-checkins] bpo-31238: pydoc ServerThread.stop() now joins itself (GH-3151) (GH-7324)

Fri Jun 1 13:39:20 EDT 2018

https://github.com/python/cpython/commit/f3297433e309e9591eaa3f36e1d7887e9d0620d7
commit: f3297433e309e9591eaa3f36e1d7887e9d0620d7
branch: 3.6
author: Victor Stinner <vstinner at redhat.com>
committer: GitHub <noreply at github.com>
date: 2018年06月01日T19:39:16+02:00
summary:
bpo-31238: pydoc ServerThread.stop() now joins itself (GH-3151) (GH-7324)
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.
(cherry picked from commit 4cab2cd0c05fcda5fcb128c9eb230253fff88c21)
files:
A Misc/NEWS.d/next/Library/2017-08-21-12-31-53.bpo-31238.Gg0LRH.rst
M Lib/pydoc.py

diff --git a/Lib/pydoc.py b/Lib/pydoc.py
index 40ee76044089..8c707540030b 100644
--- a/Lib/pydoc.py
+++ b/Lib/pydoc.py
@@ -2273,6 +2273,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
new file mode 100644
index 000000000000..3e1cd1301003
--- /dev/null
+++ 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.
