[Python-checkins] [3.11] GH-92678: Expose managed dict clear and visit functions (GH-95246). (#95256)

[pablogsal]

https://github.com/python/cpython/commit/7f731943393d57cf26ed5f2353e6e53084cd55fd
commit: 7f731943393d57cf26ed5f2353e6e53084cd55fd
branch: 3.11
author: Pablo Galindo Salgado <Pablogsal at gmail.com>
committer: pablogsal <Pablogsal at gmail.com>
date: 2022-07-25T23:05:27+01:00
summary:

[3.11] GH-92678: Expose managed dict clear and visit functions (GH-95246). (#95256)

Co-authored-by: Mark Shannon <mark at hotpy.org>

files:
A Misc/NEWS.d/next/C API/2022-07-25-15-54-27.gh-issue-92678.ziZpxz.rst
M Include/cpython/dictobject.h
M Lib/test/test_capi.py
M Modules/_testcapimodule.c
M Objects/dictobject.c

diff --git a/Include/cpython/dictobject.h b/Include/cpython/dictobject.h
index 033eaeb4c9751..b586f75281b62 100644
--- a/Include/cpython/dictobject.h
+++ b/Include/cpython/dictobject.h
@@ -76,3 +76,6 @@ typedef struct {
 
 PyAPI_FUNC(PyObject *) _PyDictView_New(PyObject *, PyTypeObject *);
 PyAPI_FUNC(PyObject *) _PyDictView_Intersect(PyObject* self, PyObject *other);
+
+PyAPI_FUNC(int) _PyObject_VisitManagedDict(PyObject *self, visitproc visit, void *arg);
+PyAPI_FUNC(void) _PyObject_ClearManagedDict(PyObject *self);
diff --git a/Lib/test/test_capi.py b/Lib/test/test_capi.py
index 904ae9bc47ecf..fba78fa443955 100644
--- a/Lib/test/test_capi.py
+++ b/Lib/test/test_capi.py
@@ -705,6 +705,20 @@ def test_export_symbols(self):
             with self.subTest(name=name):
                 self.assertTrue(hasattr(ctypes.pythonapi, name))
 
+    def test_clear_managed_dict(self):
+
+        class C:
+            def __init__(self):
+                self.a = 1
+
+        c = C()
+        _testcapi.clear_managed_dict(c)
+        self.assertEqual(c.__dict__, {})
+        c = C()
+        self.assertEqual(c.__dict__, {'a':1})
+        _testcapi.clear_managed_dict(c)
+        self.assertEqual(c.__dict__, {})
+
 
 class TestPendingCalls(unittest.TestCase):
 
diff --git a/Misc/NEWS.d/next/C API/2022-07-25-15-54-27.gh-issue-92678.ziZpxz.rst b/Misc/NEWS.d/next/C API/2022-07-25-15-54-27.gh-issue-92678.ziZpxz.rst
new file mode 100644
index 0000000000000..52473c9dfab94
--- /dev/null
+++ b/Misc/NEWS.d/next/C API/2022-07-25-15-54-27.gh-issue-92678.ziZpxz.rst	
@@ -0,0 +1,3 @@
+Adds unstable C-API functions ``_PyObject_VisitManagedDict`` and
+``_PyObject_ClearManagedDict`` to allow C extensions to allow the VM to
+manage their object's dictionaries.
diff --git a/Modules/_testcapimodule.c b/Modules/_testcapimodule.c
index 9aa7fcacb86cb..9022ee4d49a83 100644
--- a/Modules/_testcapimodule.c
+++ b/Modules/_testcapimodule.c
@@ -6014,6 +6014,14 @@ settrace_to_record(PyObject *self, PyObject *list)
     Py_RETURN_NONE;
 }
 
+static PyObject *
+clear_managed_dict(PyObject *self, PyObject *obj)
+{
+    _PyObject_ClearManagedDict(obj);
+    Py_RETURN_NONE;
+}
+
+
 static PyObject *negative_dictoffset(PyObject *, PyObject *);
 static PyObject *test_buildvalue_issue38913(PyObject *, PyObject *);
 static PyObject *getargs_s_hash_int(PyObject *, PyObject *, PyObject*);
@@ -6315,6 +6323,7 @@ static PyMethodDef TestMethods[] = {
     {"get_feature_macros", get_feature_macros, METH_NOARGS, NULL},
     {"test_code_api", test_code_api, METH_NOARGS, NULL},
     {"settrace_to_record", settrace_to_record, METH_O, NULL},
+    {"clear_managed_dict", clear_managed_dict, METH_O, NULL},
     {NULL, NULL} /* sentinel */
 };
 
diff --git a/Objects/dictobject.c b/Objects/dictobject.c
index ebbd22ee7c145..25e191fb8eadb 100644
--- a/Objects/dictobject.c
+++ b/Objects/dictobject.c
@@ -5583,6 +5583,35 @@ _PyObject_FreeInstanceAttributes(PyObject *self)
     free_values(*values_ptr);
 }
 
+int
+_PyObject_VisitManagedDict(PyObject *self, visitproc visit, void *arg)
+{
+    PyTypeObject *tp = Py_TYPE(self);
+    if((tp->tp_flags & Py_TPFLAGS_MANAGED_DICT) == 0) {
+        return 0;
+    }
+    assert(tp->tp_dictoffset);
+    int err = _PyObject_VisitInstanceAttributes(self, visit, arg);
+    if (err) {
+        return err;
+    }
+    Py_VISIT(*_PyObject_ManagedDictPointer(self));
+    return 0;
+}
+
+
+void
+_PyObject_ClearManagedDict(PyObject *self)
+{
+    PyTypeObject *tp = Py_TYPE(self);
+    if((tp->tp_flags & Py_TPFLAGS_MANAGED_DICT) == 0) {
+        return;
+    }
+    _PyObject_FreeInstanceAttributes(self);
+    *_PyObject_ValuesPointer(self) = NULL;
+    Py_CLEAR(*_PyObject_ManagedDictPointer(self));
+}
+
 PyObject *
 PyObject_GenericGetDict(PyObject *obj, void *context)
 {