Python (and Python C API): __new__ versus __init__
__new__()
can return objects of types other than the class it's bound to. __init__()
only initializes an existing instance of the class.
>>> class C(object):
... def __new__(cls):
... return 5
...
>>> c = C()
>>> print type(c)
<type 'int'>
>>> print c
5
The difference mainly arises with mutable vs immutable types.
__new__
accepts a type as the first argument, and (usually) returns a new instance of that type. Thus it is suitable for use with both mutable and immutable types.
__init__
accepts an instance as the first argument and modifies the attributes of that instance. This is inappropriate for an immutable type, as it would allow them to be modified after creation by calling obj.__init__(*args)
.
Compare the behaviour of tuple
and list
:
>>> x = (1, 2)
>>> x
(1, 2)
>>> x.__init__([3, 4])
>>> x # tuple.__init__ does nothing
(1, 2)
>>> y = [1, 2]
>>> y
[1, 2]
>>> y.__init__([3, 4])
>>> y # list.__init__ reinitialises the object
[3, 4]
As to why they're separate (aside from simple historical reasons): __new__
methods require a bunch of boilerplate to get right (the initial object creation, and then remembering to return the object at the end). __init__
methods, by contrast, are dead simple, since you just set whatever attributes you need to set.
Aside from __init__
methods being easier to write, and the mutable vs immutable distinction noted above, the separation can also be exploited to make calling the parent class __init__
in subclasses optional by setting up any absolutely required instance invariants in __new__
. This is generally a dubious practice though - it's usually clearer to just call the parent class __init__
methods as necessary.