Skip to content

Commit f406983

Browse files
author
aleksandr.tseluyko
committed
Support numeric constraints for decimal.Decimal
Extends gt, ge, lt, le, and multiple_of Meta constraints to work with decimal.Decimal types, enabling exact arithmetic comparisons and sub-integer precision constraints without floating point issues. Constraint bounds passed as int or float are coerced to Decimal via their string representation to preserve precision. multiple_of uses Python's % operator for exact arithmetic. Closes #683
1 parent 4024c90 commit f406983

4 files changed

Lines changed: 353 additions & 52 deletions

File tree

‎docs/constraints.rst‎

Lines changed: 16 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -76,7 +76,7 @@ The following constraints are supported:
7676
Numeric Constraints
7777
-------------------
7878

79-
These constraints are valid on `int` or `float` types:
79+
These constraints are valid on `int`, `float`, or `decimal.Decimal` types:
8080

8181
- ``ge``: The value must be greater than or equal to ``ge``.
8282
- ``gt``: The value must be greater than ``gt``.
@@ -88,23 +88,33 @@ These constraints are valid on `int` or `float` types:
8888
8989
>>> import msgspec
9090
91+
>>> from decimal import Decimal
92+
9193
>>> from typing import Annotated
9294
9395
>>> msgspec.json.decode(b'-1', type=Annotated[int, msgspec.Meta(ge=0)])
9496
Traceback (most recent call last):
9597
File "<stdin>", line 1, in <module>
9698
msgspec.ValidationError: Expected `int` >= 0
9799
98-
.. warning::
100+
>>> msgspec.json.decode(b'0.3', type=Annotated[Decimal, msgspec.Meta(multiple_of=Decimal('0.1'))])
101+
Decimal('0.3')
102+
103+
.. note::
99104

100105
While ``multiple_of`` works on ``float`` types, we don't recommend
101-
specifying *non-integral* ``multiple_of`` constraints, as they may be
102-
erroneously marked as invalid due to floating point precision issues. For
103-
example, annotating a ``float`` type with ``multiple_of=10`` is fine, but
104-
``multiple_of=0.1`` may lead to issues. See `this GitHub issue
106+
specifying *non-integral* ``multiple_of`` constraints on them,
107+
as they may be erroneously marked as invalid due to floating point
108+
precision issues. For example, annotating a ``float`` type with
109+
``multiple_of=10`` is fine, but ``multiple_of=0.1`` may lead to issues.
110+
See `this GitHub issue
105111
<https://github.com/json-schema-org/json-schema-spec/issues/312>`_ for more
106112
details.
107113

114+
To address this issue, ``msgspec`` supports specifying ``multiple_of``
115+
constraints with `decimal.Decimal` types, that offer arbitrary precision
116+
arithmetic.
117+
108118
String Constraints
109119
------------------
110120

‎src/msgspec/__init__.pyi‎

Lines changed: 11 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,5 @@
11
import enum
2+
from decimal import Decimal
23
from inspect import Signature
34
from typing import (
45
Any,
@@ -163,11 +164,11 @@ class Meta:
163164
def __init__(
164165
self,
165166
*,
166-
gt: Union[int, float, None] = None,
167-
ge: Union[int, float, None] = None,
168-
lt: Union[int, float, None] = None,
169-
le: Union[int, float, None] = None,
170-
multiple_of: Union[int, float, None] = None,
167+
gt: Union[int, float, Decimal, None] = None,
168+
ge: Union[int, float, Decimal, None] = None,
169+
lt: Union[int, float, Decimal, None] = None,
170+
le: Union[int, float, Decimal, None] = None,
171+
multiple_of: Union[int, float, Decimal, None] = None,
171172
pattern: Union[str, None] = None,
172173
min_length: Union[int, None] = None,
173174
max_length: Union[int, None] = None,
@@ -178,11 +179,11 @@ class Meta:
178179
extra_json_schema: Union[dict, None] = None,
179180
extra: Union[dict, None] = None,
180181
): ...
181-
gt: Final[Union[int, float, None]]
182-
ge: Final[Union[int, float, None]]
183-
lt: Final[Union[int, float, None]]
184-
le: Final[Union[int, float, None]]
185-
multiple_of: Final[Union[int, float, None]]
182+
gt: Final[Union[int, float, Decimal, None]]
183+
ge: Final[Union[int, float, Decimal, None]]
184+
lt: Final[Union[int, float, Decimal, None]]
185+
le: Final[Union[int, float, Decimal, None]]
186+
multiple_of: Final[Union[int, float, Decimal, None]]
186187
pattern: Final[Union[str, None]]
187188
min_length: Final[Union[int, None]]
188189
max_length: Final[Union[int, None]]

0 commit comments

Comments
 (0)