ormsgpack 1.9.1__cp310-cp310-musllinux_1_2_armv7l.whl → 1.10.0__cp310-cp310-musllinux_1_2_armv7l.whl

ormsgpack/__init__.py

@@ -1,6 +1,7 @@
 # SPDX-License-Identifier: (Apache-2.0 OR MIT)
 
 from .ormsgpack import (
+    OPT_DATETIME_AS_TIMESTAMP_EXT,
     OPT_NAIVE_UTC,
     OPT_NON_STR_KEYS,
     OPT_OMIT_MICROSECONDS,
@@ -30,6 +31,7 @@ __all__ = (
     "Ext",
     "MsgpackDecodeError",
     "MsgpackEncodeError",
+    "OPT_DATETIME_AS_TIMESTAMP_EXT",
     "OPT_NAIVE_UTC",
     "OPT_NON_STR_KEYS",
     "OPT_OMIT_MICROSECONDS",

ormsgpack/__init__.pyi

@@ -4,11 +4,14 @@ __version__: str
 
 def packb(
     obj: Any,
+    /,
     default: Optional[Callable[[Any], Any]] = ...,
     option: Optional[int] = None,
 ) -> bytes: ...
 def unpackb(
     obj: Union[bytes, bytearray, memoryview],
+    /,
+    *,
     ext_hook: Optional[Callable[[int, bytes], Any]] = ...,
     option: Optional[int] = ...,
 ) -> Any: ...
@@ -19,6 +22,7 @@ class MsgpackEncodeError(TypeError): ...
 class Ext:
     def __init__(self, tag: int, data: bytes) -> None: ...
 
+OPT_DATETIME_AS_TIMESTAMP_EXT: int
 OPT_NAIVE_UTC: int
 OPT_OMIT_MICROSECONDS: int
 OPT_PASSTHROUGH_BIG_INT: int

{ormsgpack-1.9.1.dist-info → ormsgpack-1.10.0.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: ormsgpack
-Version: 1.9.1
+Version: 1.10.0
 Classifier: Development Status :: 5 - Production/Stable
 Classifier: Intended Audience :: Developers
 Classifier: License :: OSI Approved :: Apache Software License
@@ -15,6 +15,7 @@ Classifier: Programming Language :: Python :: 3.11
 Classifier: Programming Language :: Python :: 3.12
 Classifier: Programming Language :: Python :: 3.13
 Classifier: Programming Language :: Python :: Implementation :: CPython
+Classifier: Programming Language :: Python :: Implementation :: PyPy
 Classifier: Programming Language :: Python
 Classifier: Programming Language :: Rust
 Classifier: Typing :: Typed
@@ -31,6 +32,7 @@ Description-Content-Type: text/markdown; charset=UTF-8; variant=GFM
 Project-URL: Source Code, https://github.com/aviramha/ormsgpack
 
 # ormsgpack
+
 ![PyPI](https://img.shields.io/pypi/v/ormsgpack)
 ![PyPI - Downloads](https://img.shields.io/pypi/dm/ormsgpack)
 
@@ -38,9 +40,14 @@ ormsgpack is a fast msgpack serialization library for Python derived
 from [orjson](https://github.com/ijl/orjson), with native support for
 various Python types.
 
-ormsgpack supports CPython 3.9, 3.10, 3.11, 3.12 and 3.13. Releases
-follow semantic versioning and serializing a new object type without
-an opt-in flag is considered a breaking change.
+ormsgpack supports the following Python implementations:
+
+- CPython 3.9, 3.10, 3.11, 3.12 and 3.13
+- PyPy 3.11
+- GraalPy 3.11
+
+Releases follow semantic versioning and serializing a new object type
+without an opt-in flag is considered a breaking change.
 
 ormsgpack is licensed under both the Apache 2.0 and MIT licenses. The
 repository and issue tracker is
@@ -52,19 +59,28 @@ available in the repository.
 1. [Usage](#usage)
     1. [Install](#install)
     2. [Quickstart](#quickstart)
-    4. [Serialize](#serialize)
+    3. [Serialize](#serialize)
         1. [default](#default)
         2. [option](#option)
-    5. [Deserialize](#deserialize)
+    4. [Deserialize](#deserialize)
 2. [Types](#types)
-    1. [dataclass](#dataclass)
-    2. [datetime](#datetime)
-    3. [enum](#enum)
-    4. [float](#float)
-    5. [int](#int)
-    6. [numpy](#numpy)
-    7. [uuid](#uuid)
-    8. [pydantic](#pydantic)
+   - [none](#none)
+   - [bool](#bool)
+   - [int](#int)
+   - [float](#float)
+   - [str](#str)
+   - [bytes](#bytes)
+   - [list](#list)
+   - [tuple](#tuple)
+   - [dict](#dict)
+   - [dataclass](#dataclass)
+   - [date](#date)
+   - [time](#time)
+   - [datetime](#datetime)
+   - [enum](#enum)
+   - [uuid](#uuid)
+   - [numpy](#numpy)
+   - [pydantic](#pydantic)
 3. [Latency](#latency)
 4. [Questions](#questions)
 5. [Packaging](#packaging)
@@ -112,29 +128,20 @@ def packb(
 ```
 
 `packb()` serializes Python objects to msgpack.
-
-It natively serializes
-`bytes`, `str`, `dict`, `list`, `tuple`, `int`, `float`, `bool`,
-`dataclasses.dataclass`, `typing.TypedDict`, `datetime.datetime`,
-`datetime.date`, `datetime.time`, `uuid.UUID`, `numpy.ndarray`, and
-`None` instances. It supports arbitrary types through `default`. It
-serializes subclasses of `str`, `int`, `dict`, `list`,
-`dataclasses.dataclass`, and `enum.Enum`. It does not serialize subclasses
-of `tuple` to avoid serializing `namedtuple` objects as arrays.
-
+It natively serializes various Python [types](#Types) and supports
+arbitrary types through the [default](#default) argument.
 The output is a `bytes` object.
 
 The global interpreter lock (GIL) is held for the duration of the call.
 
-It raises `MsgpackEncodeError` on an unsupported type. This exception message
-describes the invalid object with the error message
-`Type is not msgpack serializable: ...`. To fix this, specify
-[default](#default).
+It raises `MsgpackEncodeError` on an unsupported type. This exception
+describes the invalid object with the error message `Type is not
+msgpack serializable: ...`.
 
-It raises `MsgpackEncodeError` on a `str` that contains invalid UTF-8.
+It raises `MsgpackEncodeError` if a `str` contains invalid UTF-8.
 
 It raises `MsgpackEncodeError` if a `dict` has a key of a type other than `str` or `bytes`,
-unless `OPT_NON_STR_KEYS` is specified.
+unless [`OPT_NON_STR_KEYS`](#OPT_NON_STR_KEYS) is specified.
 
 It raises `MsgpackEncodeError` if the output of `default` recurses to handling by
 `default` more than 254 levels deep.
@@ -213,11 +220,15 @@ To modify how data is serialized, specify `option`. Each `option` is an integer
 constant in `ormsgpack`. To specify multiple options, mask them together, e.g.,
 `option=ormsgpack.OPT_NON_STR_KEYS | ormsgpack.OPT_NAIVE_UTC`.
 
+##### `OPT_DATETIME_AS_TIMESTAMP_EXT`
+
+Serialize aware `datetime.datetime` instances as timestamp extension objects.
+
 ##### `OPT_NAIVE_UTC`
 
-Serialize `datetime.datetime` objects without a `tzinfo` and `numpy.datetime64`
-objects as UTC. This has no effect on `datetime.datetime` objects that have
-`tzinfo` set.
+Serialize naive `datetime.datetime` objects and `numpy.datetime64`
+objects as UTC. This has no effect on aware `datetime.datetime`
+objects.
 
 ```python
 >>> import ormsgpack, datetime
@@ -241,6 +252,7 @@ b'\xb91970-01-01T00:00:00+00:00'
 Serialize `dict` keys of type other than `str`. This allows `dict` keys
 to be one of `str`, `int`, `float`, `bool`, `None`, `datetime.datetime`,
 `datetime.date`, `datetime.time`, `enum.Enum`, and `uuid.UUID`.
+All options other than the passthrough ones are supported.
 `dict` keys of unsupported types are not handled using `default` and
 result in `MsgpackEncodeError` being raised.
 
@@ -262,15 +274,21 @@ b'\x81\xb91970-01-01T00:00:00+00:00\x93\x01\x02\x03'
 {'1970-01-01T00:00:00+00:00': [1, 2, 3]}
 ```
 
-These types are generally serialized how they would be as
-values, e.g., `datetime.datetime` is still an RFC 3339 string and respects
-options affecting it.
+Be aware that, when using this option, a serialized map may contain
+elements with the same key, as different `dict` keys may be serialized
+to the same object. In such a case, a msgpack deserializer will
+presumably keep only one element for any given key. For example,
 
-This option has the risk of creating duplicate keys. This is because non-`str`
-objects may serialize to the same `str` as an existing key, e.g.,
-`{"1970-01-01T00:00:00+00:00": true, datetime.datetime(1970, 1, 1, 0, 0, 0): false}`.
-The last key to be inserted to the `dict` will be serialized last and a msgpack deserializer will presumably take the last
-occurrence of a key (in the above, `false`). The first value will be lost.
+```python
+>>> import ormsgpack, datetime
+>>> ormsgpack.packb(
+...     {"1970-01-01T00:00:00": True, datetime.datetime(1970, 1, 1, 0, 0, 0): False},
+...     option=ormsgpack.OPT_NON_STR_KEYS,
+... )
+b'\x82\xb31970-01-01T00:00:00\xc3\xb31970-01-01T00:00:00\xc2'
+>>> ormsgpack.unpackb(_)
+{'1970-01-01T00:00:00': False}
+```
 
 This option is not compatible with `ormsgpack.OPT_SORT_KEYS`.
 
@@ -319,8 +337,7 @@ b'\x82\xa4type\xa6bigint\xa5value\xb436893488147419103232'
 
 ##### `OPT_PASSTHROUGH_DATACLASS`
 
-Enable passthrough of `dataclasses.dataclass` instances to `default`.
-
+Enable passthrough of dataclasses to `default`.
 
 ```python
 >>> import ormsgpack, dataclasses
@@ -373,7 +390,7 @@ b'\x81\xaacreated_at\xbdThu, 01 Jan 1970 00:00:00 GMT'
 
 ##### `OPT_PASSTHROUGH_ENUM`
 
-Enable passthrough of `enum.Enum` instances to `default`.
+Enable passthrough of enum members to `default`.
 
 ##### `OPT_PASSTHROUGH_SUBCLASS`
 
@@ -426,10 +443,10 @@ Enable passthrough of `uuid.UUID` instances to `default`.
 
 ##### `OPT_SERIALIZE_NUMPY`
 
-Serialize `numpy.ndarray` instances. For more, see
-[numpy](#numpy).
+Serialize instances of numpy types.
 
 ##### `OPT_SERIALIZE_PYDANTIC`
+
 Serialize `pydantic.BaseModel` instances.
 
 ##### `OPT_SORT_KEYS`
@@ -477,6 +494,7 @@ b'\xb41970-01-01T00:00:00Z'
 ```
 
 ### Deserialize
+
 ```python
 def unpackb(
     __obj: Union[bytes, bytearray, memoryview],
@@ -524,24 +542,62 @@ Decimal('0.0842389659712649442845'
 ```
 
 #### option
-`unpackb()` supports the `OPT_NON_STR_KEYS` option, that is similar to original msgpack's `strict_map_key=False`.
+
+##### `OPT_DATETIME_AS_TIMESTAMP_EXT`
+
+Deserialize timestamp extension objects to UTC `datetime.datetime` instances.
+
+##### `OPT_NON_STR_KEYS`
+
+Deserialize map keys of type other than string.
 Be aware that this option is considered unsafe and disabled by default in msgpack due to possibility of HashDoS.
 
 ## Types
 
-### dataclass
+### none
+
+The `None` object is serialized as nil.
+
+### bool
+
+`bool` instances are serialized as booleans.
+
+### int
+
+Instances of `int` and of subclasses of `int` are serialized as
+integers. The minimum and maximum representable values are
+-9223372036854775807 and 18446744073709551615, respectively.
+
+### float
 
-ormsgpack serializes instances of `dataclasses.dataclass` natively. It serializes
-instances 40-50x as fast as other libraries and avoids a severe slowdown seen
-in other libraries compared to serializing `dict`.
+`float` instances are serialized as IEEE 754 double precision floating point numbers.
 
-It is supported to pass all variants of dataclasses, including dataclasses
-using `__slots__`, frozen dataclasses, those with optional or default
-attributes, and subclasses. There is a performance benefit to not
-using `__slots__`.
+### str
 
-Dataclasses are serialized as maps, with every attribute serialized and in
-the order given on class definition:
+Instances of `str` and of subclasses of `str` are serialized as strings.
+
+### bytes
+
+`bytes`, `bytearray` and `memoryview` instances are serialized as binary objects.
+
+### list
+
+Instances of `list` and of subclasses of `list` are serialized as arrays.
+
+### tuple
+
+`tuple` instances are serialized as arrays.
+
+### dict
+
+Instances of `dict` and of subclasses of `dict` are serialized as maps.
+
+### dataclass
+
+Dataclasses are serialized as maps. The fields are serialized in the
+order they are defined in the class. All variants of dataclasses are
+supported, including dataclasses with `__slots__`, frozen dataclasses
+and dataclasses with descriptor-typed fields.
 
 ```python
 >>> import dataclasses, ormsgpack, typing
@@ -559,24 +615,38 @@ the order given on class definition:
 >>> ormsgpack.packb(Object(1, "a", [Member(1, True), Member(2)]))
 b'\x83\xa2id\x01\xa4name\xa1a\xa7members\x92\x82\xa2id\x01\xa6active\xc3\x82\xa2id\x02\xa6active\xc2'
 ```
-#### Performance
-![alt text](doc/dataclass.svg "dataclass")
 
+### date
+
+`datetime.date` instances are serialized as [RFC 3339](https://tools.ietf.org/html/rfc3339) strings.
+
+```python
+>>> import ormsgpack, datetime
+>>> ormsgpack.packb(datetime.date(1900, 1, 2))
+b'\xaa1900-01-02'
+>>> ormsgpack.unpackb(_)
+'1900-01-02'
 ```
---------------------------------------------------------------------------------- benchmark 'dataclass': 2 tests --------------------------------------------------------------------------------
-Name (time in ms)                 Min                 Max                Mean            StdDev              Median               IQR            Outliers       OPS            Rounds  Iterations
--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------
-test_dataclass_ormsgpack       3.4248 (1.0)        7.7949 (1.0)        3.6266 (1.0)      0.3293 (1.0)        3.5815 (1.0)      0.0310 (1.0)          4;34  275.7434 (1.0)         240           1
-test_dataclass_msgpack       140.2774 (40.96)    143.6087 (18.42)    141.3847 (38.99)    1.0038 (3.05)     141.1823 (39.42)    0.7304 (23.60)         2;1    7.0729 (0.03)          8           1
--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------
+
+### time
+
+Naive `datetime.time` instances are serialized as [RFC 3339](https://tools.ietf.org/html/rfc3339) strings.
+Aware `datetime.time` instances are not supported.
+
+```python
+>>> import ormsgpack, datetime
+>>> ormsgpack.packb(datetime.time(12, 0, 15, 290))
+b'\xaf12:00:15.000290'
+>>> ormsgpack.unpackb(_)
+'12:00:15.000290'
 ```
 
 ### datetime
 
-ormsgpack serializes `datetime.datetime` objects to
-[RFC 3339](https://tools.ietf.org/html/rfc3339) format,
-e.g., "1970-01-01T00:00:00+00:00". This is a subset of ISO 8601 and is
-compatible with `isoformat()` in the standard library.
+Naive `datetime.datetime` instances are serialized as [RFC 3339](https://tools.ietf.org/html/rfc3339) strings.
+Aware `datetime.datetime` instances are serialized as [RFC 3339](https://tools.ietf.org/html/rfc3339) strings
+or alternatively as MessagePack timestamp extension objects, by using the
+[`OPT_DATETIME_AS_TIMESTAMP_EXT`](#OPT_DATETIME_AS_TIMESTAMP_EXT) option.
 
 ```python
 >>> import ormsgpack, datetime, zoneinfo
@@ -600,41 +670,17 @@ b'\xb32100-09-02T00:55:02'
 '2100-09-02T00:55:02'
 ```
 
-`datetime.datetime` supports instances with a `tzinfo` that is `None`,
-`datetime.timezone.utc`, a timezone instance from the python3.9+ `zoneinfo`
-module, or a timezone instance from the third-party `pendulum`, `pytz`, or
-`dateutil`/`arrow` libraries.
-
-`datetime.time` objects must not have a `tzinfo`.
-
-```python
->>> import ormsgpack, datetime
->>> ormsgpack.packb(datetime.time(12, 0, 15, 290))
-b'\xaf12:00:15.000290'
->>> ormsgpack.unpackb(_)
-'12:00:15.000290'
-```
-
-`datetime.date` objects will always serialize.
-
-```python
->>> import ormsgpack, datetime
->>> ormsgpack.packb(datetime.date(1900, 1, 2))
-b'\xaa1900-01-02'
->>> ormsgpack.unpackb(_)
-'1900-01-02'
-```
-
 Errors with `tzinfo` result in `MsgpackEncodeError` being raised.
 
-To use "Z" suffix instead of "+00:00" to indicate UTC ("Zulu") time, use the option
-`ormsgpack.OPT_UTC_Z`.
-
-To assume datetimes without timezone are UTC, use the option `ormsgpack.OPT_NAIVE_UTC`.
+The serialization can be customized using the
+[`OPT_NAIVE_UTC`](#OPT_NAIVE_UTC),
+[`OPT_OMIT_MICROSECONDS`](#OPT_OMIT_MICROSECONDS), and
+[`OPT_UTC_Z`](#OPT_UTC_Z) options.
 
 ### enum
 
-ormsgpack serializes enums natively. Options apply to their values.
+Enum members are serialized as their values. Options apply to their
+values. All subclasses of `enum.EnumType` are supported.
 
 ```python
 >>> import enum, datetime, ormsgpack
@@ -651,7 +697,7 @@ b'\xb91970-01-01T00:00:00+00:00'
 '1970-01-01T00:00:00+00:00'
 ```
 
-Enums with members that are not supported types can be serialized using
+Enum members whose value is not a supported type can be serialized using
 `default`:
 
 ```python
@@ -674,31 +720,42 @@ b'\x01'
 1
 ```
 
-### float
-
-ormsgpack serializes and deserializes double precision floats with no loss of
-precision and consistent rounding.
+### uuid
 
-### int
+`uuid.UUID` instances are serialized as [RFC 4122](https://tools.ietf.org/html/rfc4122) strings.
 
-ormsgpack serializes and deserializes 64-bit integers by default. The range
-supported is a signed 64-bit integer's minimum (-9223372036854775807) to
-an unsigned 64-bit integer's maximum (18446744073709551615).
+```python
+>>> import ormsgpack, uuid
+>>> ormsgpack.packb(uuid.UUID('f81d4fae-7dec-11d0-a765-00a0c91e6bf6'))
+b'\xd9$f81d4fae-7dec-11d0-a765-00a0c91e6bf6'
+>>> ormsgpack.unpackb(_)
+'f81d4fae-7dec-11d0-a765-00a0c91e6bf6'
+>>> ormsgpack.packb(uuid.uuid5(uuid.NAMESPACE_DNS, "python.org"))
+b'\xd9$886313e1-3b8a-5372-9b90-0c9aee199e5d'
+>>> ormsgpack.unpackb(_)
+'886313e1-3b8a-5372-9b90-0c9aee199e5d
+```
 
 ### numpy
 
-ormsgpack natively serializes `numpy.ndarray` and individual
-`numpy.float64`, `numpy.float32`, `numpy.float16`,
-`numpy.int64`, `numpy.int32`, `numpy.int16`, `numpy.int8`,
-`numpy.uint64`, `numpy.uint32`, `numpy.uint16`, `numpy.uint8`,
-`numpy.uintp`, `numpy.intp`, `numpy.datetime64`, and `numpy.bool`
-instances.
+`numpy.bool`, `numpy.float16`, `numpy.float32`, `numpy.float64`,
+`numpy.int8`, `numpy.int16`, `numpy.int32`, `numpy.int64`, `numpy.intp`,
+`numpy.uint8`, `numpy.uint16`, `numpy.uint32`, `numpy.uint64`, `numpy.uintp`
+instances are serialized as the corresponding builtin types.
 
-`numpy.datetime64` instances are serialized as RFC 3339 strings.
+`numpy.datetime64` instances are serialized as [RFC 3339](https://tools.ietf.org/html/rfc3339) strings.
+The serialization can be customized using the
+[`OPT_NAIVE_UTC`](#OPT_NAIVE_UTC),
+[`OPT_OMIT_MICROSECONDS`](#OPT_OMIT_MICROSECONDS), and
+[`OPT_UTC_Z`](#OPT_UTC_Z) options.
 
-ormsgpack is faster than all compared libraries at serializing
-numpy instances. Serializing numpy data requires specifying
-`option=ormsgpack.OPT_SERIALIZE_NUMPY`.
+`numpy.ndarray` instances are serialized as arrays. The array must be
+a C-contiguous array (`C_CONTIGUOUS`) and of a supported data type.
+Unsupported arrays can be serialized using [default](#default), by
+converting the array to a list with the `numpy.ndarray.tolist` method.
+
+The serialization of numpy types is disabled by default and can be
+enabled by using the [`OPT_SERIALIZE_NUMPY`](#OPT_SERIALIZE_NUMPY) option.
 
 ```python
 >>> import ormsgpack, numpy
@@ -711,100 +768,21 @@ b'\x92\x93\x01\x02\x03\x93\x04\x05\x06'
 [[1, 2, 3], [4, 5, 6]]
 ```
 
-The array must be a contiguous C array (`C_CONTIGUOUS`) and one of the
-supported datatypes.
-
-If an array is not a contiguous C array or contains an supported datatype,
-ormsgpack falls through to `default`. In `default`, `obj.tolist()` can be
-specified. If an array is malformed, which is not expected,
-`ormsgpack.MsgpackEncodeError` is raised.
-
-#### Performance
-![alt text](doc/numpy_float64.svg "numpy")
-![alt text](doc/numpy_int8.svg "numpy int8")
-![alt text](doc/numpy_int32.svg "numpy int32")
-![alt text](doc/numpy_npbool.svg "numpy npbool")
-![alt text](doc/numpy_uint8.svg "numpy uint8")
-```
----------------------------------------------------------------------------------- benchmark 'numpy float64': 2 tests ---------------------------------------------------------------------------------
-Name (time in ms)                      Min                 Max                Mean             StdDev              Median                IQR            Outliers      OPS            Rounds  Iterations
--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------
-test_numpy_ormsgpack[float64]      77.9625 (1.0)       85.2507 (1.0)       79.0326 (1.0)       1.9043 (1.0)       78.5505 (1.0)       0.7408 (1.0)           1;1  12.6530 (1.0)          13           1
-test_numpy_msgpack[float64]       511.5176 (6.56)     606.9395 (7.12)     559.0017 (7.07)     44.0661 (23.14)    572.5499 (7.29)     81.2972 (109.75)        3;0   1.7889 (0.14)          5           1
--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------
-
-
-------------------------------------------------------------------------------------- benchmark 'numpy int32': 2 tests -------------------------------------------------------------------------------------
-Name (time in ms)                      Min                   Max                  Mean             StdDev                Median                IQR            Outliers     OPS            Rounds  Iterations
-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------
-test_numpy_ormsgpack[int32]       197.8751 (1.0)        210.3111 (1.0)        201.1033 (1.0)       5.1886 (1.0)        198.8518 (1.0)       3.8297 (1.0)           1;1  4.9726 (1.0)           5           1
-test_numpy_msgpack[int32]       1,363.8515 (6.89)     1,505.4747 (7.16)     1,428.2127 (7.10)     53.4176 (10.30)    1,425.3516 (7.17)     72.8064 (19.01)         2;0  0.7002 (0.14)          5           1
-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------
-
-
--------------------------------------------------------------------------------- benchmark 'numpy int8': 2 tests ---------------------------------------------------------------------------------
-Name (time in ms)                   Min                 Max                Mean            StdDev              Median                IQR            Outliers     OPS            Rounds  Iterations
---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------
-test_numpy_ormsgpack[int8]     107.8013 (1.0)      113.7336 (1.0)      109.0364 (1.0)      1.7805 (1.0)      108.3574 (1.0)       0.4066 (1.0)           1;2  9.1712 (1.0)          10           1
-test_numpy_msgpack[int8]       685.4149 (6.36)     703.2958 (6.18)     693.2396 (6.36)     7.9572 (4.47)     691.5435 (6.38)     14.4142 (35.45)         1;0  1.4425 (0.16)          5           1
---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------
-
-
-------------------------------------------------------------------------------------- benchmark 'numpy npbool': 2 tests --------------------------------------------------------------------------------------
-Name (time in ms)                       Min                   Max                  Mean             StdDev                Median                IQR            Outliers      OPS            Rounds  Iterations
---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------
-test_numpy_ormsgpack[npbool]        87.9005 (1.0)         89.5460 (1.0)         88.7928 (1.0)       0.5098 (1.0)         88.8508 (1.0)       0.6609 (1.0)           4;0  11.2622 (1.0)          12           1
-test_numpy_msgpack[npbool]       1,095.0599 (12.46)    1,176.3442 (13.14)    1,120.5916 (12.62)    32.9993 (64.73)    1,110.4216 (12.50)    38.4189 (58.13)         1;0   0.8924 (0.08)          5           1
---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------
-
-
---------------------------------------------------------------------------------- benchmark 'numpy uint8': 2 tests ---------------------------------------------------------------------------------
-Name (time in ms)                    Min                 Max                Mean             StdDev              Median                IQR            Outliers     OPS            Rounds  Iterations
-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------
-test_numpy_ormsgpack[uint8]     133.1743 (1.0)      134.7246 (1.0)      134.2793 (1.0)       0.4946 (1.0)      134.3120 (1.0)       0.4492 (1.0)           1;1  7.4472 (1.0)           8           1
-test_numpy_msgpack[uint8]       727.1393 (5.46)     824.8247 (6.12)     775.7032 (5.78)     34.9887 (70.73)    775.9595 (5.78)     36.2824 (80.78)         2;0  1.2892 (0.17)          5           1
-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------
-```
-
-### uuid
-
-ormsgpack serializes `uuid.UUID` instances to
-[RFC 4122](https://tools.ietf.org/html/rfc4122) format, e.g.,
-"f81d4fae-7dec-11d0-a765-00a0c91e6bf6".
-
-```python
->>> import ormsgpack, uuid
->>> ormsgpack.packb(uuid.UUID('f81d4fae-7dec-11d0-a765-00a0c91e6bf6'))
-b'\xd9$f81d4fae-7dec-11d0-a765-00a0c91e6bf6'
->>> ormsgpack.unpackb(_)
-'f81d4fae-7dec-11d0-a765-00a0c91e6bf6'
->>> ormsgpack.packb(uuid.uuid5(uuid.NAMESPACE_DNS, "python.org"))
-b'\xd9$886313e1-3b8a-5372-9b90-0c9aee199e5d'
->>> ormsgpack.unpackb(_)
-'886313e1-3b8a-5372-9b90-0c9aee199e5d
-```
-
 ### Pydantic
-ormsgpack serializes `pydantic.BaseModel` instances natively, with
+
+`pydantic.BaseModel` instances are serialized as maps, with
 [duck-typing](https://docs.pydantic.dev/2.10/concepts/serialization/#serializing-with-duck-typing).
 This is equivalent to serializing
 `model.model_dump(serialize_as_any=True)` with Pydantic V2 or
 `model.dict()`with Pydantic V1.
 
-#### Performance
-![alt text](doc/pydantic.svg "pydantic")
-
-```
--------------------------------------------------------------------------------- benchmark 'pydantic': 2 tests ---------------------------------------------------------------------------------
-Name (time in ms)                Min                 Max                Mean            StdDev              Median               IQR            Outliers       OPS            Rounds  Iterations
-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------
-test_pydantic_ormsgpack       4.3918 (1.0)       12.6521 (1.0)        4.8550 (1.0)      1.1455 (3.98)       4.6101 (1.0)      0.0662 (1.0)         11;24  205.9727 (1.0)         204           1
-test_pydantic_msgpack       124.5500 (28.36)    125.5427 (9.92)     125.0582 (25.76)    0.2877 (1.0)      125.0855 (27.13)    0.2543 (3.84)          2;0    7.9963 (0.04)          8           1
-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------
-```
+The serialization of pydantic models is disabled by default and can be
+enabled by using the [`OPT_SERIALIZE_PYDANTIC`](#OPT_SERIALIZE_PYDANTIC) option.
 
 ## Latency
+
 ### Graphs
+
 ![alt text](doc/twitter_packb.svg "twitter.json serialization")
 ![alt text](doc/twitter_unpackb.svg "twitter.json deserialization")
 ![alt text](doc/github_packb.svg "github.json serialization")
@@ -813,7 +791,16 @@ test_pydantic_msgpack       124.5500 (28.36)    125.5427 (9.92)     125.0582 (25
 ![alt text](doc/citm_catalog_unpackb.svg "citm_catalog.json deserialization")
 ![alt text](doc/canada_packb.svg "canada.json serialization")
 ![alt text](doc/canada_unpackb.svg "canada.json deserialization")
+![alt text](doc/dataclass.svg "dataclass")
+![alt text](doc/numpy_float64.svg "numpy")
+![alt text](doc/numpy_int32.svg "numpy int32")
+![alt text](doc/numpy_int8.svg "numpy int8")
+![alt text](doc/numpy_npbool.svg "numpy npbool")
+![alt text](doc/numpy_uint8.svg "numpy uint8")
+![alt text](doc/pydantic.svg "pydantic")
+
 ### Data
+
 ```
 ----------------------------------------------------------------------------- benchmark 'canada packb': 2 tests ------------------------------------------------------------------------------
 Name (time in ms)                   Min                Max              Mean            StdDev            Median               IQR            Outliers       OPS            Rounds  Iterations
@@ -876,13 +863,70 @@ Name (time in ms)                      Min                Max              Mean
 test_ormsgpack_unpackb[twitter]     2.7097 (1.0)      41.1530 (1.0)      3.2721 (1.0)      3.5860 (1.03)     2.8868 (1.0)      0.0614 (1.32)         4;38  305.6098 (1.0)         314           1
 test_msgpack_unpackb[twitter]       3.8079 (1.41)     42.0617 (1.02)     4.4459 (1.36)     3.4893 (1.0)      4.1097 (1.42)     0.0465 (1.0)          2;54  224.9267 (0.74)        228           1
 -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------
+
+
+--------------------------------------------------------------------------------- benchmark 'dataclass': 2 tests --------------------------------------------------------------------------------
+Name (time in ms)                 Min                 Max                Mean            StdDev              Median               IQR            Outliers       OPS            Rounds  Iterations
+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------
+test_dataclass_ormsgpack       3.4248 (1.0)        7.7949 (1.0)        3.6266 (1.0)      0.3293 (1.0)        3.5815 (1.0)      0.0310 (1.0)          4;34  275.7434 (1.0)         240           1
+test_dataclass_msgpack       140.2774 (40.96)    143.6087 (18.42)    141.3847 (38.99)    1.0038 (3.05)     141.1823 (39.42)    0.7304 (23.60)         2;1    7.0729 (0.03)          8           1
+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------
+
+
+---------------------------------------------------------------------------------- benchmark 'numpy float64': 2 tests ---------------------------------------------------------------------------------
+Name (time in ms)                      Min                 Max                Mean             StdDev              Median                IQR            Outliers      OPS            Rounds  Iterations
+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------
+test_numpy_ormsgpack[float64]      77.9625 (1.0)       85.2507 (1.0)       79.0326 (1.0)       1.9043 (1.0)       78.5505 (1.0)       0.7408 (1.0)           1;1  12.6530 (1.0)          13           1
+test_numpy_msgpack[float64]       511.5176 (6.56)     606.9395 (7.12)     559.0017 (7.07)     44.0661 (23.14)    572.5499 (7.29)     81.2972 (109.75)        3;0   1.7889 (0.14)          5           1
+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------
+
+
+------------------------------------------------------------------------------------- benchmark 'numpy int32': 2 tests -------------------------------------------------------------------------------------
+Name (time in ms)                      Min                   Max                  Mean             StdDev                Median                IQR            Outliers     OPS            Rounds  Iterations
+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------
+test_numpy_ormsgpack[int32]       197.8751 (1.0)        210.3111 (1.0)        201.1033 (1.0)       5.1886 (1.0)        198.8518 (1.0)       3.8297 (1.0)           1;1  4.9726 (1.0)           5           1
+test_numpy_msgpack[int32]       1,363.8515 (6.89)     1,505.4747 (7.16)     1,428.2127 (7.10)     53.4176 (10.30)    1,425.3516 (7.17)     72.8064 (19.01)         2;0  0.7002 (0.14)          5           1
+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------
+
+
+-------------------------------------------------------------------------------- benchmark 'numpy int8': 2 tests ---------------------------------------------------------------------------------
+Name (time in ms)                   Min                 Max                Mean            StdDev              Median                IQR            Outliers     OPS            Rounds  Iterations
+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------
+test_numpy_ormsgpack[int8]     107.8013 (1.0)      113.7336 (1.0)      109.0364 (1.0)      1.7805 (1.0)      108.3574 (1.0)       0.4066 (1.0)           1;2  9.1712 (1.0)          10           1
+test_numpy_msgpack[int8]       685.4149 (6.36)     703.2958 (6.18)     693.2396 (6.36)     7.9572 (4.47)     691.5435 (6.38)     14.4142 (35.45)         1;0  1.4425 (0.16)          5           1
+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------
+
+
+------------------------------------------------------------------------------------- benchmark 'numpy npbool': 2 tests --------------------------------------------------------------------------------------
+Name (time in ms)                       Min                   Max                  Mean             StdDev                Median                IQR            Outliers      OPS            Rounds  Iterations
+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------
+test_numpy_ormsgpack[npbool]        87.9005 (1.0)         89.5460 (1.0)         88.7928 (1.0)       0.5098 (1.0)         88.8508 (1.0)       0.6609 (1.0)           4;0  11.2622 (1.0)          12           1
+test_numpy_msgpack[npbool]       1,095.0599 (12.46)    1,176.3442 (13.14)    1,120.5916 (12.62)    32.9993 (64.73)    1,110.4216 (12.50)    38.4189 (58.13)         1;0   0.8924 (0.08)          5           1
+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------
+
+
+--------------------------------------------------------------------------------- benchmark 'numpy uint8': 2 tests ---------------------------------------------------------------------------------
+Name (time in ms)                    Min                 Max                Mean             StdDev              Median                IQR            Outliers     OPS            Rounds  Iterations
+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------
+test_numpy_ormsgpack[uint8]     133.1743 (1.0)      134.7246 (1.0)      134.2793 (1.0)       0.4946 (1.0)      134.3120 (1.0)       0.4492 (1.0)           1;1  7.4472 (1.0)           8           1
+test_numpy_msgpack[uint8]       727.1393 (5.46)     824.8247 (6.12)     775.7032 (5.78)     34.9887 (70.73)    775.9595 (5.78)     36.2824 (80.78)         2;0  1.2892 (0.17)          5           1
+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------
+
+
+-------------------------------------------------------------------------------- benchmark 'pydantic': 2 tests ---------------------------------------------------------------------------------
+Name (time in ms)                Min                 Max                Mean            StdDev              Median               IQR            Outliers       OPS            Rounds  Iterations
+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------
+test_pydantic_ormsgpack       4.3918 (1.0)       12.6521 (1.0)        4.8550 (1.0)      1.1455 (3.98)       4.6101 (1.0)      0.0662 (1.0)         11;24  205.9727 (1.0)         204           1
+test_pydantic_msgpack       124.5500 (28.36)    125.5427 (9.92)     125.0582 (25.76)    0.2877 (1.0)      125.0855 (27.13)    0.2543 (3.84)          2;0    7.9963 (0.04)          8           1
+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------
 ```
+
 ### Reproducing
 
 The above was measured using Python 3.7.9 on Azure Linux VM (x86_64) with ormsgpack 0.2.1 and msgpack 1.0.2.
 
-The latency results can be reproduced using `./scripts/benchmark.sh` and graphs using
-`pytest --benchmark-histogram benchmarks/bench_*`.
+The latency results can be reproduced using `uv run pytest benchmarks/bench_*`.
+
 ## Questions
 
 ### Why can't I install it from PyPI?
@@ -900,15 +944,13 @@ level above this.
 
 To package ormsgpack requires [Rust](https://www.rust-lang.org/) 1.81
 or newer and the [maturin](https://github.com/PyO3/maturin) build
-tool. The default feature `unstable-simd` enables the usage of SIMD
-operations and requires nightly Rust. The recommended build command
-is:
+tool. The recommended build command is:
 
 ```sh
-maturin build --release --strip
+maturin build --release
 ```
 
-ormsgpack is tested on Linux/amd64, Linux/aarch64, Linux/armv7, macOS/amd64 and Windows/amd64.
+ormsgpack is tested on Linux/amd64, Linux/aarch64, Linux/armv7, macOS/aarch64 and Windows/amd64.
 
 There are no runtime dependencies other than libc.
 

ormsgpack-1.10.0.dist-info/RECORD

@@ -0,0 +1,13 @@
+ormsgpack-1.10.0.dist-info/METADATA,sha256=9x2lIjFUAWAeptZrApdhf0WigK_Cd8AQrJHRH9iH8Xk,43743
+ormsgpack-1.10.0.dist-info/WHEEL,sha256=j0CzeBTXvFA5zxItlWefBqXQ57yFW2cj-DPgtzd1Ask,107
+ormsgpack-1.10.0.dist-info/entry_points.txt,sha256=b4bGmxqo1PPqO42Cjz2A2X4Gy4h1PCoOygCzeS-m22I,63
+ormsgpack-1.10.0.dist-info/licenses/LICENSE-APACHE,sha256=pg7qgXUUUxZo1-AHZXMUSf4U0FnTJJ4LyTs23kX3WfI,10847
+ormsgpack-1.10.0.dist-info/licenses/LICENSE-MIT,sha256=I_GOA9xJ35FiL-KnYXZJdATkbO2KcV2dK2enRGVxzKM,1023
+ormsgpack.libs/libgcc_s-5b5488a6.so.1,sha256=HGKUsVmTeNAxEdSy7Ua5Vh_I9FN3RCbPWzvZ7H_TrwE,2749061
+ormsgpack/__init__.py,sha256=A4pm8xaw6_tIqmMoKn2jAGnqYakE96LWk2boEaB783U,1106
+ormsgpack/__init__.pyi,sha256=8j0Ff1n1lcidp8MqWl7iLtujHbuCKxYNcEFM0eEJR2k,926
+ormsgpack/_pyinstaller/__init__.py,sha256=hcOudyiUz-ny0OE09dNskv7gVZXrsbb5uwg2mScSbG8,133
+ormsgpack/_pyinstaller/hook-ormsgpack.py,sha256=R-YMI5TWEh7mZLFywYSJu2PxG5HeuWrGlSmMbofSyGI,111
+ormsgpack/ormsgpack.cpython-310-arm-linux-gnueabihf.so,sha256=T5_X_SNicuhw8DN3w2UIQTLGGuJrxY6RddG3gwLOI5E,391257
+ormsgpack/py.typed,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
+ormsgpack-1.10.0.dist-info/RECORD,,

{ormsgpack-1.9.1.dist-info → ormsgpack-1.10.0.dist-info}/WHEEL

@@ -1,4 +1,4 @@
 Wheel-Version: 1.0
-Generator: maturin (1.8.3)
+Generator: maturin (1.8.6)
 Root-Is-Purelib: false
 Tag: cp310-cp310-musllinux_1_2_armv7l

ormsgpack-1.9.1.dist-info/RECORD

@@ -1,13 +0,0 @@
-ormsgpack-1.9.1.dist-info/METADATA,sha256=N3FqJyfKD6Yuf0MXMGUYFr0yYjKJZ6nOFjVfQ9uGROs,43472
-ormsgpack-1.9.1.dist-info/WHEEL,sha256=_OfFnMP11eNMYzu-gPAmNrX5yeEPbDV28xs7JLWUNT0,107
-ormsgpack-1.9.1.dist-info/entry_points.txt,sha256=b4bGmxqo1PPqO42Cjz2A2X4Gy4h1PCoOygCzeS-m22I,63
-ormsgpack-1.9.1.dist-info/licenses/LICENSE-APACHE,sha256=pg7qgXUUUxZo1-AHZXMUSf4U0FnTJJ4LyTs23kX3WfI,10847
-ormsgpack-1.9.1.dist-info/licenses/LICENSE-MIT,sha256=I_GOA9xJ35FiL-KnYXZJdATkbO2KcV2dK2enRGVxzKM,1023
-ormsgpack.libs/libgcc_s-5b5488a6.so.1,sha256=HGKUsVmTeNAxEdSy7Ua5Vh_I9FN3RCbPWzvZ7H_TrwE,2749061
-ormsgpack/py.typed,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
-ormsgpack/__init__.py,sha256=b8h6Xdy3d26CtlF4EMCUqZl9cPvBT2R5_DQyqFCYgng,1034
-ormsgpack/_pyinstaller/__init__.py,sha256=hcOudyiUz-ny0OE09dNskv7gVZXrsbb5uwg2mScSbG8,133
-ormsgpack/_pyinstaller/hook-ormsgpack.py,sha256=R-YMI5TWEh7mZLFywYSJu2PxG5HeuWrGlSmMbofSyGI,111
-ormsgpack/__init__.pyi,sha256=ZbSQqWnNWV-2cYDTJQRHgBV-W8ZKAU6ymn0j5XtV81Q,870
-ormsgpack/ormsgpack.cpython-310-arm-linux-gnueabihf.so,sha256=oFFjc4ahL4dCzPjDuD5mryyCIJxJ4a1sAK3X-jLZKdY,395353
-ormsgpack-1.9.1.dist-info/RECORD,,