PYTHON-4654 Clean up Async API to match Motor (mongodb#1789)

Author: blink1073

doc/api/pymongo/asynchronous/mongo_client.rst

@@ -6,7 +6,7 @@
 
    .. autoclass:: pymongo.asynchronous.mongo_client.AsyncMongoClient(host='localhost', port=27017, document_class=dict, tz_aware=False, connect=True, **kwargs)
 
-      .. automethod:: aclose
+      .. automethod:: close
 
       .. describe:: c[db_name] || c.db_name
 

pymongo/asynchronous/collection.py

@@ -1893,9 +1893,7 @@ def find(self, *args: Any, **kwargs: Any) -> AsyncCursor[_DocumentType]:
         """
         return AsyncCursor(self, *args, **kwargs)
 
-    async def find_raw_batches(
-        self, *args: Any, **kwargs: Any
-    ) -> AsyncRawBatchCursor[_DocumentType]:
+    def find_raw_batches(self, *args: Any, **kwargs: Any) -> AsyncRawBatchCursor[_DocumentType]:
         """Query the database and retrieve batches of raw BSON.
 
         Similar to the :meth:`find` method but returns a
@@ -1907,7 +1905,7 @@ async def find_raw_batches(
         :mod:`bson` module.
 
           >>> import bson
-          >>> cursor = await db.test.find_raw_batches()
+          >>> cursor = db.test.find_raw_batches()
           >>> async for batch in cursor:
           ...     print(bson.decode_all(batch))
 

pymongo/asynchronous/encryption.py

@@ -299,7 +299,7 @@ async def close(self) -> None:
         self.client_ref = None
         self.key_vault_coll = None
         if self.mongocryptd_client:
-            await self.mongocryptd_client.aclose()
+            await self.mongocryptd_client.close()
             self.mongocryptd_client = None
 
 
@@ -439,7 +439,7 @@ async def close(self) -> None:
         self._closed = True
         await self._auto_encrypter.close()
         if self._internal_client:
-            await self._internal_client.aclose()
+            await self._internal_client.close()
             self._internal_client = None
 
 

pymongo/asynchronous/mongo_client.py

@@ -1378,7 +1378,7 @@ async def __aenter__(self) -> AsyncMongoClient[_DocumentType]:
         return self
 
     async def __aexit__(self, exc_type: Any, exc_val: Any, exc_tb: Any) -> None:
-        await self.aclose()
+        await self.close()
 
     # See PYTHON-3084.
     __iter__ = None
@@ -1514,7 +1514,7 @@ async def _end_sessions(self, session_ids: list[_ServerSession]) -> None:
             # command.
             pass
 
-    async def aclose(self) -> None:
+    async def close(self) -> None:
         """Cleanup client resources and disconnect from MongoDB.
 
         End all server sessions created by this client by sending one or more
@@ -1541,6 +1541,10 @@ async def aclose(self) -> None:
             # TODO: PYTHON-1921 Encrypted MongoClients cannot be re-opened.
             await self._encrypter.close()
 
+    if not _IS_SYNC:
+        # Add support for contextlib.aclosing.
+        aclose = close
+
     async def _get_topology(self) -> Topology:
         """Get the internal :class:`~pymongo.asynchronous.topology.Topology` object.
 

pymongo/synchronous/mongo_client.py

@@ -1536,6 +1536,10 @@ def close(self) -> None:
             # TODO: PYTHON-1921 Encrypted MongoClients cannot be re-opened.
             self._encrypter.close()
 
+    if not _IS_SYNC:
+        # Add support for contextlib.closing.
+        aclose = close
+
     def _get_topology(self) -> Topology:
         """Get the internal :class:`~pymongo.topology.Topology` object.
 

test/asynchronous/__init__.py

@@ -193,7 +193,7 @@ async def _connect(self, host, port, **kwargs):
             self.connection_attempts.append(f"failed to connect client {client!r}: {exc}")
             return None
         finally:
-            await client.aclose()
+            await client.close()
 
     async def _init_client(self):
         self.client = await self._connect(host, port)
@@ -409,7 +409,7 @@ async def _check_user_provided(self):
             else:
                 raise
         finally:
-            await client.aclose()
+            await client.close()
 
     def _server_started_with_auth(self):
         # MongoDB >= 2.0
@@ -1089,7 +1089,7 @@ async def async_teardown():
             await c.drop_database("pymongo_test2")
             await c.drop_database("pymongo_test_mike")
             await c.drop_database("pymongo_test_bernie")
-        await c.aclose()
+        await c.close()
 
     print_running_clients()