bpo-44584: Deprecate PYTHONTHREADDEBUG env var (GH-27065)

The threading debug (PYTHONTHREADDEBUG environment variable) is deprecated in Python 3.10 and will be removed in Python 3.12. This feature requires a debug build of Python.

Author: vstinner

Doc/using/cmdline.rst

@@ -962,10 +962,12 @@ Debug-mode variables
 
 .. envvar:: PYTHONTHREADDEBUG
 
- If set, Python will print threading debug info.
+ If set, Python will print threading debug info into stdout.
 
  Need a :ref:`debug build of Python <debug-build>`.
 
+ .. deprecated-removed:: 3.10 3.12
+
 
 .. envvar:: PYTHONDUMPREFS
 

Doc/whatsnew/3.10.rst

@@ -1691,6 +1691,11 @@ Deprecated
  * NPN features like :meth:`ssl.SSLSocket.selected_npn_protocol` and
  :meth:`ssl.SSLContext.set_npn_protocols` are replaced by ALPN.
 
+* The threading debug (:envvar:`PYTHONTHREADDEBUG` environment variable) is
+ deprecated in Python 3.10 and will be removed in Python 3.12. This feature
+ requires a :ref:`debug build of Python <debug-build>`.
+ (Contributed by Victor Stinner in :issue:`44584`.)
+
 .. _whatsnew310-removed:
 
 Removed

Lib/test/test_threading.py

@@ -32,6 +32,9 @@
 # on platforms known to behave badly.
 platforms_to_skip = ('netbsd5', 'hp-ux11')
 
+# Is Python built with Py_DEBUG macro defined?
+Py_DEBUG = hasattr(sys, 'gettotalrefcount')
+
 
 def restore_default_excepthook(testcase):
  testcase.addCleanup(setattr, threading, 'excepthook', threading.excepthook)
@@ -915,6 +918,16 @@ def noop(): pass
  threading.Thread(target=noop).start()
  # Thread.join() is not called
 
+ @unittest.skipUnless(Py_DEBUG, 'need debug build (Py_DEBUG)')
+ def test_debug_deprecation(self):
+ # bpo-44584: The PYTHONTHREADDEBUG environment variable is deprecated
+ rc, out, err = assert_python_ok("-Wdefault", "-c", "pass",
+ PYTHONTHREADDEBUG="1")
+ msg = (b'DeprecationWarning: The threading debug '
+ b'(PYTHONTHREADDEBUG environment variable) '
+ b'is deprecated and will be removed in Python 3.12')
+ self.assertIn(msg, err)
+
 
 class ThreadJoinOnShutdown(BaseTestCase):
 

Misc/NEWS.d/next/Core and Builtins/2021-07-08-12-18-56.bpo-44584.qKnSqV.rst

@@ -0,0 +1,3 @@
+The threading debug (:envvar:`PYTHONTHREADDEBUG` environment variable) is
+deprecated in Python 3.10 and will be removed in Python 3.12. This feature
+requires a debug build of Python. Patch by Victor Stinner.

Misc/python.man

@@ -550,6 +550,7 @@ if Python was configured with the
 \fB\--with-pydebug\fP build option.
 .IP PYTHONTHREADDEBUG
 If this environment variable is set, Python will print threading debug info.
+The feature is deprecated in Python 3.10 and will be removed in Python 3.12.
 .IP PYTHONDUMPREFS
 If this environment variable is set, Python will dump objects and reference
 counts still alive after shutting down the interpreter.

Python/pylifecycle.c

@@ -1057,6 +1057,8 @@ pyinit_main_reconfigure(PyThreadState *tstate)
 static PyStatus
 init_interp_main(PyThreadState *tstate)
 {
+ extern void _PyThread_debug_deprecation(void);
+
  assert(!_PyErr_Occurred(tstate));
 
  PyStatus status;
@@ -1158,6 +1160,9 @@ init_interp_main(PyThreadState *tstate)
 #endif
  }
 
+ // Warn about PYTHONTHREADDEBUG deprecation
+ _PyThread_debug_deprecation();
+
  assert(!_PyErr_Occurred(tstate));
 
  return _PyStatus_OK();

Python/thread.c

@@ -75,6 +75,25 @@ PyThread_init_thread(void)
  PyThread__init_thread();
 }
 
+void
+_PyThread_debug_deprecation(void)
+{
+#ifdef Py_DEBUG
+ if (thread_debug) {
+ // Flush previous dprintf() logs
+ fflush(stdout);
+ if (PyErr_WarnEx(PyExc_DeprecationWarning,
+ "The threading debug (PYTHONTHREADDEBUG environment "
+ "variable) is deprecated and will be removed "
+ "in Python 3.12",
+ 0))
+ {
+ _PyErr_WriteUnraisableMsg("at Python startup", NULL);
+ }
+ }
+#endif
+}
+
 #if defined(_POSIX_THREADS)
 # define PYTHREAD_NAME "pthread"
 # include "thread_pthread.h"