3-3. Property(getter, setter)

지난 강의에서 배웠듯이 파이썬의 클래스 관점에서 언더스코어(_)가 두개 붙어있으면 private한 변수다.

private한 변수에 대해서 내부의 표현을 숨기고 외부에서 들어나게 할때(캡슐화), 해당 변수를 읽거나 수정하려면 메소드를 활용해야한다.

그럼에도 직접 접근할 수 있는 방법은 있기에 @Property annotation이 존재한다.
지난 시간에 짰던 복잡한 코드를 더욱 간단하게 구현할 수 있게 된다.

Property

• 오늘의 키워드
  • Pythonic Code, @Property, Getter /Setter

@Property 를 왜 사용하나요?

1. pythonic한 코드로 작성가능하다.

다른 언어와 차별되게 간단한 문법이 파이썬의 독보적인 장점이다.
이를 활용하는 것이 파이썬을 제대로 이용한다고 볼 수 있다.

2. 변수에 제약을 설정할 수 있다.

(ex) 영어만 할당할 변수 , 숫자만 받을 변수

• 의도한 대로 프로그램이 동작할 수 있도록 해서 조금 더 견고하게 동작가능하다.

3. getter, setter 효과가 동등하다.

• 코드에 일관성이 생긴다.
• 캡슐화, 유효성 검사, 기능 추가 용이
  • 속성 노출, 내부 표현 숨기기 가능
• ⭐️ (가장 중요) 속성의 수명 및 메모리 관리 용이
  • 클래스의 레퍼런스 주소만 없어지면, 변수들이 알아서 클래스와 함께 사라짐
• 디버깅 용이
• getter,setter를 사용하는 라이브러리가 많다.
  따라서 상호운용성이 좋아진다. (django 같은 오픈소스)

@Property 사용하기

• 기존 코드는 private 한 변수가 여러개 이면 getter, setter 의 개수를 여러개 만들어야 한다. - 넘나 비효율적

class SampleB:
    def __init__(self):
        self.x = 0
        self.__y = 0
    
    def get_y(self):
        return self.__y

    def set_y(self,value):
        self.__y = value

• 어노테이션을 통해 코드를 더 쉽게 작성할 수 있다!
  언더스코어를 제외한 변수 이름으로 함수를 만들어준다.

class SampleA:
    def __init__(self):
        self.x = 0
        self.__y = 0 #private
    
    # 따로 메소드를 호출하지 않아도 알아서 필요한 시점에 동작한다.
    @property
    def y(self):
        print('Called get method.')
        return self.__y

    @y.setter
    def y(self,value):
        print('Called set method.')
        self.__y = value
    
    @y.deleter
    def y(self):
        print('Called delete method.')
        del self.__y


a = SampleA()
a.x = 1
a.y = 2 # setter가 동작한다.

print('ex 1> x : {}'.format(a.x))
print('ex 1> y : {}'.format(a.y)) # getter 동작

# deleter
del a.y

• dir로 deleter 로 변수를 지우기 전과 후의 객체를 확인해보자

print('ex 1> dir : {}'.format(dir(a)))
#[ _SampleA__y , ... , 'x', 'y']

del a.y

print('ex 1> dir : {}'.format(dir(a)))
# [ ... , 'x', 'y']

@property 로 변수에 제약 조건 추가

• private 변수 y에 0보다 큰 값만 들어오게 조건을 추가하려고 한다.
• setter에 조건문을 추가해서, 0보다 작은 값이 들어오면 에러를 발생시키면 된다.

class SampleB:
    def __init__(self):
        self.x = 0
        self.__y = 0 #private
    
    @property
    def y(self):
        return self.__y

    @y.setter
    def y(self,value):
        if value < 0:
            raise ValueError('0 보다 큰 값을 입력하세요')
        self.__y = value
    
    @y.deleter
    def y(self):
        del self.__y

b = SampleB()
b.x = 1
b.y = 10

print('ex 2> x : {}'.format(b.x))
print('ex 2> y : {}'.format(b.y))


b.y = -5
#예외 발생 ValueError: 0 보다 큰 값을 입력하세요

정리

private 변수 : __IamPrivate

#getter
@property
def IamPrivate(self):
    return self.__IamPrivate

#setter
@IamPrivate.setter
def IamPrivate(self,value):
    if [value 제약 조건]:
        (에러 처리)
    self.__IamPrivate = value  

#deleter for memory
@IamPrivate.deleter
def IamPrivate(self):
    del self.__IamPrivate

출처: 인프런 - 모두를 위한 파이썬 : 필수 문법 배우기 Feat. 오픈소스 패키지 배포 (Inflearn Original)