From e8f1dc09a5b932f00bc279d8510aa5518d68b98b Mon Sep 17 00:00:00 2001 From: "gcf-owl-bot[bot]" <78513119+gcf-owl-bot[bot]@users.noreply.github.com> Date: Fri, 8 Oct 2021 14:14:34 +0000 Subject: [PATCH] feat: add context manager support in client (#145) - [ ] 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/budget_service/async_client.py | 6 +++ .../services/budget_service/client.py | 18 +++++-- .../budget_service/transports/base.py | 9 ++++ .../budget_service/transports/grpc.py | 3 ++ .../budget_service/transports/grpc_asyncio.py | 3 ++ .../billing/budgets_v1/types/budget_model.py | 4 +- .../budgets_v1/types/budget_service.py | 6 +++ .../services/budget_service/async_client.py | 6 +++ .../services/budget_service/client.py | 18 +++++-- .../budget_service/transports/base.py | 9 ++++ .../budget_service/transports/grpc.py | 3 ++ .../budget_service/transports/grpc_asyncio.py | 3 ++ .../budgets_v1beta1/types/budget_model.py | 4 +- .../budgets_v1beta1/types/budget_service.py | 6 +++ .../gapic/budgets_v1/test_budget_service.py | 50 +++++++++++++++++++ .../budgets_v1beta1/test_budget_service.py | 50 +++++++++++++++++++ 16 files changed, 188 insertions(+), 10 deletions(-) diff --git a/google/cloud/billing/budgets_v1/services/budget_service/async_client.py b/google/cloud/billing/budgets_v1/services/budget_service/async_client.py index 4235193..1164ee0 100644 --- a/google/cloud/billing/budgets_v1/services/budget_service/async_client.py +++ b/google/cloud/billing/budgets_v1/services/budget_service/async_client.py @@ -624,6 +624,12 @@ async def delete_budget( 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/billing/budgets_v1/services/budget_service/client.py b/google/cloud/billing/budgets_v1/services/budget_service/client.py index f406f4c..84a5634 100644 --- a/google/cloud/billing/budgets_v1/services/budget_service/client.py +++ b/google/cloud/billing/budgets_v1/services/budget_service/client.py @@ -346,10 +346,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_budget( @@ -770,6 +767,19 @@ def delete_budget( 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/billing/budgets_v1/services/budget_service/transports/base.py b/google/cloud/billing/budgets_v1/services/budget_service/transports/base.py index 92ddb96..5b41d40 100644 --- a/google/cloud/billing/budgets_v1/services/budget_service/transports/base.py +++ b/google/cloud/billing/budgets_v1/services/budget_service/transports/base.py @@ -224,6 +224,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_budget( self, diff --git a/google/cloud/billing/budgets_v1/services/budget_service/transports/grpc.py b/google/cloud/billing/budgets_v1/services/budget_service/transports/grpc.py index a6c7680..0374942 100644 --- a/google/cloud/billing/budgets_v1/services/budget_service/transports/grpc.py +++ b/google/cloud/billing/budgets_v1/services/budget_service/transports/grpc.py @@ -379,5 +379,8 @@ def delete_budget( ) return self._stubs["delete_budget"] + def close(self): + self.grpc_channel.close() + __all__ = ("BudgetServiceGrpcTransport",) diff --git a/google/cloud/billing/budgets_v1/services/budget_service/transports/grpc_asyncio.py b/google/cloud/billing/budgets_v1/services/budget_service/transports/grpc_asyncio.py index ad826d5..5882e3b 100644 --- a/google/cloud/billing/budgets_v1/services/budget_service/transports/grpc_asyncio.py +++ b/google/cloud/billing/budgets_v1/services/budget_service/transports/grpc_asyncio.py @@ -383,5 +383,8 @@ def delete_budget( ) return self._stubs["delete_budget"] + def close(self): + return self.grpc_channel.close() + __all__ = ("BudgetServiceGrpcAsyncIOTransport",) diff --git a/google/cloud/billing/budgets_v1/types/budget_model.py b/google/cloud/billing/budgets_v1/types/budget_model.py index 3239e10..8e899f0 100644 --- a/google/cloud/billing/budgets_v1/types/budget_model.py +++ b/google/cloud/billing/budgets_v1/types/budget_model.py @@ -101,6 +101,7 @@ class Budget(proto.Message): class BudgetAmount(proto.Message): r"""The budgeted amount for each usage period. + Attributes: specified_amount (google.type.money_pb2.Money): A specified amount to use as the budget. ``currency_code`` @@ -135,7 +136,8 @@ class LastPeriodAmount(proto.Message): configuring a percentage of last period's spend). LastPeriodAmount cannot be set for a budget configured with a [Filter.custom_period][google.cloud.billing.budgets.v1.Filter.custom_period]. - """ + + """ class ThresholdRule(proto.Message): diff --git a/google/cloud/billing/budgets_v1/types/budget_service.py b/google/cloud/billing/budgets_v1/types/budget_service.py index 138511a..0db1437 100644 --- a/google/cloud/billing/budgets_v1/types/budget_service.py +++ b/google/cloud/billing/budgets_v1/types/budget_service.py @@ -34,6 +34,7 @@ class CreateBudgetRequest(proto.Message): r"""Request for CreateBudget + Attributes: parent (str): Required. The name of the billing account to create the @@ -49,6 +50,7 @@ class CreateBudgetRequest(proto.Message): class UpdateBudgetRequest(proto.Message): r"""Request for UpdateBudget + Attributes: budget (google.cloud.billing.budgets_v1.types.Budget): Required. The updated budget object. @@ -71,6 +73,7 @@ class UpdateBudgetRequest(proto.Message): class GetBudgetRequest(proto.Message): r"""Request for GetBudget + Attributes: name (str): Required. Name of budget to get. Values are of the form @@ -82,6 +85,7 @@ class GetBudgetRequest(proto.Message): class ListBudgetsRequest(proto.Message): r"""Request for ListBudgets + Attributes: parent (str): Required. Name of billing account to list budgets under. @@ -105,6 +109,7 @@ class ListBudgetsRequest(proto.Message): class ListBudgetsResponse(proto.Message): r"""Response for ListBudgets + Attributes: budgets (Sequence[google.cloud.billing.budgets_v1.types.Budget]): List of the budgets owned by the requested @@ -125,6 +130,7 @@ def raw_page(self): class DeleteBudgetRequest(proto.Message): r"""Request for DeleteBudget + Attributes: name (str): Required. Name of the budget to delete. Values are of the diff --git a/google/cloud/billing/budgets_v1beta1/services/budget_service/async_client.py b/google/cloud/billing/budgets_v1beta1/services/budget_service/async_client.py index c0cfb5a..34935cd 100644 --- a/google/cloud/billing/budgets_v1beta1/services/budget_service/async_client.py +++ b/google/cloud/billing/budgets_v1beta1/services/budget_service/async_client.py @@ -487,6 +487,12 @@ async def delete_budget( 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/billing/budgets_v1beta1/services/budget_service/client.py b/google/cloud/billing/budgets_v1beta1/services/budget_service/client.py index 1c750be..cc3053d 100644 --- a/google/cloud/billing/budgets_v1beta1/services/budget_service/client.py +++ b/google/cloud/billing/budgets_v1beta1/services/budget_service/client.py @@ -345,10 +345,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_budget( @@ -638,6 +635,19 @@ def delete_budget( 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/billing/budgets_v1beta1/services/budget_service/transports/base.py b/google/cloud/billing/budgets_v1beta1/services/budget_service/transports/base.py index 73490f1..a358aff 100644 --- a/google/cloud/billing/budgets_v1beta1/services/budget_service/transports/base.py +++ b/google/cloud/billing/budgets_v1beta1/services/budget_service/transports/base.py @@ -224,6 +224,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_budget( self, diff --git a/google/cloud/billing/budgets_v1beta1/services/budget_service/transports/grpc.py b/google/cloud/billing/budgets_v1beta1/services/budget_service/transports/grpc.py index 0552480..95a3b45 100644 --- a/google/cloud/billing/budgets_v1beta1/services/budget_service/transports/grpc.py +++ b/google/cloud/billing/budgets_v1beta1/services/budget_service/transports/grpc.py @@ -379,5 +379,8 @@ def delete_budget( ) return self._stubs["delete_budget"] + def close(self): + self.grpc_channel.close() + __all__ = ("BudgetServiceGrpcTransport",) diff --git a/google/cloud/billing/budgets_v1beta1/services/budget_service/transports/grpc_asyncio.py b/google/cloud/billing/budgets_v1beta1/services/budget_service/transports/grpc_asyncio.py index d273d3d..674e5a9 100644 --- a/google/cloud/billing/budgets_v1beta1/services/budget_service/transports/grpc_asyncio.py +++ b/google/cloud/billing/budgets_v1beta1/services/budget_service/transports/grpc_asyncio.py @@ -383,5 +383,8 @@ def delete_budget( ) return self._stubs["delete_budget"] + def close(self): + return self.grpc_channel.close() + __all__ = ("BudgetServiceGrpcAsyncIOTransport",) diff --git a/google/cloud/billing/budgets_v1beta1/types/budget_model.py b/google/cloud/billing/budgets_v1beta1/types/budget_model.py index 894a795..a68f880 100644 --- a/google/cloud/billing/budgets_v1beta1/types/budget_model.py +++ b/google/cloud/billing/budgets_v1beta1/types/budget_model.py @@ -99,6 +99,7 @@ class Budget(proto.Message): class BudgetAmount(proto.Message): r"""The budgeted amount for each usage period. + Attributes: specified_amount (google.type.money_pb2.Money): A specified amount to use as the budget. ``currency_code`` @@ -133,7 +134,8 @@ class LastPeriodAmount(proto.Message): configuring a percentage of last period's spend). LastPeriodAmount cannot be set for a budget configured with a [Filter.custom_period][google.cloud.billing.budgets.v1beta1.Filter.custom_period]. - """ + + """ class ThresholdRule(proto.Message): diff --git a/google/cloud/billing/budgets_v1beta1/types/budget_service.py b/google/cloud/billing/budgets_v1beta1/types/budget_service.py index 4f40a75..01d779f 100644 --- a/google/cloud/billing/budgets_v1beta1/types/budget_service.py +++ b/google/cloud/billing/budgets_v1beta1/types/budget_service.py @@ -34,6 +34,7 @@ class CreateBudgetRequest(proto.Message): r"""Request for CreateBudget + Attributes: parent (str): Required. The name of the billing account to create the @@ -49,6 +50,7 @@ class CreateBudgetRequest(proto.Message): class UpdateBudgetRequest(proto.Message): r"""Request for UpdateBudget + Attributes: budget (google.cloud.billing.budgets_v1beta1.types.Budget): Required. The updated budget object. @@ -71,6 +73,7 @@ class UpdateBudgetRequest(proto.Message): class GetBudgetRequest(proto.Message): r"""Request for GetBudget + Attributes: name (str): Required. Name of budget to get. Values are of the form @@ -82,6 +85,7 @@ class GetBudgetRequest(proto.Message): class ListBudgetsRequest(proto.Message): r"""Request for ListBudgets + Attributes: parent (str): Required. Name of billing account to list budgets under. @@ -105,6 +109,7 @@ class ListBudgetsRequest(proto.Message): class ListBudgetsResponse(proto.Message): r"""Response for ListBudgets + Attributes: budgets (Sequence[google.cloud.billing.budgets_v1beta1.types.Budget]): List of the budgets owned by the requested @@ -125,6 +130,7 @@ def raw_page(self): class DeleteBudgetRequest(proto.Message): r"""Request for DeleteBudget + Attributes: name (str): Required. Name of the budget to delete. Values are of the diff --git a/tests/unit/gapic/budgets_v1/test_budget_service.py b/tests/unit/gapic/budgets_v1/test_budget_service.py index 991aa14..2a1b30e 100644 --- a/tests/unit/gapic/budgets_v1/test_budget_service.py +++ b/tests/unit/gapic/budgets_v1/test_budget_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.billing.budgets_v1.services.budget_service import ( @@ -1784,6 +1785,9 @@ def test_budget_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_budget_service_base_transport_with_credentials_file(): @@ -2283,3 +2287,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 = BudgetServiceAsyncClient( + 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 = BudgetServiceClient( + 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 = BudgetServiceClient( + 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/budgets_v1beta1/test_budget_service.py b/tests/unit/gapic/budgets_v1beta1/test_budget_service.py index 0450139..625c6cc 100644 --- a/tests/unit/gapic/budgets_v1beta1/test_budget_service.py +++ b/tests/unit/gapic/budgets_v1beta1/test_budget_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.billing.budgets_v1beta1.services.budget_service import ( @@ -1432,6 +1433,9 @@ def test_budget_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_budget_service_base_transport_with_credentials_file(): @@ -1931,3 +1935,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 = BudgetServiceAsyncClient( + 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 = BudgetServiceClient( + 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 = BudgetServiceClient( + 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()