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.1.tar.gz (316.6 kB view details)

Uploaded Source

Built Distribution

msgspec_python313_pre-0.19.1-py3-none-any.whl (222.9 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: msgspec_python313_pre-0.19.1.tar.gz
  • Upload date:
  • Size: 316.6 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.1.tar.gz
Algorithm Hash digest
SHA256 4e5fc92d81cf3594b6579f1c8b44974484d156eff77ad3d7225b3148312766d0
MD5 08377c19fd695f545185d37acec6549c
BLAKE2b-256 5c49684eec965b2abf7cd09e3bb7dfa9c94446eb4e682854dd90cb838febb884

See more details on using hashes here.

File details

Details for the file msgspec_python313_pre-0.19.1-py3-none-any.whl.

File metadata

File hashes

Hashes for msgspec_python313_pre-0.19.1-py3-none-any.whl
Algorithm Hash digest
SHA256 32cbfe26b0950c5b83db31fece2f650d9b2ff039865f3d9a55334d67ceac8ddd
MD5 9718a27befd9fa0f5b0c1437f39d56ad
BLAKE2b-256 e77b1a2a041cbf17fc17a95d88b3d60919fbe528f0e4cd01462561abf278950f

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