[python 심화] 5. Special Method (Magic Method)

코드 - 패캠 수업 코드 참고 (패캠 수업 정리)

 

<이전 글>

https://silvercoding.tistory.com/21

[python 심화] 4. 데이터 모델(Data Model), Nametuple

 

 

<매직 메소드 관련 문서>

https://docs.python.org/3/reference/datamodel.html#special-method-names

3. Data model — Python 3.9.6 documentation

https://www.tutorialsteacher.com/python/magic-methods-in-python

Magic or Dunder Methods in Python

파이썬의 중요한 핵심 프레임 워크 : 시퀀스(Sequence), 반복(Iterator), 함수(Functions), 클래스(Class) 

 

 

 

- 매직메소드 

n = 100 
print(dir(n)) # 모든 속성 및 메소드 출력 

__xxx__ ----> 매직 메소드 

 

 

*** 사용 

print('EX1-1 - ', n + 200)
print('EX1-2 - ', n.__add__(200))
print('EX1-3 - ', n.__doc__)
print('EX1-4 - ', n.__bool__(), bool(n))
print('EX1-5 - ', n * 100, n.__mul__(100))

매직 메소드는 파이썬에서 이미 정의된 메서드라고 보면 된다. 이보다도 더 다양한 매직 메소드들이 있다. 

이러한 정수형 타입의 객체는 그냥 + , * 이러한 기호들로 사용할 수 있겠지만, 직접 클래스를 만들어 사용할 때는 직접 정의를 해서 유용하게 사용할 수 있다. 

 

 

 

 

- 클래스 매직 메소드 예제 

(1) 클래스 생성 

class Student:
    # 매직 메서드임. 파이썬에서 이미 정의된 멘서드 
    def __init__(self, name, height):
        self._name = name
        self._height = height

    def __str__(self):
        return 'Student Class Info : {}, {}'.format(self._name, self._height)

    def __ge__(self, x):
        print("Called >> __ge__ Method.")
        if self._height >= x._height:
            return True
        else:
            return False

    def __le__(self, x):
        print("Called >> __le__ Method")
        if self._height <= x._height:
            return True
        else:
            return False

    def __sub__(self, x):
        print('Called >> __sub__ Method.')
        return self._height - x._height

 

위의 문서에서 가져온 매직 메서드 의미 

__str__ ---> To get called by built-int str() method to return a string representation of a type.

__le__ ---> To get called on comparison using <= operator.

__ge__ ---> To get called on comparison using >= operator.

__sub__ ---> To get called on subtraction operation using - operator.

 

 

(2) 사용 

*** 인스턴스 생성 

s1 = Student('James', 181)
s2 = Student('Mie', 165)

Student 클래스의 인스턴스 생성!

 

*** 매직 메소드 출력 

print('EX2-1 - ', s1 >= s2)
print('EX2-2 - ', s1 <= s2)
print('EX2-3 - ', s1 - s2)
print('EX2-4 - ', s2 - s1)
print('EX2-5 - ', s1)
print('EX2-6 - ', s2)

클래스에 매직메소드를 정의하지 않았다면 객체와 객체간의 비교로 받아들이기 때문에 오류가 난다. 

클래스에서 직접 정의를 해놨으므로 오류가 나지 않고 정의한 대로 나온다. 

이와같이 매직메소드를 직접 정의하여 유용한 활용이 가능하다. 

 

 

 

- 클래스 메직메소드 사용 예제 2

(1) 클래스 생성 

class Vector(object):
    def __init__(self, *args):
        '''Create a vector, example : v = Vector(1, 2)'''
        if len(args) == 0:
            self._x, self._y = 0, 0
        else:
            self._x, self._y = args

    def __repr__(self):
        '''Returns the Vector information'''
        return 'Vector(%r, %r)' % (self._x, self._y)

    def __add__(self, other):
        '''Returns the vector addition of self and other'''
        return Vector(self._x + other._x, self._y + other._y)

    def __mul__(self, t):
        '''Returns the vector addition of self and other'''
        return Vector(self._x * t, self._y * t)

    def __bool__(self):
        return bool(max(self._x, self._y))

벡터를 생성해주는 클래스이다. 

__add__메소드는 벡터끼리 각 좌표에 대한 덧셈, __mul__메소드는 실수를 인자에 넣어주면 각 좌표에 곱해지는 것을 구현한 것이다. __bool__메소드는 x, y 좌표 중 큰 값이 0이 아니면 True를 반환하게 해준다. (정말 구현하고 싶은 대로 구현하면 된다!)

 

 

(2) 사용 

# Vector 인스턴스 생성
v1 = Vector(3, 5)
v2 = Vector(15, 20)
v3 = Vector()

# 매직 메소드 출력 
print("EX3-1 - ", Vector.__init__.__doc__)
print("EX3-2 - ", Vector.__repr__.__doc__)
print("EX3-3 - ", Vector.__add__.__doc__)
print("EX3-4 - ", v1, v2, v3)
print("EX3-5 - ", v1 + v2)
print("EX3-6 - ", v1 * 4)
print("EX3-7 - ", v2 * 10)
print('EX3-8 - ', bool(v1), bool(v2))
print('EX3-9 - ', bool(v3))

__doc__ 를 사용하면 위에서 작성했던 주석 설명이 출력된다. 나머지도 잘 실행되면 성공!