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

gcf-owl-bot[bot] · web-flow · commit 51eae67c47e2 · 2021-10-09T15:06:11.000Z
- [ ] 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: googleapis/googleapis-gen@81decff Copy-Tag: eyJwIjoiLmdpdGh1Yi8uT3dsQm90LnlhbWwiLCJoIjoiODFkZWNmZmU5ZmM3MjM5NmE4MTUzZTc1NmQxZDY3YTZlZWNmZDYyMCJ9
diff --git a/google/pubsub_v1/services/publisher/async_client.py b/google/pubsub_v1/services/publisher/async_client.py
@@ -1183,6 +1183,12 @@ async def test_iam_permissions(
         # 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/pubsub_v1/services/publisher/client.py b/google/pubsub_v1/services/publisher/client.py
@@ -399,10 +399,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_topic(
@@ -1064,6 +1061,19 @@ def detach_subscription(
         # 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()
+
     def set_iam_policy(
         self,
         request: iam_policy_pb2.SetIamPolicyRequest = None,
diff --git a/google/pubsub_v1/services/publisher/transports/base.py b/google/pubsub_v1/services/publisher/transports/base.py
@@ -302,6 +302,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_topic(
         self,
diff --git a/google/pubsub_v1/services/publisher/transports/grpc.py b/google/pubsub_v1/services/publisher/transports/grpc.py
@@ -559,5 +559,8 @@ def test_iam_permissions(
             )
         return self._stubs["test_iam_permissions"]
 
+    def close(self):
+        self.grpc_channel.close()
+
 
 __all__ = ("PublisherGrpcTransport",)
diff --git a/google/pubsub_v1/services/publisher/transports/grpc_asyncio.py b/google/pubsub_v1/services/publisher/transports/grpc_asyncio.py
@@ -569,5 +569,8 @@ def test_iam_permissions(
             )
         return self._stubs["test_iam_permissions"]
 
+    def close(self):
+        return self.grpc_channel.close()
+
 
 __all__ = ("PublisherGrpcAsyncIOTransport",)
diff --git a/google/pubsub_v1/services/schema_service/async_client.py b/google/pubsub_v1/services/schema_service/async_client.py
@@ -871,6 +871,12 @@ async def test_iam_permissions(
         # 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/pubsub_v1/services/schema_service/client.py b/google/pubsub_v1/services/schema_service/client.py
@@ -342,10 +342,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_schema(
@@ -785,6 +782,19 @@ def validate_message(
         # 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()
+
     def set_iam_policy(
         self,
         request: iam_policy_pb2.SetIamPolicyRequest = None,
diff --git a/google/pubsub_v1/services/schema_service/transports/base.py b/google/pubsub_v1/services/schema_service/transports/base.py
@@ -181,6 +181,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_schema(
         self,
diff --git a/google/pubsub_v1/services/schema_service/transports/grpc.py b/google/pubsub_v1/services/schema_service/transports/grpc.py
@@ -462,5 +462,8 @@ def test_iam_permissions(
             )
         return self._stubs["test_iam_permissions"]
 
+    def close(self):
+        self.grpc_channel.close()
+
 
 __all__ = ("SchemaServiceGrpcTransport",)
diff --git a/google/pubsub_v1/services/schema_service/transports/grpc_asyncio.py b/google/pubsub_v1/services/schema_service/transports/grpc_asyncio.py
@@ -473,5 +473,8 @@ def test_iam_permissions(
             )
         return self._stubs["test_iam_permissions"]
 
+    def close(self):
+        return self.grpc_channel.close()
+
 
 __all__ = ("SchemaServiceGrpcAsyncIOTransport",)
diff --git a/google/pubsub_v1/services/subscriber/async_client.py b/google/pubsub_v1/services/subscriber/async_client.py
@@ -1924,6 +1924,12 @@ async def test_iam_permissions(
         # 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/pubsub_v1/services/subscriber/client.py b/google/pubsub_v1/services/subscriber/client.py
@@ -401,10 +401,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_subscription(
@@ -1741,6 +1738,19 @@ def seek(
         # 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()
+
     def set_iam_policy(
         self,
         request: iam_policy_pb2.SetIamPolicyRequest = None,
diff --git a/google/pubsub_v1/services/subscriber/transports/base.py b/google/pubsub_v1/services/subscriber/transports/base.py
@@ -404,6 +404,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_subscription(
         self,
diff --git a/google/pubsub_v1/services/subscriber/transports/grpc.py b/google/pubsub_v1/services/subscriber/transports/grpc.py
@@ -817,5 +817,8 @@ def test_iam_permissions(
             )
         return self._stubs["test_iam_permissions"]
 
+    def close(self):
+        self.grpc_channel.close()
+
 
 __all__ = ("SubscriberGrpcTransport",)
diff --git a/google/pubsub_v1/services/subscriber/transports/grpc_asyncio.py b/google/pubsub_v1/services/subscriber/transports/grpc_asyncio.py
@@ -830,5 +830,8 @@ def test_iam_permissions(
             )
         return self._stubs["test_iam_permissions"]
 
+    def close(self):
+        return self.grpc_channel.close()
+
 
 __all__ = ("SubscriberGrpcAsyncIOTransport",)
diff --git a/google/pubsub_v1/types/pubsub.py b/google/pubsub_v1/types/pubsub.py
@@ -438,7 +438,8 @@ class DetachSubscriptionRequest(proto.Message):
 class DetachSubscriptionResponse(proto.Message):
     r"""Response for the DetachSubscription method.
     Reserved for future use.
-        """
+
+    """
 
 
 class Subscription(proto.Message):
@@ -1312,7 +1313,8 @@ class SeekRequest(proto.Message):
 
 
 class SeekResponse(proto.Message):
-    r"""Response for the ``Seek`` method (this response is empty).    """
+    r"""Response for the ``Seek`` method (this response is empty).
+    """
 
 
 __all__ = tuple(sorted(__protobuf__.manifest))
diff --git a/google/pubsub_v1/types/schema.py b/google/pubsub_v1/types/schema.py
@@ -195,7 +195,8 @@ class ValidateSchemaRequest(proto.Message):
 
 
 class ValidateSchemaResponse(proto.Message):
-    r"""Response for the ``ValidateSchema`` method. Empty for now.    """
+    r"""Response for the ``ValidateSchema`` method. Empty for now.
+    """
 
 
 class ValidateMessageRequest(proto.Message):
@@ -227,7 +228,8 @@ class ValidateMessageRequest(proto.Message):
 
 
 class ValidateMessageResponse(proto.Message):
-    r"""Response for the ``ValidateMessage`` method. Empty for now.    """
+    r"""Response for the ``ValidateMessage`` method. Empty for now.
+    """
 
 
 __all__ = tuple(sorted(__protobuf__.manifest))
diff --git a/tests/unit/gapic/pubsub_v1/test_publisher.py b/tests/unit/gapic/pubsub_v1/test_publisher.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.iam.v1 import iam_policy_pb2  # type: ignore
@@ -2645,6 +2646,9 @@ def test_publisher_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_publisher_base_transport_with_credentials_file():
@@ -3626,3 +3630,49 @@ async def test_test_iam_permissions_from_dict_async():
             }
         )
         call.assert_called()
+
+
+@pytest.mark.asyncio
+async def test_transport_close_async():
+    client = PublisherAsyncClient(
+        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 = PublisherClient(
+            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 = PublisherClient(
+            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/pubsub_v1/test_schema_service.py b/tests/unit/gapic/pubsub_v1/test_schema_service.py
diff --git a/tests/unit/gapic/pubsub_v1/test_subscriber.py b/tests/unit/gapic/pubsub_v1/test_subscriber.py

Original file line number	Diff line number	Diff line change
`@@ -559,5 +559,8 @@ def test_iam_permissions(`
`559`	`559`	`)`
`560`	`560`	`return self._stubs["test_iam_permissions"]`
`561`	`561`
	`562`	`+ def close(self):`
	`563`	`+ self.grpc_channel.close()`
	`564`	`+`
`562`	`565`
`563`	`566`	`__all__ = ("PublisherGrpcTransport",)`
Original file line number	Diff line number	Diff line change
`@@ -569,5 +569,8 @@ def test_iam_permissions(`
`569`	`569`	`)`
`570`	`570`	`return self._stubs["test_iam_permissions"]`
`571`	`571`
	`572`	`+ def close(self):`
	`573`	`+ return self.grpc_channel.close()`
	`574`	`+`
`572`	`575`
`573`	`576`	`__all__ = ("PublisherGrpcAsyncIOTransport",)`
Original file line number	Diff line number	Diff line change
`@@ -462,5 +462,8 @@ def test_iam_permissions(`
`462`	`462`	`)`
`463`	`463`	`return self._stubs["test_iam_permissions"]`
`464`	`464`
	`465`	`+ def close(self):`
	`466`	`+ self.grpc_channel.close()`
	`467`	`+`
`465`	`468`
`466`	`469`	`__all__ = ("SchemaServiceGrpcTransport",)`
Original file line number	Diff line number	Diff line change
`@@ -473,5 +473,8 @@ def test_iam_permissions(`
`473`	`473`	`)`
`474`	`474`	`return self._stubs["test_iam_permissions"]`
`475`	`475`
	`476`	`+ def close(self):`
	`477`	`+ return self.grpc_channel.close()`
	`478`	`+`
`476`	`479`
`477`	`480`	`__all__ = ("SchemaServiceGrpcAsyncIOTransport",)`