[3.13] gh-118789: Restore hidden _PyWeakref_ClearRef (GH-118797) (GH-118903)

miss-islington · colesbury · web-flow · commit bb5bf2422618 · 2024-05-10T14:20:22.000Z
gh-118789: Restore hidden `_PyWeakref_ClearRef` (GH-118797) _PyWeakref_ClearRef was previously exposed in the public C-API, although it begins with an underscore and is not documented. It's used by a few C-API extensions. There is currently no alternative public API that can replace its use. _PyWeakref_ClearWeakRefsExceptCallbacks is the only thread-safe way to use _PyWeakref_ClearRef in the free-threaded build. This exposes the C symbol, but does not make the API public. (cherry picked from commit db5af7d) Co-authored-by: Sam Gross <colesbury@gmail.com>
diff --git a/Include/cpython/weakrefobject.h b/Include/cpython/weakrefobject.h
@@ -40,6 +40,8 @@ struct _PyWeakReference {
 #endif
 };
 
+PyAPI_FUNC(void) _PyWeakref_ClearRef(PyWeakReference *self);
+
 Py_DEPRECATED(3.13) static inline PyObject* PyWeakref_GET_OBJECT(PyObject *ref_obj)
 {
     PyWeakReference *ref;
diff --git a/Include/internal/pycore_weakref.h b/Include/internal/pycore_weakref.h
@@ -111,8 +111,6 @@ extern Py_ssize_t _PyWeakref_GetWeakrefCount(PyObject *obj);
 // intact.
 extern void _PyWeakref_ClearWeakRefsExceptCallbacks(PyObject *obj);
 
-extern void _PyWeakref_ClearRef(PyWeakReference *self);
-
 PyAPI_FUNC(int) _PyWeakref_IsDead(PyObject *weakref);
 
 #ifdef __cplusplus
diff --git a/Misc/NEWS.d/next/C API/2024-05-08-20-13-00.gh-issue-118789.m88uUa.rst b/Misc/NEWS.d/next/C API/2024-05-08-20-13-00.gh-issue-118789.m88uUa.rst
@@ -0,0 +1,2 @@
+Restore ``_PyWeakref_ClearRef`` that was previously removed in Python 3.13
+alpha 1.

Original file line number	Diff line number	Diff line change
`@@ -40,6 +40,8 @@ struct _PyWeakReference {`
`40`	`40`	`#endif`
`41`	`41`	`};`
`42`	`42`
	`43`	`+PyAPI_FUNC(void) _PyWeakref_ClearRef(PyWeakReference *self);`
	`44`	`+`
`43`	`45`	`Py_DEPRECATED(3.13) static inline PyObject* PyWeakref_GET_OBJECT(PyObject *ref_obj)`
`44`	`46`	`{`
`45`	`47`	`PyWeakReference *ref;`
Original file line number	Diff line number	Diff line change
`@@ -0,0 +1,2 @@`
	`1`	+Restore ``_PyWeakref_ClearRef`` that was previously removed in Python 3.13
	`2`	`+alpha 1.`