[ Python ] dataclass 자세히 알아보기

Python의 Dataclass: 개념과 활용법

Python의 dataclass는 코드에서 데이터를 구조화하고 관리하는 데 매우 유용한 기능입니다. Python 3.7부터 도입된 dataclass는 보일러플레이트 코드를 줄이고, 더 가독성 있는 데이터 구조를 만들 수 있도록 도와줍니다. 이 글에서는 dataclass의 기본 개념, 특징, 사용법, 다양한 옵션을 포함한 심화 내용까지 다루겠습니다.

---

1. Dataclass란?

dataclass는 단순히 데이터를 저장하기 위해 사용하는 클래스를 정의할 때 유용한 Python의 내장 데코레이터입니다. 기본적으로 클래스의 생성자, __repr__, __eq__ 등 여러 메서드를 자동으로 생성해 줌으로써 반복적인 코드를 줄이고, 가독성을 높여줍니다.

from dataclasses import dataclass

@dataclass
class Person:
    name: str
    age: int

위와 같은 Person 클래스를 정의하면, 자동으로 생성자 __init__과 같은 메서드들이 정의됩니다.

person = Person(name="Alice", age=30)
print(person)  # 출력: Person(name='Alice', age=30)

---

2. Dataclass의 기본 사용법

필수 필드 정의하기

dataclass는 클래스의 필드를 자동으로 생성하므로, 타입 힌트를 사용하여 필수 필드를 정의할 수 있습니다.

@dataclass
class Book:
    title: str
    author: str
    year: int

book = Book(title="1984", author="George Orwell", year=1949)
print(book)  # 출력: Book(title='1984', author='George Orwell', year=1949)

기본값 설정하기

필드에 기본값을 지정할 수 있으며, 이는 dataclass에서 제공하는 방식으로 구현됩니다.

@dataclass
class Car:
    make: str
    model: str
    year: int = 2020  # 기본값

car = Car(make="Toyota", model="Camry")
print(car)  # 출력: Car(make='Toyota', model='Camry', year=2020)

기본값이 있는 필드 순서 주의

기본값이 없는 필드는 기본값이 있는 필드보다 앞에 위치해야 합니다. 그렇지 않으면 TypeError가 발생합니다.

@dataclass
class Employee:
    name: str
    position: str = "Engineer"
    salary: int
# 오류: non-default argument 'salary' follows default argument 'position'

---

3. Dataclass의 주요 옵션들

dataclass는 @dataclass 데코레이터에 다양한 옵션을 전달할 수 있습니다. 대표적인 옵션으로는 frozen, order, repr 등이 있습니다.

3.1 frozen 옵션

frozen=True를 설정하면 객체가 불변(immutable) 상태가 됩니다. 즉, 생성 후 필드 값을 변경할 수 없게 됩니다. 이를 통해 데이터의 불변성을 보장할 수 있습니다.

@dataclass(frozen=True)
class Point:
    x: int
    y: int

point = Point(1, 2)
# point.x = 3  # 오류: Cannot assign to field 'x' (frozen 상태)

3.2 order 옵션

order=True 옵션을 사용하면 비교 메서드(<, <=, >, >=)를 자동으로 생성합니다. 이를 통해 데이터의 크기 비교가 가능한 객체를 생성할 수 있습니다.

@dataclass(order=True)
class Student:
    name: str
    grade: int

s1 = Student("Alice", 85)
s2 = Student("Bob", 90)
print(s1 < s2)  # 출력: True (85 < 90)

3.3 repr 옵션

repr=False로 설정하면 __repr__ 메서드에서 해당 필드가 제외됩니다. 민감한 정보가 포함된 필드의 경우 이를 제외할 때 유용합니다.

@dataclass(repr=False)
class Account:
    username: str
    password: str

account = Account("user1", "pass123")
print(account)  # 출력: Account() (필드 표시 안 됨)

---

4. 필드의 다양한 설정 - field()

