Skip to main content

Rust acceleration core for marshmallow serialization, installed as a separate, opt-in package.

Project description

marshmallow_core

CI

A Rust acceleration core for marshmallow, shipped as a separate, opt-in package. Install it next to stock marshmallow and activate it explicitly — it replaces marshmallow's per-object _serialize / _deserialize loops with a PyO3 extension while producing identical results.

pip install marshmallow marshmallow_core
import marshmallow as ma
import marshmallow_core

marshmallow_core.install()      # patch marshmallow.Schema in this process

class Person(ma.Schema):
    name = ma.fields.String()
    age = ma.fields.Integer()

Person().load({"name": "ann", "age": "30"})   # accelerated
Person().dump({"name": "ann", "age": 30})      # accelerated

marshmallow_core.uninstall()    # restore the stock pure-Python methods

How it works

  • install() monkey-patches Schema._serialize and Schema._do_load. Each bound schema is compiled once (cached on the instance) into a recursive payload describing every field as either native (run entirely in Rust) or a callback (defers to the Python Field method). Anything not modelled natively stays a callback, so output is behaviour-identical.
  • Both cores handle the happy path and raise an internal AccelFallback on any error/edge case, so marshmallow re-runs the unchanged pure-Python path and every error message and value matches exactly. (Dump has no side effects — it builds a fresh output — so it can discard a partial result and re-run safely, just like load.)
  • dumps is fused: it writes JSON bytes directly in Rust, skipping the intermediate Python dict and the json.dumps pass, byte-for-byte identical to json.dumps(schema.dump(obj)). It activates for hook-free schemas using the stdlib json render module with no extra json kwargs, and falls back to dump + json.dumps for anything it can't reproduce exactly. (loads is already accelerated through the patched load path; a Rust JSON parser was prototyped but did not beat CPython's C json.loads, so it was not shipped.)
  • Acceleration is strictly a speedup. Set MARSHMALLOW_NO_ACCEL=1 (or hit a protocol-version mismatch between the Python and Rust halves) and the core becomes a no-op even after install().

Scope / limitations

install() accelerates dump for all compilable schemas, and load for most schemas — including those with pre_load / post_load / validates / validates_schema hooks: the core runs the per-field deserialize step while those hooks run in Python around it (mirroring marshmallow's own _do_load split). Recognized field validators (Range / Length / OneOf / Equal / NoneOf / ContainsOnly) run natively; any other validator, or field-level pre_load / post_load, keeps that field on the callback path. unknown=INCLUDE, collection/dotted partial, and dotted attribute writes are all accelerated. Natively modelled fields include the scalars plus Decimal, Dict (incl. typed keys/values), Tuple, Pluck, Constant, TimeDelta, Boolean, Integer(strict=True), and NaiveDateTime / AwareDateTime. The dump core has an AccelFallback (it discards a partial result and re-runs pure Python on any shape it can't reproduce), so it accelerates the composite fields too. Custom dict_class / get_attribute, self-referential schemas, custom strptime temporal formats, and callable defaults always fall back to pure Python.

Where the speedup is limited

Some shapes are inherently bounded — the work the core can't move into Rust dominates the call. These are correct, just not where the gains are:

  • Hook-bearing loads are the weakest case (~2x, vs ~7x without hooks). When a schema has pre_load / post_load / validates / validates_schema, the core runs the per-field deserialize but marshmallow's Python hook-dispatch (_invoke_load_processors, _invoke_field_validators) runs around it. On a small schema the core step is ~8% of the load; the remaining ~90% is that Python machinery, which wraps user callbacks and cannot be moved into Rust.
  • Small / flat schemas are capped by fixed per-call overhead (~20–30%). The dump / load entry prologue (argument normalization, the per-instance serializer-cache lookup, the partial/unknown checks) is constant per call, so it dominates exactly when the payload is tiny. It amortizes to near-zero as the payload grows — speedup on a list of records is flat regardless of length.
  • loads gains less than load. JSON parsing still goes through CPython's C json.loads; a fused Rust parser was prototyped but did not beat it, so only the subsequent per-field step is accelerated.

For collections of records (the common hot path) the fixed overhead vanishes and the speedup is steady (~7–8x). Run performance/analyze_paths.py to see whether a given schema even reaches the core, and performance/benchmark.py to measure it.

Development

Requires cargo (rustup) and maturin.

# build + install the extension into the current venv
uvx maturin develop --release

# run the tests (needs marshmallow + pytest installed)
pytest

# force the pure-Python path
MARSHMALLOW_NO_ACCEL=1 pytest

tests/test_equivalence.py asserts that dump/load produce identical output and errors with the core active vs. forced onto pure Python, across scalars, nested/list/enum/temporal/UUID fields, partial=True, and error inputs.

Benchmarking

The performance/ directory (not shipped in wheels) measures the core against stock marshmallow through the public install() / uninstall() API. Run it from the repo root with the compiled extension importable (uvx maturin develop --release first, or point PYTHONPATH at the repo while the wheel is installed):

# stock-vs-core table for dump / load / dumps / loads on four schema shapes
python -m performance.benchmark                       # all cases
python -m performance.benchmark --number 20000 --only flat,list

# coverage probe: per-field native vs callback for each schema shape
python -m performance.analyze_paths

benchmark.py reports per-call microseconds for stock and core plus the speedup ratio, across flat-scalar, nested, list-heavy, and validator-heavy schemas. analyze_paths.py inspects the compiled payload and shows which fields run native in Rust vs. fall back to a Python callback — it tells you exactly where a real schema still defers to pure Python.

Releasing

