jto 1.0.0

Convert json object to dataclass and vice versa

JTO Converter

Description

Convert json object to dataclass and vice versa.

Requirements

Required structure of dataclass field

All the parts of the below structure are required.

field_name: str = field(default=None, metadata={'name': 'json_field_name', 'required': False})

• field_name can be any variable name.
• field type should be strongly typed.
  For example in case of field containing the list it should look like this List[SomeClass]
• default field's value in the most cases will be None, but it also can be changed.
• name is the name of the field in original json including.
• required marked True if the field is required in the provided json.

Examples

Convert json object to class objects

from dataclasses import dataclass, field
from typing import List

from jto import JTOConverter

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

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

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

@dataclass
class Response:
    status: int = field(default=None, metadata={'name': 'status', 'required': False})
    data: Data = field(default=None, 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_empty_keys=True)
print(json_object)

Get class templates from json object

from jto.dataclass_generator import ClassesTemplate

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

classes = ClassesTemplate()
classes.build_classes('Response', data)
print(classes)

classes_str = classes.build_classes_string()
print(classes_str)