This issue tracker has been migrated to GitHub, and is currently read-only.
For more information, see the GitHub FAQs in the Python's Developer Guide.

classification
Title: Document __instancecheck__ and __subclasscheck__
Type: enhancement Stage:
Components: Documentation Versions: Python 3.0, Python 3.1, Python 3.2, Python 2.7, Python 2.6
process
Status: closed Resolution: fixed
Dependencies: Superseder:
Assigned To: georg.brandl Nosy List: cvrebert, georg.brandl, terry.reedy
Priority: normal Keywords: patch

Created on 2009-02-13 18:03 by terry.reedy, last changed 2022-04-11 14:56 by admin. This issue is now closed.

Files
File name Uploaded Description Edit
datamodel.rst.diff cvrebert, 2010-04-12 06:36 a draft
datamodel.rst.diff cvrebert, 2010-04-12 06:52 trivial fixes
Messages (6)
msg81956 - (view) Author: Terry J. Reedy (terry.reedy) * (Python committer) Date: 2009-02-13 18:03
http://www.python.org/dev/peps/pep-3119/#overloading-isinstance-and-issubclass
(GvR and Talin)
"The primary mechanism proposed here is to allow overloading the
built-in functions isinstance() and issubclass(). The overloading works
as follows: The call isinstance(x, C) first checks whether
C.__instancecheck__ exists, and if so, calls C.__instancecheck__(x)
instead of its normal implementation. Similarly, the call issubclass(D,
C) first checks whether C.__subclasscheck__ exists, and if so, calls
C.__subclasscheck__(D) instead of its normal implementation."

These two new special methods are not documented (for 3.x at least.  A
post on python-list today verifies that at least .__instancecheck__ was
implemented (version not specified).  I assume .__subclasscheck__ was
also.  This issue perhaps applies to 2.6/2.7 also.

I suggest either adding "Customizing instance and subclass checks" after
"Customizing class creation" or add to that section and rename it to
"Customizing class creation and checks" since the needed addition seems
too small for its own section.  Something like

The result of isinstance(object, class) can be modified by giving the
*class* a .__instancecheck__(object) method.  The result of
issubclass(sub,super) can be modified by giving the *superclass* a
.__subclasscheck__(sub) method.
msg102919 - (view) Author: Chris Rebert (cvrebert) * Date: 2010-04-12 06:36
Here's a draft of an updated version of the "Data model" docs reflecting the changes in the PEP.
msg103149 - (view) Author: Georg Brandl (georg.brandl) * (Python committer) Date: 2010-04-14 21:35
Committed a similar patch in r80081.  Thanks very much!
msg103152 - (view) Author: Chris Rebert (cvrebert) * Date: 2010-04-14 21:43
This might need to be reopened.

There's a verb missing from he following sentence of the patch:
"This is consistent with the lookup of special methods that called on instances, only that in this case the instance is itself a class."

Secondly, and more importantly, the issubclass() and isinstance() docs don't mention the new special methods in question.
msg103153 - (view) Author: Georg Brandl (georg.brandl) * (Python committer) Date: 2010-04-14 21:48
Fixed the missing verb in r80084.  I don't think the new special methods need to be mention in isinstance() or issubclass() docs; they are very rarely needed, and other builtins don't mention their special methods either (e.g. abs(), complex(), or getattr().)
msg103639 - (view) Author: Chris Rebert (cvrebert) * Date: 2010-04-19 21:03
One last triviality: Could the mention of __subclasscheck__() in http://docs.python.org/dev/library/abc.html#abc.ABCMeta.__subclasshook__ get linked to the newly-added docs?
History
Date User Action Args
2022-04-11 14:56:45adminsetgithub: 49500
2010-04-19 21:03:25cvrebertsetmessages: + msg103639
2010-04-14 21:48:18georg.brandlsetmessages: + msg103153
2010-04-14 21:43:06cvrebertsetmessages: + msg103152
2010-04-14 21:35:00georg.brandlsetstatus: open -> closed
resolution: fixed
messages: + msg103149
2010-04-12 06:52:44cvrebertsetfiles: + datamodel.rst.diff
2010-04-12 06:36:18cvrebertsetfiles: + datamodel.rst.diff
type: enhancement
messages: + msg102919

keywords: + patch
2010-04-12 04:55:53cvrebertsetnosy: + cvrebert

versions: + Python 2.6, Python 2.7, Python 3.2
2009-02-13 18:03:38terry.reedycreate