languages/cpython
languages/cpython
1
0
Fork 0
mirror of https://github.com/python/cpython synced 2024-10-17 06:18:40 +00:00
Code Issues Packages Projects Releases Wiki Activity

Clarify the return value of PyObject_IsInstance().

Browse source
This commit is contained in:
Fred Drake 2002-04-23 18:15:44 +00:00
parent 106c1a0e7a
commit b957bc3dcc
1 changed files with 9 additions and 8 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

17
Doc/api/abstract.tex
View file

@ -129,14 +129,15 @@ for which they do not apply, they will raise a Python exception.
\end{cfuncdesc}
\begin{cfuncdesc}{int}{PyObject_IsInstance}{PyObject *inst, PyObject *cls}
Return \code{1} if \var{inst} is an instance of the class \var{cls}
or a subclass of \var{cls}. If \var{cls} is a type object rather
than a class object, \cfunction{PyObject_IsInstance()} returns
\code{1} if \var{inst} is of type \var{cls}. If \var{inst} is not a
class instance and \var{cls} is neither a type object or class
object, \var{inst} must have a \member{__class__} attribute --- the
class relationship of the value of that attribute with \var{cls}
will be used to determine the result of this function.
Returns \code{1} if \var{inst} is an instance of the class \var{cls}
or a subclass of \var{cls}, or \code{0} if not. On error, returns
\code{-1} and sets an exception. If \var{cls} is a type object
rather than a class object, \cfunction{PyObject_IsInstance()}
returns \code{1} if \var{inst} is of type \var{cls}. If \var{inst}
is not a class instance and \var{cls} is neither a type object or
class object, \var{inst} must have a \member{__class__} attribute
--- the class relationship of the value of that attribute with
\var{cls} will be used to determine the result of this function.
\versionadded{2.1}
\end{cfuncdesc}