feat: [google-maps-places] Add REST Interceptors which support reading metadata (#13478)

BEGIN_COMMIT_OVERRIDE
feat: Add REST Interceptors which support reading metadata
feat: Add support for reading selective GAPIC generation methods from
service YAML
chore: Update gapic-generator-python to v1.22.0
fix: add oauth scopes to Places proto
END_COMMIT_OVERRIDE


- [ ] Regenerate this pull request now.

feat: Add support for reading selective GAPIC generation methods from
service YAML
chore: Update gapic-generator-python to v1.22.0

PiperOrigin-RevId: 724026024

Source-Link:
googleapis/googleapis@ad99638

Source-Link:
googleapis/googleapis-gen@e291c4d
Copy-Tag:
eyJwIjoicGFja2FnZXMvZ29vZ2xlLW1hcHMtcGxhY2VzLy5Pd2xCb3QueWFtbCIsImgiOiJlMjkxYzRkZDFkNjcwZWRhMTk5OThkZTc2Zjk2N2UxNjAzYTQ4OTkzIn0=

BEGIN_NESTED_COMMIT
fix: [google-maps-places] add oauth scopes to Places proto
PiperOrigin-RevId: 720741557

Source-Link:
googleapis/googleapis@280725e

Source-Link:
googleapis/googleapis-gen@194c4c3
Copy-Tag:
eyJwIjoicGFja2FnZXMvZ29vZ2xlLW1hcHMtcGxhY2VzLy5Pd2xCb3QueWFtbCIsImgiOiIxOTRjNGMzMjk0MWZlNTU5ZGQxYTk4NDhmNDg5MWRiNTk1NTYyYWY1In0=
END_NESTED_COMMIT

---------

Co-authored-by: Owl Bot <gcf-owl-bot[bot]@users.noreply.github.com>
Co-authored-by: ohmayr <[email protected]>

Author: gcf-owl-bot[bot]

packages/google-maps-places/google/maps/places/gapic_version.py

@@ -13,4 +13,4 @@
 # See the License for the specific language governing permissions and
 # limitations under the License.
 #
-__version__ = "0.1.22"  # {x-release-please-version}
+__version__ = "0.0.0"  # {x-release-please-version}

packages/google-maps-places/google/maps/places_v1/gapic_version.py

@@ -13,4 +13,4 @@
 # See the License for the specific language governing permissions and
 # limitations under the License.
 #
-__version__ = "0.1.22"  # {x-release-please-version}
+__version__ = "0.0.0"  # {x-release-please-version}

packages/google-maps-places/google/maps/places_v1/services/places/client.py

@@ -14,6 +14,8 @@
 # limitations under the License.
 #
 from collections import OrderedDict
+from http import HTTPStatus
+import json
 import logging as std_logging
 import os
 import re
@@ -546,6 +548,33 @@ def _validate_universe_domain(self):
         # NOTE (b/349488459): universe validation is disabled until further notice.
         return True
 
+    def _add_cred_info_for_auth_errors(
+        self, error: core_exceptions.GoogleAPICallError
+    ) -> None:
+        """Adds credential info string to error details for 401/403/404 errors.
+
+        Args:
+            error (google.api_core.exceptions.GoogleAPICallError): The error to add the cred info.
+        """
+        if error.code not in [
+            HTTPStatus.UNAUTHORIZED,
+            HTTPStatus.FORBIDDEN,
+            HTTPStatus.NOT_FOUND,
+        ]:
+            return
+
+        cred = self._transport._credentials
+
+        # get_cred_info is only available in google-auth>=2.35.0
+        if not hasattr(cred, "get_cred_info"):
+            return
+
+        # ignore the type check since pypy test fails when get_cred_info
+        # is not available
+        cred_info = cred.get_cred_info()  # type: ignore
+        if cred_info and hasattr(error._details, "append"):
+            error._details.append(json.dumps(cred_info))
+
     @property
     def api_endpoint(self):
         """Return the API endpoint used by the client instance.

packages/google-maps-places/google/maps/places_v1/services/places/transports/base.py

@@ -35,7 +35,7 @@
 class PlacesTransport(abc.ABC):
     """Abstract transport class for Places."""
 
-    AUTH_SCOPES = ()
+    AUTH_SCOPES = ("https://www.googleapis.com/auth/cloud-platform",)
 
     DEFAULT_HOST: str = "places.googleapis.com"
 

packages/google-maps-places/google/maps/places_v1/services/places/transports/rest.py

@@ -134,12 +134,38 @@ def post_autocomplete_places(
     ) -> places_service.AutocompletePlacesResponse:
         """Post-rpc interceptor for autocomplete_places
 
-        Override in a subclass to manipulate the response
+        DEPRECATED. Please use the `post_autocomplete_places_with_metadata`
+        interceptor instead.
+
+        Override in a subclass to read or manipulate the response
         after it is returned by the Places server but before
-        it is returned to user code.
+        it is returned to user code. This `post_autocomplete_places` interceptor runs
+        before the `post_autocomplete_places_with_metadata` interceptor.
         """
         return response
 
+    def post_autocomplete_places_with_metadata(
+        self,
+        response: places_service.AutocompletePlacesResponse,
+        metadata: Sequence[Tuple[str, Union[str, bytes]]],
+    ) -> Tuple[
+        places_service.AutocompletePlacesResponse,
+        Sequence[Tuple[str, Union[str, bytes]]],
+    ]:
+        """Post-rpc interceptor for autocomplete_places
+
+        Override in a subclass to read or manipulate the response or metadata after it
+        is returned by the Places server but before it is returned to user code.
+
+        We recommend only using this `post_autocomplete_places_with_metadata`
+        interceptor in new development instead of the `post_autocomplete_places` interceptor.
+        When both interceptors are used, this `post_autocomplete_places_with_metadata` interceptor runs after the
+        `post_autocomplete_places` interceptor. The (possibly modified) response returned by
+        `post_autocomplete_places` will be passed to
+        `post_autocomplete_places_with_metadata`.
+        """
+        return response, metadata
+
     def pre_get_photo_media(
         self,
         request: places_service.GetPhotoMediaRequest,
@@ -159,12 +185,35 @@ def post_get_photo_media(
     ) -> places_service.PhotoMedia:
         """Post-rpc interceptor for get_photo_media
 
-        Override in a subclass to manipulate the response
+        DEPRECATED. Please use the `post_get_photo_media_with_metadata`
+        interceptor instead.
+
+        Override in a subclass to read or manipulate the response
         after it is returned by the Places server but before
-        it is returned to user code.
+        it is returned to user code. This `post_get_photo_media` interceptor runs
+        before the `post_get_photo_media_with_metadata` interceptor.
         """
         return response
 
+    def post_get_photo_media_with_metadata(
+        self,
+        response: places_service.PhotoMedia,
+        metadata: Sequence[Tuple[str, Union[str, bytes]]],
+    ) -> Tuple[places_service.PhotoMedia, Sequence[Tuple[str, Union[str, bytes]]]]:
+        """Post-rpc interceptor for get_photo_media
+
+        Override in a subclass to read or manipulate the response or metadata after it
+        is returned by the Places server but before it is returned to user code.
+
+        We recommend only using this `post_get_photo_media_with_metadata`
+        interceptor in new development instead of the `post_get_photo_media` interceptor.
+        When both interceptors are used, this `post_get_photo_media_with_metadata` interceptor runs after the
+        `post_get_photo_media` interceptor. The (possibly modified) response returned by
+        `post_get_photo_media` will be passed to
+        `post_get_photo_media_with_metadata`.
+        """
+        return response, metadata
+
     def pre_get_place(
         self,
         request: places_service.GetPlaceRequest,
@@ -180,12 +229,33 @@ def pre_get_place(
     def post_get_place(self, response: place.Place) -> place.Place:
         """Post-rpc interceptor for get_place
 
-        Override in a subclass to manipulate the response
+        DEPRECATED. Please use the `post_get_place_with_metadata`
+        interceptor instead.
+
+        Override in a subclass to read or manipulate the response
         after it is returned by the Places server but before
-        it is returned to user code.
+        it is returned to user code. This `post_get_place` interceptor runs
+        before the `post_get_place_with_metadata` interceptor.
         """
         return response
 
+    def post_get_place_with_metadata(
+        self, response: place.Place, metadata: Sequence[Tuple[str, Union[str, bytes]]]
+    ) -> Tuple[place.Place, Sequence[Tuple[str, Union[str, bytes]]]]:
+        """Post-rpc interceptor for get_place
+
+        Override in a subclass to read or manipulate the response or metadata after it
+        is returned by the Places server but before it is returned to user code.
+
+        We recommend only using this `post_get_place_with_metadata`
+        interceptor in new development instead of the `post_get_place` interceptor.
+        When both interceptors are used, this `post_get_place_with_metadata` interceptor runs after the
+        `post_get_place` interceptor. The (possibly modified) response returned by
+        `post_get_place` will be passed to
+        `post_get_place_with_metadata`.
+        """
+        return response, metadata
+
     def pre_search_nearby(
         self,
         request: places_service.SearchNearbyRequest,
@@ -205,12 +275,37 @@ def post_search_nearby(
     ) -> places_service.SearchNearbyResponse:
         """Post-rpc interceptor for search_nearby
 
-        Override in a subclass to manipulate the response
+        DEPRECATED. Please use the `post_search_nearby_with_metadata`
+        interceptor instead.
+
+        Override in a subclass to read or manipulate the response
         after it is returned by the Places server but before
-        it is returned to user code.
+        it is returned to user code. This `post_search_nearby` interceptor runs
+        before the `post_search_nearby_with_metadata` interceptor.
         """
         return response
 
+    def post_search_nearby_with_metadata(
+        self,
+        response: places_service.SearchNearbyResponse,
+        metadata: Sequence[Tuple[str, Union[str, bytes]]],
+    ) -> Tuple[
+        places_service.SearchNearbyResponse, Sequence[Tuple[str, Union[str, bytes]]]
+    ]:
+        """Post-rpc interceptor for search_nearby
+
+        Override in a subclass to read or manipulate the response or metadata after it
+        is returned by the Places server but before it is returned to user code.
+
+        We recommend only using this `post_search_nearby_with_metadata`
+        interceptor in new development instead of the `post_search_nearby` interceptor.
+        When both interceptors are used, this `post_search_nearby_with_metadata` interceptor runs after the
+        `post_search_nearby` interceptor. The (possibly modified) response returned by
+        `post_search_nearby` will be passed to
+        `post_search_nearby_with_metadata`.
+        """
+        return response, metadata
+
     def pre_search_text(
         self,
         request: places_service.SearchTextRequest,
@@ -230,12 +325,37 @@ def post_search_text(
     ) -> places_service.SearchTextResponse:
         """Post-rpc interceptor for search_text
 
-        Override in a subclass to manipulate the response
+        DEPRECATED. Please use the `post_search_text_with_metadata`
+        interceptor instead.
+
+        Override in a subclass to read or manipulate the response
         after it is returned by the Places server but before
-        it is returned to user code.
+        it is returned to user code. This `post_search_text` interceptor runs
+        before the `post_search_text_with_metadata` interceptor.
         """
         return response
 
+    def post_search_text_with_metadata(
+        self,
+        response: places_service.SearchTextResponse,
+        metadata: Sequence[Tuple[str, Union[str, bytes]]],
+    ) -> Tuple[
+        places_service.SearchTextResponse, Sequence[Tuple[str, Union[str, bytes]]]
+    ]:
+        """Post-rpc interceptor for search_text
+
+        Override in a subclass to read or manipulate the response or metadata after it
+        is returned by the Places server but before it is returned to user code.
+
+        We recommend only using this `post_search_text_with_metadata`
+        interceptor in new development instead of the `post_search_text` interceptor.
+        When both interceptors are used, this `post_search_text_with_metadata` interceptor runs after the
+        `post_search_text` interceptor. The (possibly modified) response returned by
+        `post_search_text` will be passed to
+        `post_search_text_with_metadata`.
+        """
+        return response, metadata
+
 
 @dataclasses.dataclass
 class PlacesRestStub:
@@ -458,6 +578,10 @@ def __call__(
             json_format.Parse(response.content, pb_resp, ignore_unknown_fields=True)
 
             resp = self._interceptor.post_autocomplete_places(resp)
+            response_metadata = [(k, str(v)) for k, v in response.headers.items()]
+            resp, _ = self._interceptor.post_autocomplete_places_with_metadata(
+                resp, response_metadata
+            )
             if CLIENT_LOGGING_SUPPORTED and _LOGGER.isEnabledFor(
                 logging.DEBUG
             ):  # pragma: NO COVER
@@ -603,6 +727,10 @@ def __call__(
             json_format.Parse(response.content, pb_resp, ignore_unknown_fields=True)
 
             resp = self._interceptor.post_get_photo_media(resp)
+            response_metadata = [(k, str(v)) for k, v in response.headers.items()]
+            resp, _ = self._interceptor.post_get_photo_media_with_metadata(
+                resp, response_metadata
+            )
             if CLIENT_LOGGING_SUPPORTED and _LOGGER.isEnabledFor(
                 logging.DEBUG
             ):  # pragma: NO COVER
@@ -746,6 +874,10 @@ def __call__(
             json_format.Parse(response.content, pb_resp, ignore_unknown_fields=True)
 
             resp = self._interceptor.post_get_place(resp)
+            response_metadata = [(k, str(v)) for k, v in response.headers.items()]
+            resp, _ = self._interceptor.post_get_place_with_metadata(
+                resp, response_metadata
+            )
             if CLIENT_LOGGING_SUPPORTED and _LOGGER.isEnabledFor(
                 logging.DEBUG
             ):  # pragma: NO COVER
@@ -894,6 +1026,10 @@ def __call__(
             json_format.Parse(response.content, pb_resp, ignore_unknown_fields=True)
 
             resp = self._interceptor.post_search_nearby(resp)
+            response_metadata = [(k, str(v)) for k, v in response.headers.items()]
+            resp, _ = self._interceptor.post_search_nearby_with_metadata(
+                resp, response_metadata
+            )
             if CLIENT_LOGGING_SUPPORTED and _LOGGER.isEnabledFor(
                 logging.DEBUG
             ):  # pragma: NO COVER
@@ -1042,6 +1178,10 @@ def __call__(
             json_format.Parse(response.content, pb_resp, ignore_unknown_fields=True)
 
             resp = self._interceptor.post_search_text(resp)
+            response_metadata = [(k, str(v)) for k, v in response.headers.items()]
+            resp, _ = self._interceptor.post_search_text_with_metadata(
+                resp, response_metadata
+            )
             if CLIENT_LOGGING_SUPPORTED and _LOGGER.isEnabledFor(
                 logging.DEBUG
             ):  # pragma: NO COVER

packages/google-maps-places/samples/generated_samples/snippet_metadata_google.maps.places.v1.json

@@ -8,7 +8,7 @@
     ],
     "language": "PYTHON",
     "name": "google-maps-places",
-    "version": "0.1.22"
+    "version": "0.1.0"
   },
   "snippets": [
     {