From 80ccaac24d5ae9843445420bc85f830fb6a72b3f Mon Sep 17 00:00:00 2001 From: =?utf8?q?Walter=20D=C3=B6rwald?= Date: Fri, 6 Dec 2002 10:17:35 +0000 Subject: [PATCH] Backport version 1.21: Document that the second argument to PyObject_IsInstance may be a tuple. This closes SF patch http://www.python.org/sf/649095 --- Doc/api/abstract.tex | 21 +++++++++++++-------- 1 file changed, 13 insertions(+), 8 deletions(-) diff --git a/Doc/api/abstract.tex b/Doc/api/abstract.tex index 5dcfd13335c5..952b3d63a8a5 100644 --- a/Doc/api/abstract.tex +++ b/Doc/api/abstract.tex @@ -171,15 +171,20 @@ 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{cls} + is a tuple, the check will be done against every entry in \var{cls}. + The result will be \code{1} when at least one of the checks returns + \code{1}, otherwise it will be \code{0}. If \var{inst} is not a class + instance and \var{cls} is neither a type object, nor a class object, + nor a tuple, \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} + \versionchanged[Support for a tuple as the second argument added]{2.2} \end{cfuncdesc} Subclass determination is done in a fairly straightforward way, but -- 2.47.3