Skip to main content

Deep dataclasses with nested structures and validation

Project description

deep_dataclasses

Tests Coverage PyPI Python License Size

Define nested dataclass hierarchies as clean, readable schemas — no boilerplate.


The Problem

Python's @dataclass requires you to define each level of a nested hierarchy separately, then wire them together manually with field(default_factory=...):

from dataclasses import dataclass, asdict, field
@dataclass
class NestedParent:
    @dataclass
    class Child:
        @dataclass
        class GrandChild:
            grandchild_str: str = "grandchild1"
            grandchild_num: int = 1

        grandchild: GrandChild = field(default_factory=GrandChild)
        child_str: str = "child"

    child: Child = field(default_factory=Child)
    parent_str: str = "parent"

This is verbose, hard to read at a glance and the nested classnames have to be repeated three-fold

But even worse:

NestedParent(**asdict(NestedParent())) == NestedParent()  #  False

Is False which is not the behavior of flat dataclasses.


The Solution

@deep_dataclass lets you express the same hierarchy as a natural nested schema:

from deep_dataclasses import deep_dataclass

@deep_dataclass(autosnake=True)
class DeepParent:
    class Child:
        class Grandchild:
            grandchild_str: str = "grandchild1"
            grandchild_num: int = 1
        child_str: str = "child"
    parent_str: str = "parent"

print(DeepParent().child.grandchild)

The decorator recursively converts nested class blocks into proper @dataclass types, wiring up field(default_factory=...) automatically.


Fully Compatible with dataclasses

@deep_dataclass produces standard dataclass instances — all stdlib tools work as expected:

d1 = NestedParent()   # vanilla dataclass hierarchy
d2 = DeepParent()  # deep_dataclass equivalent

# Structural equality across different class definitions
asdict(d1) == asdict(d2)          # True

# But DeepParent coerses dicts correctly.
DeepParent(**asdict(d2)) == d2    # True

Third party validation via jsonschema

While deep_dataclasses dont validate they provide to_json_schema in order to allow third party validation before instantiation in one line. While to_json_schema runs equally well on all dataclasses, only flat @dataclass and @deep_dataclass make sense, nested dataclasse dont coerse dicts so there is not much use to it.

from deep_dataclasses import to_json_schema
import jsonschema

data = asdict(DeepParent())
jsonschema.validate(data, to_json_schema(DeepParent))  #  Passes

data['child']['child_str']=3
jsonschema.validate(data, to_json_schema(DeepParent))  #  Raises
Failed validating 'type' in schema['properties']['child']['properties']['child_str']:
    {'type': 'string', 'default': 'child'}

On instance['child']['child_str']:
    3

Installation

pip install deep-dataclasses

Comparison

Feature @dataclass @deep_dataclass
Nested hierarchy Manual, verbose Inline, readable
field(default_factory=...) Required per field Automatic
asdict() / == / __repr__
frozen, slots, etc. ✅ (tested)
Type validation Exports to jsonschema

Status

Early release. Core functionality is complete and test covered at 100%. API may evolve — feedback welcome on discuss.python.org.

Contributing

Issues and PRs welcome. See the issue tracker for known TODOs.

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

deep_dataclasses-0.3.2.tar.gz (20.3 kB view details)

Uploaded Source

Built Distribution

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

deep_dataclasses-0.3.2-py3-none-any.whl (10.3 kB view details)

Uploaded Python 3

File details

Details for the file deep_dataclasses-0.3.2.tar.gz.

File metadata

  • Download URL: deep_dataclasses-0.3.2.tar.gz
  • Upload date:
  • Size: 20.3 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.2.0 CPython/3.12.3

File hashes

Hashes for deep_dataclasses-0.3.2.tar.gz
Algorithm Hash digest
SHA256 7d3dcd9be6207c8404eea4e8b7535e1e734d30e3747b0c4c453e06e976244230
MD5 c71b816dcd33f0825a8ca8185b113fe5
BLAKE2b-256 1589f329ce2ca6921fcf8aa3414f61069f1008f13c157306d1c43edffdb55ec8

See more details on using hashes here.

File details

Details for the file deep_dataclasses-0.3.2-py3-none-any.whl.

File metadata

File hashes

Hashes for deep_dataclasses-0.3.2-py3-none-any.whl
Algorithm Hash digest
SHA256 f38a604656477a6fa848a4bc4cf976b47b61e63fd211b37dfb050f6880b7f740
MD5 b0ae59b833d987794f26c272e603ac7c
BLAKE2b-256 5ad653c5067f56c8bec18a2a63dc0f6f763450ed301c64e7ea9a313c1b236d23

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