pydantic-decoder

Convert json text back into proper Pydantic models.


Keywords
pydantic, json, decode, encode
License
MIT
Install
pip install pydantic-decoder==1.0.2

Documentation

pydantic_decoder

Convert json text back into proper Pydantic models.

Simple Example

from pydantic_decoder import DecoderModel, encode, decode


class MyModel(DecoderModel):
    first_name: str
    last_name: str


model = MyModel(first_name='John', last_name='Doe')
msg = model.json()
m = model.decode(msg)
assert m == model
assert isinstance(m, MyModel)

Registration Examples

Use your current models by only changing the inheritance from pydantic.BaseModel to pydantic_decoder.DecoderModel.

from pydantic_decoder import DecoderModel, register_model, encode, decode

class MyModel(DecoderModel):
    first_name: str
    last_name: str

class MyModel2(DecoderModel):
    first_name: str
    last_name: str


# Subclasses of the DecoderModel are registered automatically
# register_model(MyModel)
# register_model('Model2', MyModel2)

model = MyModel(first_name='John', last_name='Doe')
msg = encode(model)
m = decode(msg)
assert m == model
assert isinstance(m, MyModel)

model2 = MyModel2(first_name='John', last_name='Doe')
msg = encode(model2)
m2 = decode(msg)
assert m2 == model2
assert isinstance(m2, MyModel2)