return self, 나를 왜 리턴 해야 할까? (Method Cascading)

🤔 Problem

파이토치 내에 클래스 내에 궁금한 메서드가 있어서 소스 코드를 보다가 문득 이런 문법을 보게 됩니다.

def func(self, var1, var2):
    ...
    ...
    return self

제가 임의로 만들어본 메서드입니다. 저기서 self를 리턴하고 있는데 '왜 self를 리턴하고 있는 것인가?'가 궁금했습니다.

그래서 이번 포스팅에서는 이 것에 대해서 이야기해 봅니다.

 

self가 의미하는 바가 인스턴스 본인을 참조하고 있다는 것은 이제는 너무나 명확하고, 당연한 관습입니다.

헷갈리실 수 있겠지만, 문법이 아니라 관습입니다. self가 아닌 다른 걸로 해도 작동합니다. 거의 문법처럼 써서 그렇습니다. 아래의 코드도 정상적으로 작동하거든요 :)

(물론, 현실에서 저러면 많은 욕을 먹을 수도 있습니다...)

class Person():
    def __init__(myself, age: int):
        myself.age = age

    def print_age(myself):
        print(myself.age)


p1 = Person(24)
p1.print_age()

---

😀 Solution: Method Cascading를 가능하게 하기 위해서

https://stackoverflow.com/questions/43380042/purpose-of-return-self-python

Purpose of return self python

아무튼, return self를 하는 경우는 다음 예시로 너무 명쾌하게 설명할 수 있습니다.

위 레퍼런스처럼 같은 코드로 설명을 해보겠습니다.

class Counter():
    def __init__(self, start: int = 1):
        self.val = start

    def increment(self):
        self.val += 1

    def decrement(self):
        self.val -= 1

위 클래스에서 인스턴스를 선언하여, 아래와 같은 코드를 실행시켜 봅시다.

c = Counter()
c.increment().decrement()

바로 이런 에러가 나지 않나요? AttributeError: 'NoneType' object has no attribute 'decrement'

 

에러 내용을 보면, 현재 객체(인스턴스)는 decrement와 같은 attribute(속성)이 없다고 말하고 있습니다. 이게 무슨 말도 안 되는 소린가 싶습니다.

 

c라는 객체에서 increment를 하고, decrement 한 건데 c가 NoneType이라는 것은 현재 어떠한 객체를 가리키고 있지 않다는 뜻입니다. 그러면, increment까지는 잘 성공했다는 뜻이겠네요. 반대로 increment를 한 c에서 decrement는 왜 실패했을까요?

 

근데 잠시만요. c에서 increment를 수행했을 때, 우리는 왜 여전히 그 결과가 c를 가리킨다고 생각하고 있나요? increment나 decrement 구현부에서는 아무것도 리턴하고 있지 않은데 말입니다.

 

이러한 문제를 해결하기 위해서, 다시 말해 객체에 대한 메서드를 연쇄적으로 사용하기 위해서 메서드를 수행한 결과(인스턴스)를 리턴해준다면, 이를 해결할 수 있다는 것입니다. 이와 같이 메서드를 연쇄적으로 사용하는 것을 Method Cascading이라고 합니다.

 

그래서 c라는 객체가 연쇄적으로 메서드를 사용하기 위해서는 아래와 같이 클래스를 다시 선언해주어야 합니다.

class Counter():
    def __init__(self, start: int = 1):
        self.val = start

    def increment(self):
        self.val += 1
        return self

    def decrement(self):
        self.val -= 1
        return self

---

📂 Reference

https://stackoverflow.com/questions/43380042/purpose-of-return-self-python

Purpose of return self python