- Sanic에서 웹소켓을 구현하는 예제를 보던 중 클래스 위에
@dataclass라는 데코레이터가 붙어있었다.
from dataclasses import dataclass, field
...(생략)
@dataclass
class Client:
interface: websockets.server.WebSocketServerProtocol = field(repr=False)
sid: str = field(default_factory=partial(generate_code, 36))
...(생략)
dataclasses는 파이썬 3.7부터 표준 라이브러리에 포함되어 별도 설치 없이 사용할 수 있다.- 이는 데이터 클래스를 보다 용이하게 선언해주는 데코레이터이다. 타입 어노테이션으로 필드를 선언한다.
- 클래스에
@dataclass데코레이터를 사용하면__init__,__repr__,__eq__등의 메서드를 자동으로 정의해 준다.
from dataclasses import dataclass
# 이렇게 @dataclass 데코레이터를 클래스 위에 붙여준다.
@dataclass
class Item:
id: int
name: str
print(Item(1, "Apple"))
print(Item(2, "Banana"))
실행 결과
>>
Item(id=1, name='Apple')
Item(id=2, name='Banana')
- 위의 코드 같은 경우 데코레이터를 사용하지 않는다면
__init__메서드에 id와 name을 변수로 받는 것이 없기 때문에 에러가 발생한다. 만약__init__메서드를 정의했다하더라도,__repr__메서드가 정의되어 있지 않기 때문에 아래와 같이 출력된다.
class Item:
id: int
name: str
def __init__(self, id: int, name: str):
self.id = id
self.name = name
print(Item(1, "Apple"))
print(Item(2, "Banana"))
실행 결과
>>
<__main__.Item object at 0x7fd501796898>
<__main__.Item object at 0x7fd501796898>
- 데이터를 정의하는 클래스라는 점에서 기존 파이썬의
collections.namedtuple비슷하다. 하지만,@dataclass를 사용한 클래스는 말 그대로 클래스라는 점에서 메서드나 프로퍼티를 추가할 수 있다. dataclasses.field를 사용하면 해당 프로퍼티에 대한 설정을 해줄 수 있다. (ex:default_factory,repr여부)
from dataclasses import dataclass, field
import uuid
@dataclass
class Factory:
id: uuid.UUID = field(default_factory=uuid.uuid4)
items: list = field(default_factory=list)
f1 = Factory()
print(f1.items)
f1.items += ['apple', 'banana']
print(f1.items)
print(f1)
실행 결과
>>
[]
['apple', 'banana']
Factory(id=UUID('990091ef-6058-4754-b1f5-78e3546cc7bd'), items=['apple', 'banana'])
- 파이썬의
Type Annotation을 활용하긴 하지만, 해당 타입이 맞는지 검증(validate)하지는 않는다. - 만약
dataclasses를 사용하고 검증까지 원한다면 pydantic의pydantic.dataclasses를 사용하면 된다. (pydantic라이브러리는 추후에 제대로 공부해서 정리하겠다.) [참고]