What's the pythonic way to use getters and setters?

python getter-setter
Jorge Guberte picture Jorge Guberte · Apr 13, 2010 · Viewed 259.8k times · Source

I'm doing it like:

def set_property(property,value):  
def get_property(property):

or 

object.property = value  
value = object.property

I'm new to Python, so i'm still exploring the syntax, and i'd like some advice on doing this.

Answer

Grissiom picture Grissiom · Apr 13, 2010

Try this: Python Property

The sample code is:

class C(object):
    def __init__(self):
        self._x = None

    @property
    def x(self):
        """I'm the 'x' property."""
        print("getter of x called")
        return self._x

    @x.setter
    def x(self, value):
        print("setter of x called")
        self._x = value

    @x.deleter
    def x(self):
        print("deleter of x called")
        del self._x


c = C()
c.x = 'foo'  # setter called
foo = c.x    # getter called
del c.x      # deleter called

Related questions

Using @property versus getters and setters

Here is a pure Python-specific design question: class MyClass(object): ... def get_my_attr(self): ... def set_my_attr(self, value): ... and class MyClass(object): ... @property def my_attr(self): ... @my_attr.setter def my_attr(self, value): ... Python lets …

Read More
Do you use the get/set pattern (in Python)?

Using get/set seems to be a common practice in Java (for various reasons), but I hardly see Python code that uses this. Why do you use or avoid get/set methods in Python?

Read More
Correct usage of a getter/setter for dictionary values

I'm pretty new to Python, so if there's anything here that's flat-out bad, please point it out. I have an object with this dictionary: traits = {'happy': 0, 'worker': 0, 'honest': 0} The value for each trait should be an int in the range 1…

Read More