Skip to content

Commit 2d301e2

Browse files
authored
PYTHON-4531 Add back RANGEPREVIEW (#1719)
1 parent 1318533 commit 2d301e2

File tree

3 files changed

+46
-8
lines changed

3 files changed

+46
-8
lines changed

doc/changelog.rst

+2
Original file line numberDiff line numberDiff line change
@@ -8,6 +8,8 @@ PyMongo 4.9 brings a number of improvements including:
88

99
- Added support for MongoDB 8.0.
1010
- A new asynchronous API with full asyncio support.
11+
- Add support for :attr:`~pymongo.encryption.Algorithm.RANGE` and deprecate
12+
:attr:`~pymongo.encryption.Algorithm.RANGEPREVIEW`.
1113
- pymongocrypt>=1.10 is now required for :ref:`In-Use Encryption` support.
1214

1315
Issues Resolved

pymongo/asynchronous/encryption.py

+22-4
Original file line numberDiff line numberDiff line change
@@ -463,7 +463,14 @@ class Algorithm(str, enum.Enum):
463463
RANGE = "Range"
464464
"""Range.
465465
466-
.. versionadded:: 4.8
466+
.. versionadded:: 4.9
467+
"""
468+
RANGEPREVIEW = "RangePreview"
469+
"""**DEPRECATED** - RangePreview.
470+
471+
.. note:: Support for RangePreview is deprecated. Use :attr:`Algorithm.RANGE` instead.
472+
473+
.. versionadded:: 4.4
467474
"""
468475

469476

@@ -477,7 +484,18 @@ class QueryType(str, enum.Enum):
477484
"""Used to encrypt a value for an equality query."""
478485

479486
RANGE = "range"
480-
"""Used to encrypt a value for a range query."""
487+
"""Used to encrypt a value for a range query.
488+
489+
.. versionadded:: 4.9
490+
"""
491+
492+
RANGEPREVIEW = "RangePreview"
493+
"""**DEPRECATED** - Used to encrypt a value for a rangePreview query.
494+
495+
.. note:: Support for RangePreview is deprecated. Use :attr:`QueryType.RANGE` instead.
496+
497+
.. versionadded:: 4.4
498+
"""
481499

482500

483501
def _create_mongocrypt_options(**kwargs: Any) -> MongoCryptOptions:
@@ -847,7 +865,7 @@ async def encrypt(
847865
848866
:return: The encrypted value, a :class:`~bson.binary.Binary` with subtype 6.
849867
850-
.. versionchanged:: 4.8
868+
.. versionchanged:: 4.9
851869
Added the `range_opts` parameter.
852870
853871
.. versionchanged:: 4.7
@@ -903,7 +921,7 @@ async def encrypt_expression(
903921
904922
:return: The encrypted expression, a :class:`~bson.RawBSONDocument`.
905923
906-
.. versionchanged:: 4.8
924+
.. versionchanged:: 4.9
907925
Added the `range_opts` parameter.
908926
909927
.. versionchanged:: 4.7

pymongo/synchronous/encryption.py

+22-4
Original file line numberDiff line numberDiff line change
@@ -461,7 +461,14 @@ class Algorithm(str, enum.Enum):
461461
RANGE = "Range"
462462
"""Range.
463463
464-
.. versionadded:: 4.8
464+
.. versionadded:: 4.9
465+
"""
466+
RANGEPREVIEW = "RangePreview"
467+
"""**DEPRECATED** - RangePreview.
468+
469+
.. note:: Support for RangePreview is deprecated. Use :attr:`Algorithm.RANGE` instead.
470+
471+
.. versionadded:: 4.4
465472
"""
466473

467474

@@ -475,7 +482,18 @@ class QueryType(str, enum.Enum):
475482
"""Used to encrypt a value for an equality query."""
476483

477484
RANGE = "range"
478-
"""Used to encrypt a value for a range query."""
485+
"""Used to encrypt a value for a range query.
486+
487+
.. versionadded:: 4.9
488+
"""
489+
490+
RANGEPREVIEW = "RangePreview"
491+
"""**DEPRECATED** - Used to encrypt a value for a rangePreview query.
492+
493+
.. note:: Support for RangePreview is deprecated. Use :attr:`QueryType.RANGE` instead.
494+
495+
.. versionadded:: 4.4
496+
"""
479497

480498

481499
def _create_mongocrypt_options(**kwargs: Any) -> MongoCryptOptions:
@@ -845,7 +863,7 @@ def encrypt(
845863
846864
:return: The encrypted value, a :class:`~bson.binary.Binary` with subtype 6.
847865
848-
.. versionchanged:: 4.8
866+
.. versionchanged:: 4.9
849867
Added the `range_opts` parameter.
850868
851869
.. versionchanged:: 4.7
@@ -901,7 +919,7 @@ def encrypt_expression(
901919
902920
:return: The encrypted expression, a :class:`~bson.RawBSONDocument`.
903921
904-
.. versionchanged:: 4.8
922+
.. versionchanged:: 4.9
905923
Added the `range_opts` parameter.
906924
907925
.. versionchanged:: 4.7

0 commit comments

Comments
 (0)