ci: expand mypy coverage (#476)

tseaver · web-flow · commit 51bde1e2929d · 2021-12-21T13:44:13.000-05:00
* Work around invalid generated typing for map fields See: googleapis/gapic-generator-python#689 * Restore missing namespace marker file * Get mypy running against all modules in 'google/' / 'tests/' Note we still exclude generated tests, due to broken typing emitted from the gapic-generator.
diff --git a/packages/google-cloud-bigtable/.coveragerc b/packages/google-cloud-bigtable/.coveragerc
@@ -19,6 +19,7 @@
 branch = True
 omit =
   google/cloud/__init__.py
+  google/__init__.py
 
 [report]
 fail_under = 100
diff --git a/packages/google-cloud-bigtable/google/__init__.py b/packages/google-cloud-bigtable/google/__init__.py
@@ -0,0 +1,10 @@
+from typing import List
+
+try:
+    import pkg_resources
+
+    pkg_resources.declare_namespace(__name__)
+except ImportError:
+    import pkgutil
+
+    __path__: List[str] = pkgutil.extend_path(__path__, __name__)
diff --git a/packages/google-cloud-bigtable/google/cloud/bigtable_admin_v2/services/bigtable_instance_admin/async_client.py b/packages/google-cloud-bigtable/google/cloud/bigtable_admin_v2/services/bigtable_instance_admin/async_client.py
@@ -199,9 +199,7 @@ async def create_instance(
         parent: str = None,
         instance_id: str = None,
         instance: gba_instance.Instance = None,
-        clusters: Sequence[
-            bigtable_instance_admin.CreateInstanceRequest.ClustersEntry
-        ] = None,
+        clusters: Dict[str, gba_instance.Cluster] = None,
         retry: OptionalRetry = gapic_v1.method.DEFAULT,
         timeout: float = None,
         metadata: Sequence[Tuple[str, str]] = (),
@@ -235,7 +233,7 @@ async def create_instance(
                 This corresponds to the ``instance`` field
                 on the ``request`` instance; if ``request`` is provided, this
                 should not be set.
-            clusters (:class:`Sequence[google.cloud.bigtable_admin_v2.types.CreateInstanceRequest.ClustersEntry]`):
+            clusters (Dict[str, gba_instance.Cluster]):
                 Required. The clusters to be created within the
                 instance, mapped by desired cluster ID, e.g., just
                 ``mycluster`` rather than
diff --git a/packages/google-cloud-bigtable/google/cloud/bigtable_admin_v2/services/bigtable_instance_admin/client.py b/packages/google-cloud-bigtable/google/cloud/bigtable_admin_v2/services/bigtable_instance_admin/client.py
@@ -430,9 +430,7 @@ def create_instance(
         parent: str = None,
         instance_id: str = None,
         instance: gba_instance.Instance = None,
-        clusters: Sequence[
-            bigtable_instance_admin.CreateInstanceRequest.ClustersEntry
-        ] = None,
+        clusters: Dict[str, gba_instance.Cluster] = None,
         retry: OptionalRetry = gapic_v1.method.DEFAULT,
         timeout: float = None,
         metadata: Sequence[Tuple[str, str]] = (),
@@ -466,7 +464,7 @@ def create_instance(
                 This corresponds to the ``instance`` field
                 on the ``request`` instance; if ``request`` is provided, this
                 should not be set.
-            clusters (Sequence[google.cloud.bigtable_admin_v2.types.CreateInstanceRequest.ClustersEntry]):
+            clusters (Dict[str, gba_instance.Cluster]):
                 Required. The clusters to be created within the
                 instance, mapped by desired cluster ID, e.g., just
                 ``mycluster`` rather than
diff --git a/packages/google-cloud-bigtable/mypy.ini b/packages/google-cloud-bigtable/mypy.ini
@@ -1,6 +1,28 @@
 [mypy]
 python_version = 3.6
 namespace_packages = True
+exclude = tests/unit/gapic/
 
-[mypy-google.protobuf]
+[mypy-grpc.*]
+ignore_missing_imports = True
+
+[mypy-google.auth.*]
+ignore_missing_imports = True
+
+[mypy-google.iam.*]
+ignore_missing_imports = True
+
+[mypy-google.longrunning.*]
+ignore_missing_imports = True
+
+[mypy-google.oauth2.*]
+ignore_missing_imports = True
+
+[mypy-google.rpc.*]
+ignore_missing_imports = True
+
+[mypy-proto.*]
+ignore_missing_imports = True
+
+[mypy-pytest]
 ignore_missing_imports = True
diff --git a/packages/google-cloud-bigtable/noxfile.py b/packages/google-cloud-bigtable/noxfile.py
@@ -77,9 +77,10 @@ def blacken(session):
 def mypy(session):
     """Verify type hints are mypy compatible."""
     session.install("-e", ".")
-    session.install("mypy", "types-setuptools")
+    session.install("mypy", "types-setuptools", "types-protobuf", "types-mock")
+    session.install("google-cloud-testutils")
     # TODO: also verify types on tests, all of google package
-    session.run("mypy", "-p", "google.cloud.bigtable", "--no-incremental")
+    session.run("mypy", "google/", "tests/")
 
 
 @nox.session(python=DEFAULT_PYTHON_VERSION)
diff --git a/packages/google-cloud-bigtable/owlbot.py b/packages/google-cloud-bigtable/owlbot.py
@@ -15,6 +15,7 @@
 """This script is used to synthesize generated parts of this library."""
 
 from pathlib import Path
+import re
 from typing import List, Optional
 
 import synthtool as s
@@ -165,16 +166,53 @@ def lint_setup_py\(session\):
 def mypy(session):
     """Verify type hints are mypy compatible."""
     session.install("-e", ".")
-    session.install("mypy", "types-setuptools")
+    session.install("mypy", "types-setuptools", "types-protobuf", "types-mock")
+    session.install("google-cloud-testutils")
     # TODO: also verify types on tests, all of google package
-    session.run("mypy", "-p", "google.cloud.bigtable", "--no-incremental")
+    session.run("mypy", "google/", "tests/")
 
 
 @nox.session(python=DEFAULT_PYTHON_VERSION)
 def lint_setup_py(session):
 ''',
 )
 
+# Work around https://github.com/googleapis/gapic-generator-python/issues/689
+bad_clusters_typing = r"""
+        clusters: Sequence\[
+            bigtable_instance_admin\.CreateInstanceRequest\.ClustersEntry
+        \] = None,"""
+
+good_clusters_typing = """
+        clusters: Dict[str, gba_instance.Cluster] = None,"""
+
+s.replace(
+    "google/cloud/bigtable_admin_v2/services/bigtable_instance_admin/*client.py",
+    bad_clusters_typing,
+    good_clusters_typing,
+)
+
+bad_clusters_docstring_1 = re.escape(r"""
+            clusters (:class:`Sequence[google.cloud.bigtable_admin_v2.types.CreateInstanceRequest.ClustersEntry]`):""")
+
+bad_clusters_docstring_2 = re.escape(r"""
+            clusters (Sequence[google.cloud.bigtable_admin_v2.types.CreateInstanceRequest.ClustersEntry]):""")
+
+good_clusters_docstring = """
+            clusters (Dict[str, gba_instance.Cluster]):"""
+
+s.replace(
+    "google/cloud/bigtable_admin_v2/services/bigtable_instance_admin/*client.py",
+    bad_clusters_docstring_1,
+    good_clusters_docstring,
+)
+
+s.replace(
+    "google/cloud/bigtable_admin_v2/services/bigtable_instance_admin/*client.py",
+    bad_clusters_docstring_2,
+    good_clusters_docstring,
+)
+
 # ----------------------------------------------------------------------------
 # Samples templates
 # ----------------------------------------------------------------------------
