-
-
Notifications
You must be signed in to change notification settings - Fork 32.5k
gh-136843: Document how multiple inheritance works #136844
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Changes from 5 commits
4fca325
ca07bc9
bf5702b
4e7913f
2dd55e0
00c3942
7128c11
File filter
Filter by extension
Conversations
Jump to
Diff view
Diff view
There are no files selected for viewing
Original file line number | Diff line number | Diff line change |
---|---|---|
|
@@ -1421,6 +1421,9 @@ is equivalent to :: | |
class Foo(object): | ||
pass | ||
|
||
There may be one or more base classes; see :ref:`multiple-inheritance` below for more | ||
information. | ||
|
||
The class's suite is then executed in a new execution frame (see :ref:`naming`), | ||
using a newly created local namespace and the original global namespace. | ||
(Usually, the suite contains mostly function definitions.) When the class's | ||
|
@@ -1490,6 +1493,119 @@ can be used to create instance variables with different implementation details. | |
were introduced in :pep:`318`. | ||
|
||
|
||
.. _multiple-inheritance: | ||
|
||
Multiple inheritance | ||
-------------------- | ||
|
||
Python classes may have multiple base classes, a technique known as | ||
*multiple inheritance*. The base classes are specified in the class definition | ||
by listing them in parentheses after the class name, separated by commas. | ||
For example, the following class definition: | ||
|
||
.. doctest:: | ||
|
||
>>> class A: pass | ||
>>> class B: pass | ||
>>> class C(A, B): pass | ||
|
||
defines a class ``C`` that inherits from classes ``A`` and ``B``. | ||
|
||
The :term:`method resolution order` (MRO) is the order in which base classes are | ||
searched when looking up an attribute on a class. See :ref:`python_2.3_mro` for a | ||
description of how Python determines the MRO for a class. | ||
|
||
Multiple inheritance is not always allowed. Attempting to define a class with multiple | ||
inheritance will raise an error if one of the bases is invalid, if a consistent MRO | ||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. I'm not sure about "one of the bases is invalid" part. Some class is not acceptable to be base class. Is it correct to call this class "invalid"? I'd suggest little rewording. There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. I guess I was also thinking of trying to inherit from something that isn't a class. I'll reword. |
||
cannot be created, if no valid metaclass can be determined, or if there is an instance | ||
layout conflict. We'll discuss each of these in turn. | ||
|
||
First, all base classes must allow subclassing. While most classes allow subclassing, | ||
some built-in classes do not, such as :class:`bool`: | ||
|
||
.. doctest:: | ||
|
||
>>> class SubBool(bool): # TypeError | ||
... pass | ||
Traceback (most recent call last): | ||
... | ||
TypeError: type 'bool' is not an acceptable base type | ||
|
||
In the resolved MRO of a class, the class's bases appear in the order they were | ||
specified in the class's bases list. Additionally, the MRO always lists a child | ||
class before any of its bases. A class definition will fail if it is impossible to | ||
resolve a consistent MRO that satisfies these rules from the list of bases provided: | ||
|
||
.. doctest:: | ||
|
||
>>> class Base: pass | ||
>>> class Child(Base): pass | ||
>>> class Grandchild(Base, Child): pass # TypeError | ||
Traceback (most recent call last): | ||
... | ||
TypeError: Cannot create a consistent method resolution order (MRO) for bases Base, Child | ||
|
||
In the MRO of ``Grandchild``, ``Child`` must appear before ``Base`` because it is first | ||
in the base class list, but it must also appear after ``Base`` because it is a child of | ||
``Base``. This is a contradiction, so the class cannot be defined. | ||
JelleZijlstra marked this conversation as resolved.
Show resolved
Hide resolved
|
||
|
||
If some of the bases have a custom :term:`metaclass`, the metaclass of the resulting class | ||
is chosen among the metaclasses of the bases and the explicitly specified metaclass of the | ||
child class. It must be a metaclass that is a subclass of | ||
all other candidate metaclasses. If no such metaclass exists among the candidates, | ||
the class cannot be created, as explained in :ref:`metaclass-determination`. | ||
|
||
Finally, the memory layouts of the bases must be compatible. This means that it must be | ||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Is it "memory layout" or "instance layout"? Or those are fully equivalent? This is not very obvious now. There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. We debated how to describe this concept while writing the docs for the relevant ty rule. I think the clearest way to describe the concept is "the memory layout instances of the class will have", but that's a bit wordy 😄 "instance memory layout" is probably next best? There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. I'll go with "instance layout" since that's what the TypeError says. |
||
possible to compute a *solid base* for the class. Exactly which classes are solid bases | ||
depends on the Python implementation. | ||
|
||
.. impl-detail:: | ||
|
||
In CPython, a class is a solid base if it has a | ||
nonempty :attr:`~object.__slots__` definition. | ||
Many but not all classes defined in C are also solid bases, including most | ||
builtins (such as :class:`int` or :class:`BaseException`) | ||
but excluding most concrete :class:`Exception` classes. Generally, a C class | ||
is a solid base if its underlying struct is different in size from its base class. | ||
|
||
Every class has a solid base. :class:`object`, the base class, has itself as its solid base. | ||
If there is a single base, the child class's solid base is that class if it is a solid base, | ||
or else the base class's solid base. If there are multiple bases, we first find the solid base | ||
for each base class to produce a list of candidate solid bases. If there is a unique solid base | ||
that is a subclass of all others, then that class is the solid base. Otherwise, class creation | ||
fails. | ||
|
||
Example: | ||
|
||
.. doctest:: | ||
|
||
>>> class Solid1: | ||
... __slots__ = ("solid1",) | ||
>>> | ||
>>> class Solid2: | ||
... __slots__ = ("solid2",) | ||
>>> | ||
>>> class SolidChild(Solid1): | ||
... __slots__ = ("solid_child",) | ||
>>> | ||
>>> class C1: # solid base is `object` | ||
... pass | ||
>>> | ||
>>> # OK: solid bases are `Solid1` and `object`, and `Solid1` is a subclass of `object`. | ||
>>> class C2(Solid1, C1): # solid base is `Solid1` | ||
... pass | ||
>>> | ||
>>> # OK: solid bases are `SolidChild` and `Solid1`, and `SolidChild` is a subclass of `Solid1`. | ||
>>> class C3(SolidChild, Solid1): # solid base is `SolidChild` | ||
... pass | ||
>>> | ||
>>> # Error: solid bases are `Solid1` and `Solid2`, but neither is a subclass of the other. | ||
>>> class C4(Solid1, Solid2): # error: no single solid base | ||
... pass | ||
Traceback (most recent call last): | ||
... | ||
TypeError: multiple bases have instance lay-out conflict | ||
|
||
.. _async: | ||
|
||
Coroutines | ||
|
Uh oh!
There was an error while loading. Please reload this page.