BigQuery Storage: run 'blacken' during synth (googleapis#7047)

tseaver · web-flow · commit 321d747533f6 · 2019-01-04T15:48:43.000-05:00
Also, pick up stub docstring fix in GAPIC generator. Closes googleapis#6878.
diff --git a/bigquery_storage/google/cloud/bigquery_storage_v1beta1/gapic/transports/big_query_storage_grpc_transport.py b/bigquery_storage/google/cloud/bigquery_storage_v1beta1/gapic/transports/big_query_storage_grpc_transport.py
@@ -105,7 +105,7 @@ def channel(self):
 
     @property
     def create_read_session(self):
-        """Return the gRPC stub for {$apiMethod.name}.
+        """Return the gRPC stub for :meth:`BigQueryStorageClient.create_read_session`.
 
         Creates a new read session. A read session divides the contents of a
         BigQuery table into one or more streams, which can then be used to read
@@ -129,7 +129,7 @@ def create_read_session(self):
 
     @property
     def read_rows(self):
-        """Return the gRPC stub for {$apiMethod.name}.
+        """Return the gRPC stub for :meth:`BigQueryStorageClient.read_rows`.
 
         Reads rows from the table in the format prescribed by the read session.
         Each response contains one or more table rows, up to a maximum of 10 MiB
@@ -150,7 +150,7 @@ def read_rows(self):
 
     @property
     def batch_create_read_session_streams(self):
-        """Return the gRPC stub for {$apiMethod.name}.
+        """Return the gRPC stub for :meth:`BigQueryStorageClient.batch_create_read_session_streams`.
 
         Creates additional streams for a ReadSession. This API can be used to
         dynamically adjust the parallelism of a batch processing task upwards by
@@ -165,7 +165,7 @@ def batch_create_read_session_streams(self):
 
     @property
     def finalize_stream(self):
-        """Return the gRPC stub for {$apiMethod.name}.
+        """Return the gRPC stub for :meth:`BigQueryStorageClient.finalize_stream`.
 
         Triggers the graceful termination of a single stream in a ReadSession. This
         API can be used to dynamically adjust the parallelism of a batch processing
@@ -191,7 +191,7 @@ def finalize_stream(self):
 
     @property
     def split_read_stream(self):
-        """Return the gRPC stub for {$apiMethod.name}.
+        """Return the gRPC stub for :meth:`BigQueryStorageClient.split_read_stream`.
 
         Splits a given read stream into two Streams. These streams are referred
         to as the primary and the residual of the split. The original stream can
diff --git a/bigquery_storage/noxfile.py b/bigquery_storage/noxfile.py
@@ -74,6 +74,21 @@ def lint(session):
     session.run('flake8', 'tests')
 
 
+@nox.session(python="3.6")
+def blacken(session):
+    """Run black.
+
+    Format code to uniform standard.
+    """
+    session.install("black")
+    session.run(
+        "black",
+        "google",
+        "tests",
+        "docs",
+    )
+
+
 @nox.session(python='3.6')
 def lint_setup_py(session):
     """Verify that setup.py is valid (including RST check)."""
diff --git a/bigquery_storage/synth.metadata b/bigquery_storage/synth.metadata
@@ -0,0 +1,32 @@
+{
+  "updateTime": "2019-01-04T19:40:42.544142Z",
+  "sources": [
+    {
+      "generator": {
+        "name": "artman",
+        "version": "0.16.4",
+        "dockerImage": "googleapis/artman@sha256:8b45fae963557c3299921037ecbb86f0689f41b1b4aea73408ebc50562cb2857"
+      }
+    },
+    {
+      "git": {
+        "name": "googleapis",
+        "remote": "https://github.com/googleapis/googleapis.git",
+        "sha": "c050b8885af23bfbc4e2858858db47e33e311da7",
+        "internalRef": "227870263"
+      }
+    }
+  ],
+  "destinations": [
+    {
+      "client": {
+        "source": "googleapis",
+        "apiName": "bigquery-datatransfer",
+        "apiVersion": "v1",
+        "language": "python",
+        "generator": "gapic",
+        "config": "google/cloud/bigquery/storage/artman_bigquerystorage_v1beta1.yaml"
+      }
+    }
+  ]
+}
diff --git a/bigquery_storage/synth.py b/bigquery_storage/synth.py
@@ -111,3 +111,5 @@
     'google.api_core.grpc_helpers.create_channel(  # pragma: no cover',
 )
 # END: Ignore lint and coverage
+
+s.shell.run(["nox", "-s", "blacken"], hide_output=False)

Original file line number	Diff line number	Diff line change
`@@ -111,3 +111,5 @@`
`111`	`111`	`'google.api_core.grpc_helpers.create_channel( # pragma: no cover',`
`112`	`112`	`)`
`113`	`113`	`# END: Ignore lint and coverage`
	`114`	`+`
	`115`	`+s.shell.run(["nox", "-s", "blacken"], hide_output=False)`