As I understand from the book, if Sub inherits Super then one need not call superclass' (Super
's) __init__()
method.
This is misleading. It's true that you aren't required to call the superclass's __init__
method—but if you don't, whatever it does in __init__
never happens. And for normal classes, all of that needs to be done. It is occasionally useful, usually when a class wasn't designed to be inherited from, like this:
class Rot13Reader:
def __init__(self, filename):
self.file = open(filename):
def close(self):
self.file.close()
def dostuff(self):
line = next(file)
return codecs.encode(line, 'rot13')
Imagine that you want all the behavior of this class, but with a string rather than a file. The only way to do that is to skip the open
:
class LocalRot13Reader(Rot13Reader):
def __init__(self, s):
# don't call super().__init__, because we don't have a filename to open
# instead, set up self.file with something else
self.file = io.StringIO(s)
Here, we wanted to avoid the self.file
assignment in the superclass. In your case—as with almost all classes you're ever going to write—you don't want to avoid the self.name
assignment in the superclass. That's why, even though Python allows you to not call the superclass's __init__
, you almost always call it.
Notice that there's nothing special about __init__
here. For example, we can override dostuff
to call the base class's version and then do extra stuff:
def dostuff(self):
result = super().dostuff()
return result.upper()
… or we can override close
and intentionally not call the base class:
def close(self):
# do nothing, including no super, because we borrowed our file
The only difference is that good reasons to avoid calling the base class tend to be much more common in normal methods than in __init__
.
Question: Why do I need to call Super's __init__
using Super.__init__(self, name)
OR super(Sub, self).__init__(name)
instead of a direct call Super(name)
?
Because these do very different things.
Super(name)
constructs a new Super
instance, calls __init__(name)
on it, and returns it to you. And you then ignore that value.
In particular, Super.__init__
does get called one time either way—but the self
it gets called with is that new Super
instance, that you're just going to throw away, in the Super(name)
case, while it's your own self
in the super(Sub, self).__init__(name)
case.
So, in the first case, it sets the name
attribute on some other object that gets thrown away, and nobody ever sets it on your object, which is why self.name
later raises an AttributeError
.
It might help you understand this if you add something to both class's __init__
methods to show which instance is involved:
class Super:
def __init__(self,name):
print(f"Inside Super __init__ for {self}")
self.name=name
print("Name is:",name)
class Sub(Super):
def __init__(self,name):
print(f"Inside Sub __init__ for {self}")
# line you want to experiment with goes here.
If that last line is super().__init__(name)
, super(Sub, self).__init__name)
, or Super.__init__(self, name)
, you will see something like this:
Inside Sub __init__ for <__main__.Sub object at 0x10f7a9e80>
Inside Super __init__ for <__main__.Sub object at 0x10f7a9e80>
Notice that it's the same object, the Sub
at address 0x10f7a9e80, in both cases.
… but if that last line is Super(name)
:
Inside Sub __init__ for <__main__.Sub object at 0x10f7a9ea0>
Inside Super __init__ for <__main__.Super object at 0x10f7a9ec0>
Now we have two different objects, at different addresses 0x10f7a9ea0 and 0x10f7a9ec0, and with different types.
If you're curious about what the magic all looks like under the covers, Super(name)
does something like this (oversimplifying a bit and skipping over some steps1):
_newobj = Super.__new__(Super)
if isinstance(_newobj, Super):
Super.__init__(_newobj, name)
… while super(Sub, self).__init__(name)
does something like this:
_basecls = magically_find_next_class_in_mro(Sub)
_basecls.__init__(self, name)
As a side note, if a book is telling you to use super(Sub, self).__init__(name)
or Super.__init__(self, name)
, it's probably an obsolete book written for Python 2.
In Python 3, you just do this:
super().__init__(name)
: Calls the correct next superclass by method resolution order. You almost always want this.
super(Sub, self).__init__(name)
: Calls the correct next superclass—unless you make a mistake and get Sub
wrong there. You only need this if you're writing dual-version code that has to run in 2.7 as well as 3.x.
Super.__init__(self, name)
: Calls Super
, whether it's the correct next superclass or not. You only need this if the method resolution order is wrong and you have to work around it.2
If you want to understand more, it's all in the docs, but it can be a bit daunting:
The original introduction to super
, __new__
, and all the related features was very helpful to me in understanding all of this. I'm not sure if it'll be as helpful to someone who's not coming at this already understanding old-style Python classes, but it's pretty well written, and Guido (obviously) knows what he's talking about, so it might be worth reading.
1. The biggest cheat in this explanation is that super
actually returns a proxy object that acts like _baseclass
bound to self
in the same way methods are bound, which can be used to bind methods, like __init__
. This is useful/interesting knowledge if you know how methods work, but probably just extra confusion if you don't.
2. … or if you're working with old-style classes, which don't support super
(or proper method-resolution order). This never comes up in Python 3, which doesn't have old-style classes. But, unfortunately, you will see it in lots of tkinter examples, because the best tutorial is still Effbot's, which was written for Python 2.3, when Tkinter was all old-style classes, and has never been updated.