Skip to content
This repository was archived by the owner on Dec 31, 2023. It is now read-only.

Commit 6707e79

Browse files
feat: add context manager support in client (#190)
- [ ] 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
1 parent 2d9bd24 commit 6707e79

File tree

6 files changed

+85
-4
lines changed

6 files changed

+85
-4
lines changed

google/cloud/kms_v1/services/key_management_service/async_client.py

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -3148,6 +3148,12 @@ async def test_iam_permissions(
31483148
# Done; return the response.
31493149
return response
31503150

3151+
async def __aenter__(self):
3152+
return self
3153+
3154+
async def __aexit__(self, exc_type, exc, tb):
3155+
await self.transport.close()
3156+
31513157

31523158
try:
31533159
DEFAULT_CLIENT_INFO = gapic_v1.client_info.ClientInfo(

google/cloud/kms_v1/services/key_management_service/client.py

Lines changed: 14 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -464,10 +464,7 @@ def __init__(
464464
client_cert_source_for_mtls=client_cert_source_func,
465465
quota_project_id=client_options.quota_project_id,
466466
client_info=client_info,
467-
always_use_jwt_access=(
468-
Transport == type(self).get_transport_class("grpc")
469-
or Transport == type(self).get_transport_class("grpc_asyncio")
470-
),
467+
always_use_jwt_access=True,
471468
)
472469

473470
def list_key_rings(
@@ -2909,6 +2906,19 @@ def generate_random_bytes(
29092906
# Done; return the response.
29102907
return response
29112908

2909+
def __enter__(self):
2910+
return self
2911+
2912+
def __exit__(self, type, value, traceback):
2913+
"""Releases underlying transport's resources.
2914+
2915+
.. warning::
2916+
ONLY use as a context manager if the transport is NOT shared
2917+
with other clients! Exiting the with block will CLOSE the transport
2918+
and may cause errors in other clients!
2919+
"""
2920+
self.transport.close()
2921+
29122922
def set_iam_policy(
29132923
self,
29142924
request: iam_policy_pb2.SetIamPolicyRequest = None,

google/cloud/kms_v1/services/key_management_service/transports/base.py

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -530,6 +530,15 @@ def _prep_wrapped_messages(self, client_info):
530530
),
531531
}
532532

533+
def close(self):
534+
"""Closes resources associated with the transport.
535+
536+
.. warning::
537+
Only call this method if the transport is NOT shared
538+
with other clients - this may cause errors in other clients!
539+
"""
540+
raise NotImplementedError()
541+
533542
@property
534543
def list_key_rings(
535544
self,

google/cloud/kms_v1/services/key_management_service/transports/grpc.py

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1113,5 +1113,8 @@ def test_iam_permissions(
11131113
)
11141114
return self._stubs["test_iam_permissions"]
11151115

1116+
def close(self):
1117+
self.grpc_channel.close()
1118+
11161119

11171120
__all__ = ("KeyManagementServiceGrpcTransport",)

google/cloud/kms_v1/services/key_management_service/transports/grpc_asyncio.py

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1148,5 +1148,8 @@ def test_iam_permissions(
11481148
)
11491149
return self._stubs["test_iam_permissions"]
11501150

1151+
def close(self):
1152+
return self.grpc_channel.close()
1153+
11511154

11521155
__all__ = ("KeyManagementServiceGrpcAsyncIOTransport",)

tests/unit/gapic/kms_v1/test_key_management_service.py

Lines changed: 50 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -29,6 +29,7 @@
2929
from google.api_core import gapic_v1
3030
from google.api_core import grpc_helpers
3131
from google.api_core import grpc_helpers_async
32+
from google.api_core import path_template
3233
from google.auth import credentials as ga_credentials
3334
from google.auth.exceptions import MutualTLSChannelError
3435
from google.cloud.kms_v1.services.key_management_service import (
@@ -7413,6 +7414,9 @@ def test_key_management_service_base_transport():
74137414
with pytest.raises(NotImplementedError):
74147415
getattr(transport, method)(request=object())
74157416

7417+
with pytest.raises(NotImplementedError):
7418+
transport.close()
7419+
74167420

74177421
@requires_google_auth_gte_1_25_0
74187422
def test_key_management_service_base_transport_with_credentials_file():
@@ -8517,3 +8521,49 @@ async def test_test_iam_permissions_from_dict_async():
85178521
}
85188522
)
85198523
call.assert_called()
8524+
8525+
8526+
@pytest.mark.asyncio
8527+
async def test_transport_close_async():
8528+
client = KeyManagementServiceAsyncClient(
8529+
credentials=ga_credentials.AnonymousCredentials(), transport="grpc_asyncio",
8530+
)
8531+
with mock.patch.object(
8532+
type(getattr(client.transport, "grpc_channel")), "close"
8533+
) as close:
8534+
async with client:
8535+
close.assert_not_called()
8536+
close.assert_called_once()
8537+
8538+
8539+
def test_transport_close():
8540+
transports = {
8541+
"grpc": "_grpc_channel",
8542+
}
8543+
8544+
for transport, close_name in transports.items():
8545+
client = KeyManagementServiceClient(
8546+
credentials=ga_credentials.AnonymousCredentials(), transport=transport
8547+
)
8548+
with mock.patch.object(
8549+
type(getattr(client.transport, close_name)), "close"
8550+
) as close:
8551+
with client:
8552+
close.assert_not_called()
8553+
close.assert_called_once()
8554+
8555+
8556+
def test_client_ctx():
8557+
transports = [
8558+
"grpc",
8559+
]
8560+
for transport in transports:
8561+
client = KeyManagementServiceClient(
8562+
credentials=ga_credentials.AnonymousCredentials(), transport=transport
8563+
)
8564+
# Test client calls underlying transport.
8565+
with mock.patch.object(type(client.transport), "close") as close:
8566+
close.assert_not_called()
8567+
with client:
8568+
pass
8569+
close.assert_called()

0 commit comments

Comments
 (0)