test: add mypy test scenario (#476)

crwilcox · web-flow · commit 18b8277cce90 · 2021-10-14T14:41:33.000-07:00
* test: add mypy test scenario

* chore: remove ignore type from api_core imports
diff --git a/packages/google-cloud-firestore/google/cloud/firestore_v1/_helpers.py b/packages/google-cloud-firestore/google/cloud/firestore_v1/_helpers.py
@@ -18,8 +18,8 @@
 import json
 
 import google
-from google.api_core.datetime_helpers import DatetimeWithNanoseconds  # type: ignore
-from google.api_core import gapic_v1  # type: ignore
+from google.api_core.datetime_helpers import DatetimeWithNanoseconds
+from google.api_core import gapic_v1
 from google.protobuf import struct_pb2
 from google.type import latlng_pb2  # type: ignore
 import grpc  # type: ignore
diff --git a/packages/google-cloud-firestore/google/cloud/firestore_v1/async_batch.py b/packages/google-cloud-firestore/google/cloud/firestore_v1/async_batch.py
@@ -15,8 +15,8 @@
 """Helpers for batch requests to the Google Cloud Firestore API."""
 
 
-from google.api_core import gapic_v1  # type: ignore
-from google.api_core import retry as retries  # type: ignore
+from google.api_core import gapic_v1
+from google.api_core import retry as retries
 
 from google.cloud.firestore_v1.base_batch import BaseWriteBatch
 
diff --git a/packages/google-cloud-firestore/google/cloud/firestore_v1/async_client.py b/packages/google-cloud-firestore/google/cloud/firestore_v1/async_client.py
@@ -24,8 +24,8 @@
   :class:`~google.cloud.firestore_v1.async_document.AsyncDocumentReference`
 """
 
-from google.api_core import gapic_v1  # type: ignore
-from google.api_core import retry as retries  # type: ignore
+from google.api_core import gapic_v1
+from google.api_core import retry as retries
 
 from google.cloud.firestore_v1.base_client import (
     BaseClient,
diff --git a/packages/google-cloud-firestore/google/cloud/firestore_v1/async_collection.py b/packages/google-cloud-firestore/google/cloud/firestore_v1/async_collection.py
@@ -14,8 +14,8 @@
 
 """Classes for representing collections for the Google Cloud Firestore API."""
 
-from google.api_core import gapic_v1  # type: ignore
-from google.api_core import retry as retries  # type: ignore
+from google.api_core import gapic_v1
+from google.api_core import retry as retries
 
 from google.cloud.firestore_v1.base_collection import (
     BaseCollectionReference,
diff --git a/packages/google-cloud-firestore/google/cloud/firestore_v1/async_document.py b/packages/google-cloud-firestore/google/cloud/firestore_v1/async_document.py
@@ -16,8 +16,8 @@
 import datetime
 import logging
 
-from google.api_core import gapic_v1  # type: ignore
-from google.api_core import retry as retries  # type: ignore
+from google.api_core import gapic_v1
+from google.api_core import retry as retries
 from google.cloud._helpers import _datetime_to_pb_timestamp  # type: ignore
 
 from google.cloud.firestore_v1.base_document import (
diff --git a/packages/google-cloud-firestore/google/cloud/firestore_v1/async_query.py b/packages/google-cloud-firestore/google/cloud/firestore_v1/async_query.py
@@ -19,8 +19,8 @@
 a more common way to create a query than direct usage of the constructor.
 """
 
-from google.api_core import gapic_v1  # type: ignore
-from google.api_core import retry as retries  # type: ignore
+from google.api_core import gapic_v1
+from google.api_core import retry as retries
 
 from google.cloud import firestore_v1
 from google.cloud.firestore_v1.base_query import (
diff --git a/packages/google-cloud-firestore/google/cloud/firestore_v1/async_transaction.py b/packages/google-cloud-firestore/google/cloud/firestore_v1/async_transaction.py
@@ -18,8 +18,8 @@
 import asyncio
 import random
 
-from google.api_core import gapic_v1  # type: ignore
-from google.api_core import retry as retries  # type: ignore
+from google.api_core import gapic_v1
+from google.api_core import retry as retries
 
 from google.cloud.firestore_v1.base_transaction import (
     _BaseTransactional,
@@ -35,7 +35,7 @@
     _EXCEED_ATTEMPTS_TEMPLATE,
 )
 
-from google.api_core import exceptions  # type: ignore
+from google.api_core import exceptions
 from google.cloud.firestore_v1 import async_batch
 from google.cloud.firestore_v1 import _helpers
 from google.cloud.firestore_v1 import types
diff --git a/packages/google-cloud-firestore/google/cloud/firestore_v1/base_batch.py b/packages/google-cloud-firestore/google/cloud/firestore_v1/base_batch.py
@@ -18,7 +18,7 @@
 from typing import Dict, Union
 
 # Types needed only for Type Hints
-from google.api_core import retry as retries  # type: ignore
+from google.api_core import retry as retries
 from google.cloud.firestore_v1 import _helpers
 from google.cloud.firestore_v1.base_document import BaseDocumentReference
 
diff --git a/packages/google-cloud-firestore/google/cloud/firestore_v1/base_client.py b/packages/google-cloud-firestore/google/cloud/firestore_v1/base_client.py
@@ -28,10 +28,10 @@
 import grpc  # type: ignore
 
 from google.auth.credentials import AnonymousCredentials
-import google.api_core.client_options  # type: ignore
-import google.api_core.path_template  # type: ignore
-from google.api_core import retry as retries  # type: ignore
-from google.api_core.gapic_v1 import client_info  # type: ignore
+import google.api_core.client_options
+import google.api_core.path_template
+from google.api_core import retry as retries
+from google.api_core.gapic_v1 import client_info
 from google.cloud.client import ClientWithProject  # type: ignore
 
 from google.cloud.firestore_v1 import _helpers
@@ -141,7 +141,7 @@ def __init__(
         self._client_info = client_info
         if client_options:
             if type(client_options) == dict:
-                client_options = google.api_core.client_options.from_dict(  # type: ignore
+                client_options = google.api_core.client_options.from_dict(
                     client_options
                 )
         self._client_options = client_options
@@ -232,7 +232,7 @@ def _database_string(self):
             project. (The default database is also in this string.)
         """
         if self._database_string_internal is None:
-            db_str = google.api_core.path_template.expand(  # type: ignore
+            db_str = google.api_core.path_template.expand(
                 "projects/{project}/databases/{database}",
                 project=self.project,
                 database=self._database,
diff --git a/packages/google-cloud-firestore/google/cloud/firestore_v1/base_collection.py b/packages/google-cloud-firestore/google/cloud/firestore_v1/base_collection.py
@@ -16,7 +16,7 @@
 import random
 import sys
 
-from google.api_core import retry as retries  # type: ignore
+from google.api_core import retry as retries
 
 from google.cloud.firestore_v1 import _helpers
 from google.cloud.firestore_v1.document import DocumentReference
diff --git a/packages/google-cloud-firestore/google/cloud/firestore_v1/base_document.py b/packages/google-cloud-firestore/google/cloud/firestore_v1/base_document.py
@@ -16,7 +16,7 @@
 
 import copy
 
-from google.api_core import retry as retries  # type: ignore
+from google.api_core import retry as retries
 
 from google.cloud.firestore_v1.types import Document
 from google.cloud.firestore_v1 import _helpers
diff --git a/packages/google-cloud-firestore/google/cloud/firestore_v1/base_query.py b/packages/google-cloud-firestore/google/cloud/firestore_v1/base_query.py
@@ -21,7 +21,7 @@
 import copy
 import math
 
-from google.api_core import retry as retries  # type: ignore
+from google.api_core import retry as retries
 from google.protobuf import wrappers_pb2
 
 from google.cloud.firestore_v1 import _helpers
diff --git a/packages/google-cloud-firestore/google/cloud/firestore_v1/base_transaction.py b/packages/google-cloud-firestore/google/cloud/firestore_v1/base_transaction.py
@@ -14,7 +14,7 @@
 
 """Helpers for applying Google Cloud Firestore changes in a transaction."""
 
-from google.api_core import retry as retries  # type: ignore
+from google.api_core import retry as retries
 
 from google.cloud.firestore_v1 import types
 from typing import Any, Coroutine, NoReturn, Optional, Union
diff --git a/packages/google-cloud-firestore/google/cloud/firestore_v1/batch.py b/packages/google-cloud-firestore/google/cloud/firestore_v1/batch.py
@@ -14,8 +14,8 @@
 
 """Helpers for batch requests to the Google Cloud Firestore API."""
 
-from google.api_core import gapic_v1  # type: ignore
-from google.api_core import retry as retries  # type: ignore
+from google.api_core import gapic_v1
+from google.api_core import retry as retries
 
 from google.cloud.firestore_v1.base_batch import BaseWriteBatch
 
diff --git a/packages/google-cloud-firestore/google/cloud/firestore_v1/bulk_batch.py b/packages/google-cloud-firestore/google/cloud/firestore_v1/bulk_batch.py
@@ -13,8 +13,8 @@
 # limitations under the License.
 
 """Helpers for batch requests to the Google Cloud Firestore API."""
-from google.api_core import gapic_v1  # type: ignore
-from google.api_core import retry as retries  # type: ignore
+from google.api_core import gapic_v1
+from google.api_core import retry as retries
 
 from google.cloud.firestore_v1 import _helpers
 from google.cloud.firestore_v1.base_batch import BaseBatch
diff --git a/packages/google-cloud-firestore/google/cloud/firestore_v1/client.py b/packages/google-cloud-firestore/google/cloud/firestore_v1/client.py
@@ -24,8 +24,8 @@
   :class:`~google.cloud.firestore_v1.document.DocumentReference`
 """
 
-from google.api_core import gapic_v1  # type: ignore
-from google.api_core import retry as retries  # type: ignore
+from google.api_core import gapic_v1
+from google.api_core import retry as retries
 
 from google.cloud.firestore_v1.base_client import (
     BaseClient,
diff --git a/packages/google-cloud-firestore/google/cloud/firestore_v1/collection.py b/packages/google-cloud-firestore/google/cloud/firestore_v1/collection.py
@@ -14,8 +14,8 @@
 
 """Classes for representing collections for the Google Cloud Firestore API."""
 
-from google.api_core import gapic_v1  # type: ignore
-from google.api_core import retry as retries  # type: ignore
+from google.api_core import gapic_v1
+from google.api_core import retry as retries
 
 from google.cloud.firestore_v1.base_collection import (
     BaseCollectionReference,
diff --git a/packages/google-cloud-firestore/google/cloud/firestore_v1/document.py b/packages/google-cloud-firestore/google/cloud/firestore_v1/document.py
@@ -16,8 +16,8 @@
 import datetime
 import logging
 
-from google.api_core import gapic_v1  # type: ignore
-from google.api_core import retry as retries  # type: ignore
+from google.api_core import gapic_v1
+from google.api_core import retry as retries
 from google.cloud._helpers import _datetime_to_pb_timestamp  # type: ignore
 
 from google.cloud.firestore_v1.base_document import (
diff --git a/packages/google-cloud-firestore/google/cloud/firestore_v1/query.py b/packages/google-cloud-firestore/google/cloud/firestore_v1/query.py
@@ -20,9 +20,9 @@
 """
 from google.cloud import firestore_v1
 from google.cloud.firestore_v1.base_document import DocumentSnapshot
-from google.api_core import exceptions  # type: ignore
-from google.api_core import gapic_v1  # type: ignore
-from google.api_core import retry as retries  # type: ignore
+from google.api_core import exceptions
+from google.api_core import gapic_v1
+from google.api_core import retry as retries
 
 from google.cloud.firestore_v1.base_query import (
     BaseCollectionGroup,
diff --git a/packages/google-cloud-firestore/google/cloud/firestore_v1/transaction.py b/packages/google-cloud-firestore/google/cloud/firestore_v1/transaction.py
@@ -18,8 +18,8 @@
 import random
 import time
 
-from google.api_core import gapic_v1  # type: ignore
-from google.api_core import retry as retries  # type: ignore
+from google.api_core import gapic_v1
+from google.api_core import retry as retries
 
 from google.cloud.firestore_v1.base_transaction import (
     _BaseTransactional,
@@ -35,7 +35,7 @@
     _EXCEED_ATTEMPTS_TEMPLATE,
 )
 
-from google.api_core import exceptions  # type: ignore
+from google.api_core import exceptions
 from google.cloud.firestore_v1 import batch
 from google.cloud.firestore_v1.document import DocumentReference
 from google.cloud.firestore_v1 import _helpers
diff --git a/packages/google-cloud-firestore/google/cloud/firestore_v1/watch.py b/packages/google-cloud-firestore/google/cloud/firestore_v1/watch.py
@@ -18,12 +18,12 @@
 from enum import Enum
 import functools
 
-from google.api_core.bidi import ResumableBidiRpc  # type: ignore
-from google.api_core.bidi import BackgroundConsumer  # type: ignore
+from google.api_core.bidi import ResumableBidiRpc
+from google.api_core.bidi import BackgroundConsumer
 from google.cloud.firestore_v1.types import firestore
 from google.cloud.firestore_v1 import _helpers
 
-from google.api_core import exceptions  # type: ignore
+from google.api_core import exceptions
 
 import grpc  # type: ignore
 
diff --git a/packages/google-cloud-firestore/noxfile.py b/packages/google-cloud-firestore/noxfile.py
@@ -39,6 +39,7 @@
     "unit",
     "system_emulated",
     "system",
+    "mypy",
     "cover",
     "lint",
     "lint_setup_py",
@@ -81,6 +82,15 @@ def pytype(session):
     session.run("pytype",)
 
 
+@nox.session(python=DEFAULT_PYTHON_VERSION)
+def mypy(session):
+    """Verify type hints are mypy compatible."""
+    session.install("-e", ".")
+    session.install("mypy", "types-setuptools")
+    # TODO: also verify types on tests, all of google package
+    session.run("mypy", "-p", "google.cloud.firestore", "--no-incremental")
+
+
 @nox.session(python=DEFAULT_PYTHON_VERSION)
 def lint_setup_py(session):
     """Verify that setup.py is valid (including RST check)."""
diff --git a/packages/google-cloud-firestore/owlbot.py b/packages/google-cloud-firestore/owlbot.py
@@ -210,15 +210,16 @@ def system_emulated(session):
     escape="()"
 )
 
-# add system_emulated nox session
+# add system_emulated + mypy nox session
 s.replace("noxfile.py",
     """nox.options.sessions = \[
     "unit",
     "system",""",
     """nox.options.sessions = [
     "unit",
     "system_emulated",
-    "system",""",
+    "system",
+    "mypy",""",
 )
 
 s.replace(
@@ -295,10 +296,20 @@ def lint_setup_py\(session\):
     '''\
 @nox.session(python="3.7")
 def pytype(session):
-    """Run pytype
-    """
+    """Verify type hints are pytype compatible."""
     session.install(PYTYPE_VERSION)
     session.run("pytype",)
+
+
+@nox.session(python=DEFAULT_PYTHON_VERSION)
+def mypy(session):
+    """Verify type hints are mypy compatible."""
+    session.install("-e", ".")
+    session.install("mypy", "types-setuptools")
+    # TODO: also verify types on tests, all of google package
+    session.run("mypy", "-p", "google.cloud.firestore", "--no-incremental")
+
+
 @nox.session(python=DEFAULT_PYTHON_VERSION)
 def lint_setup_py(session):
 ''',
