Use a separate API

pablogsal · pablogsal · commit 6ecc7b134476 · 2022-08-04T15:11:37.000+01:00
diff --git a/Doc/library/threading.rst b/Doc/library/threading.rst
@@ -138,19 +138,23 @@ This module defines the following functions:
    .. versionadded:: 3.4
 
 
-.. function:: settrace(func, *, running_threads=False)
+.. function:: settrace(func)
 
    .. index:: single: trace function
 
    Set a trace function for all threads started from the :mod:`threading` module.
    The *func* will be passed to  :func:`sys.settrace` for each thread, before its
    :meth:`~Thread.run` method is called.
 
-   If *running_threads* is set, the tracing function will be installed in all running
-   threads.
+.. function:: settrace_all_threads(func)
 
-   .. versionchanged:: 3.12
-      The *running_threads* parameter was added.
+   Set a trace function for all threads started from the :mod:`threading` module
+   and all Python threads that are currently executing.
+
+   The *func* will be passed to  :func:`sys.settrace` for each thread, before its
+   :meth:`~Thread.run` method is called.
+
+   .. versionadded:: 3.12
 
 .. function:: gettrace()
 
@@ -163,19 +167,23 @@ This module defines the following functions:
    .. versionadded:: 3.10
 
 
-.. function:: setprofile(func, *, running_threads=False)
+.. function:: setprofile(func)
 
    .. index:: single: profile function
 
    Set a profile function for all threads started from the :mod:`threading` module.
    The *func* will be passed to  :func:`sys.setprofile` for each thread, before its
    :meth:`~Thread.run` method is called.
 
-   If *running_threads* is set, the profile function will be installed in all running
-   threads.
+.. function:: setprofile_all_threads(func)
+
+   Set a profile function for all threads started from the :mod:`threading` module
+   and all Python threads that are currently executing.
+
+   The *func* will be passed to  :func:`sys.setprofile` for each thread, before its
+   :meth:`~Thread.run` method is called.
 
-   .. versionchanged:: 3.12
-      The *running_threads* parameter was added.
+   .. versionadded:: 3.12
 
 .. function:: getprofile()
 
diff --git a/Lib/test/test_threading.py b/Lib/test/test_threading.py
@@ -853,6 +853,7 @@ def callback():
                 callback()
         finally:
             sys.settrace(old_trace)
+            threading.settrace(old_trace)
 
     def test_gettrace(self):
         def noop_trace(frame, event, arg):
@@ -883,14 +884,15 @@ def checker():
             t = threading.Thread(target=checker)
             t.start()
             first_check.wait()
-            threading.settrace(fn, running_threads=True)
+            threading.settrace_all_threads(fn)
             second_check.set()
             t.join()
             self.assertEqual(trace_funcs, [None, fn])
             self.assertEqual(threading.gettrace(), fn)
             self.assertEqual(sys.gettrace(), fn)
         finally:
-            threading.settrace(old_trace, running_threads=True)
+            threading.settrace_all_threads(old_trace)
+
         self.assertEqual(threading.gettrace(), old_trace)
         self.assertEqual(sys.gettrace(), old_trace)
 
@@ -920,14 +922,14 @@ def checker():
             t = threading.Thread(target=checker)
             t.start()
             first_check.wait()
-            threading.setprofile(fn, running_threads=True)
+            threading.setprofile_all_threads(fn)
             second_check.set()
             t.join()
             self.assertEqual(profile_funcs, [None, fn])
             self.assertEqual(threading.getprofile(), fn)
             self.assertEqual(sys.getprofile(), fn)
         finally:
-            threading.setprofile(old_profile, running_threads=True)
+            threading.setprofile_all_threads(old_profile)
 
         self.assertEqual(threading.getprofile(), old_profile)
         self.assertEqual(sys.getprofile(), old_profile)
diff --git a/Lib/threading.py b/Lib/threading.py
@@ -28,7 +28,8 @@
            'Event', 'Lock', 'RLock', 'Semaphore', 'BoundedSemaphore', 'Thread',
            'Barrier', 'BrokenBarrierError', 'Timer', 'ThreadError',
            'setprofile', 'settrace', 'local', 'stack_size',
-           'excepthook', 'ExceptHookArgs', 'gettrace', 'getprofile']
+           'excepthook', 'ExceptHookArgs', 'gettrace', 'getprofile',
+           'setprofile_all_threads','settrace_all_threads']
 
 # Rename some stuff so "from threading import *" is safe
 _start_new_thread = _thread.start_new_thread
@@ -55,39 +56,47 @@
 _profile_hook = None
 _trace_hook = None
 
-def setprofile(func, *, running_threads=False):
+def setprofile(func):
     """Set a profile function for all threads started from the threading module.
 
     The func will be passed to sys.setprofile() for each thread, before its
     run() method is called.
-
-    If running_threads is set, the profile function will be installed in all running
-    threads.
     """
     global _profile_hook
     _profile_hook = func
 
-    if running_threads:
-        _sys._setprofileallthreads(func)
+def setprofile_all_threads(func):
+    """Set a profile function for all threads started from the threading module
+    and all Python threads that are currently executing.
+
+    The func will be passed to sys.setprofile() for each thread, before its
+    run() method is called.
+    """
+    setprofile(func)
+    _sys._setprofileallthreads(func)
 
 def getprofile():
     """Get the profiler function as set by threading.setprofile()."""
     return _profile_hook
 
-def settrace(func, *, running_threads=False):
+def settrace(func):
     """Set a trace function for all threads started from the threading module.
 
     The func will be passed to sys.settrace() for each thread, before its run()
     method is called.
-
-    If running_threads is set, the trace function will be installed in all running
-    threads.
     """
     global _trace_hook
     _trace_hook = func
 
-    if running_threads:
-        _sys._settraceallthreads(func)
+def settrace_all_threads(func):
+    """Set a trace function for all threads started from the threading module
+    and all Python threads that are currently executing.
+
+    The func will be passed to sys.settrace() for each thread, before its run()
+    method is called.
+    """
+    settrace(func)
+    _sys._settraceallthreads(func)
 
 def gettrace():
     """Get the trace function as set by threading.settrace()."""
