Add PyThreadState_EnterTracing()

* runtests.py: add Python 3.11
* GitHub Action: add "nightly" version

Author: vstinner

.github/workflows/build.yml

@@ -13,7 +13,17 @@ jobs:
       matrix:
         os: [ubuntu-latest]
         # 2020-03-30: use "3.10.0-alpha - 3.10" to get Python 3.10 alpha
-        python: [2.7, 3.5, 3.6, 3.7, 3.8, 3.9, "3.10.0-alpha - 3.10", "pypy2", "pypy3"]
+        python:
+          - "2.7"
+          - "3.5"
+          - "3.6"
+          - "3.7"
+          - "3.8"
+          - "3.9"
+          - "3.10"
+          - "nightly"
+          - "pypy2"
+          - "pypy3"
         include:
           - os: windows-latest
             python: 3.6

README.rst

@@ -156,7 +156,20 @@ Upgrade Operations
 pythoncapi_compat.h functions
 =============================
 
-Some functions related to frame objects are not available on PyPy.
+Some functions related to frame objects and ``PyThreadState`` are not available
+on PyPy.
+
+Python 3.11
+-----------
+
+::
+
+    // Not available on PyPy
+    int PyThreadState_IsTracing(PyThreadState *tstate);
+    // Not available on PyPy
+    void PyThreadState_EnterTracing(PyThreadState *tstate);
+    // Not available on PyPy
+    void PyThreadState_LeaveTracing(PyThreadState *tstate);
 
 Python 3.10
 -----------
@@ -337,6 +350,8 @@ Links
 Changelog
 =========
 
+* 2021-10-15: Add PyThreadState_EnterTracing(), PyThreadState_LeaveTracing()
+  and PyThreadState_IsTracing().
 * 2021-04-09: Add Py_Is(), Py_IsNone(), Py_IsTrue(), Py_IsFalse() functions.
 * 2021-04-01:
 

pythoncapi_compat.h

@@ -251,6 +251,46 @@ PyThreadState_GetID(PyThreadState *tstate)
 }
 #endif
 
+// bpo-43760 added PyThreadState_IsTracing() to Python 3.11.0a2
+#if PY_VERSION_HEX < 0x030B00A2 && !defined(PYPY_VERSION)
+static inline int PyThreadState_IsTracing(PyThreadState *tstate)
+{
+#if PY_VERSION_HEX >= 0x030A00A1
+    return (tstate->cframe->use_tracing != 0);
+#else
+    return (tstate->use_tracing != 0);
+#endif
+}
+#endif
+
+// bpo-43760 added PyThreadState_EnterTracing() to Python 3.11.0a2
+#if PY_VERSION_HEX < 0x030B00A2 && !defined(PYPY_VERSION)
+static inline void PyThreadState_EnterTracing(PyThreadState *tstate)
+{
+    tstate->tracing++;
+#if PY_VERSION_HEX >= 0x030A00A1
+    tstate->cframe->use_tracing = 0;
+#else
+    tstate->use_tracing = 0;
+#endif
+}
+#endif
+
+// bpo-43760 added PyThreadState_LeaveTracing() to Python 3.11.0a2
+#if PY_VERSION_HEX < 0x030B00A2 && !defined(PYPY_VERSION)
+static inline void PyThreadState_LeaveTracing(PyThreadState *tstate)
+{
+    tstate->tracing--;
+    int use_tracing = (tstate->c_tracefunc != NULL
+                       || tstate->c_profilefunc != NULL);
+#if PY_VERSION_HEX >= 0x030A00A1
+    tstate->cframe->use_tracing = use_tracing;
+#else
+    tstate->use_tracing = use_tracing;
+#endif
+}
+#endif
+
 
 // bpo-37194 added PyObject_CallNoArgs() to Python 3.9.0a1
 #if PY_VERSION_HEX < 0x030900A1

runtests.py

@@ -37,6 +37,7 @@
     "python3.8",
     "python3.9",
     "python3.10",
+    "python3.11",
     "python3",
     "python3-debug",
     "pypy",

tests/test_pythoncapi_compat_cext.c

@@ -228,6 +228,14 @@ test_thread_state(PyObject *Py_UNUSED(module), PyObject* Py_UNUSED(ignored))
     assert(id > 0);
 #endif
 
+#if !defined(PYPY_VERSION)
+    // PyThreadState_IsTracing(), PyThreadState_EnterTracing(),
+    // PyThreadState_LeaveTracing()
+    PyThreadState_EnterTracing(tstate);
+    assert(PyThreadState_IsTracing(tstate) == 0);
+    PyThreadState_LeaveTracing(tstate);
+#endif
+
     Py_RETURN_NONE;
 }