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

Uploaded Source

Built Distribution

msgspec_python313_pre-0.19.0-py3-none-any.whl (4.5 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: msgspec_python313_pre-0.19.0.tar.gz
  • Upload date:
  • Size: 111.1 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.0.tar.gz
Algorithm Hash digest
SHA256 3330ea5ff644826384273033fe1d5dfa7a0a04b74fb69849c352fdb64b6c3a9d
MD5 f75e85b4b27bbe4ccbb5d747048ce558
BLAKE2b-256 6a50bd155620438019b4d7085073685f188b340c8280c2c6916273fbe6ef7f3b

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for msgspec_python313_pre-0.19.0-py3-none-any.whl
Algorithm Hash digest
SHA256 3b12af374645f74f348c17dcdfe3afeee94f9cb2f460f77090ef083156666f97
MD5 a520d9d9bc981cedc0bbae19bd340219
BLAKE2b-256 f9e3be8f301ad593368db1d9946d3ee8b26a01c8b0bdfb7c3ef75370319f7fe2

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