dataclass-extensions
Additional functionality for Python dataclasses
Installation
Python 3.10 or newer is required. You can install the package from PyPI:
pip install dataclass-extensions
Features
Encode/decode to/from JSON-safe dictionaries
from dataclasses import dataclass
from dataclass_extensions import decode, encode
@dataclass
class Fruit:
calories: int
price: float
@dataclass
class FruitBasket:
fruit: Fruit
count: int
basket = FruitBasket(fruit=Fruit(calories=200, price=1.0), count=2)
assert encode(basket) == {"fruit": {"calories": 200, "price": 1.0}, "count": 2}
assert decode(FruitBasket, encode(basket)) == basket
You can also define how to encode/decode non-dataclass types:
from dataclasses import dataclass
from dataclass_extensions import decode, encode
class Foo:
def __init__(self, x: int):
self.x = x
@dataclass
class Bar:
foo: Foo
encode.register_encoder(lambda foo: {"x": foo.x}, Foo)
decode.register_decoder(lambda d: Foo(d["x"]), Foo)
bar = Bar(foo=Foo(10))
assert encode(bar) == {"foo": {"x": 10}}
assert decode(Bar, encode(bar)) == bar
Merge dictionaries into a dataclass
from dataclasses import dataclass
from dataclass_extensions import merge
@dataclass
class Optimizer:
lr: float
steps: int
@dataclass
class Config:
optimizer: Optimizer
name: str = "default"
config = Config(optimizer=Optimizer(lr=0.1, steps=100), name="run1")
# Override top-level fields
updated = merge(config, {"name": "run2"})
assert updated.name == "run2"
assert updated.optimizer.lr == 0.1 # unchanged
# Merge recursively into nested dataclasses
updated = merge(config, {"optimizer": {"lr": 0.001}})
assert updated.optimizer.lr == 0.001
assert updated.optimizer.steps == 100 # unchanged
assert updated.name == "run1" # unchanged
# The original is never modified
assert config.optimizer.lr == 0.1
Override dataclass fields from the command line
merge_from_dotlist() works like merge() but accepts strings of the form
"field=value", where the value is parsed as YAML. Nested fields are targeted
with dot notation. This gives you a cheap way to expose a dataclass config to a
CLI:
import sys
import dataclasses
from dataclasses import dataclass
from dataclass_extensions import merge_from_dotlist
@dataclass
class Optimizer:
lr: float = 1e-3
steps: int = 1000
@dataclass
class Config:
optimizer: Optimizer = dataclasses.field(default_factory=Optimizer)
name: str = "default"
seed: int = 42
# Both "field=value" and "--field=value" forms are accepted, so this works
# whether argv looks like ["optimizer.lr=1e-4", "name=run1"] or ["--optimizer.lr=1e-4", "--name=run1"].
config = merge_from_dotlist(Config(), sys.argv[1:])
# Values are parsed as YAML, so types are handled automatically:
assert config.optimizer.lr == 0.0001 (float)
assert config.optimizer.steps == 500 (int)
assert config.name == "run1" (str)
Supported value syntax includes plain scalars (0.001, 100, true, null), quoted strings ("hello world"), lists ([1, 2, 3]), and inline mappings ({a: 1}).
Values containing = work correctly because the split happens on the first = only.
Polymorphism through registrable subclasses
from dataclasses import dataclass
from dataclass_extensions import Registrable, decode, encode
@dataclass
class Fruit(Registrable):
calories: int
price: float
@Fruit.register("banana")
@dataclass
class Banana(Fruit):
calories: int = 200
price: float = 1.25
@Fruit.register("apple")
@dataclass
class Apple(Fruit):
calories: int = 150
price: float = 1.50
variety: str = "Granny Smith"
@dataclass
class FruitBasket:
fruit: Fruit
count: int
basket = FruitBasket(fruit=Apple(), count=2)
assert encode(basket) == {
"fruit": {
"type": "apple", # corresponds to the registered name
"calories": 150,
"price": 1.5,
"variety": "Granny Smith",
},
"count": 2,
}
assert decode(FruitBasket, encode(basket)) == basket
Metadata
Release files for dataclass-extensions 0.5.0
For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.
Source distribution (sdist)
| File | Size | Uploaded | Provenance | Actions |
|---|---|---|---|---|
| dataclass_extensions-0.5.0.tar.gz | 20.4 kB | Without provenance | Details for dataclass_extensions-0.5.0.tar.gz |
Built distribution (wheel)
| File | Interpreter | ABI | Platform | Actions Reset |
|---|---|---|---|---|
| dataclass_extensions-0.5.0-py3-none-any.whl | Python 3 | none | any | Details for dataclass_extensions-0.5.0-py3-none-any.whl |
Total release size: 39.9 kB
Release files / dataclass_extensions-0.5.0.tar.gz
| Download URL | dataclass_extensions-0.5.0.tar.gz |
|---|---|
| Size | 20.4 kB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
4308b28a0d3eeea16cfd7e4bd49c06b803d030df5ecd74349559f9140263ec7a
|
|
BLAKE2b-256 checksum How to use checksums |
da85665c3d1c0a793fc8721e168218ed6cbedfaef4b81dae5daa696af3fda9c2
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/6.2.0 CPython/3.12.12
|
Release files / dataclass_extensions-0.5.0-py3-none-any.whl
| Download URL | dataclass_extensions-0.5.0-py3-none-any.whl |
|---|---|
| Size | 19.4 kB |
| Tags | Python 3 |
|
SHA-256 checksum How to use checksums |
68779b60aff8a3c3ab3d556b00b41e5b6ce19241e7b4d29a779494d4686d1d82
|
|
BLAKE2b-256 checksum How to use checksums |
e323be6c3fbb6426a4c16aebf138e6ac5aeefe997fef052fb4448c7771c5f1fd
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/6.2.0 CPython/3.12.12
|
Security for dataclass-extensions 0.5.0
Provenance
Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.
No provenance found
None of the files in this release were uploaded with provenance metadata.
A note on package security
PyPI is a repository for distributing packages, not a service for auditing them. While third-party security researchers and our staff do their best to detect and remove malicious packages, PyPI cannot guarantee the quality, security or suitability of any given package.
To learn more about protecting yourself from malicious actors, visit our package security documentation.