Skip to content

feat: [Many APIs] Add REST Interceptors which support reading metadata #13503

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
ohmayr merged 3 commits into from
Feb 18, 2025
Merged

feat: [Many APIs] Add REST Interceptors which support reading metadata #13503

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
ffd56c9
feat: Add REST Interceptors which support reading metadata
gcf-owl-bot[bot] Feb 11, 2025
b81a9ae
update replacement in grafeas
parthea Feb 12, 2025
87bfb30
🦉 Updates from OwlBot post-processor
gcf-owl-bot[bot] Feb 12, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 2 additions & 2 deletions packages/google-maps-mapsplatformdatasets/README.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -26,12 +26,12 @@ In order to use this library, you first need to go through the following steps:
1. `Select or create a Cloud Platform project.`_
2. `Enable billing for your project.`_
3. `Enable the Maps Platform Datasets API.`_
4. `Setup Authentication.`_
4. `Set up Authentication.`_

.. _Select or create a Cloud Platform project.: https://console.cloud.google.com/project
.. _Enable billing for your project.: https://cloud.google.com/billing/docs/how-to/modify-project#enable_billing_for_a_project
.. _Enable the Maps Platform Datasets API.: https://developers.google.com/maps
.. _Setup Authentication.: https://googleapis.dev/python/google-api-core/latest/auth.html
.. _Set up Authentication.: https://googleapis.dev/python/google-api-core/latest/auth.html

