jto 1.2.1

Convert json object to dataclass and vice versa

JTO Converter

Description

Convert json object to dataclass and vice versa. This package also provides tool for converting json object to dataclass template.

Requirements

Required structure of dataclass field

All the parts of the below structure are required.

field_name: Optional[FieldType] = field(default=Undefined, metadata={'name': 'json_field_name', 'required': False})

• field_name can be any variable name.
• keyword Optional indicates that the field is nullable.
• FieldType should be strongly typed.
  For example in case of field containing the list it should look like this List[SomeClass]
• default sets default field's value. Set to Undefined by default.
• name is the name of the field in original json.
• required marked True if the field is required in the provided json.

Additional rules

• If dataclass field value set to Undefined then it will not be converted to json field
• If to_json method's argument drop_nones set to True then all dataclass fields with None values will not be converted to json field

Examples

Convert json object to class objects

from dataclasses import dataclass, field
from typing import List, Optional

from jto import JTOConverter
from jto.undefined_field import Undefined

data = {
    "status": 200,
    "data": {
        "first": "qwer",
        "last": "qwer",
        "test": [
            {"f1": "1"},
            {"f1": "2"}
        ]
    }
}

@dataclass
class Test:
    f1: Optional[str] = field(default=Undefined, metadata={'name': 'f1', 'required': False})

@dataclass
class Data:
    first: Optional[str] = field(default=Undefined, metadata={'name': 'first', 'required': False})
    last: Optional[str] = field(default=Undefined, metadata={'name': 'last', 'required': False})
    test: Optional[List[Test]] = field(default=Undefined, metadata={'name': 'test', 'required': False})

@dataclass
class Response:
    status: Optional[int] = field(default=Undefined, metadata={'name': 'status', 'required': False})
    data: Optional[Data] = field(default=Undefined, metadata={'name': 'data', 'required': False})


dataclass_object = JTOConverter.from_json(Response, data)
print(dataclass_object)

dataclass_object.status = None
json_object = JTOConverter.to_json(dataclass_object, drop_nones=True)
print(json_object)

Get class templates from json object

from jto.dataclass_generator import DataclassGenerator

data = {
    "status": 200,
    "data": {
        "first": "foo",
        "last": "bar",
        "struct": [
            {"f1": "1"},
            {"f1": "2"}
        ]
    }
}

classes = DataclassGenerator()
classes_str = classes.build_classes_string('Response', data)
print(classes_str)