process: add mypy-valid type annotations to samples

google/cloud/bigquery/client.py

@@ -215,7 +215,7 @@ def __init__(
         default_query_job_config=None,
         client_info=None,
         client_options=None,
-    ):
+    ) -> None:
         super(Client, self).__init__(
             project=project,
             credentials=credentials,
@@ -3426,7 +3426,9 @@ def insert_rows_json(
         self,
         table: Union[Table, TableReference, TableListItem, str],
         json_rows: Sequence[Dict],
-        row_ids: Union[Iterable[str], AutoRowIDs, None] = AutoRowIDs.GENERATE_UUID,
+        row_ids: Union[
+            Iterable[Optional[str]], AutoRowIDs, None
+        ] = AutoRowIDs.GENERATE_UUID,
         skip_invalid_rows: bool = None,
         ignore_unknown_values: bool = None,
         template_suffix: str = None,

google/cloud/bigquery/dataset.py

@@ -27,7 +27,7 @@
 from google.cloud.bigquery.encryption_configuration import EncryptionConfiguration
 
 
-def _get_table_reference(self, table_id):
+def _get_table_reference(self, table_id: str) -> TableReference:
     """Constructs a TableReference.
 
     Args:
@@ -144,7 +144,7 @@ class AccessEntry(object):
     )
     """Allowed entity types."""
 
-    def __init__(self, role, entity_type, entity_id):
+    def __init__(self, role, entity_type, entity_id) -> None:
         if entity_type not in self.ENTITY_TYPES:
             message = "Entity type %r not among: %s" % (
                 entity_type,
@@ -407,7 +407,7 @@ class Dataset(object):
         "default_encryption_configuration": "defaultEncryptionConfiguration",
     }
 
-    def __init__(self, dataset_ref):
+    def __init__(self, dataset_ref) -> None:
         if isinstance(dataset_ref, str):
             dataset_ref = DatasetReference.from_string(dataset_ref)
         self._properties = {"datasetReference": dataset_ref.to_api_repr(), "labels": {}}

google/cloud/bigquery/encryption_configuration.py

@@ -24,7 +24,7 @@ class EncryptionConfiguration(object):
         kms_key_name (str): resource ID of Cloud KMS key used for encryption
     """
 
-    def __init__(self, kms_key_name=None):
+    def __init__(self, kms_key_name=None) -> None:
         self._properties = {}
         if kms_key_name is not None:
             self._properties["kmsKeyName"] = kms_key_name

google/cloud/bigquery/external_config.py

@@ -22,7 +22,7 @@
 
 import base64
 import copy
-from typing import FrozenSet, Iterable, Optional, Union
+from typing import Any, Dict, FrozenSet, Iterable, Optional, Union
 
 from google.cloud.bigquery._helpers import _to_bytes
 from google.cloud.bigquery._helpers import _bytes_to_json
@@ -572,8 +572,8 @@ class HivePartitioningOptions(object):
     https://cloud.google.com/bigquery/docs/reference/rest/v2/tables#HivePartitioningOptions
     """
 
-    def __init__(self):
-        self._properties = {}
+    def __init__(self) -> None:
+        self._properties: Dict[str, Any] = {}
 
     @property
     def mode(self):
@@ -654,7 +654,7 @@ class ExternalConfig(object):
             See :attr:`source_format`.
     """
 
-    def __init__(self, source_format):
+    def __init__(self, source_format) -> None:
         self._properties = {"sourceFormat": source_format}
 
     @property

google/cloud/bigquery/job/copy_.py

@@ -52,7 +52,7 @@ class CopyJobConfig(_JobConfig):
     the property name as the name of a keyword argument.
     """
 
-    def __init__(self, **kwargs):
+    def __init__(self, **kwargs) -> None:
         super(CopyJobConfig, self).__init__("copy", **kwargs)
 
     @property

google/cloud/bigquery/job/load.py

@@ -38,7 +38,7 @@ class LoadJobConfig(_JobConfig):
     the property name as the name of a keyword argument.
     """
 
-    def __init__(self, **kwargs):
+    def __init__(self, **kwargs) -> None:
         super(LoadJobConfig, self).__init__("load", **kwargs)
 
     @property

google/cloud/bigquery/job/query.py

@@ -231,7 +231,7 @@ class QueryJobConfig(_JobConfig):
     the property name as the name of a keyword argument.
     """
 
-    def __init__(self, **kwargs):
+    def __init__(self, **kwargs) -> None:
         super(QueryJobConfig, self).__init__("query", **kwargs)
 
     @property
@@ -1067,7 +1067,7 @@ def ddl_target_table(self):
         return prop
 
     @property
-    def num_dml_affected_rows(self):
+    def num_dml_affected_rows(self) -> Optional[int]:
         """Return the number of DML rows affected by the job.
 
         See:

google/cloud/bigquery/query.py

@@ -520,7 +520,7 @@ class ArrayQueryParameter(_AbstractQueryParameter):
         values (List[appropriate type]): The parameter array values.
     """
 
-    def __init__(self, name, array_type, values):
+    def __init__(self, name, array_type, values) -> None:
         self.name = name
         self.values = values
 
@@ -683,10 +683,13 @@ class StructQueryParameter(_AbstractQueryParameter):
         ]]): The sub-parameters for the struct
     """
 
-    def __init__(self, name, *sub_params):
+    def __init__(self, name, *sub_params) -> None:
         self.name = name
-        types = self.struct_types = OrderedDict()
-        values = self.struct_values = {}
+        self.struct_types: Dict[str, Any] = OrderedDict()
+        self.struct_values: Dict[str, Any] = {}
+
+        types = self.struct_types
+        values = self.struct_values
         for sub in sub_params:
             if isinstance(sub, self.__class__):
                 types[sub.name] = "STRUCT"

google/cloud/bigquery/routine/routine.py

@@ -16,7 +16,7 @@
 
 """Define resources for the BigQuery Routines API."""
 
-from typing import Optional
+from typing import Any, Dict, Optional
 
 import google.cloud._helpers  # type: ignore
 from google.cloud.bigquery import _helpers
@@ -69,7 +69,7 @@ class Routine(object):
         "determinism_level": "determinismLevel",
     }
 
-    def __init__(self, routine_ref, **kwargs):
+    def __init__(self, routine_ref, **kwargs) -> None:
         if isinstance(routine_ref, str):
             routine_ref = RoutineReference.from_string(routine_ref)
 
@@ -214,7 +214,7 @@ def return_type(self, value: StandardSqlDataType):
         self._properties[self._PROPERTY_TO_API_FIELD["return_type"]] = resource
 
     @property
-    def return_table_type(self) -> StandardSqlTableType:
+    def return_table_type(self) -> Optional[StandardSqlTableType]:
         """The return type of a Table Valued Function (TVF) routine.
 
         .. versionadded:: 2.22.0
@@ -352,8 +352,8 @@ class RoutineArgument(object):
         "mode": "mode",
     }
 
-    def __init__(self, **kwargs):
-        self._properties = {}
+    def __init__(self, **kwargs) -> None:
+        self._properties: Dict[str, Any] = {}
         for property_name in kwargs:
             setattr(self, property_name, kwargs[property_name])
 

google/cloud/bigquery/table.py

@@ -369,7 +369,7 @@ class Table(_TableBase):
         "require_partition_filter": "requirePartitionFilter",
     }
 
-    def __init__(self, table_ref, schema=None):
+    def __init__(self, table_ref, schema=None) -> None:
         table_ref = _table_arg_to_table_ref(table_ref)
         self._properties = {"tableReference": table_ref.to_api_repr(), "labels": {}}
         # Let the @property do validation.
@@ -1318,7 +1318,7 @@ class Row(object):
     # Choose unusual field names to try to avoid conflict with schema fields.
     __slots__ = ("_xxx_values", "_xxx_field_to_index")
 
-    def __init__(self, values, field_to_index):
+    def __init__(self, values, field_to_index) -> None:
         self._xxx_values = values
         self._xxx_field_to_index = field_to_index
 
@@ -2230,7 +2230,7 @@ class PartitionRange(object):
             Private. Used to construct object from API resource.
     """
 
-    def __init__(self, start=None, end=None, interval=None, _properties=None):
+    def __init__(self, start=None, end=None, interval=None, _properties=None) -> None:
         if _properties is None:
             _properties = {}
         self._properties = _properties
@@ -2305,10 +2305,10 @@ class RangePartitioning(object):
             Private. Used to construct object from API resource.
     """
 
-    def __init__(self, range_=None, field=None, _properties=None):
+    def __init__(self, range_=None, field=None, _properties=None) -> None:
         if _properties is None:
             _properties = {}
-        self._properties = _properties
+        self._properties: Dict[str, Any] = _properties
 
         if range_ is not None:
             self.range_ = range_
@@ -2414,8 +2414,8 @@ class TimePartitioning(object):
 
     def __init__(
         self, type_=None, field=None, expiration_ms=None, require_partition_filter=None
-    ):
-        self._properties = {}
+    ) -> None:
+        self._properties: Dict[str, Any] = {}
         if type_ is None:
             self.type_ = TimePartitioningType.DAY
         else:

noxfile.py

@@ -43,6 +43,7 @@
     "lint_setup_py",
     "blacken",
     "mypy",
+    "mypy_samples",
     "pytype",
     "docs",
 ]
@@ -186,6 +187,28 @@ def system(session):
     session.run("py.test", "--quiet", os.path.join("tests", "system"), *session.posargs)
 
 
+@nox.session(python=DEFAULT_PYTHON_VERSION)
+def mypy_samples(session):
+    """Run type checks with mypy."""
+    session.install("-e", ".[all]")
+
+    session.install("ipython", "pytest")
+    session.install(MYPY_VERSION)
+
+    # Just install the dependencies' type info directly, since "mypy --install-types"
+    # might require an additional pass.
+    session.install("types-mock", "types-pytz")
+    session.install("typing-extensions")  # for TypedDict in pre-3.8 Python versions
+
+    session.run(
+        "mypy",
+        "--config-file",
+        str(CURRENT_DIRECTORY / "samples" / "mypy.ini"),
+        "--no-incremental",  # Required by warn-unused-configs from mypy.ini to work
+        "samples/",
+    )
+
+
 @nox.session(python=SYSTEM_TEST_PYTHON_VERSIONS)
 def snippets(session):
     """Run the snippets test suite."""

samples/add_empty_column.py

@@ -13,7 +13,7 @@
 # limitations under the License.
 
 
-def add_empty_column(table_id):
+def add_empty_column(table_id: str) -> None:
 
     # [START bigquery_add_empty_column]
     from google.cloud import bigquery

samples/browse_table_data.py

@@ -13,7 +13,7 @@
 # limitations under the License.
 
 
-def browse_table_data(table_id):
+def browse_table_data(table_id: str) -> None:
 
     # [START bigquery_browse_table]
 
@@ -41,15 +41,17 @@ def browse_table_data(table_id):
     table = client.get_table(table_id)  # Make an API request.
     fields = table.schema[:2]  # First two columns.
     rows_iter = client.list_rows(table_id, selected_fields=fields, max_results=10)
-    rows = list(rows_iter)
     print("Selected {} columns from table {}.".format(len(rows_iter.schema), table_id))
+
+    rows = list(rows_iter)
     print("Downloaded {} rows from table {}".format(len(rows), table_id))
 
     # Print row data in tabular format.
-    rows = client.list_rows(table, max_results=10)
-    format_string = "{!s:<16} " * len(rows.schema)
-    field_names = [field.name for field in rows.schema]
+    rows_iter = client.list_rows(table, max_results=10)
+    format_string = "{!s:<16} " * len(rows_iter.schema)
+    field_names = [field.name for field in rows_iter.schema]
     print(format_string.format(*field_names))  # Prints column headers.
-    for row in rows:
+
+    for row in rows_iter:
         print(format_string.format(*row))  # Prints row data.
     # [END bigquery_browse_table]

samples/client_list_jobs.py

@@ -13,7 +13,7 @@
 # limitations under the License.
 
 
-def client_list_jobs():
+def client_list_jobs() -> None:
 
     # [START bigquery_list_jobs]
 

samples/client_load_partitioned_table.py

@@ -13,7 +13,7 @@
 # limitations under the License.
 
 
-def client_load_partitioned_table(table_id):
+def client_load_partitioned_table(table_id: str) -> None:
 
     # [START bigquery_load_table_partitioned]
     from google.cloud import bigquery

samples/client_query.py

@@ -13,7 +13,7 @@
 # limitations under the License.
 
 
-def client_query():
+def client_query() -> None:
 
     # [START bigquery_query]
 

samples/client_query_add_column.py

@@ -13,7 +13,7 @@
 # limitations under the License.
 
 
-def client_query_add_column(table_id):
+def client_query_add_column(table_id: str) -> None:
 
     # [START bigquery_add_column_query_append]
     from google.cloud import bigquery

samples/client_query_batch.py

@@ -12,8 +12,13 @@
 # See the License for the specific language governing permissions and
 # limitations under the License.
 
+import typing
+
+if typing.TYPE_CHECKING:
+    from google.cloud import bigquery
 
-def client_query_batch():
+
+def client_query_batch() -> "bigquery.QueryJob":
 
     # [START bigquery_query_batch]
     from google.cloud import bigquery
@@ -37,9 +42,12 @@ def client_query_batch():
 
     # Check on the progress by getting the job's updated state. Once the state
     # is `DONE`, the results are ready.
-    query_job = client.get_job(
-        query_job.job_id, location=query_job.location
-    )  # Make an API request.
+    query_job = typing.cast(
+        "bigquery.QueryJob",
+        client.get_job(
+            query_job.job_id, location=query_job.location
+        ),  # Make an API request.
+    )
 
     print("Job {} is currently in state {}".format(query_job.job_id, query_job.state))
     # [END bigquery_query_batch]

samples/client_query_destination_table.py

@@ -13,7 +13,7 @@
 # limitations under the License.
 
 
-def client_query_destination_table(table_id):
+def client_query_destination_table(table_id: str) -> None:
 
     # [START bigquery_query_destination_table]
     from google.cloud import bigquery

samples/client_query_destination_table_clustered.py

@@ -13,7 +13,7 @@
 # limitations under the License.
 
 
-def client_query_destination_table_clustered(table_id):
+def client_query_destination_table_clustered(table_id: str) -> None:
 
     # [START bigquery_query_clustered_table]
     from google.cloud import bigquery