gh-140160: Doc improve PyObject_IsSubclass documentation for clarity #140236
+9
−13
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
…eness Simplify and clarify the wording of PyObject_IsSubclass documentation in the C API reference. pythonGH-140160
|
All commit authors signed the Contributor License Agreement. |
Comment on lines
-379
to
+389
| 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* 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__>`. | ||
| If *cls* is a tuple, return ``1`` if *derived* is a subclass of any entry in | ||
| *cls*. | ||
| 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. |
There was a problem hiding this comment.
I think it would be better to just say that function is equivalent to the Python-level issubclass function. Then, details regarding __subclasscheck__ can be added there instead.
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
This PR Simplifies the wording of PyObject_IsSubclass documentation in the C API reference.
PyObject_IsSubclassdocumentation #140160📚 Documentation preview 📚: https://cpython-previews--140236.org.readthedocs.build/