[python] Marshmallow에서 제공하는 Meta 클래스 활용하기

04 Dec 2023

python

Marshmallow은 Python에서 JSON 직렬화와 역직렬화를 쉽게 처리하기 위한 라이브러리입니다. Marshmallow의 Meta 클래스는 스키마에 추가적인 설정을 제공하는 데 사용됩니다. 이번 포스트에서는 Marshmallow의 Meta 클래스를 활용하는 방법에 대해 알아보겠습니다.

Meta 클래스란?

Marshmallow의 스키마 클래스는 Meta 클래스를 내부에 정의할 수 있습니다. Meta 클래스를 사용하여 스키마의 동작을 커스터마이즈할 수 있습니다. 다음은 Meta 클래스가 포함된 Marshmallow 스키마의 예입니다.

from marshmallow import Schema, fields

class UserSchema(Schema):
    class Meta:
        fields = ('id', 'name', 'email')

위 코드에서 UserSchema 클래스에는 Meta 클래스가 내부에 정의되어 있습니다. Meta 클래스의 fields 속성을 통해 직렬화하거나 역직렬화할 필드를 정의할 수 있습니다.

필드 순서 지정하기

Marshmallow의 Meta 클래스를 사용하면 스키마의 필드 순서를 지정할 수 있습니다. fields 속성에 필드의 순서대로 나열하면 해당 순서대로 직렬화 및 역직렬화됩니다. 따라서 필요에 따라 필드들의 순서를 정의할 수 있습니다.

from marshmallow import Schema, fields

class UserSchema(Schema):
    class Meta:
        fields = ('id', 'name', 'email')

위 예제에서는 id, name, email 순서대로 직렬화 및 역직렬화됩니다.

필드 제외하기

Meta 클래스의 exclude 속성을 사용하면 스키마에서 특정 필드를 제외할 수 있습니다. 다음은 exclude 속성을 사용하여 email 필드를 제외한 예입니다.

from marshmallow import Schema, fields

class UserSchema(Schema):
    class Meta:
        exclude = ('email',)

위 코드에서는 email 필드를 제외한 id와 name 필드만 직렬화 및 역직렬화됩니다.

필드 추가하기

때로는 스키마에 추가적인 필드를 정의하여 사용해야 할 수도 있습니다. Meta 클래스의 fields 속성에 추가로 필드를 지정하여 사용할 수 있습니다.

from marshmallow import Schema, fields

class UserSchema(Schema):
    class Meta:
        fields = ('id', 'name', 'email')
    
    age = fields.Integer()

위 코드에서는 age라는 추가적인 필드를 정의하여 사용하고 있습니다.

결론

Marshmallow의 Meta 클래스를 활용하면 스키마의 동작을 커스터마이즈할 수 있습니다. 필드 순서 지정, 필드 제외, 필드 추가 등의 기능을 Meta 클래스를 통해 쉽게 사용할 수 있습니다.

더 자세한 내용은 Marshmallow의 공식 문서를 참조하시기 바랍니다.

Marshmallow 공식 문서: https://marshmallow.readthedocs.io