Skip to main content

A fast serialization and validation library, with builtin support for JSON, MessagePack, YAML, and TOML.

Project description

msgspec

msgspec is a fast serialization and validation library, with builtin support for JSON, MessagePack, YAML, and TOML. It features:

  • 🚀 High performance encoders/decoders for common protocols. The JSON and MessagePack implementations regularly benchmark as the fastest options for Python.

  • 🎉 Support for a wide variety of Python types. Additional types may be supported through extensions.

  • 🔍 Zero-cost schema validation using familiar Python type annotations. In benchmarks msgspec decodes and validates JSON faster than orjson can decode it alone.

  • A speedy Struct type for representing structured data. If you already use dataclasses or attrs, structs should feel familiar. However, they're 5-60x faster for common operations.

All of this is included in a lightweight library with no required dependencies.


msgspec may be used for serialization alone, as a faster JSON or MessagePack library. For the greatest benefit though, we recommend using msgspec to handle the full serialization & validation workflow:

Define your message schemas using standard Python type annotations.

>>> import msgspec

>>> class User(msgspec.Struct):
...     """A new type describing a User"""
...     name: str
...     groups: set[str] = set()
...     email: str | None = None

Encode messages as JSON, or one of the many other supported protocols.

>>> alice = User("alice", groups={"admin", "engineering"})

>>> alice
User(name='alice', groups={"admin", "engineering"}, email=None)

>>> msg = msgspec.json.encode(alice)

>>> msg
b'{"name":"alice","groups":["admin","engineering"],"email":null}'

Decode messages back into Python objects, with optional schema validation.

>>> msgspec.json.decode(msg, type=User)
User(name='alice', groups={"admin", "engineering"}, email=None)

>>> msgspec.json.decode(b'{"name":"bob","groups":[123]}', type=User)
Traceback (most recent call last):
  File "<stdin>", line 1, in <module>
msgspec.ValidationError: Expected `str`, got `int` - at `$.groups[0]`

msgspec is designed to be as performant as possible, while retaining some of the nicities of validation libraries like pydantic. For supported types, encoding/decoding a message with msgspec can be ~10-80x faster than alternative libraries.

See the documentation for more information.

LICENSE

New BSD. See the License File.

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

msgspec_python313_pre-0.19.3.tar.gz (316.8 kB view details)

Uploaded Source

Built Distribution

msgspec_python313_pre-0.19.3-cp313-cp313-macosx_15_0_x86_64.whl (391.9 kB view details)

Uploaded CPython 3.13 macOS 15.0+ x86-64

File details

Details for the file msgspec_python313_pre-0.19.3.tar.gz.

File metadata

  • Download URL: msgspec_python313_pre-0.19.3.tar.gz
  • Upload date:
  • Size: 316.8 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: pdm/2.20.0.post1 CPython/3.13.0 Darwin/24.1.0

File hashes

Hashes for msgspec_python313_pre-0.19.3.tar.gz
Algorithm Hash digest
SHA256 14394993ce7d149652067ebc77d2889727974af06975fce5d572658ac9f5136e
MD5 5229841f7e3bd6f8aaf1a793af1023b1
BLAKE2b-256 dca2143399a9a3b5009543db13b7e33a3155a9d65bcbe2f1259d2bce3dfda2ac

See more details on using hashes here.

File details

Details for the file msgspec_python313_pre-0.19.3-cp313-cp313-macosx_15_0_x86_64.whl.

File metadata

File hashes

Hashes for msgspec_python313_pre-0.19.3-cp313-cp313-macosx_15_0_x86_64.whl
Algorithm Hash digest
SHA256 42318174762a931fe550371d8e618cbe05b66a24190ea3dfec456b473678ba11
MD5 75415399e8b4909948de5b47fe2b8e03
BLAKE2b-256 7427a062c7e34f3d8f7dbd981019b3e7511a62d2ca2ca8823c226d1ea9d5787c

See more details on using hashes here.

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page