marshmallow-recipe 0.0.38

Bake marshmallow schemas based on dataclasses

marshmallow-recipe

The main goal of this opinionated library is to simplify migration from marshmallow2 to marshmallow3. Also, it helps with:

1. Stop writing marshmallow schemas completely: it generates them from dataclass.
2. Using different naming cases(camel and capital camel cases are supported).
3. Utilizing best practises on fields configuration.

Supported types:

• str, int, float, bool, datetime.datetime, datetime.date, datetime.time, decimal.Decimal, uuid.UUID
• Optional[T], T | None
• Annotated
• list, dict (with typed keys and values), tuple (only when all elements of the same type), set, frozenset
• Mapping (with typed keys and values), Set, Sequence

Example: class Annotated: pass

import dataclasses
import datetime
import decimal
import marshmallow_recipe as mr
import uuid

from typing import Annotated

@dataclasses.dataclass(frozen=True)
class Transaction:
    id: uuid.UUID
    created_at: datetime.datetime
    processed_at: datetime.datetime | None
    amount: decimal.Decimal = dataclasses.field(metadata=mr.decimal_metadata(places=4))
    transaction_amount: Annotated[decimal.Decimal, mr.decimal_metadata(places=4)]

transaction = Transaction(
    id=uuid.uuid4(),
    created_at=datetime.datetime.utcnow(),
    processed_at=None,
    amount=decimal.Decimal(42),
    transaction_amount=decimal.Decimal(42),
 )

# dumps the transaction to a dict
raw = mr.dump(transaction) 

# loads a transaction from the dict
mr.load(Transaction, raw)

# provides a generated marshmallow schema for dataclass
mr.schema(Transaction)

Update API example:

import decimal
import dataclasses
import marshmallow_recipe as mr

@dataclasses.dataclass(frozen=True)
@mr.options(none_value_handling=mr.NoneValueHandling.INCLUDE)
class CompanyUpdateData:
    name: str = mr.MISSING
    annual_turnover: decimal.Decimal | None = mr.MISSING

company_update_data = CompanyUpdateData(name="updated name")
dumped = mr.dump(company_update_data)
assert dumped == {"name": "updated name"}  # Note: no "annual_turnover" here

loaded = mr.load(CompanyUpdateData, {"name": "updated name"})
assert loaded.name == "updated name"
assert loaded.annual_turnover is mr.MISSING

loaded = mr.load(CompanyUpdateData, {"annual_turnover": None})
assert loaded.name is mr.MISSING
assert loaded.annual_turnover is None

v0.0.38(2024-01-05)

• Min support marshmallow is 2.20.5

v0.0.38a2(2023-12-15)

• Almost stop using marshmallow defaults (except Nones)

v0.0.38a1(2023-12-11)

• Use native isoformat/fromisoformat

v0.0.37(2023-12-11)

• Cache get_pre_loads results

v0.0.36(2023-12-08)

• Fix nullable with nested annotation

v0.0.34(2023-12-07)

• Support datetime.time: #137

v0.0.33(2023-09-30)

• Add validation field errors: #133, 9f13f05

v0.0.32(2023-09-28)

• Validate by regexp/Validate with a custom error

v0.0.31(2023-09-26)

• Allow to strip whitespaces on load/dump for str fields
• Allow to provide post_load delegate for str fields

v0.0.30(2023-09-25)

• Improve validation support: expose ValidationError to raise it from validators, allow to pass a sequence of validators
• Add meta shortcuts to metadata methods

v0.0.29(2023-09-23)

• Allow to use metadata as part of Annotated: #126 and #127.

v0.0.28(2023-09-22)

• Fix options decorator

v0.0.27(2023-09-22)

• Basic support of Annotated fields
• Stop using typing_inspect

v0.0.26(2023-09-18)

• Support python 3.12

v0.0.25(2023-09-11)

• Support set, set[T], frozenset, frozenset[T], tuple, tuple[T, ...], collections.abc.Set[T], collections.abc.Sequence[T], collections.abc.Mapping[K, V]

v0.0.24(2023-09-08)

• Set module for auto-generated schemas
• Calling bake_schema should reuse already generated schemas
• NamingCase should not be propagated through serialisation hierarchy
• Removal of DEFAULT_CASE

v0.0.23(2023-09-05)

• Validate dumped data against its schema for marshmallow2

v0.0.22(2023-06-27)

v0.0.22a2(2023-06-27)

• Support typed dict key

v0.0.22a1(2023-06-24)

• Support typed dict value

v0.0.21(2023-06-24)

v0.0.21a1(2023-06-08)

• Cache intermediate schema types

v0.0.20(2023-04-25)

• Allow to validate list item

v0.0.19(2023-04-24)

• Allow validations for nested/list/dict/enum

v0.0.18(2023-01-05)

• Allow to specify default_factory

v0.0.17(2022-12-20)

• Non-optional fields with default value might not present in data

v0.0.16(2022-12-02)

• Do not modify input data for marshmallow<3

v0.0.15(2022-12-01)

• Metadata name should not use others field name
• Ignore unknown fields for marshmallow2

v0.0.14(2022-11-14)

• Do not crash if an unknown arg is passed to enum meta

v0.0.13(2022-10-14)

• Add pre_load hooks

v0.0.12(2022-08-23)

• Add datetime_metadata to allow to specify a custom format

v0.0.11(2022-06-23)

• Add options, MISSING, none_value_handling

v0.0.10(2022-06-15)

• Fix input of load_many

v0.0.9(2022-04-26)

• Support Any

v0.0.8(2022-03-26)

• Allow default value for required fields

v0.0.7(2022-03-20)

• Support validation

v0.0.6(2022-03-20)

• Support enum
• Add empty schema

v0.0.5(2022-03-01)

• Validate before dump for marshmallow3
• Move many to schema
• Fix default naming case
• Fix unhashable type: 'set' error

v0.0.4(2022-02-21)

• Support decimal field
• Support metadata
• Support int field
• Support float field
• Support uuid field
• Support list and dict
• Support marshmallow3
• Support datetime and date
• Unify datetime.tzinfo behaviour

v0.0.3 (2022-02-14)

• Unify behaviour of nested_field in line with str_field/bool_field
• Rearrange api

v0.0.2 (2022-02-13)

• Customize capital camel case and add camel case

v0.0.1 (2022-02-13)

• A first version