CI (.github/workflows/ci.yml) builds the wheel and runs the suite against stock marshmallow on Python 3.10–3.13, both with the core active and with MARSHMALLOW_NO_ACCEL=1. Publishing (.github/workflows/release.yml) builds abi3 wheels + sdist for Linux/macOS/Windows on a v* tag and uploads them to PyPI via trusted publishing. Before the first release, configure the PyPI trusted publisher for this repo and create a pypi GitHub Environment, then push a tag (e.g. git tag v0.1.0 && git push --tags).

License

MIT

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

marshmallow_core-0.1.6.tar.gz (68.9 kB view details)

Uploaded Source

Built Distributions

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

marshmallow_core-0.1.6-cp310-abi3-win_amd64.whl (204.0 kB view details)

Uploaded CPython 3.10+Windows x86-64

marshmallow_core-0.1.6-cp310-abi3-manylinux_2_17_x86_64.manylinux2014_x86_64.whl (334.9 kB view details)

Uploaded CPython 3.10+manylinux: glibc 2.17+ x86-64

marshmallow_core-0.1.6-cp310-abi3-manylinux_2_17_aarch64.manylinux2014_aarch64.whl (332.9 kB view details)

Uploaded CPython 3.10+manylinux: glibc 2.17+ ARM64

marshmallow_core-0.1.6-cp310-abi3-macosx_11_0_arm64.whl (304.4 kB view details)

Uploaded CPython 3.10+macOS 11.0+ ARM64

File details

Details for the file marshmallow_core-0.1.6.tar.gz.

File metadata

  • Download URL: marshmallow_core-0.1.6.tar.gz
  • Upload date:
  • Size: 68.9 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.13.12

File hashes

Hashes for marshmallow_core-0.1.6.tar.gz
Algorithm Hash digest
SHA256 bf2e86ff3edea7675b20894855c36ed9bd7628f2027e31d21e134a200551c81e
MD5 cc745876d345a01124396b799969da7a
BLAKE2b-256 818e6fee4c06906358a608f5b72cc7ce10e0ce9e9219ab5f64c26e104b04e083

See more details on using hashes here.

Provenance

The following attestation bundles were made for marshmallow_core-0.1.6.tar.gz:

Publisher: release.yml on gunlinux/marshmallow_core

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

File details

Details for the file marshmallow_core-0.1.6-cp310-abi3-win_amd64.whl.

File metadata

File hashes

Hashes for marshmallow_core-0.1.6-cp310-abi3-win_amd64.whl
Algorithm Hash digest
SHA256 2eddb9588f6f9456d8bfee54baa289c9ec7bb4b87e0c5d5f5d7a0237444892d6
MD5 94bb2b2dc8680c8fb9b9d05a0e4da934
BLAKE2b-256 75149dbdbca170f1018c0a6927ef212506fc0c45aac4dbeaa18fcb4ad91dd2c5

See more details on using hashes here.

Provenance

The following attestation bundles were made for marshmallow_core-0.1.6-cp310-abi3-win_amd64.whl:

Publisher: release.yml on gunlinux/marshmallow_core

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

File details

Details for the file marshmallow_core-0.1.6-cp310-abi3-manylinux_2_17_x86_64.manylinux2014_x86_64.whl.

File metadata

File hashes

Hashes for marshmallow_core-0.1.6-cp310-abi3-manylinux_2_17_x86_64.manylinux2014_x86_64.whl
Algorithm Hash digest
SHA256 ba8e8dbbd67e8cbc43ad9217b1bb213492750f810f6826b5da75d23757917493
MD5 045f4a543369a93f13901771a2544ffd
BLAKE2b-256 547c387e5ddbb0409336ff23d271704014e7bec6d41e1ae9789d461611a2941d

See more details on using hashes here.

Provenance

The following attestation bundles were made for marshmallow_core-0.1.6-cp310-abi3-manylinux_2_17_x86_64.manylinux2014_x86_64.whl:

Publisher: release.yml on gunlinux/marshmallow_core

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

File details

Details for the file marshmallow_core-0.1.6-cp310-abi3-manylinux_2_17_aarch64.manylinux2014_aarch64.whl.

File metadata

File hashes

Hashes for marshmallow_core-0.1.6-cp310-abi3-manylinux_2_17_aarch64.manylinux2014_aarch64.whl
Algorithm Hash digest
SHA256 e2d11b567f58dbc27f59d0d7d71dfbab392237f415441923bae3178bb5ead8f8
MD5 fb9f3d76995804eb918c56d6a9f4948a
BLAKE2b-256 67168ceb881cbc8e085b93f5d2f94f1bad53b88e0a399d7895b4afa382a6c558

See more details on using hashes here.

Provenance

The following attestation bundles were made for marshmallow_core-0.1.6-cp310-abi3-manylinux_2_17_aarch64.manylinux2014_aarch64.whl:

Publisher: release.yml on gunlinux/marshmallow_core

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

File details

Details for the file marshmallow_core-0.1.6-cp310-abi3-macosx_11_0_arm64.whl.

File metadata

File hashes

Hashes for marshmallow_core-0.1.6-cp310-abi3-macosx_11_0_arm64.whl
Algorithm Hash digest
SHA256 2c47a00c82dce4ff84bcc47b4bf3ea9ddd30aba9ec4541bc65b64eb77883b82f
MD5 6ecbc59885a7cbc782f61cc86deeed5c
BLAKE2b-256 48e0859fa4d44ecb149bba692cca993bad494e3ea9c35e1432b5861225c9eb3c

See more details on using hashes here.

Provenance

The following attestation bundles were made for marshmallow_core-0.1.6-cp310-abi3-macosx_11_0_arm64.whl:

Publisher: release.yml on gunlinux/marshmallow_core

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

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