From 9cad312b3673009f8bcd6b51c8a24fe5dda468f0 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:42:31 +0000 Subject: [PATCH] feat: add context manager support in client (#78) - [ ] 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 --- .../async_client.py | 6 +++ .../managed_identities_service/client.py | 18 +++++-- .../transports/base.py | 9 ++++ .../transports/grpc.py | 3 ++ .../transports/grpc_asyncio.py | 3 ++ .../types/managed_identities_service.py | 1 + .../managedidentities_v1/types/resource.py | 1 + .../test_managed_identities_service.py | 50 +++++++++++++++++++ 8 files changed, 87 insertions(+), 4 deletions(-) diff --git a/google/cloud/managedidentities_v1/services/managed_identities_service/async_client.py b/google/cloud/managedidentities_v1/services/managed_identities_service/async_client.py index 430dec6..a4fe9a3 100644 --- a/google/cloud/managedidentities_v1/services/managed_identities_service/async_client.py +++ b/google/cloud/managedidentities_v1/services/managed_identities_service/async_client.py @@ -1119,6 +1119,12 @@ async def validate_trust( # 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/managedidentities_v1/services/managed_identities_service/client.py b/google/cloud/managedidentities_v1/services/managed_identities_service/client.py index 8b80c37..00335b5 100644 --- a/google/cloud/managedidentities_v1/services/managed_identities_service/client.py +++ b/google/cloud/managedidentities_v1/services/managed_identities_service/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_microsoft_ad_domain( @@ -1315,6 +1312,19 @@ def validate_trust( # 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/managedidentities_v1/services/managed_identities_service/transports/base.py b/google/cloud/managedidentities_v1/services/managed_identities_service/transports/base.py index 8917514..4f61e09 100644 --- a/google/cloud/managedidentities_v1/services/managed_identities_service/transports/base.py +++ b/google/cloud/managedidentities_v1/services/managed_identities_service/transports/base.py @@ -193,6 +193,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/managedidentities_v1/services/managed_identities_service/transports/grpc.py b/google/cloud/managedidentities_v1/services/managed_identities_service/transports/grpc.py index 7038339..e42a310 100644 --- a/google/cloud/managedidentities_v1/services/managed_identities_service/transports/grpc.py +++ b/google/cloud/managedidentities_v1/services/managed_identities_service/transports/grpc.py @@ -560,5 +560,8 @@ def validate_trust( ) return self._stubs["validate_trust"] + def close(self): + self.grpc_channel.close() + __all__ = ("ManagedIdentitiesServiceGrpcTransport",) diff --git a/google/cloud/managedidentities_v1/services/managed_identities_service/transports/grpc_asyncio.py b/google/cloud/managedidentities_v1/services/managed_identities_service/transports/grpc_asyncio.py index 98014cb..eaf3753 100644 --- a/google/cloud/managedidentities_v1/services/managed_identities_service/transports/grpc_asyncio.py +++ b/google/cloud/managedidentities_v1/services/managed_identities_service/transports/grpc_asyncio.py @@ -573,5 +573,8 @@ def validate_trust( ) return self._stubs["validate_trust"] + def close(self): + return self.grpc_channel.close() + __all__ = ("ManagedIdentitiesServiceGrpcAsyncIOTransport",) diff --git a/google/cloud/managedidentities_v1/types/managed_identities_service.py b/google/cloud/managedidentities_v1/types/managed_identities_service.py index c79314f..1e03d05 100644 --- a/google/cloud/managedidentities_v1/types/managed_identities_service.py +++ b/google/cloud/managedidentities_v1/types/managed_identities_service.py @@ -42,6 +42,7 @@ class OpMetadata(proto.Message): r"""Represents the metadata of the long-running operation. + Attributes: create_time (google.protobuf.timestamp_pb2.Timestamp): Output only. The time the operation was diff --git a/google/cloud/managedidentities_v1/types/resource.py b/google/cloud/managedidentities_v1/types/resource.py index 338fe7c..8cf9f90 100644 --- a/google/cloud/managedidentities_v1/types/resource.py +++ b/google/cloud/managedidentities_v1/types/resource.py @@ -25,6 +25,7 @@ class Domain(proto.Message): r"""Represents a managed Microsoft Active Directory domain. + Attributes: name (str): Required. The unique name of the domain using the form: diff --git a/tests/unit/gapic/managedidentities_v1/test_managed_identities_service.py b/tests/unit/gapic/managedidentities_v1/test_managed_identities_service.py index bf535ad..5982639 100644 --- a/tests/unit/gapic/managedidentities_v1/test_managed_identities_service.py +++ b/tests/unit/gapic/managedidentities_v1/test_managed_identities_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.managedidentities_v1.services.managed_identities_service import ( @@ -3047,6 +3048,9 @@ def test_managed_identities_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): @@ -3564,3 +3568,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 = ManagedIdentitiesServiceAsyncClient( + 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 = ManagedIdentitiesServiceClient( + 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 = ManagedIdentitiesServiceClient( + 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()