property 데코레이터

개요

---

작업을 하던 도중 처음보는 데코레이터를 발견했다.. 보통 우리는 객체의 필드에 직접 접근하는 것을 방지하기 위해 protected나 private 접근제한자를 사용하고, getter와 setter를 통해서만 접근할 수 있도록 캡슐화(Encapsulation)을 한다. 이러한 과정을 간소화 시켜주는 것이 프로퍼티의 역할이다.

 

---

 

사용 예시

---

class Palette:
    def __init__(self):
        self.__color = 'blue'
    
    def get_color(self):
        return self.__color

    def set_color(self, color):
        self.__color = color

    def del_color(self):
        del self.__color

    color = property(fget=get_color, fset=set_color, fdel=del_color)


if __name__ == '__main__':
    p1 = Palette()
    print(p1.color) # get_color 호출
    
    p1.color = 'red' # set_color 호출
    print(p1.color) # get_color 호출
    
    del p1.color # del_color 호출
    print(p1.color) # get_color 호출

 

우선 데코레이터를 사용하기 이전에 프로퍼티 객체에 대해 알아보자.

• 첫 번째 인자(fget)로 getter메소드를 지정할 수 있다. print(p1.color)를 수행할 때, 지정된 getter 메소드(get_color)가 호출된다.
• 두 번째 인자(fset)로 setter 메소드를 지정할 수 있다. p1.color = 'red'를 수행할 때, 지정된 getter 메소드(set_color)가 호출된다.
• 마지막 인자(fdel)로 delete 메소드를 지정할 수 있다. 이는 해당 필드가 삭제될 때 호출될 메소드를 지정한다.

$ python t.py
blue
red
Traceback (most recent call last):
  File "/Users/shawn/Documents/Github/strawberry/python-training/t.py", line 25, in <module>
    print(p1.color) # get_color 호출
          ^^^^^^^^
  File "/Users/shawn/Documents/Github/strawberry/python-training/t.py", line 6, in get_color
    return self.__color
           ^^^^^^^^^^^^
AttributeError: 'Palette' object has no attribute '_Palette__color'

• 실행결과를 보면 del을 통해 해당 필드를 삭제했기 때문에 더 이상 접근할 수 없는 모습을 보여준다.

 

# decorator를 사용한 속성 정의
class PaletteWithDecorator:
	def __init__(self):
		self.__color = 'blue'
	
	@property
	def color(self):
		return self.__color

	@color.setter
	def color(self, color):
		self.__color = color

	@color.deleter
	def color(self):
		del self.__color


if __name__ == '__main__':    
    p2 = PaletteWithDecorator()
    print(p2.color) # get_color 호출

    p2.color = 'green' # set_color 호출
    print(p2.color) # get_color 호출

    del p2.color # del_color 호출
    print(p2.color) # get_color 호출

 

• @property 데코레이터를 통해서도 간단하게 getter, setter, deleter 정의가 가능하다.
  • 먼저 getter에 대한 @property 데코레이터와 함께 메소드가 정의되어야 한다.
  • getter 역할을 수행하는 메소드명(위 예시에서는 color)을 setter, deleter 역할을 수행하는 메소드의 데코레이터에 명시한다. (@<getter 메소드명>.setter / deleter)