PYTHON-3052 Add Typings to PyMongo Itself (mongodb#829)

Author: blink1073

.github/workflows/test-python.yml

@@ -26,3 +26,24 @@ jobs:
       - name: Run tests
         run: |
           python setup.py test
+
+  mypytest:
+    name: Run mypy
+    runs-on: ubuntu-latest
+    strategy:
+      matrix:
+        python-version: ['3.7', '3.10']
+      fail-fast: false
+    steps:
+      - uses: actions/checkout@v2
+      - name: Set up Python ${{ matrix.python-version }}
+        uses: actions/setup-python@v2
+        with:
+          python-version: ${{ matrix.python-version }}
+      - name: Install dependencies
+        run: |
+          python -m pip install -U pip mypy
+          pip install -e ".[zstd, srv]"
+      - name: Run mypy
+        run: |
+          mypy --install-types --non-interactive bson gridfs tools

bson/__init__.py

@@ -15,22 +15,23 @@
 """Setstate and getstate functions for objects with __slots__, allowing
     compatibility with default pickling protocol
 """
+from typing import Any, Mapping
 
 
-def _setstate_slots(self, state):
+def _setstate_slots(self: Any, state: Any) -> None:
     for slot, value in state.items():
         setattr(self, slot, value)
 
 
-def _mangle_name(name, prefix):
+def _mangle_name(name: str, prefix: str) -> str:
     if name.startswith("__"):
         prefix = "_"+prefix
     else:
         prefix = ""
     return prefix + name
 
 
-def _getstate_slots(self):
+def _getstate_slots(self: Any) -> Mapping[Any, Any]:
     prefix = self.__class__.__name__
     ret = dict()
     for name in self.__slots__:

bson/_helpers.py

@@ -12,8 +12,8 @@
 # See the License for the specific language governing permissions and
 # limitations under the License.
 
+from typing import Any, Tuple, Type
 from uuid import UUID
-from warnings import warn
 
 """Tools for representing BSON binary data.
 """
@@ -69,7 +69,7 @@ class UuidRepresentation:
     code. When decoding a BSON binary field with a UUID subtype, a
     :class:`~bson.binary.Binary` instance will be returned instead of a
     :class:`uuid.UUID` instance.
-    
+
     See :ref:`unspecified-representation-details` for details.
 
     .. versionadded:: 3.11
@@ -81,7 +81,7 @@ class UuidRepresentation:
     :class:`uuid.UUID` instances will automatically be encoded to
     and decoded from BSON binary, using RFC-4122 byte order with
     binary subtype :data:`UUID_SUBTYPE`.
-    
+
     See :ref:`standard-representation-details` for details.
 
     .. versionadded:: 3.11
@@ -93,7 +93,7 @@ class UuidRepresentation:
     :class:`uuid.UUID` instances will automatically be encoded to
     and decoded from BSON binary, using RFC-4122 byte order with
     binary subtype :data:`OLD_UUID_SUBTYPE`.
-    
+
     See :ref:`python-legacy-representation-details` for details.
 
     .. versionadded:: 3.11
@@ -105,7 +105,7 @@ class UuidRepresentation:
     :class:`uuid.UUID` instances will automatically be encoded to
     and decoded from BSON binary subtype :data:`OLD_UUID_SUBTYPE`,
     using the Java driver's legacy byte order.
-    
+
     See :ref:`java-legacy-representation-details` for details.
 
     .. versionadded:: 3.11
@@ -117,7 +117,7 @@ class UuidRepresentation:
     :class:`uuid.UUID` instances will automatically be encoded to
     and decoded from BSON binary subtype :data:`OLD_UUID_SUBTYPE`,
     using the C# driver's legacy byte order.
-    
+
     See :ref:`csharp-legacy-representation-details` for details.
 
     .. versionadded:: 3.11
@@ -153,11 +153,12 @@ class UuidRepresentation:
 """
 
 ALL_UUID_SUBTYPES = (OLD_UUID_SUBTYPE, UUID_SUBTYPE)
-ALL_UUID_REPRESENTATIONS = (UuidRepresentation.UNSPECIFIED,
-                            UuidRepresentation.STANDARD,
-                            UuidRepresentation.PYTHON_LEGACY,
-                            UuidRepresentation.JAVA_LEGACY,
-                            UuidRepresentation.CSHARP_LEGACY)
+ALL_UUID_REPRESENTATIONS = (
+    UuidRepresentation.UNSPECIFIED,
+    UuidRepresentation.STANDARD,
+    UuidRepresentation.PYTHON_LEGACY,
+    UuidRepresentation.JAVA_LEGACY,
+    UuidRepresentation.CSHARP_LEGACY)
 UUID_REPRESENTATION_NAMES = {
     UuidRepresentation.UNSPECIFIED: 'UuidRepresentation.UNSPECIFIED',
     UuidRepresentation.STANDARD: 'UuidRepresentation.STANDARD',
@@ -208,8 +209,9 @@ class Binary(bytes):
     """
 
     _type_marker = 5
+    __subtype: int
 
-    def __new__(cls, data, subtype=BINARY_SUBTYPE):
+    def __new__(cls: Type["Binary"], data: bytes, subtype: int = BINARY_SUBTYPE) -> "Binary":
         if not isinstance(subtype, int):
             raise TypeError("subtype must be an instance of int")
         if subtype >= 256 or subtype < 0:
@@ -220,7 +222,7 @@ def __new__(cls, data, subtype=BINARY_SUBTYPE):
         return self
 
     @classmethod
-    def from_uuid(cls, uuid, uuid_representation=UuidRepresentation.STANDARD):
+    def from_uuid(cls: Type["Binary"], uuid: UUID, uuid_representation: int = UuidRepresentation.STANDARD) -> "Binary":
         """Create a BSON Binary object from a Python UUID.
 
         Creates a :class:`~bson.binary.Binary` object from a
@@ -271,7 +273,7 @@ def from_uuid(cls, uuid, uuid_representation=UuidRepresentation.STANDARD):
 
         return cls(payload, subtype)
 
-    def as_uuid(self, uuid_representation=UuidRepresentation.STANDARD):
+    def as_uuid(self, uuid_representation: int = UuidRepresentation.STANDARD) -> UUID:
         """Create a Python UUID from this BSON Binary object.
 
         Decodes this binary object as a native :class:`uuid.UUID` instance
@@ -316,19 +318,19 @@ def as_uuid(self, uuid_representation=UuidRepresentation.STANDARD):
                 self.subtype, UUID_REPRESENTATION_NAMES[uuid_representation]))
 
     @property
