🐍[Python] 매직 메소드 - 1

Written by metterian
on November 06, 2021

들어가며

우리가 코드를 작성할 때, 파이썬이 내부적으로 Built-in 함수를 수정해서 사용하여 되면 좀 더 효율적이 코딩이 가능 합니다. 이것을 매직 메소드 혹은 스페셜 메소드라고 합니다.

파이썬을 잘하기 위해서는 시퀀스(Sequence), 반복(Iterator), 함수(Functions), 클래스(Class) 이 4가지 요소를 잘 알아야 합니다.

매직 메소드

클래스 안에 정의할 수 있는 특별한(Built-in) 메소드를 매직 메소드라고 합니다.

기본형

다음과 같이 int 메소드를 출력하면 어떻게 될까요? 다음과 같이 <class 'int'> 로 출력 됩니다. 다시 말해 파이썬의 모든 데이터 타입은 클래스 입니다. 그래서 클래스가 중요한 것 입니다.

print(int)
# <class 'int'>

모든 속성 및 메소드 출력

그렇다면 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']

우리가 이전에 사용했던 변수들 보다는 훨씬 더 많은 메소드들을 포함하고 있습니다. 다음과 같이 n 에 int 형 숫자를 선언 하고 type 을 찍어보면 다음과 같이 int class 를 출력합니다. 즉, int class 의 메소드들을 수정하면 보다 low-level에서 코딩이 가능해 집니다.

n = 10
print(type(n))
# <class 'int'>

다음 코딩과 같이 + 를 사용하건, __add__ 메소드를 사용하건 결과가 동일 합니다. 우리가 덧셈을 할 때 + 이 아니라 __add__ 를 사용하면 어떨까요? 굉장히 사용하기 어렵고 가독성도 떨어 질 것 입니다. 때문에 파이썬 언어에서 이를 wrapping 처리를 하여 + 으로 연산이 가능하도록 한 것 입니다.

>>> n = 10
>>> print(n+ 100)
>>> print(n.__add__(100))

# 110
# 110

예제#1

다음과 같이 클래스 코드를 작성한다.

# 클래스 예제1
class Fruit:
    def __init__(self, name, price) -> None:
        self._name = name
        self._price = price

    def __str__(self) -> str:
        return f'Fruit Class Info {self._name}, {self._price}'

    def __add__(self, x):
        return self._price + x._price

다음과 같이 인스턴스를 생성한다.

# 인스턴스 사용
s1 = Fruit("Orange", 7500)
s2 = Fruit('Banana', 3000)

자 이 둘의 과일 가격을 계산하면 어떻게 해야 할까? 인스턴스를 직접 접속해서 연산하는 것은 매우 위험한 행동이라고 했다. 또한 코드의 양도 늘어 나고 가독성도 떨어지게 된다.

# 일반적인 연산
s1._price + s2._price

# 매직 메소드를 사용한 연산
s1 + s2

위와 같이 매직 메소드를 사용하면 인스턴스 변수도 보호 할 수 있을 뿐만 아니라 코드의 가독성도 살아나게 된다.

예제#2

예를 들어, 2차원 평면상의 좌표를 덧셈하는 문제가 주어졌다고 가정해보자.

(5,2) + (4,3)  = (9,5)
(10,3) + * 5 = (50, 15)
max((5,10)) = 10

클래스 구현

class Vector(object):
    ''''''
    def __init__(self,  *args) -> None:
        """Create a vector, example : v = Vector(5,10)"""
        if len(args) == 0:
            self._x, self._y = 0, 0

        else:
            self._x, self._y = args

    def __repr__(self) -> str:
        "Return the Vector information"
        return f"Vector({self._x}, {self._y})"

    def __add__(self, other):
        """Return the vector addition of inputs"""
        return Vector(self._x + other._x, self._y + other._y)

    def __mul__(self, other):
        """Return the vector multiply of inputs"""
        return Vector(self._x * other._x, self._y * other._y)

    def __bool__(self):
        """Check inputs are in 2-D coordinate"""
        return bool(max(self._x, self._y))

출력

print(Vector.__init__.__doc__)
# Create a vector, example : v = Vector(5,10)
print(Vector.__add__.__doc__)
# Return the vector addition of inputs


print(v1, v2, v3)
# Vector(5, 7) Vector(23, 35) Vector(0, 0)

print(v1 + v2)
# Vector(28, 42)
print(v1 * v2)
# Vector(115, 245)

dataclasses 한 스푼

python의 dataclasses를 사용해서 위에서 작성한 클래스를 보다 더 개선 할 있습니다.

from dataclasses import dataclass

@dataclass
class Vector(object):
    _x : int = 0
    _y : int = 0

    def __repr__(self) -> str:
        """Return the Vector information"""
        return f"Vector({self._x}, {self._y})"

    def __add__(self, other):
        """Return the vector addition of inputs"""
        return Vector(self._x + other._x, self._y + other._y)

    def __mul__(self, other):
        """Return the vector multiply of inputs"""
        return Vector(self._x * other._x, self._y * other._y)

    def __bool__(self):
        """Check inputs are in 2-D coordinate"""
        return bool(max(self._x, self._y))

    
>>> print(v1, v2, v3)
# Vector(5, 7) Vector(23, 35) Vector(0, 0)
>>> print(v1 + v2)
# Vector(28, 42)
>>> print(v1 * v2)
# Vector(115, 245)

dataclass를 사용하므로써, __init__ 메소드에서 복잡하게 인자를 받아 코드를 작성 할 때 보다. 코드의 가독성이 좋아지고 사용성도 좋아 졌습니다.

← → Top