Skip to content

Commit f72768f

Browse files
pythongh-141004: Document C APIs for dictionary keys, values, and items (pythonGH-141009)
Co-authored-by: Petr Viktorin <[email protected]>
1 parent c2470b3 commit f72768f

File tree

1 file changed

+46
-0
lines changed

1 file changed

+46
-0
lines changed

Doc/c-api/dict.rst

Lines changed: 46 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -431,3 +431,49 @@ Dictionary Objects
431431
it before returning.
432432
433433
.. versionadded:: 3.12
434+
435+
436+
Dictionary View Objects
437+
^^^^^^^^^^^^^^^^^^^^^^^
438+
439+
.. c:function:: int PyDictViewSet_Check(PyObject *op)
440+
441+
Return true if *op* is a view of a set inside a dictionary. This is currently
442+
equivalent to :c:expr:`PyDictKeys_Check(op) || PyDictItems_Check(op)`. This
443+
function always succeeds.
444+
445+
446+
.. c:var:: PyTypeObject PyDictKeys_Type
447+
448+
Type object for a view of dictionary keys. In Python, this is the type of
449+
the object returned by :meth:`dict.keys`.
450+
451+
452+
.. c:function:: int PyDictKeys_Check(PyObject *op)
453+
454+
Return true if *op* is an instance of a dictionary keys view. This function
455+
always succeeds.
456+
457+
458+
.. c:var:: PyTypeObject PyDictValues_Type
459+
460+
Type object for a view of dictionary values. In Python, this is the type of
461+
the object returned by :meth:`dict.values`.
462+
463+
464+
.. c:function:: int PyDictValues_Check(PyObject *op)
465+
466+
Return true if *op* is an instance of a dictionary values view. This function
467+
always succeeds.
468+
469+
470+
.. c:var:: PyTypeObject PyDictItems_Type
471+
472+
Type object for a view of dictionary items. In Python, this is the type of
473+
the object returned by :meth:`dict.items`.
474+
475+
476+
.. c:function:: int PyDictItems_Check(PyObject *op)
477+
478+
Return true if *op* is an instance of a dictionary items view. This function
479+
always succeeds.

0 commit comments

Comments
 (0)