PYTHON-1588 Remove deprecated killCursors APIs

Author: ShaneHarvey

doc/api/pymongo/index.rst

@@ -38,7 +38,6 @@ Sub-modules:
    collection
    command_cursor
    cursor
-   cursor_manager
    database
    driver_info
    encryption

doc/api/pymongo/mongo_client.rst

@@ -43,6 +43,3 @@
       .. automethod:: get_database
       .. automethod:: server_info
       .. automethod:: watch
-      .. automethod:: close_cursor
-      .. automethod:: kill_cursors
-      .. automethod:: set_cursor_manager

doc/api/pymongo/mongo_replica_set_client.rst

@@ -27,7 +27,4 @@
       .. automethod:: database_names
       .. automethod:: drop_database
       .. automethod:: get_database
-      .. automethod:: close_cursor
-      .. automethod:: kill_cursors
-      .. automethod:: set_cursor_manager
       .. automethod:: get_default_database

doc/changelog.rst

@@ -22,6 +22,12 @@ Breaking Changes in 4.0
   :meth:`pymongo.mongo_client.MongoClient.unlock`, and
   :attr:`pymongo.mongo_client.MongoClient.is_locked`.
 - Removed :meth:`pymongo.collection.Collection.parallel_scan`.
+- Removed :meth:`pymongo.mongo_client.MongoClient.close_cursor`. Use
+  :meth:`pymongo.cursor.Cursor.close` instead.
+- Removed :meth:`pymongo.mongo_client.MongoClient.kill_cursors`.
+- Removed :class:`pymongo.cursor_manager.CursorManager` and
+  :mod:`pymongo.cursor_manager`.
+- Removed :meth:`pymongo.mongo_client.MongoClient.set_cursor_manager`.
 - Removed :mod:`pymongo.thread_util`.
 
 Notable improvements

doc/migrate-to-pymongo4.rst

@@ -99,6 +99,23 @@ collection::
 Removed features with no migration path
 ---------------------------------------
 
+cursor_manager support is removed
+.................................
+
+Removed :class:`pymongo.cursor_manager.CursorManager`,
+:mod:`pymongo.cursor_manager`, and
+:meth:`pymongo.mongo_client.MongoClient.set_cursor_manager`.
+
+MongoClient.close_cursor is removed
+...................................
+
+Removed :meth:`pymongo.mongo_client.MongoClient.close_cursor` and
+:meth:`pymongo.mongo_client.MongoClient.kill_cursors`. Instead, close cursors
+with :meth:`pymongo.cursor.Cursor.close` or
+:meth:`pymongo.command_cursor.CommandCursor.close`.
+
+.. _killCursors command: https://docs.mongodb.com/manual/reference/command/killCursors/
+
 Database.eval, Database.system_js, and SystemJS are removed
 ...........................................................
 
@@ -117,7 +134,6 @@ can be changed to this::
   >>> from bson.code import Code
   >>> result = database.command('eval', Code('function (x) {return x;}'), args=[3]).get('retval')
 
-
 Collection.parallel_scan is removed
 ...................................
 

pymongo/common.py

@@ -63,7 +63,8 @@
 # Frequency to call ismaster on servers, in seconds.
 HEARTBEAT_FREQUENCY = 10
 
-# Frequency to process kill-cursors, in seconds. See MongoClient.close_cursor.
+# Frequency to clean up unclosed cursors, in seconds.
+# See MongoClient._process_kill_cursors.
 KILL_CURSOR_FREQUENCY = 1
 
 # Frequency to process events queue, in seconds.

pymongo/cursor.py

@@ -1171,10 +1171,6 @@ def alive(self):
     def cursor_id(self):
         """Returns the id of the cursor
 
-        Useful if you need to manage cursor ids and want to handle killing
-        cursors manually using
-        :meth:`~pymongo.mongo_client.MongoClient.kill_cursors`
-
         .. versionadded:: 2.2
         """
         return self.__id

pymongo/mongo_client.py

