TIL11. Python : Special method

📌 이 포스팅에서는 Python의 special method에 대해 익숙해지는 시간을 가져보겠습니다.

🌈 Special method

🔥 Special method란?

🔥 Special method를 오버라이딩하기

🔥 Special method로 Vector 만들기

1. Special method란?

🤔 special method가 무엇일까?

✔️ 파이썬의 모든 자료형은 데이터 구조에서 객체로 취급하기 때문에 class 형태를 가지고 있고, 데이터 타입별로 유용한 메서드를 가지고 있습니다.
✔️ 자료구조의 살펴보면 더블 언더스코어(__)로 시작하고 끝나는 형태의 매서드가 존재하는데 이를 "Magic method" 또는 "Special method"라 부릅니다.

print(int) # <class 'int'>
print(dir(int))
"""
['__abs__', '__add__', '__and__', '__bool__', '__ceil__', '__class__', '__delattr__',
'__dir__', '__divmod__', '__doc__', '__eq__', '__float__', '__floor__', '__floordiv__',
'__format__', '__ge__', '__getattribute__', '__getnewargs__', '__gt__', '__hash__',
'__index__', '__init__', '__init_subclass__', '__int__', '__invert__', '__le__',
'__lshift__', '__lt__', '__mod__', '__mul__', '__ne__', '__neg__', '__new__', '__or__',
'__pos__', '__pow__', '__radd__', '__rand__', '__rdivmod__', '__reduce__',
'__reduce_ex__', '__repr__', '__rfloordiv__', '__rlshift__', '__rmod__', '__rmul__',
'__ror__', '__round__', '__rpow__', '__rrshift__', '__rshift__', '__rsub__',
'__rtruediv__', '__rxor__', '__setattr__', '__sizeof__', '__str__', '__sub__',
'__subclasshook__', '__truediv__', '__trunc__', '__xor__', 'as_integer_ratio',
'bit_length', 'conjugate', 'denominator', 'from_bytes', 'imag', 'numerator',
'real', 'to_bytes']
"""

✔️ 예를들어, int형 데이터가 +(더하기), -(빼기) 등 사칙연산이 가능한 것은 int형 데이터 구조가에는 이를 위한 "Special method"가 준비되었기 때문입니다.

# 더하기(+)
n = 100
print(n+200) # 300
print(n.__add__(200)) # 300
print(n.__doc__)
"""
int([x]) -> integer
int(x, base=10) -> integer
Convert a number or string to an integer, or return 0 if no arguments
are given.  If x is a number, return x.__int__().  For floating point
numbers, this truncates towards zero.
If x is not a number or if base is given, then x must be a string,
bytes, or bytearray instance representing an integer literal in the
given base.  The literal can be preceded by '+' or '-' and be surrounded
by whitespace.  The base defaults to 10.  Valid bases are 0 and 2-36.
Base 0 means to interpret the base from the string as an integer literal.
>> int('0b100', base=0)
4
"""
# 곱하기(*)
n = 2
print(n*100) # 200
print(n.__mul__(100)) # 200
# Boolean
n = 0
print(bool(n)) # False
print(n.__bool__()) # False

2. Special method를 오버라이딩하기

🤔 specail method를 오버라이딩하면 불가능 했던 것을 가능하게 할 수 있습니다.

✔️ Calss 객체는 int형처럼 사칙연산이나 대소비교 등을 시도하면 TypeError가 발생됩니다.

class Student:
    def __init__(self, name, height):
        self._name = name
        self._height = height
# 객체 생성
s1 = Student('Jaewon', 171)
s2 = Student('Haezin', 163)
print(s1 + s2) # TypeError
print(s1 >= s2) # TypeError
print(s1 <= s2) # TypeError
print(s1 - s2) # TypeError

✔️ 이럴ㄷ 때, "Special method"를 오버라이딩하여 사용하면 필요에 따라 그 기능을 제공할 수 있고, 작동 방법을 다르게 custom할 수도 있습니다.

class Student:
    def __init__(self, name, height):
        self._name = name
        self._height = height
    # __str__ 오버라이딩
    def __str__(self): 
        return 'Student Class Info : {}, {}'.format(self._name, self._height)
    # __ge__ 오버라이딩
    def __ge__(self, x): # 👈 ge : 크거나 같다
        if self._height >= x._height:
            return True
        else:
            return False
    # __le__ 오버라이딩
    def __le__(self, x): # 👈 le : 작거나 같다
        if self._height <= x._height:
            return True
        else:
            return False
    # __sub__ 오버라이딩
    def __sub__(self, x):
        return self._height - x._height
# 객체 생성
s1 = Student('Jaewon', 171)
s2 = Student('Haezin', 163)
# __str__ 매서드 출력
print(s1) # Student Class Info : Jaewon, 171
print(s2) # Student Class Info : Haezin, 163
# __ge__  매서드 출력
print(s1 >= s2) # True
print(s1.__ge__(s2)) # True
# __le__ 매서드 출력
print(s1 <= s2) # False
print(s1.__le__(s2)) # False
# __sub__ 매서드 출력
print(s1 - s2) # 8
print(s2 - s1) # -8

3. Special method로 Vector 만들기

# Magic Method
class Vector(object):
    def __init__(self, *args):
        """Create a vetor, 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 informations"""
        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, y):
        return Vector(self._x * y, self._y * y)
    def __bool__(self):
        return bool(max(self._x, self._y))
# Vector 인스턴스 생성
v1 = Vector(3,5)
v2 = Vector(15,20)
v3 = Vector()
# 매직메소드 출력
print(Vector.__init__.__doc__) # Create a vetor, example : v = Vector(1,2)
print(Vector.__repr__.__doc__) # Returns the vector informations
print(Vector.__add__.__doc__) # Returns the vector addition of self and other
print(v1, v2, v3) # Vector(3, 5) Vector(15, 20) Vector(0, 0)
print(v1 + v2) # Vector(18, 25)
print(v1 * 4) # Vector(12, 20)
print(v2 * 10) # Vector(150, 200)
print(bool(v1), bool(v2), bool(v3)) # True True False