From e7c0b46e31b827b8560f55f30f3a12efe2ff97ec Mon Sep 17 00:00:00 2001 From: Victor Stinner Date: Sun, 15 Nov 2026 15:16:41 +0100 Subject: [PATCH] gh-162047: Add PyFrozenDict_New() to the limited C API Add PEP 814 frozendict functions to the limited C API: * PyAnyDict_Check() * PyAnyDict_CheckExact() * PyFrozenDict_Check() * PyFrozenDict_CheckExact() * PyFrozenDict_New() Move test wrappers from _testcapi to _testlimitedcapi. --- Doc/whatsnew/3.16.rst | 10 +++++ Include/cpython/dictobject.h | 13 ------ Include/dictobject.h | 16 +++++++ Lib/test/test_capi/test_dict.py | 10 ++--- ...-11-15-15-30-40.gh-issue-162047.Zl2chW.rst | 9 ++++ Misc/stable_abi.toml | 10 +++++ Modules/_testcapi/dict.c | 42 ----------------- Modules/_testlimitedcapi/dict.c | 45 +++++++++++++++++++ 8 files changed, 95 insertions(+), 60 deletions(-) create mode 100644 Misc/NEWS.d/next/C_API/2026-11-15-15-30-40.gh-issue-162047.Zl2chW.rst diff --git a/Doc/whatsnew/3.16.rst b/Doc/whatsnew/3.16.rst index 33328b2ee005219..99cd2936b6bc032 100644 --- a/Doc/whatsnew/3.16.rst +++ b/Doc/whatsnew/3.16.rst @@ -1574,6 +1574,16 @@ New features * Add the :ref:`PyUnicodeWriter API ` to the limited C API. (Contributed by Victor Stinner in :gh:`161172`.) +* Add :pep:`814` :class:`frozendict` functions to the limited C API: + + * :c:func:`PyAnyDict_CheckExact` + * :c:func:`PyAnyDict_Check` + * :c:func:`PyFrozenDict_CheckExact` + * :c:func:`PyFrozenDict_Check` + * :c:func:`PyFrozenDict_New` + + (Contributed by Victor Stinner in :gh:`162047`.) + * Add :c:func:`PyUnstable_InterpreterFrame_GetLocal` to read a local variable of an internal interpreter frame by its localsplus index, and :c:func:`PyUnstable_Code_GetLocalPlusNames` to get the matching variable diff --git a/Include/cpython/dictobject.h b/Include/cpython/dictobject.h index 9f05890852f5e4c..b8fe2e75faa37cb 100644 --- a/Include/cpython/dictobject.h +++ b/Include/cpython/dictobject.h @@ -32,16 +32,6 @@ typedef struct { PyDictValues *ma_values; } PyDictObject; -// frozendict -PyAPI_DATA(PyTypeObject) PyFrozenDict_Type; -#define PyFrozenDict_Check(op) PyObject_TypeCheck((op), &PyFrozenDict_Type) -#define PyFrozenDict_CheckExact(op) Py_IS_TYPE((op), &PyFrozenDict_Type) - -#define PyAnyDict_CheckExact(ob) \ - (PyDict_CheckExact(ob) || PyFrozenDict_CheckExact(ob)) -#define PyAnyDict_Check(ob) \ - (PyDict_Check(ob) || PyFrozenDict_Check(ob)) - PyAPI_FUNC(PyObject *) _PyDict_GetItem_KnownHash(PyObject *mp, PyObject *key, Py_hash_t hash); // PyDict_GetItemStringRef() can be used instead @@ -104,9 +94,6 @@ PyAPI_FUNC(int) PyDict_ClearWatcher(int watcher_id); PyAPI_FUNC(int) PyDict_Watch(int watcher_id, PyObject* dict); PyAPI_FUNC(int) PyDict_Unwatch(int watcher_id, PyObject* dict); -// Create a frozendict. Create an empty dictionary if iterable is NULL. -PyAPI_FUNC(PyObject*) PyFrozenDict_New(PyObject *iterable); - // Create a frozendict from existing dict. // Transfers existing keys and values. PyAPI_FUNC(PyObject*) PyDict_AsFrozenDictAndClear(PyObject *dict); diff --git a/Include/dictobject.h b/Include/dictobject.h index 0384e3131dcdb52..f345dc3cea6f249 100644 --- a/Include/dictobject.h +++ b/Include/dictobject.h @@ -107,6 +107,22 @@ PyAPI_DATA(PyTypeObject) PyDictRevIterKey_Type; PyAPI_DATA(PyTypeObject) PyDictRevIterItem_Type; PyAPI_DATA(PyTypeObject) PyDictRevIterValue_Type; +/* Frozendict */ + +#if !defined(Py_LIMITED_API) || Py_LIMITED_API+0 >= _Py_PACK_VERSION(3, 16) +PyAPI_DATA(PyTypeObject) PyFrozenDict_Type; +#define PyFrozenDict_Check(op) PyObject_TypeCheck((op), &PyFrozenDict_Type) +#define PyFrozenDict_CheckExact(op) Py_IS_TYPE((op), &PyFrozenDict_Type) + +#define PyAnyDict_CheckExact(ob) \ + (PyDict_CheckExact(ob) || PyFrozenDict_CheckExact(ob)) +#define PyAnyDict_Check(ob) \ + (PyDict_Check(ob) || PyFrozenDict_Check(ob)) + +// Create a frozendict. Create an empty dictionary if iterable is NULL. +PyAPI_FUNC(PyObject*) PyFrozenDict_New(PyObject *iterable); +#endif // Py_LIMITED_API + #ifndef Py_LIMITED_API # define Py_CPYTHON_DICTOBJECT_H diff --git a/Lib/test/test_capi/test_dict.py b/Lib/test/test_capi/test_dict.py index 9a2e79d4da7e715..7ea63c154d91686 100644 --- a/Lib/test/test_capi/test_dict.py +++ b/Lib/test/test_capi/test_dict.py @@ -642,7 +642,7 @@ class DictSubtype(dict): ... def test_frozendict_check(self): # Test PyFrozenDict_Check() - check = _testcapi.frozendict_check + check = _testlimitedcapi.frozendict_check for dict_type in FROZENDICT_TYPES: self.assertTrue(check(dict_type(x=1))) for dict_type in NOT_FROZENDICT_TYPES + OTHER_TYPES: @@ -651,7 +651,7 @@ def test_frozendict_check(self): def test_frozendict_checkexact(self): # Test PyFrozenDict_CheckExact() - check = _testcapi.frozendict_checkexact + check = _testlimitedcapi.frozendict_checkexact for dict_type in FROZENDICT_TYPES: self.assertEqual(check(dict_type(x=1)), dict_type == frozendict) for dict_type in NOT_FROZENDICT_TYPES + OTHER_TYPES: @@ -660,7 +660,7 @@ def test_frozendict_checkexact(self): def test_anydict_check(self): # Test PyAnyDict_Check() - check = _testcapi.anydict_check + check = _testlimitedcapi.anydict_check for dict_type in ANYDICT_TYPES: self.assertTrue(check(dict_type({1: 2}))) for test_type in NOT_ANYDICT_TYPES + OTHER_TYPES: @@ -669,7 +669,7 @@ def test_anydict_check(self): def test_anydict_checkexact(self): # Test PyAnyDict_CheckExact() - check = _testcapi.anydict_checkexact + check = _testlimitedcapi.anydict_checkexact for dict_type in ANYDICT_TYPES: self.assertEqual(check(dict_type(x=1)), dict_type in (dict, frozendict)) @@ -679,7 +679,7 @@ def test_anydict_checkexact(self): def test_frozendict_new(self): # Test PyFrozenDict_New() - frozendict_new = _testcapi.frozendict_new + frozendict_new = _testlimitedcapi.frozendict_new for dict_type in ANYDICT_TYPES: dct = frozendict_new(dict_type({'x': 1})) diff --git a/Misc/NEWS.d/next/C_API/2026-11-15-15-30-40.gh-issue-162047.Zl2chW.rst b/Misc/NEWS.d/next/C_API/2026-11-15-15-30-40.gh-issue-162047.Zl2chW.rst new file mode 100644 index 000000000000000..a8809db7134b34c --- /dev/null +++ b/Misc/NEWS.d/next/C_API/2026-11-15-15-30-40.gh-issue-162047.Zl2chW.rst @@ -0,0 +1,9 @@ +Add :pep:`814` :class:`frozendict` functions to the limited C API: + +* :c:func:`PyAnyDict_CheckExact` +* :c:func:`PyAnyDict_Check` +* :c:func:`PyFrozenDict_CheckExact` +* :c:func:`PyFrozenDict_Check` +* :c:func:`PyFrozenDict_New` + +Patch by Victor Stinner. diff --git a/Misc/stable_abi.toml b/Misc/stable_abi.toml index dc892fc5f737eee..b7c15d822694f37 100644 --- a/Misc/stable_abi.toml +++ b/Misc/stable_abi.toml @@ -2941,3 +2941,13 @@ added = '3.16' [function.PyUnicodeWriter_DecodeUTF8Stateful] added = '3.16' +[macro.PyFrozenDict_Check] + added = '3.16' +[macro.PyFrozenDict_CheckExact] + added = '3.16' +[macro.PyAnyDict_CheckExact] + added = '3.16' +[macro.PyAnyDict_Check] + added = '3.16' +[function.PyFrozenDict_New] + added = '3.16' diff --git a/Modules/_testcapi/dict.c b/Modules/_testcapi/dict.c index 5e169d99c179d57..87cf9772dfc72d5 100644 --- a/Modules/_testcapi/dict.c +++ b/Modules/_testcapi/dict.c @@ -265,43 +265,6 @@ dict_as_frozendict_and_clear(PyObject *self, PyObject *obj) } -static PyObject * -frozendict_check(PyObject *self, PyObject *obj) -{ - NULLABLE(obj); - return PyLong_FromLong(PyFrozenDict_Check(obj)); -} - -static PyObject * -frozendict_checkexact(PyObject *self, PyObject *obj) -{ - NULLABLE(obj); - return PyLong_FromLong(PyFrozenDict_CheckExact(obj)); -} - -static PyObject * -anydict_check(PyObject *self, PyObject *obj) -{ - NULLABLE(obj); - return PyLong_FromLong(PyAnyDict_Check(obj)); -} - -static PyObject * -anydict_checkexact(PyObject *self, PyObject *obj) -{ - NULLABLE(obj); - return PyLong_FromLong(PyAnyDict_CheckExact(obj)); -} - - -static PyObject * -frozendict_new(PyObject *self, PyObject *obj) -{ - NULLABLE(obj); - return PyFrozenDict_New(obj); -} - - static PyMethodDef test_methods[] = { {"dict_containsstring", dict_containsstring, METH_VARARGS}, {"dict_getitemref", dict_getitemref, METH_VARARGS}, @@ -314,11 +277,6 @@ static PyMethodDef test_methods[] = { {"dict_popstring_null", dict_popstring_null, METH_VARARGS}, {"test_dict_iteration", test_dict_iteration, METH_NOARGS}, {"dict_as_frozendict_and_clear", dict_as_frozendict_and_clear, METH_O}, - {"frozendict_check", frozendict_check, METH_O}, - {"frozendict_checkexact", frozendict_checkexact, METH_O}, - {"anydict_check", anydict_check, METH_O}, - {"anydict_checkexact", anydict_checkexact, METH_O}, - {"frozendict_new", frozendict_new, METH_O}, {NULL}, }; diff --git a/Modules/_testlimitedcapi/dict.c b/Modules/_testlimitedcapi/dict.c index b9acda00897ad45..49c9a590d2803f4 100644 --- a/Modules/_testlimitedcapi/dict.c +++ b/Modules/_testlimitedcapi/dict.c @@ -1,3 +1,6 @@ +// Need limited C API version 3.16 for PyFrozenDict_New() +#define Py_LIMITED_API 0x03100000 + #include "parts.h" #include "util.h" @@ -255,6 +258,43 @@ dict_mergefromseq2(PyObject *self, PyObject *args) } +static PyObject * +frozendict_check(PyObject *self, PyObject *obj) +{ + NULLABLE(obj); + return PyLong_FromLong(PyFrozenDict_Check(obj)); +} + +static PyObject * +frozendict_checkexact(PyObject *self, PyObject *obj) +{ + NULLABLE(obj); + return PyLong_FromLong(PyFrozenDict_CheckExact(obj)); +} + +static PyObject * +anydict_check(PyObject *self, PyObject *obj) +{ + NULLABLE(obj); + return PyLong_FromLong(PyAnyDict_Check(obj)); +} + +static PyObject * +anydict_checkexact(PyObject *self, PyObject *obj) +{ + NULLABLE(obj); + return PyLong_FromLong(PyAnyDict_CheckExact(obj)); +} + + +static PyObject * +frozendict_new(PyObject *self, PyObject *obj) +{ + NULLABLE(obj); + return PyFrozenDict_New(obj); +} + + static PyMethodDef test_methods[] = { {"dict_check", dict_check, METH_O}, {"dict_checkexact", dict_checkexact, METH_O}, @@ -278,6 +318,11 @@ static PyMethodDef test_methods[] = { {"dict_merge", dict_merge, METH_VARARGS}, {"dict_update", dict_update, METH_VARARGS}, {"dict_mergefromseq2", dict_mergefromseq2, METH_VARARGS}, + {"frozendict_check", frozendict_check, METH_O}, + {"frozendict_checkexact", frozendict_checkexact, METH_O}, + {"anydict_check", anydict_check, METH_O}, + {"anydict_checkexact", anydict_checkexact, METH_O}, + {"frozendict_new", frozendict_new, METH_O}, {NULL}, };