Skip to main content

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.)

Since creating this library, I've discovered Pydentic, which is a much more professional library, that in 99% of cases will be much more suitable than this library. So I strongly recommend using Pydentic. If you use dataclass-dict-convert, beware that it is poorly maintained, not very well documented, may contain some bugs, and has some strange edge cases where it doesn't work.

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


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

dataclass_dict_convert-1.7.4.tar.gz (21.6 kB view details)

Uploaded Source

Built Distribution

dataclass_dict_convert-1.7.4-py3-none-any.whl (15.5 kB view details)

Uploaded Python 3

File details

Details for the file dataclass_dict_convert-1.7.4.tar.gz.

File metadata

  • Download URL: dataclass_dict_convert-1.7.4.tar.gz
  • Upload date:
  • Size: 21.6 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.0.1 CPython/3.12.5

File hashes

Hashes for dataclass_dict_convert-1.7.4.tar.gz
Algorithm Hash digest
SHA256 66bfa54c68410d6b996d3b23c94d1dc5ed51450ed097745caa876240b0be020c
MD5 c6eda6df0281d13cd4a8877686f86143
BLAKE2b-256 2361813d6eaa91a1e902ee1178e61852694ddc52f7eb2118ac209e755ac2244e

See more details on using hashes here.

File details

Details for the file dataclass_dict_convert-1.7.4-py3-none-any.whl.

File metadata

File hashes

Hashes for dataclass_dict_convert-1.7.4-py3-none-any.whl
Algorithm Hash digest
SHA256 7fae1595611d635f33683ea9de500417c42d3a420f79e5c879fd425b9a34cd00
MD5 4212773d679a654c4591e85d0196f066
BLAKE2b-256 671c9f3280c0abc096d189563c3815ce153c8e84f8b68f728e9071af49ff0902

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page