Pydantic enum field does not get converted to string

Question

I am trying to restrict one field in a class to an enum. However, when I try to get a dictionary out of class, it doesn't get converted to string. Instead it retains the enum. I checked pydantic documentation, but couldn't find anything relevant to my problem.

This code is representative of what I actually need.

from enum import Enum
from pydantic import BaseModel

class S(str, Enum):
    am = 'am'
    pm = 'pm'

class K(BaseModel):
    k: S
    z: str

a = K(k='am', z='rrrr')
print(a.dict()) # {'k': <S.am: 'am'>, 'z': 'rrrr'}

I'm trying to get the .dict() method to return {'k': 'am', 'z': 'rrrr'}

literals are the easier way to achieve the result stackoverflow.com/a/76973419/3140992 — citynorman
– citynorman, Commented Jan 13 at 23:03

alex_noname · Accepted Answer · 2020-12-09 06:32:22Z

189

You need to use use_enum_values option of model config:

use_enum_values

whether to populate models with the value property of enums, rather than the raw enum. This may be useful if you want to serialise model.dict() later (default: False)

from enum import Enum
from pydantic import BaseModel

class S(str, Enum):
    am='am'
    pm='pm'

class K(BaseModel):
    k:S
    z:str

    class Config:  
        use_enum_values = True  # <--

a = K(k='am', z='rrrr')
print(a.dict())

answered Dec 9, 2020 at 6:32

alex_noname

33.2k6 gold badges95 silver badges110 bronze badges

Sign up to request clarification or add additional context in comments.

6 Comments

Krishna Over a year ago

is there a reason that this option is False by default? I feel in most of the cases we would require that to be true.

Stephen Carboni Over a year ago

@Krishna one could argue why not leave dates as ISO8601 strings? Principle of least surprise is that you get what you ask for, you asked for an Enum

vianmixt Over a year ago

Is there a way to use the enum values when serializing using .dict() but keep the full enum when deserializing and constructing the pydantic object ?

masus04 Over a year ago

I was wondering the same as @vianmixt. The whole reason why anyone would use an enum is so that when working with the object, one has the convenience that enums offer, but yet it can be serialized as a string as this is the simplest way to be language independent.

johnthagen Over a year ago

@vianmixt See y26805's answer for a solution that relies on FastAPI.

|

Yaakov Bressler · Accepted Answer · 2023-08-24 23:11:48Z

30

Pydantic 2.0

By default, Pydantic preserves the enum data type in its serialization. To override this behavior, specify use_enum_values in the model config.

from enum import Enum
from pydantic import BaseModel, ConfigDict

class S(str, Enum):
    am = 'am'
    pm = 'pm'


class K(BaseModel):
    model_config = ConfigDict(use_enum_values=True)

    k: S
    z: str

a = K(k='am', z='rrrr')
print(a.model_dump()) # {'k': 'am', 'z': 'rrrr'}

Note: model_config is now an attribute of type ConfigDict (this is a breaking change from V1).

Neater: Specify config options as model class kwargs

Alternatively, you can populate directly in the class definition:

class K(BaseModel, use_enum_values=True):
    k: S
    z: str

answered Aug 24, 2023 at 23:11

Yaakov Bressler

12.7k5 gold badges66 silver badges96 bronze badges

3 Comments

nmu Over a year ago

Thanks for the tip about the kwargss!

Brad K. Over a year ago

Calling .model_dump(mode="json") allows for being able to get a json-able dict when dumping the object while retaining the ability to construct and deserialize objects with the actual enum type.

Mohamed Mostafa Aug 28 at 11:42

@BradK. You should use model.dump_json() instead

johnthagen · Accepted Answer · 2022-10-24 19:26:16Z

14

You can use FastAPI's jsonable_encoder:

from enum import Enum
from pydantic import BaseModel
from fastapi.encoders import jsonable_encoder

class S(str, Enum):
    am = 'am'
    pm = 'pm'

class K(BaseModel):
    k: S
    z: str

a = K(k='am', z='rrrr')
print(jsonable_encoder(a)) # {'k': 'am', 'z': 'rrrr'}

edited Oct 24, 2022 at 19:26

johnthagen

9,3798 gold badges44 silver badges49 bronze badges

answered Sep 13, 2022 at 3:21

y26805

1411 silver badge4 bronze badges

2 Comments

johnthagen Over a year ago

This is nice because you can keep the full Enum when deserializing and constructing the Pydantic object.

jack west Over a year ago

This is my preferred way of doing this as you don't always want to loose the enum type when using model_dump, would be nicer to pass use_enum_values when calling model_dump. Using model_dump_json does not always work in our use case either.

mr_mo · Accepted Answer · 2023-05-10 23:06:09Z

9

The answer by using Config class is correct but may not be necessary. It may be inconvenient to repeatedly implement and could be redundant for some readers so I offer easier alternatives and a short explanation.

TL;DR

For JSON serialization, no need to do anything. Using (Str,Enum) subclasses is enough without Config.
For printable representational string/other feature, create a custom StrEnum class. This was added in 3.11 but since previous versions don't support it - I provide an example.

Example

from enum import Enum

class StrEnum(str, Enum):
    def __repr__(self) -> str:
        return str.__repr__(self.value)

class A(str, Enum):
    FOO = "foo"

class B(StrEnum):
    BAR= "bar"

class C(BaseModel):
    a: A = Field(...)
    b: B = Field(...)

print(C(a="foo", b="bar").dict())

import json

print(json.dumps(C(a="foo", b="bar").dict()))

Outputs:

{'a': <A.FOO: 'foo'>, 'b': 'bar'}
{"a": "foo", "b": "bar"}

Explanation

Class A and B are of types (str, Enum) and StrEnum, respectively. Both are JSON serializable; StrEnum also prints as a primitive string.

answered May 10, 2023 at 23:06

mr_mo

1,5489 silver badges14 bronze badges

1 Comment

Tobx Over a year ago

This doesn't work with Pydantic, there you need use_enum_values=True as described above.

Collectives™ on Stack Overflow

Pydantic enum field does not get converted to string

4 Answers 4

6 Comments

Pydantic 2.0

Neater: Specify config options as model class kwargs

3 Comments

2 Comments

TL;DR

Example

Explanation

1 Comment

Your Answer

Linked

Hot Network Questions

Collectives™ on Stack Overflow

4 Answers 4

6 Comments

Pydantic 2.0

Neater: Specify config options as model class kwargs

3 Comments

2 Comments

TL;DR

Example

Explanation

1 Comment

Your Answer

Sign up or log in

Post as a guest

Linked

Related