PYTHON-3737 Use __future__ annotations for forward reference type hin…

…ts (#1234)
mongodb · Jun 15, 2023 · 601d1ec · 601d1ec
1 parent 2cfebf5
commit 601d1ec
Show file tree

Hide file tree

Showing 10 changed files with 101 additions and 87 deletions.
diff --git a/pymongo/change_stream.py b/pymongo/change_stream.py
@@ -13,6 +13,7 @@
 # permissions and limitations under the License.
 
 """Watch changes on a collection, a database, or the entire cluster."""
+from __future__ import annotations
 
 import copy
 from typing import TYPE_CHECKING, Any, Dict, Generic, Mapping, Optional, Union
@@ -96,7 +97,7 @@ class ChangeStream(Generic[_DocumentType]):
     def __init__(
         self,
         target: Union[
-            "MongoClient[_DocumentType]", "Database[_DocumentType]", "Collection[_DocumentType]"
+            MongoClient[_DocumentType], Database[_DocumentType], Collection[_DocumentType]
         ],
         pipeline: Optional[_Pipeline],
         full_document: Optional[str],
@@ -105,7 +106,7 @@ def __init__(
         batch_size: Optional[int],
         collation: Optional[_CollationIn],
         start_at_operation_time: Optional[Timestamp],
-        session: Optional["ClientSession"],
+        session: Optional[ClientSession],
         start_after: Optional[Mapping[str, Any]],
         comment: Optional[Any] = None,
         full_document_before_change: Optional[str] = None,

diff --git a/pymongo/client_session.py b/pymongo/client_session.py
@@ -133,6 +133,8 @@
 =======
 """
 
+from __future__ import annotations
+
 import collections
 import time
 import uuid
@@ -478,7 +480,7 @@ class ClientSession:
 
     def __init__(
         self,
-        client: "MongoClient",
+        client: MongoClient,
         server_session: Any,
         options: SessionOptions,
         implicit: bool,
@@ -524,7 +526,7 @@ def __exit__(self, exc_type: Any, exc_val: Any, exc_tb: Any) -> None:
         self._end_session(lock=True)
 
     @property
-    def client(self) -> "MongoClient":
+    def client(self) -> MongoClient:
         """The :class:`~pymongo.mongo_client.MongoClient` this session was
         created from.
         """

diff --git a/pymongo/collection.py b/pymongo/collection.py
@@ -13,6 +13,7 @@
 # limitations under the License.
 
 """Collection level utilities for Mongo."""
+from __future__ import annotations
 
 from collections import abc
 from typing import (
@@ -114,14 +115,14 @@ class Collection(common.BaseObject, Generic[_DocumentType]):
 
     def __init__(
         self,
-        database: "Database[_DocumentType]",
+        database: Database[_DocumentType],
         name: str,
         create: Optional[bool] = False,
-        codec_options: Optional["CodecOptions[_DocumentTypeArg]"] = None,
+        codec_options: Optional[CodecOptions[_DocumentTypeArg]] = None,
         read_preference: Optional[_ServerMode] = None,
         write_concern: Optional[WriteConcern] = None,
-        read_concern: Optional["ReadConcern"] = None,
-        session: Optional["ClientSession"] = None,
+        read_concern: Optional[ReadConcern] = None,
+        session: Optional[ClientSession] = None,
         **kwargs: Any,
     ) -> None:
         """Get / create a Mongo collection.
@@ -335,7 +336,7 @@ def __create(
                 session=session,
             )
 
-    def __getattr__(self, name: str) -> "Collection[_DocumentType]":
+    def __getattr__(self, name: str) -> Collection[_DocumentType]:
         """Get a sub-collection of this collection by name.
 
         Raises InvalidName if an invalid collection name is used.
@@ -351,7 +352,7 @@ def __getattr__(self, name: str) -> "Collection[_DocumentType]":
             )
         return self.__getitem__(name)
 
-    def __getitem__(self, name: str) -> "Collection[_DocumentType]":
+    def __getitem__(self, name: str) -> Collection[_DocumentType]:
         return Collection(
             self.__database,
             f"{self.__name}.{name}",
@@ -397,19 +398,19 @@ def name(self) -> str:
         return self.__name
 
     @property
-    def database(self) -> "Database[_DocumentType]":
+    def database(self) -> Database[_DocumentType]:
         """The :class:`~pymongo.database.Database` that this
         :class:`Collection` is a part of.
         """
         return self.__database
 
     def with_options(
         self,
-        codec_options: Optional["bson.CodecOptions[_DocumentTypeArg]"] = None,
+        codec_options: Optional[bson.CodecOptions[_DocumentTypeArg]] = None,
         read_preference: Optional[_ServerMode] = None,
         write_concern: Optional[WriteConcern] = None,
-        read_concern: Optional["ReadConcern"] = None,
-    ) -> "Collection[_DocumentType]":
+        read_concern: Optional[ReadConcern] = None,
+    ) -> Collection[_DocumentType]:
         """Get a clone of this collection changing the specified settings.
 
           >>> coll1.read_preference
@@ -455,7 +456,7 @@ def bulk_write(
         requests: Sequence[_WriteOp[_DocumentType]],
         ordered: bool = True,
         bypass_document_validation: bool = False,
-        session: Optional["ClientSession"] = None,
+        session: Optional[ClientSession] = None,
         comment: Optional[Any] = None,
         let: Optional[Mapping] = None,
     ) -> BulkWriteResult:
@@ -585,7 +586,7 @@ def insert_one(
         self,
         document: Union[_DocumentType, RawBSONDocument],
         bypass_document_validation: bool = False,
-        session: Optional["ClientSession"] = None,
+        session: Optional[ClientSession] = None,
         comment: Optional[Any] = None,
     ) -> InsertOneResult:
         """Insert a single document.
@@ -653,7 +654,7 @@ def insert_many(
         documents: Iterable[Union[_DocumentType, RawBSONDocument]],
         ordered: bool = True,
         bypass_document_validation: bool = False,
-        session: Optional["ClientSession"] = None,
+        session: Optional[ClientSession] = None,
         comment: Optional[Any] = None,
     ) -> InsertManyResult:
         """Insert an iterable of documents.
@@ -855,7 +856,7 @@ def replace_one(
         bypass_document_validation: bool = False,
         collation: Optional[_CollationIn] = None,
         hint: Optional[_IndexKeyHint] = None,
-        session: Optional["ClientSession"] = None,
+        session: Optional[ClientSession] = None,
         let: Optional[Mapping[str, Any]] = None,
         comment: Optional[Any] = None,
     ) -> UpdateResult:
@@ -959,7 +960,7 @@ def update_one(
         collation: Optional[_CollationIn] = None,
         array_filters: Optional[Sequence[Mapping[str, Any]]] = None,
         hint: Optional[_IndexKeyHint] = None,
-        session: Optional["ClientSession"] = None,
+        session: Optional[ClientSession] = None,
         let: Optional[Mapping[str, Any]] = None,
         comment: Optional[Any] = None,
     ) -> UpdateResult:
@@ -1073,7 +1074,7 @@ def update_many(
         bypass_document_validation: Optional[bool] = None,
         collation: Optional[_CollationIn] = None,
         hint: Optional[_IndexKeyHint] = None,
-        session: Optional["ClientSession"] = None,
+        session: Optional[ClientSession] = None,
         let: Optional[Mapping[str, Any]] = None,
         comment: Optional[Any] = None,
     ) -> UpdateResult:
@@ -1168,7 +1169,7 @@ def update_many(
 
     def drop(
         self,
-        session: Optional["ClientSession"] = None,
+        session: Optional[ClientSession] = None,
         comment: Optional[Any] = None,
         encrypted_fields: Optional[Mapping[str, Any]] = None,
     ) -> None:
@@ -1306,7 +1307,7 @@ def delete_one(
         filter: Mapping[str, Any],
         collation: Optional[_CollationIn] = None,
         hint: Optional[_IndexKeyHint] = None,
-        session: Optional["ClientSession"] = None,
+        session: Optional[ClientSession] = None,
         let: Optional[Mapping[str, Any]] = None,
         comment: Optional[Any] = None,
     ) -> DeleteResult:
@@ -1373,7 +1374,7 @@ def delete_many(
         filter: Mapping[str, Any],
         collation: Optional[_CollationIn] = None,
         hint: Optional[_IndexKeyHint] = None,
-        session: Optional["ClientSession"] = None,
+        session: Optional[ClientSession] = None,
         let: Optional[Mapping[str, Any]] = None,
         comment: Optional[Any] = None,
     ) -> DeleteResult:
@@ -1769,7 +1770,7 @@ def _cmd(session, server, sock_info, read_preference):
     def count_documents(
         self,
         filter: Mapping[str, Any],
-        session: Optional["ClientSession"] = None,
+        session: Optional[ClientSession] = None,
         comment: Optional[Any] = None,
         **kwargs: Any,
     ) -> int:
@@ -1860,7 +1861,7 @@ def _retryable_non_cursor_read(self, func, session):
     def create_indexes(
         self,
         indexes: Sequence[IndexModel],
-        session: Optional["ClientSession"] = None,
+        session: Optional[ClientSession] = None,
         comment: Optional[Any] = None,
         **kwargs: Any,
     ) -> List[str]:
@@ -1952,7 +1953,7 @@ def gen_indexes():
     def create_index(
         self,
         keys: _IndexKeyHint,
-        session: Optional["ClientSession"] = None,
+        session: Optional[ClientSession] = None,
         comment: Optional[Any] = None,
         **kwargs: Any,
     ) -> str:
@@ -2071,7 +2072,7 @@ def create_index(
 
     def drop_indexes(
         self,
-        session: Optional["ClientSession"] = None,
+        session: Optional[ClientSession] = None,
         comment: Optional[Any] = None,
         **kwargs: Any,
     ) -> None:
@@ -2107,7 +2108,7 @@ def drop_indexes(
     def drop_index(
         self,
         index_or_name: _IndexKeyHint,
-        session: Optional["ClientSession"] = None,
+        session: Optional[ClientSession] = None,
         comment: Optional[Any] = None,
         **kwargs: Any,
     ) -> None:
@@ -2174,7 +2175,7 @@ def drop_index(
 
     def list_indexes(
         self,
-        session: Optional["ClientSession"] = None,
+        session: Optional[ClientSession] = None,
         comment: Optional[Any] = None,
     ) -> CommandCursor[MutableMapping[str, Any]]:
         """Get a cursor over the index documents for this collection.
@@ -2239,7 +2240,7 @@ def _cmd(session, server, sock_info, read_preference):
 
     def index_information(
         self,
-        session: Optional["ClientSession"] = None,
+        session: Optional[ClientSession] = None,
         comment: Optional[Any] = None,
     ) -> MutableMapping[str, Any]:
         """Get information on this collection's indexes.
@@ -2282,7 +2283,7 @@ def index_information(
 
     def options(
         self,
-        session: Optional["ClientSession"] = None,
+        session: Optional[ClientSession] = None,
         comment: Optional[Any] = None,
     ) -> MutableMapping[str, Any]:
         """Get the options set on this collection.
@@ -2361,7 +2362,7 @@ def _aggregate(
     def aggregate(
         self,
         pipeline: _Pipeline,
-        session: Optional["ClientSession"] = None,
+        session: Optional[ClientSession] = None,
         let: Optional[Mapping[str, Any]] = None,
         comment: Optional[Any] = None,
         **kwargs: Any,
@@ -2458,7 +2459,7 @@ def aggregate(
     def aggregate_raw_batches(
         self,
         pipeline: _Pipeline,
-        session: Optional["ClientSession"] = None,
+        session: Optional[ClientSession] = None,
         comment: Optional[Any] = None,
         **kwargs: Any,
     ) -> RawBatchCursor[_DocumentType]:
@@ -2509,7 +2510,7 @@ def watch(
         batch_size: Optional[int] = None,
         collation: Optional[_CollationIn] = None,
         start_at_operation_time: Optional[Timestamp] = None,
-        session: Optional["ClientSession"] = None,
+        session: Optional[ClientSession] = None,
         start_after: Optional[Mapping[str, Any]] = None,
         comment: Optional[Any] = None,
         full_document_before_change: Optional[str] = None,
@@ -2644,7 +2645,7 @@ def watch(
     def rename(
         self,
         new_name: str,
-        session: Optional["ClientSession"] = None,
+        session: Optional[ClientSession] = None,
         comment: Optional[Any] = None,
         **kwargs: Any,
     ) -> MutableMapping[str, Any]:
@@ -2709,7 +2710,7 @@ def distinct(
         self,
         key: str,
         filter: Optional[Mapping[str, Any]] = None,
-        session: Optional["ClientSession"] = None,
+        session: Optional[ClientSession] = None,
         comment: Optional[Any] = None,
         **kwargs: Any,
     ) -> List:
@@ -2860,7 +2861,7 @@ def find_one_and_delete(
         projection: Optional[Union[Mapping[str, Any], Iterable[str]]] = None,
         sort: Optional[_IndexList] = None,
         hint: Optional[_IndexKeyHint] = None,
-        session: Optional["ClientSession"] = None,
+        session: Optional[ClientSession] = None,
         let: Optional[Mapping[str, Any]] = None,
         comment: Optional[Any] = None,
         **kwargs: Any,
@@ -2953,7 +2954,7 @@ def find_one_and_replace(
         upsert: bool = False,
         return_document: bool = ReturnDocument.BEFORE,
         hint: Optional[_IndexKeyHint] = None,
-        session: Optional["ClientSession"] = None,
+        session: Optional[ClientSession] = None,
         let: Optional[Mapping[str, Any]] = None,
         comment: Optional[Any] = None,
         **kwargs: Any,
@@ -3062,7 +3063,7 @@ def find_one_and_update(
         return_document: bool = ReturnDocument.BEFORE,
         array_filters: Optional[Sequence[Mapping[str, Any]]] = None,
         hint: Optional[_IndexKeyHint] = None,
-        session: Optional["ClientSession"] = None,
+        session: Optional[ClientSession] = None,
         let: Optional[Mapping[str, Any]] = None,
         comment: Optional[Any] = None,
         **kwargs: Any,

diff --git a/pymongo/command_cursor.py b/pymongo/command_cursor.py
@@ -13,6 +13,7 @@
 # limitations under the License.
 
 """CommandCursor class to iterate over command results."""
+from __future__ import annotations
 
 from collections import deque
 from typing import TYPE_CHECKING, Any, Generic, Iterator, Mapping, NoReturn, Optional
@@ -36,12 +37,12 @@ class CommandCursor(Generic[_DocumentType]):
 
     def __init__(
         self,
-        collection: "Collection[_DocumentType]",
+        collection: Collection[_DocumentType],
         cursor_info: Mapping[str, Any],
         address: Optional[_Address],
         batch_size: int = 0,
         max_await_time_ms: Optional[int] = None,
-        session: Optional["ClientSession"] = None,
+        session: Optional[ClientSession] = None,
         explicit_session: bool = False,
         comment: Any = None,
     ) -> None:
@@ -267,7 +268,7 @@ def address(self) -> Optional[_Address]:
         return self.__address
 
     @property
-    def session(self) -> Optional["ClientSession"]:
+    def session(self) -> Optional[ClientSession]:
         """The cursor's :class:`~pymongo.client_session.ClientSession`, or None.
 
         .. versionadded:: 3.6
@@ -312,12 +313,12 @@ class RawBatchCommandCursor(CommandCursor, Generic[_DocumentType]):
 
     def __init__(
         self,
-        collection: "Collection[_DocumentType]",
+        collection: Collection[_DocumentType],
         cursor_info: Mapping[str, Any],
         address: Optional[_Address],
         batch_size: int = 0,
         max_await_time_ms: Optional[int] = None,
-        session: Optional["ClientSession"] = None,
+        session: Optional[ClientSession] = None,
         explicit_session: bool = False,
         comment: Any = None,
     ) -> None: