Merge pull request #2739 from ShaneHarvey/uuidRepr-deprecation-warning

Update uuidRepresentation warnings with "unspecified" as the future default

Author: bagerard

mongoengine/base/document.py

@@ -450,7 +450,8 @@ def to_json(self, *args, **kwargs):
                 "No 'json_options' are specified! Falling back to "
                 "LEGACY_JSON_OPTIONS with uuid_representation=PYTHON_LEGACY. "
                 "For use with other MongoDB drivers specify the UUID "
-                "representation to use.",
+                "representation to use. This will be changed to "
+                "uuid_representation=UNSPECIFIED in a future release.",
                 DeprecationWarning,
             )
             kwargs["json_options"] = LEGACY_JSON_OPTIONS
@@ -480,7 +481,8 @@ def from_json(cls, json_data, created=False, **kwargs):
                 "No 'json_options' are specified! Falling back to "
                 "LEGACY_JSON_OPTIONS with uuid_representation=PYTHON_LEGACY. "
                 "For use with other MongoDB drivers specify the UUID "
-                "representation to use.",
+                "representation to use. This will be changed to "
+                "uuid_representation=UNSPECIFIED in a future release.",
                 DeprecationWarning,
             )
             kwargs["json_options"] = LEGACY_JSON_OPTIONS

mongoengine/connection.py

@@ -177,7 +177,7 @@ def _get_connection_settings(
             "For compatibility with other MongoDB drivers this should be "
             "specified as 'standard' or '{java,csharp}Legacy' to work with "
             "older drivers in those languages. This will be changed to "
-            "'standard' in a future release.",
+            "'unspecified' in a future release.",
             DeprecationWarning,
         )
         kwargs["uuidRepresentation"] = "pythonLegacy"

mongoengine/pymongo_support.py

@@ -7,6 +7,8 @@
 
 PYMONGO_VERSION = tuple(pymongo.version_tuple[:2])
 
+# This will be changed to UuidRepresentation.UNSPECIFIED in a future
+# (breaking) release.
 if PYMONGO_VERSION >= (4,):
     LEGACY_JSON_OPTIONS = json_util.LEGACY_JSON_OPTIONS.with_options(
         uuid_representation=binary.UuidRepresentation.PYTHON_LEGACY,

mongoengine/queryset/base.py

@@ -1283,7 +1283,8 @@ def to_json(self, *args, **kwargs):
                 "No 'json_options' are specified! Falling back to "
                 "LEGACY_JSON_OPTIONS with uuid_representation=PYTHON_LEGACY. "
                 "For use with other MongoDB drivers specify the UUID "
-                "representation to use.",
+                "representation to use. This will be changed to "
+                "uuid_representation=UNSPECIFIED in a future release.",
                 DeprecationWarning,
             )
             kwargs["json_options"] = LEGACY_JSON_OPTIONS