diff --git a/Doc/data/stable_abi.dat b/Doc/data/stable_abi.dat index 5f424391519d591..5d68f90ec01b0d1 100644 --- a/Doc/data/stable_abi.dat +++ b/Doc/data/stable_abi.dat @@ -18,6 +18,8 @@ const,PyABIInfo_GIL,3.15,, const,PyABIInfo_STABLE,3.15,, macro,PyABIInfo_VAR,3.15,, function,PyAIter_Check,3.10,, +macro,PyAnyDict_Check,3.16,, +macro,PyAnyDict_CheckExact,3.16,, function,PyArg_Parse,3.2,, function,PyArg_ParseTuple,3.2,, function,PyArg_ParseTupleAndKeywords,3.2,, @@ -150,6 +152,7 @@ data,PyDictRevIterItem_Type,3.8,, data,PyDictRevIterKey_Type,3.8,, data,PyDictRevIterValue_Type,3.8,, data,PyDictValues_Type,3.2,, +function,PyDict_AsFrozenDictAndClear,3.16,, function,PyDict_Clear,3.2,, function,PyDict_Contains,3.2,, function,PyDict_Copy,3.2,, @@ -335,6 +338,10 @@ data,PyFloat_Type,3.2,, struct,PyFrameObject,3.2,,opaque function,PyFrame_GetCode,3.10,, function,PyFrame_GetLineNumber,3.10,, +macro,PyFrozenDict_Check,3.16,, +macro,PyFrozenDict_CheckExact,3.16,, +function,PyFrozenDict_New,3.16,, +data,PyFrozenDict_Type,3.16,, function,PyFrozenSet_New,3.2,, data,PyFrozenSet_Type,3.2,, function,PyGC_Collect,3.2,, diff --git a/Doc/whatsnew/3.16.rst b/Doc/whatsnew/3.16.rst index 33328b2ee005219..4af2402f651d377 100644 --- a/Doc/whatsnew/3.16.rst +++ b/Doc/whatsnew/3.16.rst @@ -1574,6 +1574,17 @@ 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:`PyDict_AsFrozenDictAndClear` + * :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..89b97588ae73084 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 @@ -103,10 +93,3 @@ PyAPI_FUNC(int) PyDict_ClearWatcher(int watcher_id); // Mark given dictionary as "watched" (callback will be called if it is modified) 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..c1a9b0bf789d082 100644 --- a/Include/dictobject.h +++ b/Include/dictobject.h @@ -107,6 +107,26 @@ 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); + +// Create a frozendict from existing dict. +// Transfers existing keys and values. +PyAPI_FUNC(PyObject*) PyDict_AsFrozenDictAndClear(PyObject *dict); +#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..2c8d6f6841eaa2f 100644 --- a/Lib/test/test_capi/test_dict.py +++ b/Lib/test/test_capi/test_dict.py @@ -611,7 +611,7 @@ def test_dict_popstring(self): def test_dict_as_frozendict_and_clear(self): # Test PyDict_AsFrozenDictAndClear() - as_frozendict = _testcapi.dict_as_frozendict_and_clear + as_frozendict = _testlimitedcapi.dict_as_frozendict_and_clear d = dict(x=1, y=2) f = as_frozendict(d) self.assertIs(type(f), frozendict) @@ -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/Lib/test/test_stable_abi_ctypes.py b/Lib/test/test_stable_abi_ctypes.py index f9125f395de0b4b..d9709c5cb2029d6 100644 --- a/Lib/test/test_stable_abi_ctypes.py +++ b/Lib/test/test_stable_abi_ctypes.py @@ -153,6 +153,7 @@ def test_windows_feature_macros(self): "PyDictRevIterKey_Type", "PyDictRevIterValue_Type", "PyDictValues_Type", + "PyDict_AsFrozenDictAndClear", "PyDict_Clear", "PyDict_Contains", "PyDict_Copy", @@ -337,6 +338,8 @@ def test_windows_feature_macros(self): "PyFloat_Type", "PyFrame_GetCode", "PyFrame_GetLineNumber", + "PyFrozenDict_New", + "PyFrozenDict_Type", "PyFrozenSet_New", "PyFrozenSet_Type", "PyGC_Collect", 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..508a6bf9b392613 --- /dev/null +++ b/Misc/NEWS.d/next/C_API/2026-11-15-15-30-40.gh-issue-162047.Zl2chW.rst @@ -0,0 +1,10 @@ +Add :pep:`814` :class:`frozendict` functions to the limited C API: + +* :c:func:`PyAnyDict_CheckExact` +* :c:func:`PyAnyDict_Check` +* :c:func:`PyDict_AsFrozenDictAndClear` +* :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..e099c315af6c7b1 100644 --- a/Misc/stable_abi.toml +++ b/Misc/stable_abi.toml @@ -2941,3 +2941,17 @@ 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' +[data.PyFrozenDict_Type] + added = '3.16' +[function.PyDict_AsFrozenDictAndClear] + added = '3.16' diff --git a/Modules/_testcapi/dict.c b/Modules/_testcapi/dict.c index 5e169d99c179d57..b7c73d7332bd4e9 100644 --- a/Modules/_testcapi/dict.c +++ b/Modules/_testcapi/dict.c @@ -257,50 +257,6 @@ test_dict_iteration(PyObject* self, PyObject *Py_UNUSED(ignored)) Py_RETURN_NONE; } -static PyObject * -dict_as_frozendict_and_clear(PyObject *self, PyObject *obj) -{ - NULLABLE(obj); - return PyDict_AsFrozenDictAndClear(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}, @@ -313,12 +269,6 @@ static PyMethodDef test_methods[] = { {"dict_popstring", dict_popstring, METH_VARARGS}, {"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..fc185c40c8b0a00 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,57 @@ dict_mergefromseq2(PyObject *self, PyObject *args) } +// Test PyFrozenDict_Check() +static PyObject * +frozendict_check(PyObject *self, PyObject *obj) +{ + NULLABLE(obj); + return PyLong_FromLong(PyFrozenDict_Check(obj)); +} + +// Test PyFrozenDict_CheckExact() +static PyObject * +frozendict_checkexact(PyObject *self, PyObject *obj) +{ + NULLABLE(obj); + return PyLong_FromLong(PyFrozenDict_CheckExact(obj)); +} + +// Test PyAnyDict_Check() +static PyObject * +anydict_check(PyObject *self, PyObject *obj) +{ + NULLABLE(obj); + return PyLong_FromLong(PyAnyDict_Check(obj)); +} + +// Test PyAnyDict_CheckExact() +static PyObject * +anydict_checkexact(PyObject *self, PyObject *obj) +{ + NULLABLE(obj); + return PyLong_FromLong(PyAnyDict_CheckExact(obj)); +} + + +// Test PyFrozenDict_New() +static PyObject * +frozendict_new(PyObject *self, PyObject *obj) +{ + NULLABLE(obj); + return PyFrozenDict_New(obj); +} + + +// Test PyDict_AsFrozenDictAndClear() +static PyObject * +dict_as_frozendict_and_clear(PyObject *self, PyObject *obj) +{ + NULLABLE(obj); + return PyDict_AsFrozenDictAndClear(obj); +} + + static PyMethodDef test_methods[] = { {"dict_check", dict_check, METH_O}, {"dict_checkexact", dict_checkexact, METH_O}, @@ -278,6 +332,12 @@ 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}, + {"dict_as_frozendict_and_clear", dict_as_frozendict_and_clear, METH_O}, {NULL}, }; diff --git a/PC/python3dll.c b/PC/python3dll.c index 412dd5ce66cbc30..3992c2e19bf24dc 100755 --- a/PC/python3dll.c +++ b/PC/python3dll.c @@ -183,6 +183,7 @@ EXPORT_FUNC(PyDescr_NewClassMethod) EXPORT_FUNC(PyDescr_NewGetSet) EXPORT_FUNC(PyDescr_NewMember) EXPORT_FUNC(PyDescr_NewMethod) +EXPORT_FUNC(PyDict_AsFrozenDictAndClear) EXPORT_FUNC(PyDict_Clear) EXPORT_FUNC(PyDict_Contains) EXPORT_FUNC(PyDict_Copy) @@ -301,6 +302,7 @@ EXPORT_FUNC(PyFloat_GetMax) EXPORT_FUNC(PyFloat_GetMin) EXPORT_FUNC(PyFrame_GetCode) EXPORT_FUNC(PyFrame_GetLineNumber) +EXPORT_FUNC(PyFrozenDict_New) EXPORT_FUNC(PyFrozenSet_New) EXPORT_FUNC(PyGC_Collect) EXPORT_FUNC(PyGC_Disable) @@ -959,6 +961,7 @@ EXPORT_DATA(PyExc_WindowsError) EXPORT_DATA(PyExc_ZeroDivisionError) EXPORT_DATA(PyFilter_Type) EXPORT_DATA(PyFloat_Type) +EXPORT_DATA(PyFrozenDict_Type) EXPORT_DATA(PyFrozenSet_Type) EXPORT_DATA(PyGetSetDescr_Type) EXPORT_DATA(PyList_Type)