@@ -1551,38 +1551,6 @@ def __getitem__(self, name):
         """
         return database.Database(self, name)
 
-    def close_cursor(self, cursor_id, address=None):
-        """DEPRECATED - Send a kill cursors message soon with the given id.
-
-        Raises :class:`TypeError` if `cursor_id` is not an instance of
-        ``(int, long)``.
-
-        This method may be called from a :class:`~pymongo.cursor.Cursor`
-        destructor during garbage collection, so it isn't safe to take a
-        lock or do network I/O. Instead, we schedule the cursor to be closed
-        soon on a background thread.
-
-        :Parameters:
-          - `cursor_id`: id of cursor to close
-          - `address` (optional): (host, port) pair of the cursor's server.
-            If it is not provided, the client attempts to close the cursor on
-            the primary or standalone, or a mongos server.
-
-        .. versionchanged:: 3.7
-           Deprecated.
-
-        .. versionchanged:: 3.0
-           Added ``address`` parameter.
-        """
-        warnings.warn(
-            "close_cursor is deprecated.",
-            DeprecationWarning,
-            stacklevel=2)
-        if not isinstance(cursor_id, integer_types):
-            raise TypeError("cursor_id must be an instance of (int, long)")
-
-        self._close_cursor(cursor_id, address)
-
     def _close_cursor(self, cursor_id, address):
         """Send a kill cursors message with the given id.
 
@@ -1607,37 +1575,6 @@ def _close_cursor_now(self, cursor_id, address=None, session=None):
             # Make another attempt to kill the cursor later.
             self.__kill_cursors_queue.append((address, [cursor_id]))
 
-    def kill_cursors(self, cursor_ids, address=None):
-        """DEPRECATED - Send a kill cursors message soon with the given ids.
-
-        Raises :class:`TypeError` if `cursor_ids` is not an instance of
-        ``list``.
-
-        :Parameters:
-          - `cursor_ids`: list of cursor ids to kill
-          - `address` (optional): (host, port) pair of the cursor's server.
-            If it is not provided, the client attempts to close the cursor on
-            the primary or standalone, or a mongos server.
-
-        .. versionchanged:: 3.3
-           Deprecated.
-
-        .. versionchanged:: 3.0
-           Now accepts an `address` argument. Schedules the cursors to be
-           closed on a background thread instead of sending the message
-           immediately.
-        """
-        warnings.warn(
-            "kill_cursors is deprecated.",
-            DeprecationWarning,
-            stacklevel=2)
-
-        if not isinstance(cursor_ids, list):
-            raise TypeError("cursor_ids must be a list")
-
-        # "Atomic", needs no lock.
-        self.__kill_cursors_queue.append((address, cursor_ids))
-
     def _kill_cursors(self, cursor_ids, address, topology, session):
         """Send a kill cursors message with the given ids."""
         listeners = self._event_listeners

test/test_legacy_api.py

@@ -1366,63 +1366,6 @@ def run(self):
         self.assertEqual(10001, coll.count())
         coll.drop()
 
-    def test_kill_cursors_with_cursoraddress(self):
-        coll = self.client.pymongo_test.test
-        coll.drop()
-
-        coll.insert_many([{'_id': i} for i in range(200)])
-        cursor = coll.find().batch_size(1)
-        next(cursor)
-        self.client.kill_cursors(
-            [cursor.cursor_id],
-            _CursorAddress(self.client.address, coll.full_name))
-
-        # Prevent killcursors from reaching the server while a getmore is in
-        # progress -- the server logs "Assertion: 16089:Cannot kill active
-        # cursor."
-        time.sleep(2)
-
-        def raises_cursor_not_found():
-            try:
-                next(cursor)
-                return False
-            except CursorNotFound:
-                return True
-
-        wait_until(raises_cursor_not_found, 'close cursor')
-
-    def test_kill_cursors_with_tuple(self):
-        # Some evergreen distros (Debian 7.1) still test against 3.6.5 where
-        # OP_KILL_CURSORS does not work.
-        if (client_context.is_mongos and client_context.auth_enabled and
-                (3, 6, 0) <= client_context.version < (3, 6, 6)):
-            raise SkipTest("SERVER-33553 This server version does not support "
-                           "OP_KILL_CURSORS")
-
-        coll = self.client.pymongo_test.test
-        coll.drop()
-
-        coll.insert_many([{'_id': i} for i in range(200)])
-        cursor = coll.find().batch_size(1)
-        next(cursor)
-        self.client.kill_cursors(
-            [cursor.cursor_id],
-            self.client.address)
-
-        # Prevent killcursors from reaching the server while a getmore is in
-        # progress -- the server logs "Assertion: 16089:Cannot kill active
-        # cursor."
-        time.sleep(2)
-
-        def raises_cursor_not_found():
-            try:
-                next(cursor)
-                return False
-            except CursorNotFound:
-                return True
-
-        wait_until(raises_cursor_not_found, 'close cursor')
-
 
 class TestLegacyBulk(BulkTestBase):