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

gcf-owl-bot[bot] · web-flow · commit 090c723e249c · 2021-10-07T00:40:46.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: https://github.com/googleapis/googleapis-gen/commit/81decffe9fc72396a8153e756d1d67a6eecfd620 Copy-Tag: eyJwIjoiLmdpdGh1Yi8uT3dsQm90LnlhbWwiLCJoIjoiODFkZWNmZmU5ZmM3MjM5NmE4MTUzZTc1NmQxZDY3YTZlZWNmZDYyMCJ9
diff --git a/google/cloud/workflows/executions_v1/services/executions/async_client.py b/google/cloud/workflows/executions_v1/services/executions/async_client.py
@@ -479,6 +479,12 @@ async def cancel_execution(
         # 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/workflows/executions_v1/services/executions/client.py b/google/cloud/workflows/executions_v1/services/executions/client.py
@@ -363,10 +363,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_executions(
@@ -688,6 +685,19 @@ def cancel_execution(
         # 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/workflows/executions_v1/services/executions/transports/base.py b/google/cloud/workflows/executions_v1/services/executions/transports/base.py
@@ -166,6 +166,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_executions(
         self,
diff --git a/google/cloud/workflows/executions_v1/services/executions/transports/grpc.py b/google/cloud/workflows/executions_v1/services/executions/transports/grpc.py
@@ -337,5 +337,8 @@ def cancel_execution(
             )
         return self._stubs["cancel_execution"]
 
+    def close(self):
+        self.grpc_channel.close()
+
 
 __all__ = ("ExecutionsGrpcTransport",)
diff --git a/google/cloud/workflows/executions_v1/services/executions/transports/grpc_asyncio.py b/google/cloud/workflows/executions_v1/services/executions/transports/grpc_asyncio.py
@@ -340,5 +340,8 @@ def cancel_execution(
             )
         return self._stubs["cancel_execution"]
 
+    def close(self):
+        return self.grpc_channel.close()
+
 
 __all__ = ("ExecutionsGrpcAsyncIOTransport",)
diff --git a/google/cloud/workflows/executions_v1/types/executions.py b/google/cloud/workflows/executions_v1/types/executions.py
@@ -84,6 +84,7 @@ class State(proto.Enum):
 
     class Error(proto.Message):
         r"""Error describes why the execution was abnormally terminated.
+
         Attributes:
             payload (str):
                 Error payload returned by the execution,
@@ -108,6 +109,7 @@ class Error(proto.Message):
 
 class ListExecutionsRequest(proto.Message):
     r"""Request for the [ListExecutions][] method.
+
     Attributes:
         parent (str):
             Required. Name of the workflow for which the
diff --git a/google/cloud/workflows/executions_v1beta/services/executions/async_client.py b/google/cloud/workflows/executions_v1beta/services/executions/async_client.py
@@ -480,6 +480,12 @@ async def cancel_execution(
         # 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/workflows/executions_v1beta/services/executions/client.py b/google/cloud/workflows/executions_v1beta/services/executions/client.py
@@ -364,10 +364,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_executions(
@@ -689,6 +686,19 @@ def cancel_execution(
         # 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/workflows/executions_v1beta/services/executions/transports/base.py b/google/cloud/workflows/executions_v1beta/services/executions/transports/base.py
@@ -166,6 +166,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_executions(
         self,
diff --git a/google/cloud/workflows/executions_v1beta/services/executions/transports/grpc.py b/google/cloud/workflows/executions_v1beta/services/executions/transports/grpc.py
@@ -338,5 +338,8 @@ def cancel_execution(
             )
         return self._stubs["cancel_execution"]
 
+    def close(self):
+        self.grpc_channel.close()
+
 
 __all__ = ("ExecutionsGrpcTransport",)
diff --git a/google/cloud/workflows/executions_v1beta/services/executions/transports/grpc_asyncio.py b/google/cloud/workflows/executions_v1beta/services/executions/transports/grpc_asyncio.py
@@ -341,5 +341,8 @@ def cancel_execution(
             )
         return self._stubs["cancel_execution"]
 
+    def close(self):
+        return self.grpc_channel.close()
+
 
 __all__ = ("ExecutionsGrpcAsyncIOTransport",)
diff --git a/google/cloud/workflows/executions_v1beta/types/executions.py b/google/cloud/workflows/executions_v1beta/types/executions.py
@@ -84,6 +84,7 @@ class State(proto.Enum):
 
     class Error(proto.Message):
         r"""Error describes why the execution was abnormally terminated.
+
         Attributes:
             payload (str):
                 Error payload returned by the execution,
diff --git a/google/cloud/workflows_v1/services/workflows/async_client.py b/google/cloud/workflows_v1/services/workflows/async_client.py
@@ -630,6 +630,12 @@ async def update_workflow(
         # 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/workflows_v1/services/workflows/client.py b/google/cloud/workflows_v1/services/workflows/client.py
@@ -350,10 +350,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_workflows(
@@ -823,6 +820,19 @@ def update_workflow(
         # 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/workflows_v1/services/workflows/transports/base.py b/google/cloud/workflows_v1/services/workflows/transports/base.py
@@ -171,6 +171,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/workflows_v1/services/workflows/transports/grpc.py b/google/cloud/workflows_v1/services/workflows/transports/grpc.py
@@ -385,5 +385,8 @@ def update_workflow(
             )
         return self._stubs["update_workflow"]
 
+    def close(self):
+        self.grpc_channel.close()
+
 
 __all__ = ("WorkflowsGrpcTransport",)
diff --git a/google/cloud/workflows_v1/services/workflows/transports/grpc_asyncio.py b/google/cloud/workflows_v1/services/workflows/transports/grpc_asyncio.py
@@ -398,5 +398,8 @@ def update_workflow(
             )
         return self._stubs["update_workflow"]
 
+    def close(self):
+        return self.grpc_channel.close()
+
 
 __all__ = ("WorkflowsGrpcAsyncIOTransport",)
diff --git a/google/cloud/workflows_v1/types/workflows.py b/google/cloud/workflows_v1/types/workflows.py
@@ -36,6 +36,7 @@
 
 class Workflow(proto.Message):
     r"""Workflow program to be executed by Workflows.
+
     Attributes:
         name (str):
             The resource name of the workflow.
@@ -265,6 +266,7 @@ class UpdateWorkflowRequest(proto.Message):
 
 class OperationMetadata(proto.Message):
     r"""Represents the metadata of the long-running operation.
+
     Attributes:
         create_time (google.protobuf.timestamp_pb2.Timestamp):
             The time the operation was created.
diff --git a/google/cloud/workflows_v1beta/services/workflows/async_client.py b/google/cloud/workflows_v1beta/services/workflows/async_client.py
@@ -630,6 +630,12 @@ async def update_workflow(
         # 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/workflows_v1beta/services/workflows/client.py b/google/cloud/workflows_v1beta/services/workflows/client.py
@@ -350,10 +350,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_workflows(
@@ -823,6 +820,19 @@ def update_workflow(
         # 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/workflows_v1beta/services/workflows/transports/base.py b/google/cloud/workflows_v1beta/services/workflows/transports/base.py
@@ -171,6 +171,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/workflows_v1beta/services/workflows/transports/grpc.py b/google/cloud/workflows_v1beta/services/workflows/transports/grpc.py
@@ -385,5 +385,8 @@ def update_workflow(
             )
         return self._stubs["update_workflow"]
 
+    def close(self):
+        self.grpc_channel.close()
+
 
 __all__ = ("WorkflowsGrpcTransport",)
diff --git a/google/cloud/workflows_v1beta/services/workflows/transports/grpc_asyncio.py b/google/cloud/workflows_v1beta/services/workflows/transports/grpc_asyncio.py
@@ -398,5 +398,8 @@ def update_workflow(
             )
         return self._stubs["update_workflow"]
 
+    def close(self):
+        return self.grpc_channel.close()
+
 
 __all__ = ("WorkflowsGrpcAsyncIOTransport",)
diff --git a/google/cloud/workflows_v1beta/types/workflows.py b/google/cloud/workflows_v1beta/types/workflows.py
@@ -36,6 +36,7 @@
 
 class Workflow(proto.Message):
     r"""Workflow program to be executed by Workflows.
+
     Attributes:
         name (str):
             The resource name of the workflow.
@@ -265,6 +266,7 @@ class UpdateWorkflowRequest(proto.Message):
 
 class OperationMetadata(proto.Message):
     r"""Represents the metadata of the long-running operation.
+
     Attributes:
         create_time (google.protobuf.timestamp_pb2.Timestamp):
             The time the operation was created.
diff --git a/tests/unit/gapic/executions_v1/test_executions.py b/tests/unit/gapic/executions_v1/test_executions.py
diff --git a/tests/unit/gapic/executions_v1beta/test_executions.py b/tests/unit/gapic/executions_v1beta/test_executions.py
diff --git a/tests/unit/gapic/workflows_v1/test_workflows.py b/tests/unit/gapic/workflows_v1/test_workflows.py
diff --git a/tests/unit/gapic/workflows_v1beta/test_workflows.py b/tests/unit/gapic/workflows_v1beta/test_workflows.py

Original file line number	Diff line number	Diff line change
`@@ -337,5 +337,8 @@ def cancel_execution(`
`337`	`337`	`)`
`338`	`338`	`return self._stubs["cancel_execution"]`
`339`	`339`
	`340`	`+ def close(self):`
	`341`	`+ self.grpc_channel.close()`
	`342`	`+`
`340`	`343`
`341`	`344`	`__all__ = ("ExecutionsGrpcTransport",)`
Original file line number	Diff line number	Diff line change
`@@ -340,5 +340,8 @@ def cancel_execution(`
`340`	`340`	`)`
`341`	`341`	`return self._stubs["cancel_execution"]`
`342`	`342`
	`343`	`+ def close(self):`
	`344`	`+ return self.grpc_channel.close()`
	`345`	`+`
`343`	`346`
`344`	`347`	`__all__ = ("ExecutionsGrpcAsyncIOTransport",)`
Original file line number	Diff line number	Diff line change
`@@ -338,5 +338,8 @@ def cancel_execution(`
`338`	`338`	`)`
`339`	`339`	`return self._stubs["cancel_execution"]`
`340`	`340`
	`341`	`+ def close(self):`
	`342`	`+ self.grpc_channel.close()`
	`343`	`+`
`341`	`344`
`342`	`345`	`__all__ = ("ExecutionsGrpcTransport",)`