Deprecate backend_webagg.ServerThread.

anntzer · chahak13 · commit 0632fbd7374b · 2022-10-18T13:37:27.000-05:00
It is clearly just for internal use, can be replaced by a plain
Thread(target=...), and removing it gets rid of a large block in the
webagg api docs that just restates the standard Thread docstring.
diff --git a/doc/api/next_api_changes/deprecations/24208-AL.rst b/doc/api/next_api_changes/deprecations/24208-AL.rst
@@ -0,0 +1,3 @@
+``backend_webagg.ServerThread`` is deprecated
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+... with no replacement.
diff --git a/lib/matplotlib/backends/backend_webagg.py b/lib/matplotlib/backends/backend_webagg.py
@@ -40,12 +40,14 @@
     TimerAsyncio, TimerTornado)
 
 
+@mpl._api.deprecated("3.7")
 class ServerThread(threading.Thread):
     def run(self):
         tornado.ioloop.IOLoop.instance().start()
 
 
-webagg_server_thread = ServerThread()
+webagg_server_thread = threading.Thread(
+    target=lambda: tornado.ioloop.IOLoop.instance().start())
 
 
 class FigureManagerWebAgg(core.FigureManagerWebAgg):

Original file line number	Diff line number	Diff line change
`@@ -0,0 +1,3 @@`
	`1`	+``backend_webagg.ServerThread`` is deprecated
	`2`	`+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~`
	`3`	`+... with no replacement.`