PYTHON-3414 Improve error message when using incompatible pymongocrypt version

Author: blink1073

pymongo/asynchronous/encryption.py

@@ -66,7 +66,12 @@
 from pymongo.asynchronous.mongo_client import AsyncMongoClient
 from pymongo.common import CONNECT_TIMEOUT
 from pymongo.daemon import _spawn_daemon
-from pymongo.encryption_options import AutoEncryptionOpts, RangeOpts, TextOpts
+from pymongo.encryption_options import (
+    AutoEncryptionOpts,
+    RangeOpts,
+    TextOpts,
+    check_min_pymongocrypt,
+)
 from pymongo.errors import (
     ConfigurationError,
     EncryptedCollectionError,
@@ -675,6 +680,8 @@ def __init__(
                 "python -m pip install --upgrade 'pymongo[encryption]'"
             )
 
+        check_min_pymongocrypt()
+
         if not isinstance(codec_options, CodecOptions):
             raise TypeError(
                 f"codec_options must be an instance of bson.codec_options.CodecOptions, not {type(codec_options)}"

pymongo/common.py

@@ -20,6 +20,7 @@
 import warnings
 from collections import OrderedDict, abc
 from difflib import get_close_matches
+from importlib.metadata import requires
 from typing import (
     TYPE_CHECKING,
     Any,
@@ -1092,3 +1093,76 @@ def has_c() -> bool:
         return True
     except ImportError:
         return False
+
+
+class Version(tuple):
+    def __new__(cls, *version):
+        padded_version = cls._padded(version, 4)
+        return super().__new__(cls, tuple(padded_version))
+
+    @classmethod
+    def _padded(cls, iter, length, padding=0):
+        as_list = list(iter)
+        if len(as_list) < length:
+            for _ in range(length - len(as_list)):
+                as_list.append(padding)
+        return as_list
+
+    @classmethod
+    def from_string(cls, version_string):
+        mod = 0
+        bump_patch_level = False
+        if version_string.endswith("+"):
+            version_string = version_string[0:-1]
+            mod = 1
+        elif version_string.endswith("-pre-"):
+            version_string = version_string[0:-5]
+            mod = -1
+        elif version_string.endswith("-"):
+            version_string = version_string[0:-1]
+            mod = -1
+        # Deal with '-rcX' substrings
+        if "-rc" in version_string:
+            version_string = version_string[0 : version_string.find("-rc")]
+            mod = -1
+        # Deal with git describe generated substrings
+        elif "-" in version_string:
+            version_string = version_string[0 : version_string.find("-")]
+            mod = -1
+            bump_patch_level = True
+
+        version = [int(part) for part in version_string.split(".")]
+        version = cls._padded(version, 3)
+        # Make from_string and from_version_array agree. For example:
+        # MongoDB Enterprise > db.runCommand('buildInfo').versionArray
+        # [ 3, 2, 1, -100 ]
+        # MongoDB Enterprise > db.runCommand('buildInfo').version
+        # 3.2.0-97-g1ef94fe
+        if bump_patch_level:
+            version[-1] += 1
+        version.append(mod)
+
+        return Version(*version)
+
+    @classmethod
+    def from_version_array(cls, version_array):
+        version = list(version_array)
+        if version[-1] < 0:
+            version[-1] = -1
+        version = cls._padded(version, 3)
+        return Version(*version)
+
+    def at_least(self, *other_version):
+        return self >= Version(*other_version)
+
+    def __str__(self):
+        return ".".join(map(str, self))
+
+
+def check_for_min_version(package_version: str, package_name: str) -> tuple[str, bool]:
+    package_version = Version.from_string(package_version)
+    requirement = (
+        [i for i in requires("pymongo") if i.startswith(package_name)].next().split(";").next()
+    )
+    required_version = requirement[requirement.find(">=") + 2 :]
+    return required_version, package_version > Version.from_string(required_version)

pymongo/encryption_options.py

@@ -23,7 +23,7 @@
 from pymongo.uri_parser_shared import _parse_kms_tls_options
 
 try:
-    import pymongocrypt  # type:ignore[import-untyped] # noqa: F401
+    from pymongocrypt import __version__ as pymongocrypt_version  # type:ignore[import-untyped]
 
     # Check for pymongocrypt>=1.10.
     from pymongocrypt import synchronous as _  # noqa: F401
@@ -32,14 +32,26 @@
 except ImportError:
     _HAVE_PYMONGOCRYPT = False
 from bson import int64
-from pymongo.common import validate_is_mapping
+from pymongo.common import check_for_min_version, validate_is_mapping
 from pymongo.errors import ConfigurationError
 
 if TYPE_CHECKING:
     from pymongo.pyopenssl_context import SSLContext
     from pymongo.typings import _AgnosticMongoClient
 
 
+def check_min_pymongocrypt() -> None:
+    """Raise an appropriate error if the min pymongocrypt is not installed."""
+    required_version, is_valid = check_for_min_version(pymongocrypt_version, "pymongocrypt")
+    if not is_valid:
+        raise ConfigurationError(
+            f"client side encryption requires the pymongocrypt>={required_version}, "
+            f"found version {pymongocrypt_version}. "
+            "Install a compatible version with: "
+            "python -m pip install 'pymongo[encryption]'"
+        )
+
+
 class AutoEncryptionOpts:
     """Options to configure automatic client-side field level encryption."""
 
@@ -215,6 +227,7 @@ def __init__(
                 "install a compatible version with: "
                 "python -m pip install 'pymongo[encryption]'"
             )
+        check_min_pymongocrypt()
         if encrypted_fields_map:
             validate_is_mapping("encrypted_fields_map", encrypted_fields_map)
         self._encrypted_fields_map = encrypted_fields_map

pymongo/synchronous/encryption.py

@@ -61,7 +61,12 @@
 from pymongo import _csot
 from pymongo.common import CONNECT_TIMEOUT
 from pymongo.daemon import _spawn_daemon
-from pymongo.encryption_options import AutoEncryptionOpts, RangeOpts, TextOpts
+from pymongo.encryption_options import (
+    AutoEncryptionOpts,
+    RangeOpts,
+    TextOpts,
+    check_min_pymongocrypt,
+)
 from pymongo.errors import (
     ConfigurationError,
     EncryptedCollectionError,
@@ -672,6 +677,8 @@ def __init__(
                 "python -m pip install --upgrade 'pymongo[encryption]'"
             )
 
+        check_min_pymongocrypt()
+
         if not isinstance(codec_options, CodecOptions):
             raise TypeError(
                 f"codec_options must be an instance of bson.codec_options.CodecOptions, not {type(codec_options)}"

test/version.py

@@ -15,64 +15,10 @@
 """Some tools for running tests based on MongoDB server version."""
 from __future__ import annotations
 
+from pymongo.common import Version as BaseVersion
 
-class Version(tuple):
-    def __new__(cls, *version):
-        padded_version = cls._padded(version, 4)
-        return super().__new__(cls, tuple(padded_version))
-
-    @classmethod
-    def _padded(cls, iter, length, padding=0):
-        l = list(iter)
-        if len(l) < length:
-            for _ in range(length - len(l)):
-                l.append(padding)
-        return l
-
-    @classmethod
-    def from_string(cls, version_string):
-        mod = 0
-        bump_patch_level = False
-        if version_string.endswith("+"):
-            version_string = version_string[0:-1]
-            mod = 1
-        elif version_string.endswith("-pre-"):
-            version_string = version_string[0:-5]
-            mod = -1
-        elif version_string.endswith("-"):
-            version_string = version_string[0:-1]
-            mod = -1
-        # Deal with '-rcX' substrings
-        if "-rc" in version_string:
-            version_string = version_string[0 : version_string.find("-rc")]
-            mod = -1
-        # Deal with git describe generated substrings
-        elif "-" in version_string:
-            version_string = version_string[0 : version_string.find("-")]
-            mod = -1
-            bump_patch_level = True
-
-        version = [int(part) for part in version_string.split(".")]
-        version = cls._padded(version, 3)
-        # Make from_string and from_version_array agree. For example:
-        # MongoDB Enterprise > db.runCommand('buildInfo').versionArray
-        # [ 3, 2, 1, -100 ]
-        # MongoDB Enterprise > db.runCommand('buildInfo').version
-        # 3.2.0-97-g1ef94fe
-        if bump_patch_level:
-            version[-1] += 1
-        version.append(mod)
-
-        return Version(*version)
-
-    @classmethod
-    def from_version_array(cls, version_array):
-        version = list(version_array)
-        if version[-1] < 0:
-            version[-1] = -1
-        version = cls._padded(version, 3)
-        return Version(*version)
 
+class Version(BaseVersion):
     @classmethod
     def from_client(cls, client):
         info = client.server_info()
@@ -86,9 +32,3 @@ async def async_from_client(cls, client):
         if "versionArray" in info:
             return cls.from_version_array(info["versionArray"])
         return cls.from_string(info["version"])
-
-    def at_least(self, *other_version):
-        return self >= Version(*other_version)
-
-    def __str__(self):
-        return ".".join(map(str, self))