Merge branch 'master' into issue4340-readconsistency

Author: chemelnucfin

README.rst

@@ -15,9 +15,15 @@ Google Cloud Python Client
 .. _API Documentation: https://googlecloudplatform.github.io/google-cloud-python/latest/
 .. _Read The Docs Documentation: https://google-cloud-python.readthedocs.io/en/latest/
 
+.. note::
+
+    These libraries currently do not run on Google App Engine Standard.
+    We are actively working on adding this support.
+
 The following client libraries have **GA** support:
 
 -  `Google Cloud Datastore`_ (`Datastore README`_)
+-  `Google Cloud Natural Language`_ (`Natural Language README`_)
 -  `Google Cloud Storage`_ (`Storage README`_)
 -  `Google Cloud Translation`_ (`Translation README`_)
 -  `Stackdriver Logging`_ (`Logging README`_)
@@ -29,11 +35,16 @@ of critical security issues) or with an extensive deprecation period.
 Issues and requests against GA libraries are addressed with the highest
 priority.
 
+.. note::
+
+    Sub-components of GA libraries explicitly marked as beta in the
+    import path (e.g. ``google.cloud.language_v1beta2``) should be considered
+    to be beta.
+
 The following client libraries have **beta** support:
 
 -  `Google BigQuery`_ (`BigQuery README`_)
 -  `Google Cloud Firestore`_ (`Firestore README`_)
--  `Google Cloud Natural Language`_ (`Natural Language README`_)
 -  `Google Cloud Pub/Sub`_ (`Pub/Sub README`_)
 -  `Google Cloud Spanner`_ (`Spanner README`_)
 -  `Google Cloud Speech`_ (`Speech README`_)

api_core/google/api_core/gapic_v1/__init__.py

@@ -14,8 +14,10 @@
 
 from google.api_core.gapic_v1 import config
 from google.api_core.gapic_v1 import method
+from google.api_core.gapic_v1 import routing_header
 
 __all__ = [
     'config',
     'method',
+    'routing_header',
 ]

api_core/google/api_core/gapic_v1/routing_header.py

@@ -0,0 +1,53 @@
+# Copyright 2017 Google LLC
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#     http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+
+"""Helpers for constructing routing headers.
+
+These headers are used by Google infrastructure to determine how to route
+requests, especially for services that are regional.
+
+Generally, these headers are specified as gRPC metadata.
+"""
+
+from six.moves.urllib.parse import urlencode
+
+ROUTING_METADATA_KEY = 'x-goog-header-params'
+
+
+def to_routing_header(params):
+    """Returns a routing header string for the given request parameters.
+
+    Args:
+        params (Mapping[str, Any]): A dictionary containing the request
+            parameters used for routing.
+
+    Returns:
+        str: The routing header string.
+    """
+    return urlencode(params)
+
+
+def to_grpc_metadata(params):
+    """Returns the gRPC metadata containing the routing headers for the given
+    request parameters.
+
+    Args:
+        params (Mapping[str, Any]): A dictionary containing the request
+            parameters used for routing.
+
+    Returns:
+        Tuple(str, str): The gRPC metadata containing the routing header key
+            and value.
+    """
+    return (ROUTING_METADATA_KEY, to_routing_header(params))

api_core/tests/unit/gapic/test_routing_header.py

@@ -0,0 +1,29 @@
+# Copyright 2017 Google LLC
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#     http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+
+
+from google.api_core.gapic_v1 import routing_header
+
+
+def test_to_routing_header():
+    params = [('name', 'meep'), ('book.read', '1')]
+    value = routing_header.to_routing_header(params)
+    assert value == "name=meep&book.read=1"
+
+
+def test_to_grpc_metadata():
+    params = [('name', 'meep'), ('book.read', '1')]
+    metadata = routing_header.to_grpc_metadata(params)
+    assert metadata == (
+        routing_header.ROUTING_METADATA_KEY, "name=meep&book.read=1")

bigquery/tests/unit/test_dataset.py

@@ -206,7 +206,7 @@ def _setUpConstants(self):
         self.DS_FULL_ID = '%s:%s' % (self.PROJECT, self.DS_ID)
         self.RESOURCE_URL = 'http://example.com/path/to/resource'
 
-    def _makeResource(self):
+    def _make_resource(self):
         self._setUpConstants()
         USER_EMAIL = 'phred@example.com'
         GROUP_EMAIL = 'group-name@lists.example.com'
@@ -422,7 +422,7 @@ def test_from_api_repr_bare(self):
         self._verify_resource_properties(dataset, RESOURCE)
 
     def test_from_api_repr_w_properties(self):
-        RESOURCE = self._makeResource()
+        RESOURCE = self._make_resource()
         klass = self._get_target_class()
         dataset = klass.from_api_repr(RESOURCE)
         self._verify_resource_properties(dataset, RESOURCE)