Skip to main content

Helpers to parse dicts, e.g., from JSON parsing, to dataclasses.

Project description

dict2dc - dictionary to dataclass parsing

Python PyPI version Downloads GitHub stars last release status

dict2dc is a small Python library that helps to parse Python dicts to dataclass structures. E.g., these dicts could originate from JSON deserialization.

The library supports nested dataclasses, collections and union types. It always tries to initiate the best matching class.

🚀 Getting started

Install it in your Python project:

pip install dict2dc # or uv add or poetry add...

💻 Usage Examples

Deserialization/Parsing

import datetime
import dataclasses
from collections.abc import Collection
from dict2dc.dict2dc import Dict2Dc


class MyDataSubClass1:
    a: str


@dataclasses.dataclass(frozen=True)
class MyDataSubClass2:
    a: int


@dataclasses.dataclass
class MyDataClass:
    a: int
    b: set[str]
    c: Collection[MyDataSubClass1 | MyDataSubClass2] = dataclasses.field(default_factory=list)
    d: datetime.datetime | None = None


data = {
    "a": 1,
    "b": ["Hello", "World"],  # JSON does not know sets thus they probably come as list
    "c": [{"a": "Hello"}, {"a": 42}],
    "d": "2026-01-26T10:33:48.703386",
}  # e.g., from json.load() or response.json()

Dict2Dc().from_dict_enforced(data, cls=MyDataClass)

Serialization

JSON

import dataclasses
import json
from dict2dc.dc2json import Dc2Json, DcJsonEncoder
from dict2dc.models.base import UNTOUCHED, UNTOUCHED_TYPE


@dataclasses.dataclass
class MyDataClass:
    a: str
    b: str | None = None
    c: int | UNTOUCHED_TYPE = UNTOUCHED  # Unmodified, the key will be omitted in the serializable dict


my_obj: MyDataClass = MyDataClass(a="Hello World")
serializable = Dc2Json().as_serializable(my_obj)
json.dumps(serializable)  # {"a": "Hello World", "b": None}

# Alternative
json.dumps(serializable, cls=DcJsonEncoder)

Query Parameters

from dict2dc.dc2query import Dc2Query

my_obj: MyDataClass = MyDataClass(...)
query_params = Dc2Query().as_query_params(my_obj)
requests.get("https://example.com", params=query_params)

🛠️ Advanced Usage

The parsing has some opinionated defaults, e.g., regarding datetime representation. If you want to adjust them or add your own parsing methods, you can pass a mapping from target type to method to the constructor:

import datetime
from dict2dc.dict2dc import Dict2Dc


def convert(v: str) -> datetime.datetime:
    return datetime.datetime.fromtimestamp(float(v), tz=datetime.UTC)


dict2dc = Dict2Dc(
    special_conversions={
        datetime.datetime: convert
    }
)

dict2dc.from_dict_enforced(
    {
        "created": "1769416853"
    }, cls=MyDataClass
)

The default conversions can be found in dict2dc.py. You can also use the optional replace parameter of the constructor to omit the default conversions entirely.
Note: These conversions are currently only triggered if the value to parse is a string.

To adjust the serialization helpers (Dc2Json, DcJsonEncoder, Dc2Query), you need to create your own subclasses. There you can override the existing methods or add your own for custom conversions.

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

dict2dc-0.2.0.tar.gz (72.1 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

dict2dc-0.2.0-py3-none-any.whl (12.5 kB view details)

Uploaded Python 3

File details

Details for the file dict2dc-0.2.0.tar.gz.

File metadata

  • Download URL: dict2dc-0.2.0.tar.gz
  • Upload date:
  • Size: 72.1 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: uv/0.11.15 {"installer":{"name":"uv","version":"0.11.15","subcommand":["publish"]},"python":null,"implementation":{"name":null,"version":null},"distro":{"name":"Ubuntu","version":"24.04","id":"noble","libc":null},"system":{"name":null,"release":null},"cpu":null,"openssl_version":null,"setuptools_version":null,"rustc_version":null,"ci":true}

File hashes

Hashes for dict2dc-0.2.0.tar.gz
Algorithm Hash digest
SHA256 bce24e7b316fd08fd7ab8460cc6bcc6c6b5a5caec4a6d64b06755afd9f02951a
MD5 50cea649ac2135b97be97fa353d0371f
BLAKE2b-256 1340ca137285a74582997db9d1df4f2ee1c84cc2ae2a41dd2f3afafa38a541b2

See more details on using hashes here.

File details

Details for the file dict2dc-0.2.0-py3-none-any.whl.

File metadata

  • Download URL: dict2dc-0.2.0-py3-none-any.whl
  • Upload date:
  • Size: 12.5 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: uv/0.11.15 {"installer":{"name":"uv","version":"0.11.15","subcommand":["publish"]},"python":null,"implementation":{"name":null,"version":null},"distro":{"name":"Ubuntu","version":"24.04","id":"noble","libc":null},"system":{"name":null,"release":null},"cpu":null,"openssl_version":null,"setuptools_version":null,"rustc_version":null,"ci":true}

File hashes

Hashes for dict2dc-0.2.0-py3-none-any.whl
Algorithm Hash digest
SHA256 94cfc2f352cef7fa5d275de19ec512153855225f8e34502c1f529466e072afad
MD5 db36e3f0cff9da6a8392e2ae17180b4a
BLAKE2b-256 7a5634260132384194d42526ffb4b2fb2ee49d863636a0eee2ce7a0bad832bae

See more details on using hashes here.

Supported by

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