Convert between Dataclasses and dict/json
Project description
Dataclass Dict Convert
This library converts between python dataclasses and dicts (and json).
It was created because when using the dataclasses-json library for my use case, I ran into limitations and performance issues. (There's also typed-json-dataclass but I haven't evaluated that library.)
dataclass-dict-convert
supports lists, optionals, dicts, enums, nested dataclasses, etc.
It handles dates using RFC3339 (and enforces timezones and timezone aware datetime
).
Example:
from dataclasses import dataclass
from stringcase import camelcase
from typing import Optional, List
from dataclass_dict_convert import dataclass_dict_convert
@dataclass_dict_convert(dict_letter_case=camelcase)
@dataclass(frozen=True)
class TestB:
an_int: int
a_str: str
a_float: float
a_bool: bool
@dataclass_dict_convert(dict_letter_case=camelcase)
@dataclass(frozen=True)
class Test:
nestedClass: TestB
nestedInOpt: Optional[TestB]
nestedInList: List[TestB]
the_instanceB1 = TestB(1, 'foo', 0.1, True)
the_instanceB2 = TestB(2, 'bar', 0.2, False)
the_instanceB3 = TestB(3, 'baz', 0.3, True)
the_instanceB4 = TestB(4, 'huh', 0.4, False)
the_instance = Test(the_instanceB1, the_instanceB2, [the_instanceB3, the_instanceB4])
the_dict = {
'nestedClass': {'anInt': 1, 'aStr': 'foo', 'aFloat': 0.1, 'aBool': True, },
'nestedInOpt': {'anInt': 2, 'aStr': 'bar', 'aFloat': 0.2, 'aBool': False, },
'nestedInList': [
{'anInt': 3, 'aStr': 'baz', 'aFloat': 0.3, 'aBool': True, },
{'anInt': 4, 'aStr': 'huh', 'aFloat': 0.4, 'aBool': False, },
],
}
expected = the_dict
actual = the_instance.to_dict()
assert actual == expected
expected = the_instance
actual = Test.from_dict(the_dict)
assert actual == expected
The library also includes:
- RFC3339 tools (the default format for converting datetime to string),
- dataclass type checking tools
- dataclass copy method generator
- dataclass multiline repr (replace auto generated repr for dataclasses by a multiline version)
Links:
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
Close
Hashes for dataclass-dict-convert-1.5.0.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | 8be4effe0d029d06ef1826353a04cd0bb717b6f079f052c34ca7c34ae07629b9 |
|
MD5 | 6136e2d32b7c8e93f1611564a14339eb |
|
BLAKE2b-256 | 094789c5ad1de18c77e3d0c7d798ba8846eb5a662a3d011311443183ab67edcf |
Close
Hashes for dataclass_dict_convert-1.5.0-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | afcdd05f7ec8f56399fd40e77fcd2419d6cae273359aa1902aa01fd07c5fdee8 |
|
MD5 | ce74add6fffc104ad180445e154d9762 |
|
BLAKE2b-256 | f646793e3715618f678580c05406f7da80058e3e0ea209c4acf792b630127530 |