mirror of
https://github.com/python/cpython.git
synced 2026-06-25 02:20:56 +00:00
f5231469b5
Implementation of python/peps#4968.
(cherry picked from commit 08218030a5)
Co-authored-by: Jelle Zijlstra <jelle.zijlstra@gmail.com>
47 lines
1.7 KiB
ReStructuredText
47 lines
1.7 KiB
ReStructuredText
.. highlight:: c
|
|
|
|
.. _sentinelobjects:
|
|
|
|
Sentinel objects
|
|
----------------
|
|
|
|
.. c:var:: PyTypeObject PySentinel_Type
|
|
|
|
This instance of :c:type:`PyTypeObject` represents the Python
|
|
:class:`sentinel` type. This is the same object as :class:`sentinel`.
|
|
|
|
.. versionadded:: 3.15
|
|
|
|
.. c:function:: int PySentinel_Check(PyObject *o)
|
|
|
|
Return true if *o* is a :class:`sentinel` object or a subtype.
|
|
The :class:`sentinel` type does not currently allow subclasses,
|
|
so this check is exact.
|
|
Future Python versions may choose to allow subtyping.
|
|
This function always succeeds.
|
|
|
|
.. versionadded:: 3.15
|
|
|
|
.. c:function:: int PySentinel_CheckExact(PyObject *o)
|
|
|
|
Return true if *o* is a :class:`sentinel` object, but not a subtype.
|
|
The :class:`sentinel` type does not currently allow subclasses.
|
|
Future Python versions may choose to allow subtyping.
|
|
This function always succeeds.
|
|
|
|
.. versionadded:: 3.15
|
|
|
|
.. c:function:: PyObject* PySentinel_New(const char *name, const char *module_name, const char *repr)
|
|
|
|
Return a new :class:`sentinel` object with :attr:`~sentinel.__name__` set to
|
|
*name* and :attr:`~sentinel.__module__` set to *module_name*.
|
|
*name* must not be ``NULL``. If *module_name* is ``NULL``, :attr:`~sentinel.__module__`
|
|
is set to ``None``. If *repr* is ``NULL``, ``repr()`` returns :attr:`~sentinel.__name__`.
|
|
Return ``NULL`` with an exception set on failure.
|
|
|
|
For pickling to work, *module_name* must be the name of an importable
|
|
module, and the sentinel must be accessible from that module under a
|
|
path matching *name*. Pickle treats *name* as a global variable name
|
|
in *module_name* (see :meth:`object.__reduce__`).
|
|
|
|
.. versionadded:: 3.15
|