Django Mixin 사용법

💬 Intro

📖 Rule of Thumb

🤷‍♂️ Why?

📚 References

Intro

Django의 CBV(Class Based View)를 사용할 때, Mixin을 활용하면 필요한 기능을 손쉽게 추가할 수 있습니다.

예를 들어 RetrieveAPIView를 사용하고 있는데 Create 기능이 필요하면 다음과 같이 CreateModelMixin을 상속받아 Create 기능을 추가할 수 있습니다.

# 잘못된 사용 

class ProductRetrieveCreateView(RetrieveAPIView, CreateModelMixin):
		pass
Python
복사

다만 Mixin을 올바르게 사용하기 위해서는 몇 가지 고려해야 하는 사항이 있습니다.

Django CBV와 Mixin을 올바르게 사용하는 방법에 대해 간단하게 알아보겠습니다.

Rule of Thumb

Mixin을 사용할 때 <Two Scoops of Django 3.x>에서 추천하는 사용 방법은 다음과 같습니다.

Django가 제공하는 Base View Class는 가장 오른쪽에 둔다.

Mixin은 Base View의 왼쪽에 둔다.

또한 Mixin은 어떤 Class로부터라도 상속을 받아서 안 된다.

위의 방법을 적용한 예시는 다음과 같습니다.

from django.views.generic import TemplateView 


class FreshFruitMixin:
		def get_context_data(self, **kwargs):
				context = super().get_context_data(**kwargs) 
				context["has_fresh_fruit"] = True
				return context

class FruityFlavorView(FreshFruitMixin, TemplateView): 
		template_name = "fruity_flavor.html"
Python
복사

위의 예시에서 주의 깊게 보아야 하는 점은

FruitFlavorView의 상속 순서에서 FreshFruitMixin이 TemplateView 보다 왼쪽에 있고

FreshFruitMixin이 다른 클래스로부터 상속 받지 않는 클래스라는 것입니다.

Why?

왜 위와 같은 방법을 추천하는 걸까요?

정답은 Python의 MRO(Method Resolution Order)와 관련 있습니다.

Python은 다중 상속을 받은 클래스에서 attribute나 method를 탐색할 때, C3 Linearization 알고리즘을 사용합니다.

C3 Linearization 알고리즘 한 문장으로 표현하면 다음과 같습니다:

depth-first until classes are encountered that will share a parent, and then breadth-first over those ...

attribute나 method 탐색 시에

먼저 현재 클래스에서 찾습니다.

현재 클래스에서 찾지 못하면 부모 클래스로 이동하여 depth-first 탐색을 합니다.

탐색 중 공유되는 parent class를 만나면 돌아가서 breadth-first 탐색을 합니다.

예시를 통해서 더 자세하게 알아봅시다.

다음과 같은 상속 관계를 가진 클래스들을 정의해줍니다:

class A(): pass
class B(A): pass
class C(A): pass
class D_0(B, C): pass
class D_1(B, C): pass
class E_0(D_0): pass
class E_1(D_1): pass
class F(E_0, E_1): pass
Python
복사

위의 상속관계를 도식화 하여 표현하면 다음과 같습니다:

F 클래스의 MRO를 순차적으로 출력해보면 다음과 같습니다:

print([x.__name__ for x in F.mro()])
Python
복사

['F', 'E_0', 'D_0', 'E_1', 'D_1', 'B', 'C', 'A', 'object']
Python
복사

위에서 설명한 룰에 따라 F 인스턴스에서 어떤 attribute나 method를 호출하면,

본인 클래스(F)를 먼저 탐색한 뒤, 첫 번째 부모 클래스부터 순차적으로 깊이 우선 탐색을 진행합니다:

['F', 'E_0', 'D_0', 'E_1', 'D_1', 'B', 'C', 'A', 'object']
Python
복사

D_0와 D_1에서 공통으로 상속 받은 부모 클래스(B)를 만나면, F의 두 번째 부모 클래스인 E_1부터 다시 탐색을 시작합니다:

['F', 'E_0', 'D_0', 'E_1', 'D_1', 'B', 'C', 'A', 'object']
Python
복사

마지막으로 공통 부모인 B부터 탐색하는데 이 때도 A가 공통 부모이기 때문에 탐색 순서는 다음과 같습니다:

['F', 'E_0', 'D_0', 'E_1', 'D_1', 'B', 'C', 'A', 'object']
Python
복사

따라서 현재 클래스에 있는 attribute나 method가 아니면 상속 받은 클래스를 탐색할 때 왼쪽에 있는 Mixin부터 탐색하고 마지막으로 Base View를 확인할 것입니다.

우리가 Mixin을 사용하는 경우는 일반적으로 기존 View에 새로운 기능을 추가하기 위한 것이기 때문에 탐색을 할 때도 BaseView 보다는 Mixin를 먼저 탐색하는 것이 합리적입니다.

또 가급적 Mixin은 다른 Class로부터 상속을 받지 않아서 inheritance chain을 단순하게 유지함으로서 예상하지 못한 결과를 방지할 수 있습니다.

References

Two Scoops of Django 3.x: Best Practices for the Django Web Framework

540+ pages, 485 while in Alpha Once again, we're releasing a book chock-full of material that will help you with your Django projects! In Two Scoops of Django we introduce you to various tips, tricks, patterns, code snippets, and techniques that we've picked up over the years.

https://www.feldroy.com/collections/two-scoops-press/products/two-scoops-of-django-3-x

Is mro order depth-first or breadth-first?

Ignoring classic classes, Python resolves method and attribute lookups using the C3 linearisation of the class and its parents. The C3 linearisation is neither depth-first nor breadth-first in complex multiple inheritance hierarchies. In some sense, it is: depth-first until classes are encountered that will share a parent, and then breadth-first over those although that is a very loose characterisation.

https://stackoverflow.com/questions/47117327/is-mro-order-depth-first-or-breadth-first

C3 linearization - Wikipedia

In computing, C3 superclass linearization is an algorithm used primarily to obtain the order in which methods should be inherited in the presence of multiple inheritance. In other words, the output of C3 superclass linearization is a deterministic Method Resolution Order ( MRO).

https://en.wikipedia.org/wiki/C3_linearization

Method resolution order in Python Inheritance - GeeksforGeeks

Method Resolution Order : Method Resolution Order(MRO) it denotes the way a programming language resolves a method or attribute. Python supports classes inheriting from other classes. The class being inherited is called the Parent or Superclass, while the class that inherits is called the Child or Subclass.

https://www.geeksforgeeks.org/method-resolution-order-in-python-inheritance