Where is it better to declare variables within a Python class?

Question

When I write a class, I declare a some variables within the __init__ method and some other in the other functions. So, I usually end up with something like this:

class Foo:
    def __init__(self,a, b):
        self.a=a
        self.b=b
    def foo1(self,c, d)
        sum=self.a+self.b+c+d
        foo2(sum)
    def foo2(self,sum)
        print ("The sum is ", sum)

I find this way a bit messy because it gets difficult to keep track of all variables. In contrary, managing variables when they are declared within the __init__ method becomes more easy. So, instead of the previous form, we would have:

class Foo:
    def __init__(self,a, b, c, d, sum):
        self.a=a
        self.b=b
        self.c=c
        self.d=d
        self.sum=sum
    def foo1(self)
        self.sum=self.a+self.b+self.c+self.d
        foo2(self.sum)
    def foo2(self)
        print ("The sum is ", self.sum)

Which one would you choose and why? Do you think declaring all the variables of all functions of the class in the __init__ method would be a better practice?

Your foo2(sum) call in Foo.foo1 will not be executed, because you have a return statement on the line above it. — Martijn Pieters
– Martijn Pieters, Commented Oct 10, 2013 at 9:29

alexvassel · Accepted Answer · 2013-10-10 09:48:37Z

5

Your sum is a good candidate for a computed value i.e. method that acts like class variable (not method). This can be done by @property

class Foo(object):
    def __init__(self, a, b):
        self.a = a
        self.b = b

    @property
    def sum(self)
        return self.a + self.b

f = Foo(1, 2)
print 'The sum is' + f.sum

http://docs.python.org/2/library/functions.html#property

edited Oct 10, 2013 at 9:48

answered Oct 10, 2013 at 9:30

alexvassel

10.8k3 gold badges33 silver badges32 bronze badges

Sign up to request clarification or add additional context in comments.

2 Comments

alexvassel Over a year ago

see link in my answer

multigoodverse Over a year ago

@alexvassel Probably you should explain your answer more explicitly.

miku · Accepted Answer · 2013-10-10 09:35:18Z

4

There are at least three aspects to this:

From a design standpoint your constructor should only define variables, that are used at least in two methods in your class or that convey an essential characteristic of the thing you try to model.
From a performance point of view, you should use variables with the smallest scope possible, it saves lookups.
Keeping the variables local, keeps the cognitive load low.

edited Oct 10, 2013 at 9:35

answered Oct 10, 2013 at 9:29

miku

189k47 gold badges314 silver badges317 bronze badges

2 Comments

multigoodverse Over a year ago

So, you should not perform any operations within the constructor other than declaring variables. What about calling other methods of the class from within the constructor?

miku Over a year ago

I'm not saying the constructor should only declare variables, just saying that the variables declared best be essential rather than accidental (e.g. intermediate results, helper vars, etc.).

Collectives™ on Stack Overflow

Where is it better to declare variables within a Python class?

2 Answers 2

2 Comments

2 Comments

Your Answer

Hot Network Questions

Collectives™ on Stack Overflow

2 Answers 2

2 Comments

2 Comments

Your Answer

Sign up or log in

Post as a guest

Related