Stowage/cpython
2
0
Fork 0
mirror of https://github.com/python/cpython.git synced 2026-02-05 17:35:34 +00:00
Code Issues Projects Releases Packages Wiki Activity

Doc: improve PyObject_IsSubclass documentation for clarity and conciseness

Browse source 
Simplify and clarify the wording of PyObject_IsSubclass documentation in
the C API reference.

GH-140160
This commit is contained in:
Someshwar Tripathi 2025-10-17 05:00:07 +05:30
parent 9a87ce8b57
commit 194f6ddba3
No known key found for this signature in database
GPG key ID: E5171ADF224B9A97
1 changed files with 9 additions and 13 deletions
Download patch file Download diff file Expand all files Collapse all files

22
Doc/c-api/object.rst
View file

@ -376,21 +376,17 @@ Object Protocol
.. c:function:: int PyObject_IsSubclass(PyObject *derived, PyObject *cls)
Return ``1`` if the class *derived* is identical to or derived from the class
*cls*, otherwise return ``0``. In case of an error, return ``-1``.
Return ``1`` if *derived* is a subclass of *cls*, ``0`` if not, or ``-1`` on
error.
If *cls* is a tuple, the check will be done against every entry in *cls*.
The result will be ``1`` when at least one of the checks returns ``1``,
otherwise it will be ``0``.
If *cls* is a tuple, return ``1`` if *derived* is a subclass of any entry in
*cls*.
If *cls* has a :meth:`~type.__subclasscheck__` method, it will be called to
determine the subclass status as described in :pep:`3119`. Otherwise,
*derived* is a subclass of *cls* if it is a direct or indirect subclass,
i.e. contained in :attr:`cls.__mro__ <type.__mro__>`.
Normally only class objects, i.e. instances of :class:`type` or a derived
class, are considered classes. However, objects can override this by having
a :attr:`~type.__bases__` attribute (which must be a tuple of base classes).
The check respects :meth:`~type.__subclasscheck__` method if defined (see
:pep:`3119`); otherwise, checks whether *derived* is in
:attr:`cls.__mro__ <type.__mro__>`. Non-class objects with a
:attr:`~type.__bases__` attribute (which must be a tuple of base classes)
are also supported.
.. c:function:: int PyObject_IsInstance(PyObject *inst, PyObject *cls)