FazBrowse GitHub Viewer | Trending |
URL:
| Home
Tools: [Download Repo ZIP]   [Original HTTPS Page]

bpo-44584: Deprecate PYTHONTHREADDEBUG env var (GH-27065) · python/cpython@4d77691 · GitHub

/ cpython Public

Commit 4d77691

Browse files
vstinner
authored
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.
1 parent 938e84b commit 4d77691

7 files changed

Lines changed: 49 additions & 1 deletion

File tree

‎Doc/using/cmdline.rst‎

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -962,10 +962,12 @@ Debug-mode variables
962962

963963
.. envvar:: PYTHONTHREADDEBUG
964964

965-
If set, Python will print threading debug info.
965+
If set, Python will print threading debug info into stdout.
966966

967967
Need a :ref:`debug build of Python <debug-build>`.
968968

969+
.. deprecated-removed:: 3.10 3.12
970+
969971

970972
.. envvar:: PYTHONDUMPREFS
971973

‎Doc/whatsnew/3.10.rst‎

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1691,6 +1691,11 @@ Deprecated
16911691
* NPN features like :meth:`ssl.SSLSocket.selected_npn_protocol` and
16921692
:meth:`ssl.SSLContext.set_npn_protocols` are replaced by ALPN.
16931693
1694+
* The threading debug (:envvar:`PYTHONTHREADDEBUG` environment variable) is
1695+
deprecated in Python 3.10 and will be removed in Python 3.12. This feature
1696+
requires a :ref:`debug build of Python <debug-build>`.
1697+
(Contributed by Victor Stinner in :issue:`44584`.)
1698+
16941699
.. _whatsnew310-removed:
16951700
16961701
Removed

‎Lib/test/test_threading.py‎

Lines changed: 13 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -32,6 +32,9 @@
3232
# on platforms known to behave badly.
3333
platforms_to_skip = ('netbsd5', 'hp-ux11')
3434

35+
# Is Python built with Py_DEBUG macro defined?
36+
Py_DEBUG = hasattr(sys, 'gettotalrefcount')
37+
3538

3639
def restore_default_excepthook(testcase):
3740
testcase.addCleanup(setattr, threading, 'excepthook', threading.excepthook)
@@ -915,6 +918,16 @@ def noop(): pass
915918
threading.Thread(target=noop).start()
916919
# Thread.join() is not called
917920

921+
@unittest.skipUnless(Py_DEBUG, 'need debug build (Py_DEBUG)')
922+
def test_debug_deprecation(self):
923+
# bpo-44584: The PYTHONTHREADDEBUG environment variable is deprecated
924+
rc, out, err = assert_python_ok("-Wdefault", "-c", "pass",
925+
PYTHONTHREADDEBUG="1")
926+
msg = (b'DeprecationWarning: The threading debug '
927+
b'(PYTHONTHREADDEBUG environment variable) '
928+
b'is deprecated and will be removed in Python 3.12')
929+
self.assertIn(msg, err)
930+
918931

919932
class ThreadJoinOnShutdown(BaseTestCase):
920933

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

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,3 @@
1+
The threading debug (:envvar:`PYTHONTHREADDEBUG` environment variable) is
2+
deprecated in Python 3.10 and will be removed in Python 3.12. This feature
3+
requires a debug build of Python. Patch by Victor Stinner.

‎Misc/python.man‎

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -550,6 +550,7 @@ if Python was configured with the
550550
\fB\--with-pydebug\fP build option.
551551
.IP PYTHONTHREADDEBUG
552552
If this environment variable is set, Python will print threading debug info.
553+
The feature is deprecated in Python 3.10 and will be removed in Python 3.12.
553554
.IP PYTHONDUMPREFS
554555
If this environment variable is set, Python will dump objects and reference
555556
counts still alive after shutting down the interpreter.

‎Python/pylifecycle.c‎

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1057,6 +1057,8 @@ pyinit_main_reconfigure(PyThreadState *tstate)
10571057
static PyStatus
10581058
init_interp_main(PyThreadState *tstate)
10591059
{
1060+
extern void _PyThread_debug_deprecation(void);
1061+
10601062
assert(!_PyErr_Occurred(tstate));
10611063

10621064
PyStatus status;
@@ -1158,6 +1160,9 @@ init_interp_main(PyThreadState *tstate)
11581160
#endif
11591161
}
11601162

1163+
// Warn about PYTHONTHREADDEBUG deprecation
1164+
_PyThread_debug_deprecation();
1165+
11611166
assert(!_PyErr_Occurred(tstate));
11621167

11631168
return _PyStatus_OK();

‎Python/thread.c‎

Lines changed: 19 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -75,6 +75,25 @@ PyThread_init_thread(void)
7575
PyThread__init_thread();
7676
}
7777

78+
void
79+
_PyThread_debug_deprecation(void)
80+
{
81+
#ifdef Py_DEBUG
82+
if (thread_debug) {
83+
// Flush previous dprintf() logs
84+
fflush(stdout);
85+
if (PyErr_WarnEx(PyExc_DeprecationWarning,
86+
"The threading debug (PYTHONTHREADDEBUG environment "
87+
"variable) is deprecated and will be removed "
88+
"in Python 3.12",
89+
0))
90+
{
91+
_PyErr_WriteUnraisableMsg("at Python startup", NULL);
92+
}
93+
}
94+
#endif
95+
}
96+
7897
#if defined(_POSIX_THREADS)
7998
# define PYTHREAD_NAME "pthread"
8099
# include "thread_pthread.h"

0 commit comments

Comments
 (0)
Back | FazBrowse Home | New Git URL