databind 4.4.0

Databind is a library inspired by jackson-databind to de-/serialize Python dataclasses. The `databind` package will install the full suite of databind packages. Compatible with Python 3.7 and newer.

databind

Databind is a Python serialization library on top of dataclasses, inspired by similar libraries from other languages like jackson-databind and serde-rs.

CORE Guide | JSON Examples

Overview 📖

The databind.core package provides the core framework for databind. It is then used by databind.json to provide comprehensive serializatio support between Python and JSON-like data structure. The serialization can easily be extended to YAML or TOML by combining it with respective libraries (e.g. pyaaml and tomli).

@dataclass
class Server:
    host: str
    port: int

@dataclass
class Config:
    server: Server

from databind.json import dump, load
assert load({"server": {"host": "localhost", "port": 8080}}, Config) == Config(server=Server(host='localhost', port=8080))
assert dump(Config(server=Server(host='localhost', port=8080)), Config) == {"server": {"host": "localhost", "port": 8080}}

If you install the databind proxy package, you get matching versions of databind.core and databind.json.

Features ✨

• Support for a plethora of builtin types, including Enum, Decimal, UUID, Path, datetime, date, time, timedelta
• Support for multiple union serialization modes (nested, flat, keyed, typing.Literal)
• Support for generic types, e.g. load([{"name": "Jane Doe"}], list[Person])
• Support for new-style type hints in older Python versions when using forward refererences (strings or __future__.annotations) thanks to typeapi
  • PEP 604 - Allow writing union types as X | Y
  • PEP585 - Type Hinting Generics in Standard Collections)
• Support for customized serialization and deserialization of types
• Support for flattening fields of a nested dataclass or collecting remaining fields in a dict
• Full runtime type checking during serialization
• Use "settings" to customize serialization behaviour
  • As global settings per load()/dump() call: load(..., settings=[ExtraKeys(True)])
  • As class-level settings using a decorator: @Union(style=Union.FLAT) or @ExtraKeys(True)
  • As type-hint level settings using typing.Annotated (or typing_extensions.Annotated): full_name: Annotated[str, Alias("fullName")] or FullNameField = Annotated[str, Alias("fullName")]

---

Copyright © 2022 – Niklas Rosenstein