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

- [ ] 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/resourcesettings_v1/services/resource_settings_service/async_client.py

@@ -428,6 +428,12 @@ async def update_setting(
         # 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(

google/cloud/resourcesettings_v1/services/resource_settings_service/client.py

@@ -358,10 +358,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 list_settings(
@@ -584,6 +581,19 @@ def update_setting(
         # 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(

google/cloud/resourcesettings_v1/services/resource_settings_service/transports/base.py

@@ -201,6 +201,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 list_settings(
         self,

google/cloud/resourcesettings_v1/services/resource_settings_service/transports/grpc.py

@@ -336,5 +336,8 @@ def update_setting(
             )
         return self._stubs["update_setting"]
 
+    def close(self):
+        self.grpc_channel.close()
+
 
 __all__ = ("ResourceSettingsServiceGrpcTransport",)

google/cloud/resourcesettings_v1/services/resource_settings_service/transports/grpc_asyncio.py

@@ -344,5 +344,8 @@ def update_setting(
             )
         return self._stubs["update_setting"]
 
+    def close(self):
+        return self.grpc_channel.close()
+
 
 __all__ = ("ResourceSettingsServiceGrpcAsyncIOTransport",)

google/cloud/resourcesettings_v1/types/resource_settings.py

@@ -41,6 +41,7 @@ class SettingView(proto.Enum):
 
 class Setting(proto.Message):
     r"""The schema for settings.
+
     Attributes:
         name (str):
             The resource name of the setting. Must be in one of the
@@ -139,6 +140,7 @@ class DataType(proto.Enum):
 
 class Value(proto.Message):
     r"""The data in a setting value.
+
     Attributes:
         boolean_value (bool):
             Defines this value as being a boolean value.
@@ -184,6 +186,7 @@ class EnumValue(proto.Message):
 
 class ListSettingsRequest(proto.Message):
     r"""The request for ListSettings.
+
     Attributes:
         parent (str):
             Required. The Cloud resource that parents the setting. Must
@@ -210,6 +213,7 @@ class ListSettingsRequest(proto.Message):
 
 class ListSettingsResponse(proto.Message):
     r"""The response from ListSettings.
+
     Attributes:
         settings (Sequence[google.cloud.resourcesettings_v1.types.Setting]):
             A list of settings that are available at the
@@ -229,6 +233,7 @@ def raw_page(self):
 
 class GetSettingRequest(proto.Message):
     r"""The request for GetSetting.
+
     Attributes:
         name (str):
             Required. The name of the setting to get. See
@@ -244,6 +249,7 @@ class GetSettingRequest(proto.Message):
 
 class UpdateSettingRequest(proto.Message):
     r"""The request for UpdateSetting.
+
     Attributes:
         setting (google.cloud.resourcesettings_v1.types.Setting):
             Required. The setting to update. See

tests/unit/gapic/resourcesettings_v1/test_resource_settings_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.resourcesettings_v1.services.resource_settings_service import (
@@ -1346,6 +1347,9 @@ def test_resource_settings_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_resource_settings_service_base_transport_with_credentials_file():
@@ -1830,3 +1834,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 = ResourceSettingsServiceAsyncClient(
+        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 = ResourceSettingsServiceClient(
+            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 = ResourceSettingsServiceClient(
+            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()