-    def subtype(self):
+    def subtype(self) -> int:
         """Subtype of this binary data.
         """
         return self.__subtype
 
-    def __getnewargs__(self):
+    def __getnewargs__(self) -> Tuple[bytes, int]:  # type: ignore[override]
         # Work around http://bugs.python.org/issue7382
         data = super(Binary, self).__getnewargs__()[0]
         if not isinstance(data, bytes):
             data = data.encode('latin-1')
         return data, self.__subtype
 
-    def __eq__(self, other):
+    def __eq__(self, other : Any) -> bool:
         if isinstance(other, Binary):
             return ((self.__subtype, bytes(self)) ==
                     (other.subtype, bytes(other)))
@@ -337,10 +339,10 @@ def __eq__(self, other):
         # subclass of str...
         return False
 
-    def __hash__(self):
+    def __hash__(self) -> int:
         return super(Binary, self).__hash__() ^ hash(self.__subtype)
 
-    def __ne__(self, other):
+    def __ne__(self, other: Any) -> bool:
         return not self == other
 
     def __repr__(self):

bson/binary.py

@@ -16,6 +16,7 @@
 """
 
 from collections.abc import Mapping as _Mapping
+from typing import Any, Mapping, Optional, Type, Union
 
 
 class Code(str):
@@ -47,49 +48,50 @@ class Code(str):
     """
 
     _type_marker = 13
+    __scope: Union[Mapping[str, Any], None]
 
-    def __new__(cls, code, scope=None, **kwargs):
+    def __new__(cls: Type["Code"], code: Union[str, "Code"], scope: Optional[Mapping[str, Any]] = None, **kwargs: Any) -> "Code":
         if not isinstance(code, str):
             raise TypeError("code must be an instance of str")
 
         self = str.__new__(cls, code)
 
         try:
-            self.__scope = code.scope
+            self.__scope = code.scope  # type: ignore
         except AttributeError:
             self.__scope = None
 
         if scope is not None:
             if not isinstance(scope, _Mapping):
                 raise TypeError("scope must be an instance of dict")
             if self.__scope is not None:
-                self.__scope.update(scope)
+                self.__scope.update(scope)  # type: ignore
             else:
                 self.__scope = scope
 
         if kwargs:
             if self.__scope is not None:
-                self.__scope.update(kwargs)
+                self.__scope.update(kwargs)  # type: ignore
             else:
                 self.__scope = kwargs
 
         return self
 
     @property
-    def scope(self):
+    def scope(self) -> Optional[Mapping[str, Any]]:
         """Scope dictionary for this instance or ``None``.
         """
         return self.__scope
 
     def __repr__(self):
         return "Code(%s, %r)" % (str.__repr__(self), self.__scope)
 
-    def __eq__(self, other):
+    def __eq__(self, other: Any) -> bool:
         if isinstance(other, Code):
             return (self.__scope, str(self)) == (other.__scope, str(other))
         return False
 
-    __hash__ = None
+    __hash__: Any = None
 
-    def __ne__(self, other):
+    def __ne__(self, other: Any) -> bool:
         return not self == other