From 5df0cf1696c5908faa079ae702d6da4c36bd3f72 Mon Sep 17 00:00:00 2001 From: "gcf-owl-bot[bot]" <78513119+gcf-owl-bot[bot]@users.noreply.github.com> Date: Thu, 7 Oct 2021 00:36:23 +0000 Subject: [PATCH] feat: add context manager support in client (#93) - [ ] Regenerate this pull request now. chore: fix docstring for first attribute of protos committer: @busunkim96 PiperOrigin-RevId: 401271153 Source-Link: https://github.com/googleapis/googleapis/commit/787f8c9a731f44e74a90b9847d48659ca9462d10 Source-Link: https://github.com/googleapis/googleapis-gen/commit/81decffe9fc72396a8153e756d1d67a6eecfd620 Copy-Tag: eyJwIjoiLmdpdGh1Yi8uT3dsQm90LnlhbWwiLCJoIjoiODFkZWNmZmU5ZmM3MjM5NmE4MTUzZTc1NmQxZDY3YTZlZWNmZDYyMCJ9 --- .../services/catalog_service/async_client.py | 6 +++ .../services/catalog_service/client.py | 18 +++++-- .../catalog_service/transports/base.py | 9 ++++ .../catalog_service/transports/grpc.py | 3 ++ .../transports/grpc_asyncio.py | 3 ++ .../async_client.py | 6 +++ .../prediction_api_key_registry/client.py | 18 +++++-- .../transports/base.py | 9 ++++ .../transports/grpc.py | 3 ++ .../transports/grpc_asyncio.py | 3 ++ .../prediction_service/async_client.py | 6 +++ .../services/prediction_service/client.py | 18 +++++-- .../prediction_service/transports/base.py | 9 ++++ .../prediction_service/transports/grpc.py | 3 ++ .../transports/grpc_asyncio.py | 3 ++ .../user_event_service/async_client.py | 6 +++ .../services/user_event_service/client.py | 18 +++++-- .../user_event_service/transports/base.py | 9 ++++ .../user_event_service/transports/grpc.py | 3 ++ .../transports/grpc_asyncio.py | 3 ++ .../types/catalog.py | 3 ++ .../types/catalog_service.py | 6 +++ .../types/common.py | 2 + .../types/import_.py | 4 ++ .../prediction_apikey_registry_service.py | 4 ++ .../types/prediction_service.py | 2 + .../types/user_event.py | 4 ++ .../types/user_event_service.py | 5 ++ .../test_catalog_service.py | 50 +++++++++++++++++++ .../test_prediction_api_key_registry.py | 50 +++++++++++++++++++ .../test_prediction_service.py | 50 +++++++++++++++++++ .../test_user_event_service.py | 50 +++++++++++++++++++ 32 files changed, 370 insertions(+), 16 deletions(-) diff --git a/google/cloud/recommendationengine_v1beta1/services/catalog_service/async_client.py b/google/cloud/recommendationengine_v1beta1/services/catalog_service/async_client.py index 3b3bb449..565df1b1 100644 --- a/google/cloud/recommendationengine_v1beta1/services/catalog_service/async_client.py +++ b/google/cloud/recommendationengine_v1beta1/services/catalog_service/async_client.py @@ -751,6 +751,12 @@ async def import_catalog_items( # Done; return the response. return response + async def __aenter__(self): + return self + + async def __aexit__(self, exc_type, exc, tb): + await self.transport.close() + try: DEFAULT_CLIENT_INFO = gapic_v1.client_info.ClientInfo( diff --git a/google/cloud/recommendationengine_v1beta1/services/catalog_service/client.py b/google/cloud/recommendationengine_v1beta1/services/catalog_service/client.py index 09cde147..6ee71e58 100644 --- a/google/cloud/recommendationengine_v1beta1/services/catalog_service/client.py +++ b/google/cloud/recommendationengine_v1beta1/services/catalog_service/client.py @@ -352,10 +352,7 @@ def __init__( client_cert_source_for_mtls=client_cert_source_func, quota_project_id=client_options.quota_project_id, client_info=client_info, - always_use_jwt_access=( - Transport == type(self).get_transport_class("grpc") - or Transport == type(self).get_transport_class("grpc_asyncio") - ), + always_use_jwt_access=True, ) def create_catalog_item( @@ -879,6 +876,19 @@ def import_catalog_items( # Done; return the response. return response + def __enter__(self): + return self + + def __exit__(self, type, value, traceback): + """Releases underlying transport's resources. + + .. warning:: + ONLY use as a context manager if the transport is NOT shared + with other clients! Exiting the with block will CLOSE the transport + and may cause errors in other clients! + """ + self.transport.close() + try: DEFAULT_CLIENT_INFO = gapic_v1.client_info.ClientInfo( diff --git a/google/cloud/recommendationengine_v1beta1/services/catalog_service/transports/base.py b/google/cloud/recommendationengine_v1beta1/services/catalog_service/transports/base.py index aba97928..666c571e 100644 --- a/google/cloud/recommendationengine_v1beta1/services/catalog_service/transports/base.py +++ b/google/cloud/recommendationengine_v1beta1/services/catalog_service/transports/base.py @@ -251,6 +251,15 @@ def _prep_wrapped_messages(self, client_info): ), } + def close(self): + """Closes resources associated with the transport. + + .. warning:: + Only call this method if the transport is NOT shared + with other clients - this may cause errors in other clients! + """ + raise NotImplementedError() + @property def operations_client(self) -> operations_v1.OperationsClient: """Return the client designed to process long-running operations.""" diff --git a/google/cloud/recommendationengine_v1beta1/services/catalog_service/transports/grpc.py b/google/cloud/recommendationengine_v1beta1/services/catalog_service/transports/grpc.py index 0f6a96d1..2727df13 100644 --- a/google/cloud/recommendationengine_v1beta1/services/catalog_service/transports/grpc.py +++ b/google/cloud/recommendationengine_v1beta1/services/catalog_service/transports/grpc.py @@ -412,5 +412,8 @@ def import_catalog_items( ) return self._stubs["import_catalog_items"] + def close(self): + self.grpc_channel.close() + __all__ = ("CatalogServiceGrpcTransport",) diff --git a/google/cloud/recommendationengine_v1beta1/services/catalog_service/transports/grpc_asyncio.py b/google/cloud/recommendationengine_v1beta1/services/catalog_service/transports/grpc_asyncio.py index b5bfe539..4c0a19f8 100644 --- a/google/cloud/recommendationengine_v1beta1/services/catalog_service/transports/grpc_asyncio.py +++ b/google/cloud/recommendationengine_v1beta1/services/catalog_service/transports/grpc_asyncio.py @@ -427,5 +427,8 @@ def import_catalog_items( ) return self._stubs["import_catalog_items"] + def close(self): + return self.grpc_channel.close() + __all__ = ("CatalogServiceGrpcAsyncIOTransport",) diff --git a/google/cloud/recommendationengine_v1beta1/services/prediction_api_key_registry/async_client.py b/google/cloud/recommendationengine_v1beta1/services/prediction_api_key_registry/async_client.py index f955d504..d290efa4 100644 --- a/google/cloud/recommendationengine_v1beta1/services/prediction_api_key_registry/async_client.py +++ b/google/cloud/recommendationengine_v1beta1/services/prediction_api_key_registry/async_client.py @@ -445,6 +445,12 @@ async def delete_prediction_api_key_registration( request, retry=retry, timeout=timeout, metadata=metadata, ) + async def __aenter__(self): + return self + + async def __aexit__(self, exc_type, exc, tb): + await self.transport.close() + try: DEFAULT_CLIENT_INFO = gapic_v1.client_info.ClientInfo( diff --git a/google/cloud/recommendationengine_v1beta1/services/prediction_api_key_registry/client.py b/google/cloud/recommendationengine_v1beta1/services/prediction_api_key_registry/client.py index ecbcc4ae..82580462 100644 --- a/google/cloud/recommendationengine_v1beta1/services/prediction_api_key_registry/client.py +++ b/google/cloud/recommendationengine_v1beta1/services/prediction_api_key_registry/client.py @@ -387,10 +387,7 @@ def __init__( client_cert_source_for_mtls=client_cert_source_func, quota_project_id=client_options.quota_project_id, client_info=client_info, - always_use_jwt_access=( - Transport == type(self).get_transport_class("grpc") - or Transport == type(self).get_transport_class("grpc_asyncio") - ), + always_use_jwt_access=True, ) def create_prediction_api_key_registration( @@ -650,6 +647,19 @@ def delete_prediction_api_key_registration( request, retry=retry, timeout=timeout, metadata=metadata, ) + def __enter__(self): + return self + + def __exit__(self, type, value, traceback): + """Releases underlying transport's resources. + + .. warning:: + ONLY use as a context manager if the transport is NOT shared + with other clients! Exiting the with block will CLOSE the transport + and may cause errors in other clients! + """ + self.transport.close() + try: DEFAULT_CLIENT_INFO = gapic_v1.client_info.ClientInfo( diff --git a/google/cloud/recommendationengine_v1beta1/services/prediction_api_key_registry/transports/base.py b/google/cloud/recommendationengine_v1beta1/services/prediction_api_key_registry/transports/base.py index fdecd78c..0495282d 100644 --- a/google/cloud/recommendationengine_v1beta1/services/prediction_api_key_registry/transports/base.py +++ b/google/cloud/recommendationengine_v1beta1/services/prediction_api_key_registry/transports/base.py @@ -204,6 +204,15 @@ def _prep_wrapped_messages(self, client_info): ), } + def close(self): + """Closes resources associated with the transport. + + .. warning:: + Only call this method if the transport is NOT shared + with other clients - this may cause errors in other clients! + """ + raise NotImplementedError() + @property def create_prediction_api_key_registration( self, diff --git a/google/cloud/recommendationengine_v1beta1/services/prediction_api_key_registry/transports/grpc.py b/google/cloud/recommendationengine_v1beta1/services/prediction_api_key_registry/transports/grpc.py index ce696ccc..9f1e15e4 100644 --- a/google/cloud/recommendationengine_v1beta1/services/prediction_api_key_registry/transports/grpc.py +++ b/google/cloud/recommendationengine_v1beta1/services/prediction_api_key_registry/transports/grpc.py @@ -330,5 +330,8 @@ def delete_prediction_api_key_registration( ) return self._stubs["delete_prediction_api_key_registration"] + def close(self): + self.grpc_channel.close() + __all__ = ("PredictionApiKeyRegistryGrpcTransport",) diff --git a/google/cloud/recommendationengine_v1beta1/services/prediction_api_key_registry/transports/grpc_asyncio.py b/google/cloud/recommendationengine_v1beta1/services/prediction_api_key_registry/transports/grpc_asyncio.py index 81bec6b7..d4322306 100644 --- a/google/cloud/recommendationengine_v1beta1/services/prediction_api_key_registry/transports/grpc_asyncio.py +++ b/google/cloud/recommendationengine_v1beta1/services/prediction_api_key_registry/transports/grpc_asyncio.py @@ -335,5 +335,8 @@ def delete_prediction_api_key_registration( ) return self._stubs["delete_prediction_api_key_registration"] + def close(self): + return self.grpc_channel.close() + __all__ = ("PredictionApiKeyRegistryGrpcAsyncIOTransport",) diff --git a/google/cloud/recommendationengine_v1beta1/services/prediction_service/async_client.py b/google/cloud/recommendationengine_v1beta1/services/prediction_service/async_client.py index 25ad2792..ab12b374 100644 --- a/google/cloud/recommendationengine_v1beta1/services/prediction_service/async_client.py +++ b/google/cloud/recommendationengine_v1beta1/services/prediction_service/async_client.py @@ -304,6 +304,12 @@ async def predict( # Done; return the response. return response + async def __aenter__(self): + return self + + async def __aexit__(self, exc_type, exc, tb): + await self.transport.close() + try: DEFAULT_CLIENT_INFO = gapic_v1.client_info.ClientInfo( diff --git a/google/cloud/recommendationengine_v1beta1/services/prediction_service/client.py b/google/cloud/recommendationengine_v1beta1/services/prediction_service/client.py index fee4948e..9d9f27ec 100644 --- a/google/cloud/recommendationengine_v1beta1/services/prediction_service/client.py +++ b/google/cloud/recommendationengine_v1beta1/services/prediction_service/client.py @@ -353,10 +353,7 @@ def __init__( client_cert_source_for_mtls=client_cert_source_func, quota_project_id=client_options.quota_project_id, client_info=client_info, - always_use_jwt_access=( - Transport == type(self).get_transport_class("grpc") - or Transport == type(self).get_transport_class("grpc_asyncio") - ), + always_use_jwt_access=True, ) def predict( @@ -491,6 +488,19 @@ def predict( # Done; return the response. return response + def __enter__(self): + return self + + def __exit__(self, type, value, traceback): + """Releases underlying transport's resources. + + .. warning:: + ONLY use as a context manager if the transport is NOT shared + with other clients! Exiting the with block will CLOSE the transport + and may cause errors in other clients! + """ + self.transport.close() + try: DEFAULT_CLIENT_INFO = gapic_v1.client_info.ClientInfo( diff --git a/google/cloud/recommendationengine_v1beta1/services/prediction_service/transports/base.py b/google/cloud/recommendationengine_v1beta1/services/prediction_service/transports/base.py index 61068e86..ddeccec0 100644 --- a/google/cloud/recommendationengine_v1beta1/services/prediction_service/transports/base.py +++ b/google/cloud/recommendationengine_v1beta1/services/prediction_service/transports/base.py @@ -171,6 +171,15 @@ def _prep_wrapped_messages(self, client_info): ), } + def close(self): + """Closes resources associated with the transport. + + .. warning:: + Only call this method if the transport is NOT shared + with other clients - this may cause errors in other clients! + """ + raise NotImplementedError() + @property def predict( self, diff --git a/google/cloud/recommendationengine_v1beta1/services/prediction_service/transports/grpc.py b/google/cloud/recommendationengine_v1beta1/services/prediction_service/transports/grpc.py index fa9d8335..3f6fb665 100644 --- a/google/cloud/recommendationengine_v1beta1/services/prediction_service/transports/grpc.py +++ b/google/cloud/recommendationengine_v1beta1/services/prediction_service/transports/grpc.py @@ -257,5 +257,8 @@ def predict( ) return self._stubs["predict"] + def close(self): + self.grpc_channel.close() + __all__ = ("PredictionServiceGrpcTransport",) diff --git a/google/cloud/recommendationengine_v1beta1/services/prediction_service/transports/grpc_asyncio.py b/google/cloud/recommendationengine_v1beta1/services/prediction_service/transports/grpc_asyncio.py index f290c6cb..8993ac35 100644 --- a/google/cloud/recommendationengine_v1beta1/services/prediction_service/transports/grpc_asyncio.py +++ b/google/cloud/recommendationengine_v1beta1/services/prediction_service/transports/grpc_asyncio.py @@ -261,5 +261,8 @@ def predict( ) return self._stubs["predict"] + def close(self): + return self.grpc_channel.close() + __all__ = ("PredictionServiceGrpcAsyncIOTransport",) diff --git a/google/cloud/recommendationengine_v1beta1/services/user_event_service/async_client.py b/google/cloud/recommendationengine_v1beta1/services/user_event_service/async_client.py index bbb39b17..c6d7d4d7 100644 --- a/google/cloud/recommendationengine_v1beta1/services/user_event_service/async_client.py +++ b/google/cloud/recommendationengine_v1beta1/services/user_event_service/async_client.py @@ -837,6 +837,12 @@ async def import_user_events( # Done; return the response. return response + async def __aenter__(self): + return self + + async def __aexit__(self, exc_type, exc, tb): + await self.transport.close() + try: DEFAULT_CLIENT_INFO = gapic_v1.client_info.ClientInfo( diff --git a/google/cloud/recommendationengine_v1beta1/services/user_event_service/client.py b/google/cloud/recommendationengine_v1beta1/services/user_event_service/client.py index 4f0726a0..59a7e45f 100644 --- a/google/cloud/recommendationengine_v1beta1/services/user_event_service/client.py +++ b/google/cloud/recommendationengine_v1beta1/services/user_event_service/client.py @@ -359,10 +359,7 @@ def __init__( client_cert_source_for_mtls=client_cert_source_func, quota_project_id=client_options.quota_project_id, client_info=client_info, - always_use_jwt_access=( - Transport == type(self).get_transport_class("grpc") - or Transport == type(self).get_transport_class("grpc_asyncio") - ), + always_use_jwt_access=True, ) def write_user_event( @@ -981,6 +978,19 @@ def import_user_events( # Done; return the response. return response + def __enter__(self): + return self + + def __exit__(self, type, value, traceback): + """Releases underlying transport's resources. + + .. warning:: + ONLY use as a context manager if the transport is NOT shared + with other clients! Exiting the with block will CLOSE the transport + and may cause errors in other clients! + """ + self.transport.close() + try: DEFAULT_CLIENT_INFO = gapic_v1.client_info.ClientInfo( diff --git a/google/cloud/recommendationengine_v1beta1/services/user_event_service/transports/base.py b/google/cloud/recommendationengine_v1beta1/services/user_event_service/transports/base.py index 401b0e7d..08dc3f76 100644 --- a/google/cloud/recommendationengine_v1beta1/services/user_event_service/transports/base.py +++ b/google/cloud/recommendationengine_v1beta1/services/user_event_service/transports/base.py @@ -236,6 +236,15 @@ def _prep_wrapped_messages(self, client_info): ), } + def close(self): + """Closes resources associated with the transport. + + .. warning:: + Only call this method if the transport is NOT shared + with other clients - this may cause errors in other clients! + """ + raise NotImplementedError() + @property def operations_client(self) -> operations_v1.OperationsClient: """Return the client designed to process long-running operations.""" diff --git a/google/cloud/recommendationengine_v1beta1/services/user_event_service/transports/grpc.py b/google/cloud/recommendationengine_v1beta1/services/user_event_service/transports/grpc.py index 383800b2..8eb9cccc 100644 --- a/google/cloud/recommendationengine_v1beta1/services/user_event_service/transports/grpc.py +++ b/google/cloud/recommendationengine_v1beta1/services/user_event_service/transports/grpc.py @@ -397,5 +397,8 @@ def import_user_events( ) return self._stubs["import_user_events"] + def close(self): + self.grpc_channel.close() + __all__ = ("UserEventServiceGrpcTransport",) diff --git a/google/cloud/recommendationengine_v1beta1/services/user_event_service/transports/grpc_asyncio.py b/google/cloud/recommendationengine_v1beta1/services/user_event_service/transports/grpc_asyncio.py index 03441e44..93426387 100644 --- a/google/cloud/recommendationengine_v1beta1/services/user_event_service/transports/grpc_asyncio.py +++ b/google/cloud/recommendationengine_v1beta1/services/user_event_service/transports/grpc_asyncio.py @@ -408,5 +408,8 @@ def import_user_events( ) return self._stubs["import_user_events"] + def close(self): + return self.grpc_channel.close() + __all__ = ("UserEventServiceGrpcAsyncIOTransport",) diff --git a/google/cloud/recommendationengine_v1beta1/types/catalog.py b/google/cloud/recommendationengine_v1beta1/types/catalog.py index 31813d64..5638397e 100644 --- a/google/cloud/recommendationengine_v1beta1/types/catalog.py +++ b/google/cloud/recommendationengine_v1beta1/types/catalog.py @@ -92,6 +92,7 @@ class CatalogItem(proto.Message): class CategoryHierarchy(proto.Message): r"""Category represents catalog item category hierarchy. + Attributes: categories (Sequence[str]): Required. Catalog item categories. Each @@ -172,6 +173,7 @@ class StockState(proto.Enum): class ExactPrice(proto.Message): r"""Exact product price. + Attributes: display_price (float): Optional. Display price of the product. @@ -214,6 +216,7 @@ class PriceRange(proto.Message): class Image(proto.Message): r"""Catalog item thumbnail/detail image. + Attributes: uri (str): Required. URL of the image with a length diff --git a/google/cloud/recommendationengine_v1beta1/types/catalog_service.py b/google/cloud/recommendationengine_v1beta1/types/catalog_service.py index 86da784d..1e783e55 100644 --- a/google/cloud/recommendationengine_v1beta1/types/catalog_service.py +++ b/google/cloud/recommendationengine_v1beta1/types/catalog_service.py @@ -34,6 +34,7 @@ class CreateCatalogItemRequest(proto.Message): r"""Request message for CreateCatalogItem method. + Attributes: parent (str): Required. The parent catalog resource name, such as @@ -48,6 +49,7 @@ class CreateCatalogItemRequest(proto.Message): class GetCatalogItemRequest(proto.Message): r"""Request message for GetCatalogItem method. + Attributes: name (str): Required. Full resource name of catalog item, such as @@ -59,6 +61,7 @@ class GetCatalogItemRequest(proto.Message): class ListCatalogItemsRequest(proto.Message): r"""Request message for ListCatalogItems method. + Attributes: parent (str): Required. The parent catalog resource name, such as @@ -83,6 +86,7 @@ class ListCatalogItemsRequest(proto.Message): class ListCatalogItemsResponse(proto.Message): r"""Response message for ListCatalogItems method. + Attributes: catalog_items (Sequence[google.cloud.recommendationengine_v1beta1.types.CatalogItem]): The catalog items. @@ -104,6 +108,7 @@ def raw_page(self): class UpdateCatalogItemRequest(proto.Message): r"""Request message for UpdateCatalogItem method. + Attributes: name (str): Required. Full resource name of catalog item, such as @@ -126,6 +131,7 @@ class UpdateCatalogItemRequest(proto.Message): class DeleteCatalogItemRequest(proto.Message): r"""Request message for DeleteCatalogItem method. + Attributes: name (str): Required. Full resource name of catalog item, such as diff --git a/google/cloud/recommendationengine_v1beta1/types/common.py b/google/cloud/recommendationengine_v1beta1/types/common.py index fa8964d8..2adbf290 100644 --- a/google/cloud/recommendationengine_v1beta1/types/common.py +++ b/google/cloud/recommendationengine_v1beta1/types/common.py @@ -48,6 +48,7 @@ class FeatureMap(proto.Message): class StringList(proto.Message): r"""A list of string features. + Attributes: value (Sequence[str]): String feature value with a length limit of @@ -58,6 +59,7 @@ class StringList(proto.Message): class FloatList(proto.Message): r"""A list of float features. + Attributes: value (Sequence[float]): Float feature value. diff --git a/google/cloud/recommendationengine_v1beta1/types/import_.py b/google/cloud/recommendationengine_v1beta1/types/import_.py index bb19a7bd..6b6cb763 100644 --- a/google/cloud/recommendationengine_v1beta1/types/import_.py +++ b/google/cloud/recommendationengine_v1beta1/types/import_.py @@ -91,6 +91,7 @@ class UserEventInlineSource(proto.Message): class ImportErrorsConfig(proto.Message): r"""Configuration of destination for Import related errors. + Attributes: gcs_prefix (str): Google Cloud Storage path for import errors. This must be an @@ -104,6 +105,7 @@ class ImportErrorsConfig(proto.Message): class ImportCatalogItemsRequest(proto.Message): r"""Request message for Import methods. + Attributes: parent (str): Required. @@ -132,6 +134,7 @@ class ImportCatalogItemsRequest(proto.Message): class ImportUserEventsRequest(proto.Message): r"""Request message for the ImportUserEvents request. + Attributes: parent (str): Required. @@ -160,6 +163,7 @@ class ImportUserEventsRequest(proto.Message): class InputConfig(proto.Message): r"""The input config source. + Attributes: catalog_inline_source (google.cloud.recommendationengine_v1beta1.types.CatalogInlineSource): The Inline source for the input content for diff --git a/google/cloud/recommendationengine_v1beta1/types/prediction_apikey_registry_service.py b/google/cloud/recommendationengine_v1beta1/types/prediction_apikey_registry_service.py index 94dc44fa..1acea0a9 100644 --- a/google/cloud/recommendationengine_v1beta1/types/prediction_apikey_registry_service.py +++ b/google/cloud/recommendationengine_v1beta1/types/prediction_apikey_registry_service.py @@ -30,6 +30,7 @@ class PredictionApiKeyRegistration(proto.Message): r"""Registered Api Key. + Attributes: api_key (str): The API key. @@ -59,6 +60,7 @@ class CreatePredictionApiKeyRegistrationRequest(proto.Message): class ListPredictionApiKeyRegistrationsRequest(proto.Message): r"""Request message for the ``ListPredictionApiKeyRegistrations``. + Attributes: parent (str): Required. The parent placement resource name such as @@ -79,6 +81,7 @@ class ListPredictionApiKeyRegistrationsRequest(proto.Message): class ListPredictionApiKeyRegistrationsResponse(proto.Message): r"""Response message for the ``ListPredictionApiKeyRegistrations``. + Attributes: prediction_api_key_registrations (Sequence[google.cloud.recommendationengine_v1beta1.types.PredictionApiKeyRegistration]): The list of registered API keys. @@ -100,6 +103,7 @@ def raw_page(self): class DeletePredictionApiKeyRegistrationRequest(proto.Message): r"""Request message for ``DeletePredictionApiKeyRegistration`` method. + Attributes: name (str): Required. The API key to unregister including full resource diff --git a/google/cloud/recommendationengine_v1beta1/types/prediction_service.py b/google/cloud/recommendationengine_v1beta1/types/prediction_service.py index 2402b138..5ffa0f11 100644 --- a/google/cloud/recommendationengine_v1beta1/types/prediction_service.py +++ b/google/cloud/recommendationengine_v1beta1/types/prediction_service.py @@ -27,6 +27,7 @@ class PredictRequest(proto.Message): r"""Request message for Predict method. + Attributes: name (str): Required. Full resource name of the format: @@ -151,6 +152,7 @@ class PredictRequest(proto.Message): class PredictResponse(proto.Message): r"""Response message for predict method. + Attributes: results (Sequence[google.cloud.recommendationengine_v1beta1.types.PredictResponse.PredictionResult]): A list of recommended items. The order diff --git a/google/cloud/recommendationengine_v1beta1/types/user_event.py b/google/cloud/recommendationengine_v1beta1/types/user_event.py index 164c3061..bb913090 100644 --- a/google/cloud/recommendationengine_v1beta1/types/user_event.py +++ b/google/cloud/recommendationengine_v1beta1/types/user_event.py @@ -119,6 +119,7 @@ class EventSource(proto.Enum): class UserInfo(proto.Message): r"""Information of end users. + Attributes: visitor_id (str): Required. A unique identifier for tracking @@ -166,6 +167,7 @@ class UserInfo(proto.Message): class EventDetail(proto.Message): r"""User event details shared by all recommendation types. + Attributes: uri (str): Optional. Complete url (window.location.href) @@ -306,6 +308,7 @@ class ProductEventDetail(proto.Message): class PurchaseTransaction(proto.Message): r"""A transaction represents the entire purchase transaction. + Attributes: id (str): Optional. The transaction ID with a length @@ -345,6 +348,7 @@ class PurchaseTransaction(proto.Message): class ProductDetail(proto.Message): r"""Detailed product information associated with a user event. + Attributes: id (str): Required. Catalog item ID. UTF-8 encoded diff --git a/google/cloud/recommendationengine_v1beta1/types/user_event_service.py b/google/cloud/recommendationengine_v1beta1/types/user_event_service.py index 717f76d3..05b14d11 100644 --- a/google/cloud/recommendationengine_v1beta1/types/user_event_service.py +++ b/google/cloud/recommendationengine_v1beta1/types/user_event_service.py @@ -35,6 +35,7 @@ class PurgeUserEventsRequest(proto.Message): r"""Request message for PurgeUserEvents method. + Attributes: parent (str): Required. The resource name of the event_store under which @@ -111,6 +112,7 @@ class PurgeUserEventsResponse(proto.Message): class WriteUserEventRequest(proto.Message): r"""Request message for WriteUserEvent method. + Attributes: parent (str): Required. The parent eventStore resource name, such as @@ -125,6 +127,7 @@ class WriteUserEventRequest(proto.Message): class CollectUserEventRequest(proto.Message): r"""Request message for CollectUserEvent method. + Attributes: parent (str): Required. The parent eventStore name, such as @@ -153,6 +156,7 @@ class CollectUserEventRequest(proto.Message): class ListUserEventsRequest(proto.Message): r"""Request message for ListUserEvents method. + Attributes: parent (str): Required. The parent eventStore resource name, such as @@ -211,6 +215,7 @@ class ListUserEventsRequest(proto.Message): class ListUserEventsResponse(proto.Message): r"""Response message for ListUserEvents method. + Attributes: user_events (Sequence[google.cloud.recommendationengine_v1beta1.types.UserEvent]): The user events. diff --git a/tests/unit/gapic/recommendationengine_v1beta1/test_catalog_service.py b/tests/unit/gapic/recommendationengine_v1beta1/test_catalog_service.py index de507feb..b9842bc2 100644 --- a/tests/unit/gapic/recommendationengine_v1beta1/test_catalog_service.py +++ b/tests/unit/gapic/recommendationengine_v1beta1/test_catalog_service.py @@ -32,6 +32,7 @@ from google.api_core import grpc_helpers_async from google.api_core import operation_async # type: ignore from google.api_core import operations_v1 +from google.api_core import path_template from google.auth import credentials as ga_credentials from google.auth.exceptions import MutualTLSChannelError from google.cloud.recommendationengine_v1beta1.services.catalog_service import ( @@ -2211,6 +2212,9 @@ def test_catalog_service_base_transport(): with pytest.raises(NotImplementedError): getattr(transport, method)(request=object()) + with pytest.raises(NotImplementedError): + transport.close() + # Additionally, the LRO client (a property) should # also raise NotImplementedError with pytest.raises(NotImplementedError): @@ -2724,3 +2728,49 @@ def test_client_withDEFAULT_CLIENT_INFO(): credentials=ga_credentials.AnonymousCredentials(), client_info=client_info, ) prep.assert_called_once_with(client_info) + + +@pytest.mark.asyncio +async def test_transport_close_async(): + client = CatalogServiceAsyncClient( + credentials=ga_credentials.AnonymousCredentials(), transport="grpc_asyncio", + ) + with mock.patch.object( + type(getattr(client.transport, "grpc_channel")), "close" + ) as close: + async with client: + close.assert_not_called() + close.assert_called_once() + + +def test_transport_close(): + transports = { + "grpc": "_grpc_channel", + } + + for transport, close_name in transports.items(): + client = CatalogServiceClient( + credentials=ga_credentials.AnonymousCredentials(), transport=transport + ) + with mock.patch.object( + type(getattr(client.transport, close_name)), "close" + ) as close: + with client: + close.assert_not_called() + close.assert_called_once() + + +def test_client_ctx(): + transports = [ + "grpc", + ] + for transport in transports: + client = CatalogServiceClient( + credentials=ga_credentials.AnonymousCredentials(), transport=transport + ) + # Test client calls underlying transport. + with mock.patch.object(type(client.transport), "close") as close: + close.assert_not_called() + with client: + pass + close.assert_called() diff --git a/tests/unit/gapic/recommendationengine_v1beta1/test_prediction_api_key_registry.py b/tests/unit/gapic/recommendationengine_v1beta1/test_prediction_api_key_registry.py index 91345c62..d9ba858c 100644 --- a/tests/unit/gapic/recommendationengine_v1beta1/test_prediction_api_key_registry.py +++ b/tests/unit/gapic/recommendationengine_v1beta1/test_prediction_api_key_registry.py @@ -29,6 +29,7 @@ from google.api_core import gapic_v1 from google.api_core import grpc_helpers from google.api_core import grpc_helpers_async +from google.api_core import path_template from google.auth import credentials as ga_credentials from google.auth.exceptions import MutualTLSChannelError from google.cloud.recommendationengine_v1beta1.services.prediction_api_key_registry import ( @@ -1603,6 +1604,9 @@ def test_prediction_api_key_registry_base_transport(): with pytest.raises(NotImplementedError): getattr(transport, method)(request=object()) + with pytest.raises(NotImplementedError): + transport.close() + @requires_google_auth_gte_1_25_0 def test_prediction_api_key_registry_base_transport_with_credentials_file(): @@ -2133,3 +2137,49 @@ def test_client_withDEFAULT_CLIENT_INFO(): credentials=ga_credentials.AnonymousCredentials(), client_info=client_info, ) prep.assert_called_once_with(client_info) + + +@pytest.mark.asyncio +async def test_transport_close_async(): + client = PredictionApiKeyRegistryAsyncClient( + credentials=ga_credentials.AnonymousCredentials(), transport="grpc_asyncio", + ) + with mock.patch.object( + type(getattr(client.transport, "grpc_channel")), "close" + ) as close: + async with client: + close.assert_not_called() + close.assert_called_once() + + +def test_transport_close(): + transports = { + "grpc": "_grpc_channel", + } + + for transport, close_name in transports.items(): + client = PredictionApiKeyRegistryClient( + credentials=ga_credentials.AnonymousCredentials(), transport=transport + ) + with mock.patch.object( + type(getattr(client.transport, close_name)), "close" + ) as close: + with client: + close.assert_not_called() + close.assert_called_once() + + +def test_client_ctx(): + transports = [ + "grpc", + ] + for transport in transports: + client = PredictionApiKeyRegistryClient( + credentials=ga_credentials.AnonymousCredentials(), transport=transport + ) + # Test client calls underlying transport. + with mock.patch.object(type(client.transport), "close") as close: + close.assert_not_called() + with client: + pass + close.assert_called() diff --git a/tests/unit/gapic/recommendationengine_v1beta1/test_prediction_service.py b/tests/unit/gapic/recommendationengine_v1beta1/test_prediction_service.py index 13d2384b..a5256164 100644 --- a/tests/unit/gapic/recommendationengine_v1beta1/test_prediction_service.py +++ b/tests/unit/gapic/recommendationengine_v1beta1/test_prediction_service.py @@ -29,6 +29,7 @@ from google.api_core import gapic_v1 from google.api_core import grpc_helpers from google.api_core import grpc_helpers_async +from google.api_core import path_template from google.auth import credentials as ga_credentials from google.auth.exceptions import MutualTLSChannelError from google.cloud.recommendationengine_v1beta1.services.prediction_service import ( @@ -1015,6 +1016,9 @@ def test_prediction_service_base_transport(): with pytest.raises(NotImplementedError): getattr(transport, method)(request=object()) + with pytest.raises(NotImplementedError): + transport.close() + @requires_google_auth_gte_1_25_0 def test_prediction_service_base_transport_with_credentials_file(): @@ -1507,3 +1511,49 @@ def test_client_withDEFAULT_CLIENT_INFO(): credentials=ga_credentials.AnonymousCredentials(), client_info=client_info, ) prep.assert_called_once_with(client_info) + + +@pytest.mark.asyncio +async def test_transport_close_async(): + client = PredictionServiceAsyncClient( + credentials=ga_credentials.AnonymousCredentials(), transport="grpc_asyncio", + ) + with mock.patch.object( + type(getattr(client.transport, "grpc_channel")), "close" + ) as close: + async with client: + close.assert_not_called() + close.assert_called_once() + + +def test_transport_close(): + transports = { + "grpc": "_grpc_channel", + } + + for transport, close_name in transports.items(): + client = PredictionServiceClient( + credentials=ga_credentials.AnonymousCredentials(), transport=transport + ) + with mock.patch.object( + type(getattr(client.transport, close_name)), "close" + ) as close: + with client: + close.assert_not_called() + close.assert_called_once() + + +def test_client_ctx(): + transports = [ + "grpc", + ] + for transport in transports: + client = PredictionServiceClient( + credentials=ga_credentials.AnonymousCredentials(), transport=transport + ) + # Test client calls underlying transport. + with mock.patch.object(type(client.transport), "close") as close: + close.assert_not_called() + with client: + pass + close.assert_called() diff --git a/tests/unit/gapic/recommendationengine_v1beta1/test_user_event_service.py b/tests/unit/gapic/recommendationengine_v1beta1/test_user_event_service.py index f84f8afb..4bc37c9a 100644 --- a/tests/unit/gapic/recommendationengine_v1beta1/test_user_event_service.py +++ b/tests/unit/gapic/recommendationengine_v1beta1/test_user_event_service.py @@ -33,6 +33,7 @@ from google.api_core import grpc_helpers_async from google.api_core import operation_async # type: ignore from google.api_core import operations_v1 +from google.api_core import path_template from google.auth import credentials as ga_credentials from google.auth.exceptions import MutualTLSChannelError from google.cloud.recommendationengine_v1beta1.services.user_event_service import ( @@ -1964,6 +1965,9 @@ def test_user_event_service_base_transport(): with pytest.raises(NotImplementedError): getattr(transport, method)(request=object()) + with pytest.raises(NotImplementedError): + transport.close() + # Additionally, the LRO client (a property) should # also raise NotImplementedError with pytest.raises(NotImplementedError): @@ -2481,3 +2485,49 @@ def test_client_withDEFAULT_CLIENT_INFO(): credentials=ga_credentials.AnonymousCredentials(), client_info=client_info, ) prep.assert_called_once_with(client_info) + + +@pytest.mark.asyncio +async def test_transport_close_async(): + client = UserEventServiceAsyncClient( + credentials=ga_credentials.AnonymousCredentials(), transport="grpc_asyncio", + ) + with mock.patch.object( + type(getattr(client.transport, "grpc_channel")), "close" + ) as close: + async with client: + close.assert_not_called() + close.assert_called_once() + + +def test_transport_close(): + transports = { + "grpc": "_grpc_channel", + } + + for transport, close_name in transports.items(): + client = UserEventServiceClient( + credentials=ga_credentials.AnonymousCredentials(), transport=transport + ) + with mock.patch.object( + type(getattr(client.transport, close_name)), "close" + ) as close: + with client: + close.assert_not_called() + close.assert_called_once() + + +def test_client_ctx(): + transports = [ + "grpc", + ] + for transport in transports: + client = UserEventServiceClient( + credentials=ga_credentials.AnonymousCredentials(), transport=transport + ) + # Test client calls underlying transport. + with mock.patch.object(type(client.transport), "close") as close: + close.assert_not_called() + with client: + pass + close.assert_called()