Redundancy in __init__ in python?

[Isaac0427]

TL;DR Summary

I am learning about classes, and something about __init__ seems redundant-- I'm sure there's a reason for it, which is what I am looking for.

Here is an example code in python, describing a class of fruits:

class Fruits(object):
    def __init__(self, color, taste):
        self.color = color
        self.taste = taste

If, in general, we ALWAYS do this:

class ExampleClass(object):
    def __init__(self, property1, property2):
        self.property1 = property1
        self.property2 = property2

why don't we just write

def __init__(self, property1, property2)

instead of adding the self.property1 = property1 etc?

Is there ever a time where we wouldn't follow the "general formula" in this post's second block of code? If not, is there a reason python can't just fill in the rest of the "formula" if given

def __init__(self, property1, property2)

?

Thank you!

 

[Ibix]

We don't always do that. You could imagine a class that stores a direction vector and can take initialisation in terms of (x,y,z) or (r,theta,phi):

class UnitDirectionVector:
    def __init__(self, r1, r2, r3, vectorType):
        if vectorType == "cartesian":
            # Interpret r1,r2,r3 as x,y,z and convert to unit vector
            r = math.sqrt(r1*r1+r2*r2+r3*r3)
            self.x = r1 / r
            self.y = r2 / r
            self.z = r3 / r
        elif vectorType == "polar":
            # Interpret r1,r2,r3 as r,theta,phi and store unit vector
            self.x = math.cos(r3) * math.sin(r2)
            self.y = math.sin(r3) * math.sin(r2)
            self.z = math.cos(r2)
        else:
            raise ValueError("Unrecognised vectorType "+str(vectorType))

That said, it is a common pattern to be just copying the __init__ function arguments into members, at least as part of what __init__ does. There are ways of using python's ability to examine its own code to do just that (Google lead me here), but the general feeling seems to be that it's overly complex for something straightforward. Do you really want python to re-examine a function's argument list every time you create an object, just to save you a bit of typing? That would potentially be rather slow, possibly critically so if the object is being created in a loop.

Now, if someone could write a macro for my code editor that parses my __init__() definition and auto-generates the self.param1 = param1 statements for me, that would be great.

 

[PeterDonis]

if someone could write a macro for my code editor that parses my __init__() definition and auto-generates the self.param1 = param1 statements for me, that would be great.

There's a somewhat hackish way to do this:

class Test:
    def __init__(self, a, b, c):
        self.__dict__.update((k, v) for k, v in locals().items() if k != 'self')

test = Test("a", "b", "c")
print(test.a)  # prints a
print(test.b)  # prints b
print(test.c)  # prints c
print(test.__dict__)  #  {'a': 'a', 'b': 'b', 'c': 'c'}

 

[Ibix]

There's a somewhat hackish way to do this:

class Test:
    def __init__(self, a, b, c):
        self.__dict__.update((k, v) for k, v in locals().items() if k != 'self')

test = Test("a", "b", "c")
print(test.a)  # prints a
print(test.b)  # prints b
print(test.c)  # prints c
print(test.__dict__)  #  {'a': 'a', 'b': 'b', 'c': 'c'}

That's related to one of the suggestions in the page I linked, which did self.__dict__.update(kwargs). The comments seemed to be along the lines of "think of the poor guy who has to maintain this". I was thinking more of a code generator in the editor that, given def __init__(self,a,b,c):, would generate

        self.a=a
        self.b=b
        self.c=c

 

[PeterDonis]

The comments seemed to be along the lines of "think of the poor guy who has to maintain this".

I agree that just having def __init__(self, **kwargs) is not good. That's why I explicitly specified the arguments to __init__ and did the dictionary update excluding self.

I was thinking more of a code generator in the editor

My general attitude towards code generators is that I would rather write a library function or use some other general feature of the language so that I don't have to write boilerplate code at all. I am probably an outlier in this respect.

 

[Ibix]

My general attitude towards code generators is that I would rather write a library function or use some other general feature of the language so that I don't have to write boilerplate code at all. I am probably an outlier in this respect.

I've done both. For something like copying a half dozen parameters into members I'd prefer the boilerplate just to save the cognitive load involved in parsing your update() call. On the other hand I've seen code that calculated the mean values of each one of eighty columns in a dataset by summing each one, counting it, and dividing the two, with eighty cut-and-paste copies. I ended up writing a new program to analyse the original program in order to convince myself that every variable had gone through the same process. That got replaced with smarter code.

 

[PeterDonis]

For something like copying a half dozen parameters into members I'd prefer the boilerplate just to save the cognitive load involved in parsing your update() call.

Python now (as of 3.7) has data classes, which are a less hacky way of doing what I did and can also help to reduce the cognitive load involved:

https://www.python.org/dev/peps/pep-0557/

 

[sysprog]

Now, if someone could write a macro for my code editor that parses my __init__() definition and auto-generates the self.param1 = param1 statements for me, that would be great.

Which editor are you using?