ormsgpack 1.7.0__cp311-cp311-win_amd64.whl → 1.8.0__cp311-cp311-win_amd64.whl

ormsgpack/__init__.py

@@ -9,6 +9,7 @@ from .ormsgpack import (
     OPT_PASSTHROUGH_DATETIME,
     OPT_PASSTHROUGH_SUBCLASS,
     OPT_PASSTHROUGH_TUPLE,
+    OPT_PASSTHROUGH_UUID,
     OPT_SERIALIZE_NUMPY,
     OPT_SERIALIZE_PYDANTIC,
     OPT_SORT_KEYS,
@@ -36,6 +37,7 @@ __all__ = (
     "OPT_PASSTHROUGH_DATETIME",
     "OPT_PASSTHROUGH_SUBCLASS",
     "OPT_PASSTHROUGH_TUPLE",
+    "OPT_PASSTHROUGH_UUID",
     "OPT_SERIALIZE_NUMPY",
     "OPT_SERIALIZE_PYDANTIC",
     "OPT_SORT_KEYS",

ormsgpack/__init__.pyi

@@ -26,6 +26,7 @@ OPT_PASSTHROUGH_DATACLASS: int
 OPT_PASSTHROUGH_DATETIME: int
 OPT_PASSTHROUGH_SUBCLASS: int
 OPT_PASSTHROUGH_TUPLE: int
+OPT_PASSTHROUGH_UUID: int
 OPT_SERIALIZE_NUMPY: int
 OPT_SERIALIZE_PYDANTIC: int
 OPT_NON_STR_KEYS: int

{ormsgpack-1.7.0.dist-info → ormsgpack-1.8.0.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: ormsgpack
-Version: 1.7.0
+Version: 1.8.0
 Classifier: Development Status :: 5 - Production/Stable
 Classifier: Intended Audience :: Developers
 Classifier: License :: OSI Approved :: Apache Software License
@@ -120,8 +120,7 @@ It natively serializes
 `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. To avoid
-serializing subclasses, specify the option `ormsgpack.OPT_PASSTHROUGH_SUBCLASS`.
+of `tuple` to avoid serializing `namedtuple` objects as arrays.
 
 The output is a `bytes` object.
 
@@ -205,13 +204,16 @@ value, respectively.
 b'\xc7\x18\x000.0842389659712649442845'
 ```
 
+`default` can also be used to serialize some supported types to a custom
+format by enabling the corresponding passthrough options.
+
 #### option
 
 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_NAIVE_UTC
+##### `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
@@ -234,11 +236,13 @@ b'\xb91970-01-01T00:00:00+00:00'
 '1970-01-01T00:00:00+00:00'
 ```
 
-##### OPT_NON_STR_KEYS
+##### `OPT_NON_STR_KEYS`
 
 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`.
+`dict` keys of unsupported types are not handled using `default` and
+result in `MsgpackEncodeError` being raised.
 
 ```python
 >>> import ormsgpack, datetime, uuid
@@ -270,7 +274,7 @@ occurrence of a key (in the above, `false`). The first value will be lost.
 
 This option is not compatible with `ormsgpack.OPT_SORT_KEYS`.
 
-##### OPT_OMIT_MICROSECONDS
+##### `OPT_OMIT_MICROSECONDS`
 
 Do not serialize the microsecond component of `datetime.datetime`,
 `datetime.time` and `numpy.datetime64` instances.
@@ -292,9 +296,10 @@ b'\xb31970-01-01T00:00:00'
 '1970-01-01T00:00:00'
 ```
 
-##### OPT_PASSTHROUGH_BIG_INT
+##### `OPT_PASSTHROUGH_BIG_INT`
 
-Enables passthrough of big (Python) ints. By setting this option, one can set a `default` function for ints larger than 63 bits, smaller ints are still serialized efficiently.
+Enable passthrough of `int` instances smaller than -9223372036854775807 or
+larger than 18446744073709551615 to `default`.
 
 ```python
 >>> import ormsgpack
@@ -312,10 +317,9 @@ b'\x82\xa4type\xa6bigint\xa5value\xb436893488147419103232'
 {'type': 'bigint', 'value': '36893488147419103232'}
 ```
 
-##### OPT_PASSTHROUGH_DATACLASS
+##### `OPT_PASSTHROUGH_DATACLASS`
 
-Passthrough `dataclasses.dataclass` instances to `default`. This allows
-customizing their output but is much slower.
+Enable passthrough of `dataclasses.dataclass` instances to `default`.
 
 
 ```python
@@ -343,11 +347,10 @@ TypeError: Type is not msgpack serializable: User
 b'\x82\xa2id\xa33b1\xa4name\xa3asd'
 ```
 
-##### OPT_PASSTHROUGH_DATETIME
+##### `OPT_PASSTHROUGH_DATETIME`
 
-Passthrough `datetime.datetime`, `datetime.date`, and `datetime.time` instances
-to `default`. This allows serializing datetimes to a custom format, e.g.,
-HTTP dates:
+Enable passthrough of `datetime.datetime`, `datetime.date`, and
+`datetime.time` instances to `default`.
 
 ```python
 >>> import ormsgpack, datetime
@@ -368,11 +371,10 @@ TypeError: Type is not msgpack serializable: datetime.datetime
 b'\x81\xaacreated_at\xbdThu, 01 Jan 1970 00:00:00 GMT'
 ```
 
-This does not affect datetimes in `dict` keys if using OPT_NON_STR_KEYS.
-
-##### OPT_PASSTHROUGH_SUBCLASS
+##### `OPT_PASSTHROUGH_SUBCLASS`
 
-Passthrough subclasses of builtin types to `default`.
+Enable passthrough of subclasses of `str`, `int`, `dict` and `list` to
+`default`.
 
 ```python
 >>> import ormsgpack
@@ -392,12 +394,9 @@ TypeError: Type is not msgpack serializable: Secret
 b'\xa6******'
 ```
 
-This does not affect serializing subclasses as `dict` keys if using
-OPT_NON_STR_KEYS.
-
-##### OPT_PASSTHROUGH_TUPLE
+##### `OPT_PASSTHROUGH_TUPLE`
 
-Passthrough tuples to `default`.
+Enable passthrough of `tuple` instances to `default`.
 
 ```python
 >>> import ormsgpack
@@ -417,15 +416,19 @@ b'\x82\xa4type\xa5tuple\xa5value\x93\xcd#\xe9\xa4test*'
 {'type': 'tuple', 'value': [9193, 'test', 42]}
 ```
 
-##### OPT_SERIALIZE_NUMPY
+##### `OPT_PASSTHROUGH_UUID`
+
+Enable passthrough of `uuid.UUID` instances to `default`.
+
+##### `OPT_SERIALIZE_NUMPY`
 
 Serialize `numpy.ndarray` instances. For more, see
 [numpy](#numpy).
 
-##### OPT_SERIALIZE_PYDANTIC
+##### `OPT_SERIALIZE_PYDANTIC`
 Serialize `pydantic.BaseModel` instances.
 
-##### OPT_SORT_KEYS
+##### `OPT_SORT_KEYS`
 
 Serialize `dict` keys and pydantic model fields in sorted order. The default
 is to serialize in an unspecified order.
@@ -451,7 +454,7 @@ b'\x83\xa1A\x03\xa1a\x01\xa2\xc3\xa4\x02'
 
 `dataclass` also serialize as maps but this has no effect on them.
 
-##### OPT_UTC_Z
+##### `OPT_UTC_Z`
 
 Serialize a UTC timezone on `datetime.datetime` and `numpy.datetime64` instances
 as `Z` instead of `+00:00`.
@@ -620,9 +623,6 @@ b'\xaa1900-01-02'
 
 Errors with `tzinfo` result in `MsgpackEncodeError` being raised.
 
-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`.
 

ormsgpack-1.8.0.dist-info/RECORD

@@ -0,0 +1,9 @@
+ormsgpack-1.8.0.dist-info/METADATA,sha256=Xl3RmNAi8eDYZg5SPudylK9YEn46gXDliC86fynnAcA,44268
+ormsgpack-1.8.0.dist-info/WHEEL,sha256=FfBmcAWtop0bmP9Ri8DvsApqdaZzji_i0KSrSP4fKhk,96
+ormsgpack-1.8.0.dist-info/licenses/LICENSE-APACHE,sha256=fP1zjFPWHHnwfjSPYiv3cHyQhCNwVNN_vgd4inX1iBw,11048
+ormsgpack-1.8.0.dist-info/licenses/LICENSE-MIT,sha256=NlFq79yExdWh50hUJZE6ItvaaesZMMXoTWrklytRlLk,1046
+ormsgpack/py.typed,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
+ormsgpack/__init__.py,sha256=8OwJ6fMUN0Yv3HpqVCOMut34chTbKtoaR9yJQmF5TDE,1025
+ormsgpack/__init__.pyi,sha256=xlbnosG9L-NzjW4eN-C_Zhbg6nd9X6iY_hD4dEoBkAE,878
+ormsgpack/ormsgpack.cp311-win_amd64.pyd,sha256=yYmfSKjivtQeSk08YuBeWql037ULQTASl_C-gLpzdW8,215552
+ormsgpack-1.8.0.dist-info/RECORD,,

{ormsgpack-1.7.0.dist-info → ormsgpack-1.8.0.dist-info}/WHEEL

@@ -1,4 +1,4 @@
 Wheel-Version: 1.0
-Generator: maturin (1.7.8)
+Generator: maturin (1.8.2)
 Root-Is-Purelib: false
 Tag: cp311-cp311-win_amd64

ormsgpack-1.7.0.dist-info/RECORD

@@ -1,9 +0,0 @@
-ormsgpack-1.7.0.dist-info/METADATA,sha256=UIb3GG9Z4O4O3xUEFYv8TL3eeeJoLVBSrUM9dGOTe-I,44379
-ormsgpack-1.7.0.dist-info/WHEEL,sha256=WsIShqAueIiqoJF6ENvmF0oWsvt5oIWOPbl3_KwvlDE,96
-ormsgpack-1.7.0.dist-info/licenses/LICENSE-APACHE,sha256=fP1zjFPWHHnwfjSPYiv3cHyQhCNwVNN_vgd4inX1iBw,11048
-ormsgpack-1.7.0.dist-info/licenses/LICENSE-MIT,sha256=NlFq79yExdWh50hUJZE6ItvaaesZMMXoTWrklytRlLk,1046
-ormsgpack/py.typed,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
-ormsgpack/__init__.py,sha256=cO7CRlLMoqVgapEc5lz2nE0SNNuvi659IAbl0fYU4_Q,969
-ormsgpack/__init__.pyi,sha256=ifO6bsEVSuexKoxAF37hhZperoUVIyT6it2NLq79fa8,851
-ormsgpack/ormsgpack.cp311-win_amd64.pyd,sha256=SeuLAJMNP1A9Qk8HmxC7lebo4t13mfXPZO2NRaY3QN4,213504
-ormsgpack-1.7.0.dist-info/RECORD,,