chore: add py.typed file for PEP 561 (googleapis#716)

cojenco · web-flow · commit e8a8abc8e4ce · 2022-02-17T15:21:26.000-08:00
diff --git a/google/__init__.py b/google/__init__.py
@@ -13,7 +13,7 @@
 # limitations under the License.
 
 try:
-    import pkg_resources
+    import pkg_resources  # type: ignore
 
     pkg_resources.declare_namespace(__name__)
 except ImportError:
diff --git a/google/cloud/__init__.py b/google/cloud/__init__.py
@@ -13,7 +13,7 @@
 # limitations under the License.
 
 try:
-    import pkg_resources
+    import pkg_resources  # type: ignore
 
     pkg_resources.declare_namespace(__name__)
 except ImportError:
diff --git a/google/cloud/storage/_helpers.py b/google/cloud/storage/_helpers.py
@@ -22,7 +22,7 @@
 import os
 from urllib.parse import urlsplit
 
-from google import resumable_media
+from google import resumable_media  # type: ignore
 from google.auth import environment_vars
 from google.cloud.storage.constants import _DEFAULT_TIMEOUT
 from google.cloud.storage.retry import DEFAULT_RETRY
diff --git a/google/cloud/storage/_http.py b/google/cloud/storage/_http.py
@@ -16,9 +16,9 @@
 
 import functools
 import os
-import pkg_resources
+import pkg_resources  # type: ignore
 
-from google.cloud import _http
+from google.cloud import _http  # type: ignore
 
 from google.cloud.storage import __version__
 
diff --git a/google/cloud/storage/acl.py b/google/cloud/storage/acl.py
@@ -412,7 +412,7 @@ def get_entities(self):
         self._ensure_loaded()
         return list(self.entities.values())
 
-    @property
+    @property  # type: ignore
     def client(self):
         """Abstract getter for the object client."""
         raise NotImplementedError
diff --git a/google/cloud/storage/batch.py b/google/cloud/storage/batch.py
@@ -23,7 +23,7 @@
 import io
 import json
 
-import requests
+import requests  # type: ignore
 
 from google.cloud import _helpers
 from google.cloud import exceptions
diff --git a/google/cloud/storage/blob.py b/google/cloud/storage/blob.py
@@ -42,7 +42,7 @@
 from urllib.parse import urlunsplit
 import warnings
 
-from google import resumable_media
+from google import resumable_media  # type: ignore
 from google.resumable_media.requests import ChunkedDownload
 from google.resumable_media.requests import Download
 from google.resumable_media.requests import RawDownload
diff --git a/google/cloud/storage/client.py b/google/cloud/storage/client.py
@@ -25,7 +25,7 @@
 
 from google.auth.credentials import AnonymousCredentials
 
-from google import resumable_media
+from google import resumable_media  # type: ignore
 
 from google.api_core import page_iterator
 from google.cloud._helpers import _LocalStack, _NOW
diff --git a/google/cloud/storage/py.typed b/google/cloud/storage/py.typed
@@ -0,0 +1,2 @@
+# Marker file for PEP 561.
+# The google-cloud-storage package uses inline types.
diff --git a/google/cloud/storage/retry.py b/google/cloud/storage/retry.py
@@ -12,8 +12,8 @@
 # See the License for the specific language governing permissions and
 # limitations under the License.
 
-import requests
-import requests.exceptions as requests_exceptions
+import requests  # type: ignore
+import requests.exceptions as requests_exceptions  # type: ignore
 
 from google.api_core import exceptions as api_exceptions
 from google.api_core import retry
diff --git a/mypy.ini b/mypy.ini
@@ -0,0 +1,4 @@
+[mypy]
+python_version = 3.7
+namespace_packages = True
+ignore_missing_imports = True
diff --git a/noxfile.py b/noxfile.py
@@ -63,6 +63,16 @@ def blacken(session):
     )
 
 
+@nox.session(python=DEFAULT_PYTHON_VERSION)
+def mypy(session):
+    """Verify type hints are mypy compatible."""
+    session.install("-e", ".")
+    session.install(
+        "mypy", "types-setuptools", "types-requests",
+    )
+    session.run("mypy", "-p", "google.cloud.storage", "--no-incremental")
+
+
 @nox.session(python=DEFAULT_PYTHON_VERSION)
 def lint_setup_py(session):
     """Verify that setup.py is valid (including RST check)."""

Original file line number	Diff line number	Diff line change
`@@ -0,0 +1,2 @@`
	`1`	`+# Marker file for PEP 561.`
	`2`	`+# The google-cloud-storage package uses inline types.`