feat: add context manager support in client (#51)

- [ ] Regenerate this pull request now. chore: fix docstring for first attribute of protos committer: @busunkim96 PiperOrigin-RevId: 401271153 Source-Link: googleapis/googleapis@787f8c9 Source-Link: https://github.com/googleapis/googleapis-gen/commit/81decffe9fc72396a8153e756d1d67a6eecfd620 Copy-Tag: eyJwIjoiLmdpdGh1Yi8uT3dsQm90LnlhbWwiLCJoIjoiODFkZWNmZmU5ZmM3MjM5NmE4MTUzZTc1NmQxZDY3YTZlZWNmZDYyMCJ9

Author: gcf-owl-bot[bot]

google/cloud/essential_contacts_v1/services/essential_contacts_service/async_client.py

@@ -682,6 +682,12 @@ async def send_test_message(
  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(

google/cloud/essential_contacts_v1/services/essential_contacts_service/client.py

@@ -348,10 +348,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_contact(
@@ -849,6 +846,19 @@ def send_test_message(
  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(

google/cloud/essential_contacts_v1/services/essential_contacts_service/transports/base.py

@@ -200,6 +200,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_contact(
  self,

google/cloud/essential_contacts_v1/services/essential_contacts_service/transports/grpc.py

@@ -410,5 +410,8 @@ def send_test_message(
  )
  return self._stubs["send_test_message"]
 
+ def close(self):
+ self.grpc_channel.close()
+
 
 __all__ = ("EssentialContactsServiceGrpcTransport",)

google/cloud/essential_contacts_v1/services/essential_contacts_service/transports/grpc_asyncio.py

@@ -419,5 +419,8 @@ def send_test_message(
  )
  return self._stubs["send_test_message"]
 
+ def close(self):
+ return self.grpc_channel.close()
+
 
 __all__ = ("EssentialContactsServiceGrpcAsyncIOTransport",)

google/cloud/essential_contacts_v1/types/service.py

@@ -39,6 +39,7 @@
 
 class Contact(proto.Message):
  r"""A contact that will receive notifications from Google Cloud.
+
  Attributes:
  name (str):
  The identifier for the contact. Format:
@@ -79,6 +80,7 @@ class Contact(proto.Message):
 
 class ListContactsRequest(proto.Message):
  r"""Request message for the ListContacts method.
+
  Attributes:
  parent (str):
  Required. The parent resource name. Format:
@@ -105,6 +107,7 @@ class ListContactsRequest(proto.Message):
 
 class ListContactsResponse(proto.Message):
  r"""Response message for the ListContacts method.
+
  Attributes:
  contacts (Sequence[google.cloud.essential_contacts_v1.types.Contact]):
  The contacts for the specified resource.
@@ -126,6 +129,7 @@ def raw_page(self):
 
 class GetContactRequest(proto.Message):
  r"""Request message for the GetContact method.
+
  Attributes:
  name (str):
  Required. The name of the contact to retrieve. Format:
@@ -139,6 +143,7 @@ class GetContactRequest(proto.Message):
 
 class DeleteContactRequest(proto.Message):
  r"""Request message for the DeleteContact method.
+
  Attributes:
  name (str):
  Required. The name of the contact to delete. Format:
@@ -152,6 +157,7 @@ class DeleteContactRequest(proto.Message):
 
 class CreateContactRequest(proto.Message):
  r"""Request message for the CreateContact method.
+
  Attributes:
  parent (str):
  Required. The resource to save this contact for. Format:
@@ -168,6 +174,7 @@ class CreateContactRequest(proto.Message):
 
 class UpdateContactRequest(proto.Message):
  r"""Request message for the UpdateContact method.
+
  Attributes:
  contact (google.cloud.essential_contacts_v1.types.Contact):
  Required. The contact resource to replace the
@@ -187,6 +194,7 @@ class UpdateContactRequest(proto.Message):
 
 class ComputeContactsRequest(proto.Message):
  r"""Request message for the ComputeContacts method.
+
  Attributes:
  parent (str):
  Required. The name of the resource to compute contacts for.
@@ -221,6 +229,7 @@ class ComputeContactsRequest(proto.Message):
 
 class ComputeContactsResponse(proto.Message):
  r"""Response message for the ComputeContacts method.
+
  Attributes:
  contacts (Sequence[google.cloud.essential_contacts_v1.types.Contact]):
  All contacts for the resource that are
@@ -245,6 +254,7 @@ def raw_page(self):
 
 class SendTestMessageRequest(proto.Message):
  r"""Request message for the SendTestMessage method.
+
  Attributes:
  contacts (Sequence[str]):
  Required. The list of names of the contacts to send a test

tests/unit/gapic/essential_contacts_v1/test_essential_contacts_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.essential_contacts_v1.services.essential_contacts_service import (
@@ -2303,6 +2304,9 @@ def test_essential_contacts_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_essential_contacts_service_base_transport_with_credentials_file():
@@ -2787,3 +2791,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 = EssentialContactsServiceAsyncClient(
+ 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 = EssentialContactsServiceClient(
+ 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 = EssentialContactsServiceClient(
+ 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()