dataclass의 필드는 field() 함수를 사용해 보다 세부적으로 설정할 수 있습니다. 예를 들어, 기본값을 설정하거나, 특정 필드를 비교에서 제외하는 등의 작업을 할 수 있습니다.

from dataclasses import dataclass, field

@dataclass
class Movie:
    title: str
    year: int
    rating: float = field(default=5.0)  # 기본값 설정
    reviews: list = field(default_factory=list)  # 리스트 기본값 설정

movie = Movie(title="Inception", year=2010)
print(movie)  # 출력: Movie(title='Inception', year=2010, rating=5.0, reviews=[])

비교에서 제외 - compare=False

field()에 compare=False를 지정하면 특정 필드를 비교에서 제외할 수 있습니다.

@dataclass
class Product:
    name: str
    price: float
    category: str = field(compare=False)

p1 = Product(name="Laptop", price=1000, category="Electronics")
p2 = Product(name="Laptop", price=1000, category="Computers")

print(p1 == p2)  # 출력: True (category는 비교에서 제외됨)

---

5. dataclass에서의 메서드 추가

dataclass는 메서드 추가를 방해하지 않습니다. 필요할 경우 사용자 정의 메서드를 추가할 수 있으며, 데이터 조작 및 비즈니스 로직을 포함할 수 있습니다.

@dataclass
class Rectangle:
    width: float
    height: float

    def area(self) -> float:
        return self.width * self.height

rect = Rectangle(10, 5)
print(rect.area())  # 출력: 50.0

---

6. Dataclass와 상속

dataclass는 상속도 지원합니다. 부모 클래스의 dataclass 필드를 자식 클래스가 상속받고, 추가적인 필드를 정의할 수 있습니다.

@dataclass
class Animal:
    name: str

@dataclass
class Dog(Animal):
    breed: str

dog = Dog(name="Buddy", breed="Golden Retriever")
print(dog)  # 출력: Dog(name='Buddy', breed='Golden Retriever')

---

7. dataclass와 __post_init__

__post_init__ 메서드는 dataclass 객체가 생성된 후 추가적인 초기화가 필요할 때 사용됩니다. 예를 들어, 특정 조건에 따라 값을 변경하거나 검증을 수행할 수 있습니다.

@dataclass
class Person:
    name: str
    age: int

    def __post_init__(self):
        if self.age < 0:
            raise ValueError("Age cannot be negative")

person = Person("Alice", -5)  # 오류 발생: Age cannot be negative

---

8. Dataclass의 장단점

장점

• 코드 간결성: 기본 생성자와 다양한 메서드가 자동으로 생성되어 코드가 간결해집니다.
• 타입 힌트 지원: 필드의 타입을 지정해 타입 안전성을 높일 수 있습니다.
• 자동 비교 연산 지원: order=True 옵션을 사용해 비교 연산자를 간편하게 사용할 수 있습니다.
• 불변성 지원: frozen=True로 설정하여 객체를 불변으로 만들어 안정성을 높일 수 있습니다.

단점

• 가변 기본값 문제: 리스트나 딕셔너리 같은 가변 객체를 필드의 기본값으로 사용할 때 주의해야 합니다. default_factory로 해결할 수 있지만, 이를 모르면 예상치 못한 오류가 발생할 수 있습니다.
• 상속 제약: 다중 상속과 같은 복잡한 상속 구조에서는 다소 제약이 있을 수 있습니다.
• 성능: 일반 클래스보다 메모리를 다소 더 많이 사용할 수 있으며, 특히 대규모 애플리케이션에서 성능에 미세한 차이가 있을 수 있습니다.

---

결론

Python의 dataclass는 데이터 중심의 클래스 작성에 있어 코드의 가독성과 유지보수성을 크게 향상시켜주는 유용한 도구입니다. 불필요한 코드를 줄이고 데이터 객체를 효율적으로 관리할 수 있으며, field() 설정, frozen 불변 객체, order 정렬 등의 다양한 옵션을 통해 고도의 커스터마이징이 가능합니다.