MOTOR-946 Deprecated APIs will not be Removed in Motor 3.0 (#168)

mongodb · Apr 26, 2022 · 2f75a40 · 2f75a40
1 parent c564a02
commit 2f75a40
Show file tree

Hide file tree

Showing 5 changed files with 10 additions and 9 deletions.
diff --git a/doc/developer-guide.rst b/doc/developer-guide.rst
@@ -45,7 +45,7 @@ See the ``frameworks/tornado`` and ``frameworks/asyncio`` modules.
    list above are not used internally in Motor. Instead of being removed
    from the codebase, they have been left in a deprecated state to avoid
    breaking any libraries built on top of Motor. These deprecated functions
-   will be removed in Motor 3.0.
+   may be removed in a future major release.
 
 A framework-specific class, like ``MotorClient`` for Tornado or
 ``AsyncIOMotorClient`` for asyncio, is created by the

diff --git a/motor/core.py b/motor/core.py
@@ -1324,8 +1324,8 @@ def fetch_next(self):
         .. _`gen.coroutine`: http://tornadoweb.org/en/stable/gen.html
         """
         warnings.warn(
-            "The fetch_next property is deprecated and will be "
-            "removed in Motor 3.0. Use `async for` to iterate "
+            "The fetch_next property is deprecated and may be "
+            "removed in a future major release. Use `async for` to iterate "
             "over Cursor objects instead.",
             DeprecationWarning,
             stacklevel=2,
@@ -1348,16 +1348,16 @@ def next_object(self):
         """**DEPRECATED** - Get a document from the most recently fetched
         batch, or ``None``. See :attr:`fetch_next`.
 
-        The :meth:`next_object` method is deprecated and will be removed
-        in Motor 3.0. Use `async for` to elegantly iterate over
+        The :meth:`next_object` method is deprecated and may be removed
+        in a future major release. Use `async for` to elegantly iterate over
         :class:`MotorCursor` objects instead.
 
         .. versionchanged:: 2.2
            Deprecated.
         """
         warnings.warn(
-            "The next_object method is deprecated and will be "
-            "removed in Motor 3.0. Use Use `async for` to iterate "
+            "The next_object method is deprecated and may be "
+            "removed in a future major release.  Use `async for` to iterate "
             "over Cursor objects instead.",
             DeprecationWarning,
             stacklevel=2,

diff --git a/motor/frameworks/asyncio/__init__.py b/motor/frameworks/asyncio/__init__.py
@@ -147,7 +147,7 @@ async def _wrapper(self, *args, **kwargs):
 
 def yieldable(future):
     warnings.warn(
-        "The yieldable function is deprecated and will be removed in  Motor 3.0",
+        "The yieldable function is deprecated and may be removed in a future major release",
         DeprecationWarning,
         stacklevel=2,
     )

diff --git a/motor/frameworks/tornado/__init__.py b/motor/frameworks/tornado/__init__.py
@@ -129,7 +129,7 @@ async def _wrapper(self, *args, **kwargs):
 
 def yieldable(future):
     warnings.warn(
-        "The yieldable function is deprecated and will be removed in Motor 3.0",
+        "The yieldable function is deprecated and may be removed in a future major release.",
         DeprecationWarning,
         stacklevel=2,
     )

diff --git a/motor/motor_gridfs.py b/motor/motor_gridfs.py
@@ -43,6 +43,7 @@ class AgnosticGridOutCursor(AgnosticCursor):
 
     def next_object(self):
         """**DEPRECATED** - Get next GridOut object from cursor."""
+        # Note: the super() call will raise a warning for the deprecation.
         grid_out = super().next_object()
         if grid_out:
             grid_out_class = create_class_with_framework(