ormsgpack 1.3.0__cp38-none-win_amd64.whl → 1.4.1__cp38-none-win_amd64.whl

ormsgpack/__init__.py

@@ -7,6 +7,7 @@ __all__ = (
     "__version__",
     "packb",
     "unpackb",
+    "Ext",
     "MsgpackDecodeError",
     "MsgpackEncodeError",
     "OPT_NAIVE_UTC",

ormsgpack/__init__.pyi

@@ -8,7 +8,9 @@ def packb(
     option: Optional[int] = None,
 ) -> bytes: ...
 def unpackb(
-    __obj: Union[str, bytes, bytearray, memoryview], option: Optional[int] = ...
+    __obj: Union[str, bytes, bytearray, memoryview],
+    ext_hook: Optional[Callable[[int, bytes], Any]] = ...,
+    option: Optional[int] = ...,
 ) -> Any: ...
 
 class MsgpackDecodeError(ValueError): ...

{ormsgpack-1.3.0.dist-info → ormsgpack-1.4.1.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: ormsgpack
-Version: 1.3.0
+Version: 1.4.1
 Classifier: Development Status :: 5 - Production/Stable
 Classifier: Intended Audience :: Developers
 Classifier: License :: OSI Approved :: Apache Software License
@@ -37,11 +37,11 @@ Project-URL: Source Code, https://github.com/aviramha/ormsgpack
 ormsgpack is a fast msgpack library for Python. It is a fork/reboot of [orjson](https://github.com/ijl/orjson)
 It serializes faster than [msgpack-python](https://github.com/msgpack/msgpack-python) and deserializes a bit slower (right now).
 It supports serialization of:
-[dataclass](https://github.com/aviramha/ormsgpack#dataclass),
-[datetime](https://github.com/aviramha/ormsgpack#datetime),
-[numpy](https://github.com/aviramha/ormsgpack#numpy),
-[pydantic](https://github.com/aviramha/ormsgpack#OPT_SERIALIZE_PYDANTIC) and
-[UUID](https://github.com/aviramha/ormsgpack#uuid) instances natively.
+[dataclass](#dataclass),
+[datetime](#datetime),
+[numpy](#numpy),
+[pydantic](#pydantic) and
+[UUID](#uuid) instances natively.
 
 Its features and drawbacks compared to other Python msgpack libraries:
 
@@ -49,7 +49,7 @@ Its features and drawbacks compared to other Python msgpack libraries:
 * serializes `datetime`, `date`, and `time` instances to RFC 3339 format,
 e.g., "1970-01-01T00:00:00+00:00"
 * serializes `numpy.ndarray` instances natively and faster.
-* serializes `pydantic.BaseModel` instances natively (disregards the configuration ATM).
+* serializes `pydantic.BaseModel` instances natively
 * serializes arbitrary types using a `default` hook
 
 ormsgpack supports CPython 3.8, 3.9, 3.10, 3.11 and 3.12. ormsgpack does not support PyPy. Releases follow semantic
@@ -63,26 +63,26 @@ submitted there. There is a
 [CHANGELOG](https://github.com/aviramha/ormsgpack/blob/master/CHANGELOG.md)
 available in the repository.
 
-1. [Usage](https://github.com/aviramha/ormsgpack#usage)
-    1. [Install](https://github.com/aviramha/ormsgpack#install)
-    2. [Quickstart](https://github.com/aviramha/ormsgpack#quickstart)
-    4. [Serialize](https://github.com/aviramha/ormsgpack#serialize)
-        1. [default](https://github.com/aviramha/ormsgpack#default)
-        2. [option](https://github.com/aviramha/ormsgpack#option)
-    5. [Deserialize](https://github.com/aviramha/ormsgpack#deserialize)
-2. [Types](https://github.com/aviramha/ormsgpack#types)
-    1. [dataclass](https://github.com/aviramha/ormsgpack#dataclass)
-    2. [datetime](https://github.com/aviramha/ormsgpack#datetime)
-    3. [enum](https://github.com/aviramha/ormsgpack#enum)
-    4. [float](https://github.com/aviramha/ormsgpack#float)
-    5. [int](https://github.com/aviramha/ormsgpack#int)
-    6. [numpy](https://github.com/aviramha/ormsgpack#numpy)
-    7. [uuid](https://github.com/aviramha/ormsgpack#uuid)
-    8. [pydantic](https://github.com/aviramha/ormsgpack#pydantic)
-3. [Latency](https://github.com/aviramha/ormsgpack#latency)
-4. [Questions](https://github.com/aviramha/ormsgpack#questions)
-5. [Packaging](https://github.com/aviramha/ormsgpack#packaging)
-6. [License](https://github.com/aviramha/ormsgpack#license)
+1. [Usage](#usage)
+    1. [Install](#install)
+    2. [Quickstart](#quickstart)
+    4. [Serialize](#serialize)
+        1. [default](#default)
+        2. [option](#option)
+    5. [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)
+3. [Latency](#latency)
+4. [Questions](#questions)
+5. [Packaging](#packaging)
+6. [License](#license)
 
 ## Usage
 
@@ -98,7 +98,7 @@ pip install --upgrade ormsgpack
 Notice that Linux environments with a `pip` version shipped in 2018 or earlier
 must first upgrade `pip` to support `manylinux2014` wheels.
 
-To build a wheel, see [packaging](https://github.com/aviramha/ormsgpack#packaging).
+To build a wheel, see [packaging](#packaging).
 
 ### Quickstart
 
@@ -146,8 +146,8 @@ 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 JSON serializable: ...`. To fix this, specify
-[default](https://github.com/aviramha/ormsgpack#default).
+`Type is not msgpack serializable: ...`. To fix this, specify
+[default](#default).
 
 It raises `MsgpackEncodeError` on a `str` that contains invalid UTF-8.
 
@@ -162,8 +162,7 @@ It raises `MsgpackEncodeError` on circular references.
 It raises `MsgpackEncodeError`  if a `tzinfo` on a datetime object is
 unsupported.
 
-`MsgpackEncodeError` is a subclass of `TypeError`. This is for compatibility
-with the standard library.
+`MsgpackEncodeError` is a subclass of `TypeError`.
 
 #### default
 
@@ -181,7 +180,7 @@ def default(obj):
     raise TypeError
 
 >>> ormsgpack.packb(decimal.Decimal("0.0842389659712649442845"))
-MsgpackEncodeError: Type is not JSON serializable: decimal.Decimal
+MsgpackEncodeError: Type is not msgpack serializable: decimal.Decimal
 >>> ormsgpack.packb(decimal.Decimal("0.0842389659712649442845"), default=default)
 b'\xb80.0842389659712649442845'
 >>> ormsgpack.packb({1, 2}, default=default)
@@ -207,6 +206,23 @@ def default(obj):
 {'set': None}
 ```
 
+To serialize a type as a MessagePack extension type, return an
+`ormsgpack.Ext` object. The instantiation arguments are an integer in
+the range `[0, 127]` and a `bytes` object, defining the type and
+value, respectively.
+
+```python
+>>> import ormsgpack, decimal
+>>>
+def default(obj):
+    if isinstance(obj, decimal.Decimal):
+        return ormsgpack.Ext(0, str(obj).encode())
+    raise TypeError
+
+>>> ormsgpack.packb(decimal.Decimal("0.0842389659712649442845"), default=default)
+b'\xc7\x18\x000.0842389659712649442845'
+```
+
 #### option
 
 To modify how data is serialized, specify `option`. Each `option` is an integer
@@ -235,9 +251,7 @@ has no effect on `datetime.datetime` objects that have `tzinfo` set.
 
 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`. For comparison,
-the standard library serializes `str`, `int`, `float`, `bool` or `None` by
-default.
+`datetime.date`, `datetime.time`, `enum.Enum`, and `uuid.UUID`.
 
 ```python
 >>> import ormsgpack, datetime, uuid
@@ -410,17 +424,15 @@ Passthrough tuples to `default`.
 ##### OPT_SERIALIZE_NUMPY
 
 Serialize `numpy.ndarray` instances. For more, see
-[numpy](https://github.com/aviramha/ormsgpack#numpy).
+[numpy](#numpy).
 
 ##### OPT_SERIALIZE_PYDANTIC
-Serialize `pydantic.BaseModel` instances. Right now it ignores the config (str transformations), support might be added
-later.
+Serialize `pydantic.BaseModel` instances.
 
 ##### OPT_SORT_KEYS
 
 Serialize `dict` keys in sorted order. The default is to serialize in an
-unspecified order. This is equivalent to `sort_keys=True` in the standard
-library.
+unspecified order.
 
 This can be used to ensure the order is deterministic for hashing or tests.
 It has a substantial performance penalty and is not recommended in general.
@@ -441,8 +453,6 @@ The sorting is not collation/locale-aware:
 b'\x83\xa1A\x03\xa1a\x01\xa2\xc3\xa4\x02'
 ```
 
-This is the same sorting behavior as the standard library.
-
 `dataclass` also serialize as maps but this has no effect on them.
 
 ##### OPT_UTC_Z
@@ -465,7 +475,12 @@ b'"1970-01-01T00:00:00Z"'
 
 ### Deserialize
 ```python
-def unpackb(__obj: Union[bytes, bytearray, memoryview], / , option=None) -> Any: ...
+def unpackb(
+    __obj: Union[bytes, bytearray, memoryview],
+    /,
+    ext_hook: Optional[Callable[[int, bytes], Any]] = ...,
+    option: Optional[int] = ...,
+) -> Any: ...
 ```
 
 `unpackb()` deserializes msgpack to Python objects. It deserializes to `dict`,
@@ -484,6 +499,27 @@ msgpack.
 
 `MsgpackDecodeError` is a subclass of `ValueError`.
 
+#### ext_hook
+
+To deserialize extension types, specify the optional `ext_hook`
+argument. The value should be a callable and is invoked with the
+extension type and value as arguments.
+
+```python
+>>> import ormsgpack, decimal
+>>>
+def ext_hook(tag, data):
+    if tag == 0:
+        return decimal.Decimal(data.decode())
+    raise TypeError
+
+>>> ormsgpack.packb(
+    ormsgpack.Ext(0, str(decimal.Decimal("0.0842389659712649442845")).encode())
+)
+>>> ormsgpack.unpackb(_, ext_hook=ext_hook)
+Decimal('0.0842389659712649442845')
+```
+
 #### option
 `unpackb()` supports the `OPT_NON_STR_KEYS` option, that is similar to original msgpack's `strict_map_keys=False`.
 Be aware that this option is considered unsafe and disabled by default in msgpack due to possibility of HashDoS.
@@ -543,7 +579,7 @@ test_dataclass_msgpack       140.2774 (40.96)    143.6087 (18.42)    141.3847 (3
 
 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
+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.
 
 ```python
@@ -590,17 +626,13 @@ module, or a timezone instance from the third-party `pendulum`, `pytz`, or
 
 Errors with `tzinfo` result in `MsgpackEncodeError` being raised.
 
-It is faster to have ormsgpack serialize datetime objects than to do so
-before calling `packb()`. If using an unsupported type such as
-`pendulum.datetime`, use `default`.
-
 To disable serialization of `datetime` objects specify the option
 `ormsgpack.OPT_PASSTHROUGH_DATETIME`.
 
 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, se the option `ormsgpack.OPT_NAIVE_UTC`.
+To assume datetimes without timezone are UTC, use the option `ormsgpack.OPT_NAIVE_UTC`.
 
 ### enum
 
@@ -655,11 +687,13 @@ an unsigned 64-bit integer's maximum (18446744073709551615).
 
 ### numpy
 
-ormsgpack natively serializes `numpy.ndarray` and individual `numpy.float64`,
-`numpy.float32`, `numpy.int64`, `numpy.int32`, `numpy.int8`, `numpy.uint64`,
-`numpy.uint32`, and `numpy.uint8` instances. Arrays may have a
-`dtype` of `numpy.bool`, `numpy.float32`, `numpy.float64`, `numpy.int32`,
-`numpy.int64`, `numpy.uint32`, `numpy.uint64`, `numpy.uintp`, or `numpy.intp`.
+ormsgpack natively serializes `numpy.ndarray` and individual
+`numpy.float64`, `numpy.float32`,
+`numpy.int64`, `numpy.int32`, `numpy.int16`, `numpy.int8`,
+`numpy.uint64`, `numpy.uint32`, `numpy.uint16`, `numpy.uint8`,
+`numpy.uintp`, `numpy.intp`, and `numpy.bool`
+instances.
+
 ormsgpack is faster than all compared libraries at serializing
 numpy instances. Serializing numpy data requires specifying
 `option=ormsgpack.OPT_SERIALIZE_NUMPY`.
@@ -744,10 +778,12 @@ ormsgpack serializes `uuid.UUID` instances to
 >>> ormsgpack.unpackb(_)
 "886313e1-3b8a-5372-9b90-0c9aee199e5d"
 ```
+
 ### Pydantic
-![alt text](doc/pydantic.svg "pydantic")
-ormsgpack serializes `pydantic.BaseModel` instances natively. Currently it ignores `pydantic.BaseModel.Config`.
+ormsgpack serializes `pydantic.BaseModel` instances natively.
+
 #### Performance
+![alt text](doc/pydantic.svg "pydantic")
 
 ```
 -------------------------------------------------------------------------------- benchmark 'pydantic': 2 tests ---------------------------------------------------------------------------------
@@ -757,6 +793,7 @@ test_pydantic_ormsgpack       4.3918 (1.0)       12.6521 (1.0)        4.8550 (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
 ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------
 ```
+
 ## Latency
 ### Graphs
 ![alt text](doc/twitter_packb.svg "twitter.json serialization")
@@ -856,36 +893,17 @@ If someone implements it well.
 
 ## Packaging
 
-To package ormsgpack requires [Rust](https://www.rust-lang.org/) on the
- nightly channel and the [maturin](https://github.com/PyO3/maturin)
-build tool. maturin can be installed from PyPI or packaged as
-well. This is the simplest and recommended way of installing
-from source, assuming `rustup` is available from a
-package manager:
+To package ormsgpack requires [Rust](https://www.rust-lang.org/) 1.65
+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:
 
 ```sh
-rustup default nightly
-pip wheel --no-binary=ormsgpack ormsgpack
+maturin build --release --strip
 ```
 
-This is an example of building a wheel using the repository as source,
-`rustup` installed from upstream, and a pinned version of Rust:
-
-```sh
-pip install maturin
-curl https://sh.rustup.rs -sSf | sh -s -- --default-toolchain nightly-2021-05-25 --profile minimal -y
-export RUSTFLAGS="-C target-cpu=k8"
-maturin build --release --strip --manylinux off
-ls -1 target/wheels
-```
-
-Problems with the Rust nightly channel may require pinning a version.
-`nightly-2021-05-25` is known to be ok.
-
-ormsgpack is tested for amd64 and aarch64 on Linux, macOS, and Windows. It
-may not work on 32-bit targets. It has recommended `RUSTFLAGS`
-specified in `.cargo/config` so it is recommended to either not set
-`RUSTFLAGS` or include these options.
+ormsgpack is tested for amd64 on Linux, macOS, and Windows.
 
 There are no runtime dependencies other than libc.
 

ormsgpack-1.4.1.dist-info/RECORD

@@ -0,0 +1,9 @@
+ormsgpack-1.4.1.dist-info/METADATA,sha256=0nsqWb3DQK3nLDmG5xqY5Ty3hviYoVhW-sEKRQDVy_8,43847
+ormsgpack-1.4.1.dist-info/WHEEL,sha256=T1RLm43AXt41GKrFU5GP7AbI-r0Ir8iMFRaUAG9tOo0,94
+ormsgpack-1.4.1.dist-info/license_files/LICENSE-APACHE,sha256=fP1zjFPWHHnwfjSPYiv3cHyQhCNwVNN_vgd4inX1iBw,11048
+ormsgpack-1.4.1.dist-info/license_files/LICENSE-MIT,sha256=NlFq79yExdWh50hUJZE6ItvaaesZMMXoTWrklytRlLk,1046
+ormsgpack/py.typed,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
+ormsgpack/__init__.py,sha256=jGcrk6dQSfTAgcqkXznT4VlrV-z9KZ9t6bHuDepqfJA,583
+ormsgpack/__init__.pyi,sha256=vVfpvAXniV3FAfa546Ni7ZjwYfb4l0OevDCkK2SH9CQ,784
+ormsgpack/ormsgpack.cp38-win_amd64.pyd,sha256=tpEXzZA1mi_ABzhACWe6J6LeO3JV04YIZcW4tmuoLlw,280064
+ormsgpack-1.4.1.dist-info/RECORD,,

{ormsgpack-1.3.0.dist-info → ormsgpack-1.4.1.dist-info}/WHEEL

@@ -1,4 +1,4 @@
 Wheel-Version: 1.0
-Generator: maturin (1.3.0)
+Generator: maturin (1.3.1)
 Root-Is-Purelib: false
 Tag: cp38-none-win_amd64

ormsgpack-1.3.0.dist-info/RECORD

@@ -1,9 +0,0 @@
-ormsgpack-1.3.0.dist-info/METADATA,sha256=lmsRxG5lKniXeM6ua5ZxQp2OIJ807_senzboTRTquxw,45202
-ormsgpack-1.3.0.dist-info/WHEEL,sha256=VYinC71WLuLn3fOubSwjM4Pwno7UIsfdYgaVIbybp3o,94
-ormsgpack-1.3.0.dist-info/license_files/LICENSE-APACHE,sha256=fP1zjFPWHHnwfjSPYiv3cHyQhCNwVNN_vgd4inX1iBw,11048
-ormsgpack-1.3.0.dist-info/license_files/LICENSE-MIT,sha256=NlFq79yExdWh50hUJZE6ItvaaesZMMXoTWrklytRlLk,1046
-ormsgpack/py.typed,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
-ormsgpack/__init__.py,sha256=G2SlQjBKVUXBe5DJQeAPWd6dU8lzQL8AHPPD-RyGbLc,571
-ormsgpack/__init__.pyi,sha256=X1zSvvHC-pSmtFnxyjIGh03uItz0Vg8mgJrUi7bXL9U,718
-ormsgpack/ormsgpack.cp38-win_amd64.pyd,sha256=ZRXXyuo-bvhXV5tkFZm7r3G5OXVXliZc9PjlU_gHc-o,295936
-ormsgpack-1.3.0.dist-info/RECORD,,