Installation
~~~~~~~~~~~~
Expand Down
2 changes: 1 addition & 1 deletion packages/google-maps-mapsplatformdatasets/google/maps/mapsplatformdatasets/gapic_version.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -13,4 +13,4 @@
# See the License for the specific language governing permissions and
# limitations under the License.
#
__version__ = "0.4.5" # {x-release-please-version}
__version__ = "0.0.0" # {x-release-please-version}
2 changes: 1 addition & 1 deletion ...ges/google-maps-mapsplatformdatasets/google/maps/mapsplatformdatasets_v1/gapic_version.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -13,4 +13,4 @@
# See the License for the specific language governing permissions and
# limitations under the License.
#
__version__ = "0.4.5" # {x-release-please-version}
__version__ = "0.0.0" # {x-release-please-version}
29 changes: 29 additions & 0 deletions ...ormdatasets/google/maps/mapsplatformdatasets_v1/services/maps_platform_datasets/client.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down Expand Up @@ -486,6 +488,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.
Expand Down
161 changes: 151 additions & 10 deletions ...ts/google/maps/mapsplatformdatasets_v1/services/maps_platform_datasets/transports/rest.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -139,12 +139,35 @@ def pre_create_dataset(
def post_create_dataset(self, response: gmm_dataset.Dataset) -> gmm_dataset.Dataset:
"""Post-rpc interceptor for create_dataset

Override in a subclass to manipulate the response
DEPRECATED. Please use the `post_create_dataset_with_metadata`
interceptor instead.

Override in a subclass to read or manipulate the response
after it is returned by the MapsPlatformDatasets server but before
it is returned to user code.
it is returned to user code. This `post_create_dataset` interceptor runs
before the `post_create_dataset_with_metadata` interceptor.
"""
return response

def post_create_dataset_with_metadata(
self,
response: gmm_dataset.Dataset,
metadata: Sequence[Tuple[str, Union[str, bytes]]],
) -> Tuple[gmm_dataset.Dataset, Sequence[Tuple[str, Union[str, bytes]]]]:
"""Post-rpc interceptor for create_dataset

Override in a subclass to read or manipulate the response or metadata after it
is returned by the MapsPlatformDatasets server but before it is returned to user code.

We recommend only using this `post_create_dataset_with_metadata`
interceptor in new development instead of the `post_create_dataset` interceptor.
When both interceptors are used, this `post_create_dataset_with_metadata` interceptor runs after the
`post_create_dataset` interceptor. The (possibly modified) response returned by
`post_create_dataset` will be passed to
`post_create_dataset_with_metadata`.
"""
return response, metadata

def pre_delete_dataset(
self,
request: maps_platform_datasets.DeleteDatasetRequest,
Expand Down Expand Up @@ -180,12 +203,38 @@ def post_fetch_dataset_errors(
) -> maps_platform_datasets.FetchDatasetErrorsResponse:
"""Post-rpc interceptor for fetch_dataset_errors

Override in a subclass to manipulate the response
DEPRECATED. Please use the `post_fetch_dataset_errors_with_metadata`
interceptor instead.

Override in a subclass to read or manipulate the response
after it is returned by the MapsPlatformDatasets server but before
it is returned to user code.
it is returned to user code. This `post_fetch_dataset_errors` interceptor runs
before the `post_fetch_dataset_errors_with_metadata` interceptor.
"""
return response

def post_fetch_dataset_errors_with_metadata(
self,
response: maps_platform_datasets.FetchDatasetErrorsResponse,
metadata: Sequence[Tuple[str, Union[str, bytes]]],
) -> Tuple[
maps_platform_datasets.FetchDatasetErrorsResponse,
Sequence[Tuple[str, Union[str, bytes]]],
]:
"""Post-rpc interceptor for fetch_dataset_errors

Override in a subclass to read or manipulate the response or metadata after it
is returned by the MapsPlatformDatasets server but before it is returned to user code.

We recommend only using this `post_fetch_dataset_errors_with_metadata`
interceptor in new development instead of the `post_fetch_dataset_errors` interceptor.
When both interceptors are used, this `post_fetch_dataset_errors_with_metadata` interceptor runs after the
`post_fetch_dataset_errors` interceptor. The (possibly modified) response returned by
`post_fetch_dataset_errors` will be passed to
`post_fetch_dataset_errors_with_metadata`.
"""
return response, metadata

def pre_get_dataset(
self,
request: maps_platform_datasets.GetDatasetRequest,
Expand All @@ -204,12 +253,35 @@ def pre_get_dataset(
def post_get_dataset(self, response: dataset.Dataset) -> dataset.Dataset:
"""Post-rpc interceptor for get_dataset

Override in a subclass to manipulate the response
DEPRECATED. Please use the `post_get_dataset_with_metadata`
interceptor instead.

Override in a subclass to read or manipulate the response
after it is returned by the MapsPlatformDatasets server but before
it is returned to user code.
it is returned to user code. This `post_get_dataset` interceptor runs
before the `post_get_dataset_with_metadata` interceptor.
"""
return response

def post_get_dataset_with_metadata(
self,
response: dataset.Dataset,
metadata: Sequence[Tuple[str, Union[str, bytes]]],
) -> Tuple[dataset.Dataset, Sequence[Tuple[str, Union[str, bytes]]]]:
"""Post-rpc interceptor for get_dataset

Override in a subclass to read or manipulate the response or metadata after it
is returned by the MapsPlatformDatasets server but before it is returned to user code.

We recommend only using this `post_get_dataset_with_metadata`
interceptor in new development instead of the `post_get_dataset` interceptor.
When both interceptors are used, this `post_get_dataset_with_metadata` interceptor runs after the
`post_get_dataset` interceptor. The (possibly modified) response returned by
`post_get_dataset` will be passed to
`post_get_dataset_with_metadata`.
"""
return response, metadata

def pre_list_datasets(
self,
request: maps_platform_datasets.ListDatasetsRequest,
Expand All @@ -230,12 +302,38 @@ def post_list_datasets(
) -> maps_platform_datasets.ListDatasetsResponse:
"""Post-rpc interceptor for list_datasets

Override in a subclass to manipulate the response
DEPRECATED. Please use the `post_list_datasets_with_metadata`
interceptor instead.

Override in a subclass to read or manipulate the response
after it is returned by the MapsPlatformDatasets server but before
it is returned to user code.
it is returned to user code. This `post_list_datasets` interceptor runs
before the `post_list_datasets_with_metadata` interceptor.
"""
return response

def post_list_datasets_with_metadata(
self,
response: maps_platform_datasets.ListDatasetsResponse,
metadata: Sequence[Tuple[str, Union[str, bytes]]],
) -> Tuple[
maps_platform_datasets.ListDatasetsResponse,
Sequence[Tuple[str, Union[str, bytes]]],
]:
"""Post-rpc interceptor for list_datasets

Override in a subclass to read or manipulate the response or metadata after it
is returned by the MapsPlatformDatasets server but before it is returned to user code.

We recommend only using this `post_list_datasets_with_metadata`
interceptor in new development instead of the `post_list_datasets` interceptor.
When both interceptors are used, this `post_list_datasets_with_metadata` interceptor runs after the
`post_list_datasets` interceptor. The (possibly modified) response returned by
`post_list_datasets` will be passed to
`post_list_datasets_with_metadata`.
"""
return response, metadata

def pre_update_dataset_metadata(
self,
request: maps_platform_datasets.UpdateDatasetMetadataRequest,
Expand All @@ -256,12 +354,35 @@ def post_update_dataset_metadata(
) -> gmm_dataset.Dataset:
"""Post-rpc interceptor for update_dataset_metadata

Override in a subclass to manipulate the response
DEPRECATED. Please use the `post_update_dataset_metadata_with_metadata`
interceptor instead.

Override in a subclass to read or manipulate the response
after it is returned by the MapsPlatformDatasets server but before
it is returned to user code.
it is returned to user code. This `post_update_dataset_metadata` interceptor runs
before the `post_update_dataset_metadata_with_metadata` interceptor.
"""
return response

def post_update_dataset_metadata_with_metadata(
self,
response: gmm_dataset.Dataset,
metadata: Sequence[Tuple[str, Union[str, bytes]]],
) -> Tuple[gmm_dataset.Dataset, Sequence[Tuple[str, Union[str, bytes]]]]:
"""Post-rpc interceptor for update_dataset_metadata

Override in a subclass to read or manipulate the response or metadata after it
is returned by the MapsPlatformDatasets server but before it is returned to user code.

We recommend only using this `post_update_dataset_metadata_with_metadata`
interceptor in new development instead of the `post_update_dataset_metadata` interceptor.
When both interceptors are used, this `post_update_dataset_metadata_with_metadata` interceptor runs after the
`post_update_dataset_metadata` interceptor. The (possibly modified) response returned by
`post_update_dataset_metadata` will be passed to
`post_update_dataset_metadata_with_metadata`.
"""
return response, metadata


@dataclasses.dataclass
class MapsPlatformDatasetsRestStub:
Expand Down Expand Up @@ -475,6 +596,10 @@ def __call__(
json_format.Parse(response.content, pb_resp, ignore_unknown_fields=True)

resp = self._interceptor.post_create_dataset(resp)
response_metadata = [(k, str(v)) for k, v in response.headers.items()]
resp, _ = self._interceptor.post_create_dataset_with_metadata(
resp, response_metadata
)
if CLIENT_LOGGING_SUPPORTED and _LOGGER.isEnabledFor(
logging.DEBUG
): # pragma: NO COVER
Expand Down Expand Up @@ -730,6 +855,10 @@ def __call__(
json_format.Parse(response.content, pb_resp, ignore_unknown_fields=True)

resp = self._interceptor.post_fetch_dataset_errors(resp)
response_metadata = [(k, str(v)) for k, v in response.headers.items()]
resp, _ = self._interceptor.post_fetch_dataset_errors_with_metadata(
resp, response_metadata
)
if CLIENT_LOGGING_SUPPORTED and _LOGGER.isEnabledFor(
logging.DEBUG
): # pragma: NO COVER
Expand Down Expand Up @@ -877,6 +1006,10 @@ def __call__(
json_format.Parse(response.content, pb_resp, ignore_unknown_fields=True)

resp = self._interceptor.post_get_dataset(resp)
response_metadata = [(k, str(v)) for k, v in response.headers.items()]
resp, _ = self._interceptor.post_get_dataset_with_metadata(
resp, response_metadata
)
if CLIENT_LOGGING_SUPPORTED and _LOGGER.isEnabledFor(
logging.DEBUG
): # pragma: NO COVER
Expand Down Expand Up @@ -1019,6 +1152,10 @@ def __call__(
json_format.Parse(response.content, pb_resp, ignore_unknown_fields=True)

resp = self._interceptor.post_list_datasets(resp)
response_metadata = [(k, str(v)) for k, v in response.headers.items()]
resp, _ = self._interceptor.post_list_datasets_with_metadata(
resp, response_metadata
)
if CLIENT_LOGGING_SUPPORTED and _LOGGER.isEnabledFor(
logging.DEBUG
): # pragma: NO COVER
Expand Down Expand Up @@ -1175,6 +1312,10 @@ def __call__(
json_format.Parse(response.content, pb_resp, ignore_unknown_fields=True)

resp = self._interceptor.post_update_dataset_metadata(resp)
response_metadata = [(k, str(v)) for k, v in response.headers.items()]
resp, _ = self._interceptor.post_update_dataset_metadata_with_metadata(
resp, response_metadata
)
if CLIENT_LOGGING_SUPPORTED and _LOGGER.isEnabledFor(
logging.DEBUG
): # pragma: NO COVER
Expand Down
Loading