]> git.ipfire.org Git - thirdparty/Python/cpython.git/commitdiff
gh-141004: Document C APIs for dictionary keys, values, and items (GH-141009)
authorPeter Bierma <zintensitydev@gmail.com>
Thu, 13 Nov 2025 15:02:21 +0000 (10:02 -0500)
committerGitHub <noreply@github.com>
Thu, 13 Nov 2025 15:02:21 +0000 (15:02 +0000)
Co-authored-by: Petr Viktorin <encukou@gmail.com>
Doc/c-api/dict.rst

index 246ce5391e142c234fe6c97aa767810e0b215236..b7f201811aad6cc2a13c4d6cbbc4a18d84d61df8 100644 (file)
@@ -431,3 +431,49 @@ Dictionary Objects
    it before returning.
 
    .. versionadded:: 3.12
+
+
+Dictionary View Objects
+^^^^^^^^^^^^^^^^^^^^^^^
+
+.. c:function:: int PyDictViewSet_Check(PyObject *op)
+
+   Return true if *op* is a view of a set inside a dictionary. This is currently
+   equivalent to :c:expr:`PyDictKeys_Check(op) || PyDictItems_Check(op)`. This
+   function always succeeds.
+
+
+.. c:var:: PyTypeObject PyDictKeys_Type
+
+   Type object for a view of dictionary keys. In Python, this is the type of
+   the object returned by :meth:`dict.keys`.
+
+
+.. c:function:: int PyDictKeys_Check(PyObject *op)
+
+   Return true if *op* is an instance of a dictionary keys view. This function
+   always succeeds.
+
+
+.. c:var:: PyTypeObject PyDictValues_Type
+
+   Type object for a view of dictionary values. In Python, this is the type of
+   the object returned by :meth:`dict.values`.
+
+
+.. c:function:: int PyDictValues_Check(PyObject *op)
+
+   Return true if *op* is an instance of a dictionary values view. This function
+   always succeeds.
+
+
+.. c:var:: PyTypeObject PyDictItems_Type
+
+   Type object for a view of dictionary items. In Python, this is the type of
+   the object returned by :meth:`dict.items`.
+
+
+.. c:function:: int PyDictItems_Check(PyObject *op)
+
+   Return true if *op* is an instance of a dictionary items view. This function
+   always succeeds.