gh-139852: Add PyObject_GetDictPtr() function by vstinner · Pull Request #139854 · python/cpython · GitHub
Skip to content
Closed
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
29 changes: 24 additions & 5 deletions Doc/c-api/object.rst
8 changes: 8 additions & 0 deletions Doc/whatsnew/3.15.rst
Original file line number Diff line number Diff line change
Expand Up @@ -852,6 +852,10 @@ New features

(Contributed by Victor Stinner in :gh:`129813`.)

* Add :c:type:`PyObject_GetDictPtr` function to get a pointer to
:py:attr:`~object.__dict__` of an object.
(Contributed by Victor Stinner in :gh:`139852`.)


Porting to Python 3.15
----------------------
Expand Down Expand Up @@ -912,6 +916,10 @@ Deprecated C APIs
since 3.15 and will be removed in 3.17.
(Contributed by Nikita Sobolev in :gh:`136355`.)

* Deprecate private :c:func:`_PyObject_GetDictPtr` function:
use public :c:func:`PyObject_GetDictPtr` instead.
(Contributed by Victor Stinner in :gh:`139852`.)


.. Add C API deprecations above alphabetically, not here at the end.

Expand Down
1 change: 1 addition & 0 deletions Include/cpython/object.h
Original file line number Diff line number Diff line change
Expand Up @@ -299,6 +299,7 @@ PyAPI_FUNC(void) _PyObject_Dump(PyObject *);

PyAPI_FUNC(PyObject*) _PyObject_GetAttrId(PyObject *, _Py_Identifier *);

PyAPI_FUNC(int) PyObject_GetDictPtr(PyObject *obj, PyObject ***dict_ptr);
PyAPI_FUNC(PyObject **) _PyObject_GetDictPtr(PyObject *);
PyAPI_FUNC(void) PyObject_CallFinalizer(PyObject *);
PyAPI_FUNC(int) PyObject_CallFinalizerFromDealloc(PyObject *);
Expand Down
19 changes: 19 additions & 0 deletions Lib/test/test_capi/test_object.py
Original file line number Diff line number Diff line change
Expand Up @@ -247,5 +247,24 @@ def func(x):

func(object())

def test_object_getdictptr(self):
object_getdictptr = _testcapi.object_getdictptr

class MyClass:
pass
obj = MyClass()
obj.attr = 123

dict1 = object_getdictptr(obj)
dict2 = obj.__dict__
self.assertIs(dict1, dict2)

class NoDict:
__slots__ = ()
obj = NoDict()

self.assertEqual(object_getdictptr(obj), AttributeError)


if __name__ == "__main__":
unittest.main()
Original file line number Diff line number Diff line change
@@ -0,0 +1,2 @@
Add :c:type:`PyObject_GetDictPtr` function to get a pointer to
:py:attr:`~object.__dict__` of an object. Patch by Victor Stinner.
Original file line number Diff line number Diff line change
@@ -0,0 +1,2 @@
Deprecate private :c:func:`_PyObject_GetDictPtr` function: use public
:c:func:`PyObject_GetDictPtr` instead.
23 changes: 23 additions & 0 deletions Modules/_testcapi/object.c
Original file line number Diff line number Diff line change
Expand Up @@ -485,6 +485,28 @@ is_uniquely_referenced(PyObject *self, PyObject *op)
}


static PyObject *
object_getdictptr(PyObject *self, PyObject *obj)
{
NULLABLE(obj);

PyObject **dict_ptr = UNINITIALIZED_PTR;
switch (PyObject_GetDictPtr(obj, &dict_ptr)) {
case -1:
assert(dict_ptr == NULL);
return NULL;
case 0:
assert(dict_ptr == NULL);
return Py_NewRef(PyExc_AttributeError);
case 1:
return Py_NewRef(*dict_ptr);
default:
Py_FatalError("PyObject_GetDictPtr() returned invalid code");
Py_UNREACHABLE();
}
}


static PyMethodDef test_methods[] = {
{"call_pyobject_print", call_pyobject_print, METH_VARARGS},
{"pyobject_print_null", pyobject_print_null, METH_VARARGS},
Expand All @@ -511,6 +533,7 @@ static PyMethodDef test_methods[] = {
{"test_py_is_funcs", test_py_is_funcs, METH_NOARGS},
{"clear_managed_dict", clear_managed_dict, METH_O, NULL},
{"is_uniquely_referenced", is_uniquely_referenced, METH_O},
{"object_getdictptr", object_getdictptr, METH_O},
{NULL},
};

Expand Down
37 changes: 26 additions & 11 deletions Objects/object.c