[Django] 모델 __str__() 메서드에서 외래키 표현

[jseop-lim]

class Parent(models.Model):
    name = models.CharField('이름')

    def __str__(self):
        return f'[부모 {self.id}] {self.name}'


class Child(models.Model):
    age = models.IntegerField('나이')
    parent = models.ForeignKey(Parent, verbose_name='부모')

    def __str__(self):
        return f'[자식 {self.id}] {self.parent.name}'  # DO
        return f'[자식 {self.id}] {self.parent}'       # DO NOT

모델 __str__() 메서드에서 반환 값에 외래키를 포함한다면, 참조하는 모델의 외래키 아닌 필드를 직접 명시하는 것이 좋습니다. 스타일 가이드의 영역인지 모호하다고 생각합니다만, 그렇다면 가이드에 삽입해도 좋아보입니다.

DO NOT 경우를 사용할 때 사용하는 지점에서 N+1 문제 발생 원인을 파악하기 어렵습니다.

상세 이유는 하기와 같습니다.

1. __str__()을 통한 연속적인 외래키 참조는 직접 확인해보지 않고 알기 쉽지 않습니다.
2. __str__()을 명시적으로 적지 않지만 해당 메서드를 사용하는 지점이 많습니다. 테스트, 로그, 어드민 등이 해당합니다. 매직 메서드가 호출된다는 지식이 없을 경우 N+1 문제로 인해 성능 저하가 크게 발생합니다.