Skip to content

Commit ef84740

Browse files
gcf-owl-bot[bot]gcf-owl-bot[bot]
authored
feat: add context manager support in client (#38)
- [ ] 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
1 parent 319e0bb commit ef84740

9 files changed

Lines changed: 100 additions & 4 deletions

File tree

‎packages/google-cloud-network-management/google/cloud/network_management_v1/services/reachability_service/async_client.py‎

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -729,6 +729,12 @@ async def delete_connectivity_test(
729729
# Done; return the response.
730730
return response
731731

732+
async def __aenter__(self):
733+
return self
734+
735+
async def __aexit__(self, exc_type, exc, tb):
736+
await self.transport.close()
737+
732738

733739
try:
734740
DEFAULT_CLIENT_INFO = gapic_v1.client_info.ClientInfo(

‎packages/google-cloud-network-management/google/cloud/network_management_v1/services/reachability_service/client.py‎

Lines changed: 14 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -362,10 +362,7 @@ def __init__(
362362
client_cert_source_for_mtls=client_cert_source_func,
363363
quota_project_id=client_options.quota_project_id,
364364
client_info=client_info,
365-
always_use_jwt_access=(
366-
Transport == type(self).get_transport_class("grpc")
367-
or Transport == type(self).get_transport_class("grpc_asyncio")
368-
),
365+
always_use_jwt_access=True,
369366
)
370367

371368
def list_connectivity_tests(
@@ -916,6 +913,19 @@ def delete_connectivity_test(
916913
# Done; return the response.
917914
return response
918915

916+
def __enter__(self):
917+
return self
918+
919+
def __exit__(self, type, value, traceback):
920+
"""Releases underlying transport's resources.
921+
922+
.. warning::
923+
ONLY use as a context manager if the transport is NOT shared
924+
with other clients! Exiting the with block will CLOSE the transport
925+
and may cause errors in other clients!
926+
"""
927+
self.transport.close()
928+
919929

920930
try:
921931
DEFAULT_CLIENT_INFO = gapic_v1.client_info.ClientInfo(

‎packages/google-cloud-network-management/google/cloud/network_management_v1/services/reachability_service/transports/base.py‎

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -189,6 +189,15 @@ def _prep_wrapped_messages(self, client_info):
189189
),
190190
}
191191

192+
def close(self):
193+
"""Closes resources associated with the transport.
194+
195+
.. warning::
196+
Only call this method if the transport is NOT shared
197+
with other clients - this may cause errors in other clients!
198+
"""
199+
raise NotImplementedError()
200+
192201
@property
193202
def operations_client(self) -> operations_v1.OperationsClient:
194203
"""Return the client designed to process long-running operations."""

‎packages/google-cloud-network-management/google/cloud/network_management_v1/services/reachability_service/transports/grpc.py‎

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -462,5 +462,8 @@ def delete_connectivity_test(
462462
)
463463
return self._stubs["delete_connectivity_test"]
464464

465+
def close(self):
466+
self.grpc_channel.close()
467+
465468

466469
__all__ = ("ReachabilityServiceGrpcTransport",)

‎packages/google-cloud-network-management/google/cloud/network_management_v1/services/reachability_service/transports/grpc_asyncio.py‎

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -471,5 +471,8 @@ def delete_connectivity_test(
471471
)
472472
return self._stubs["delete_connectivity_test"]
473473

474+
def close(self):
475+
return self.grpc_channel.close()
476+
474477

475478
__all__ = ("ReachabilityServiceGrpcAsyncIOTransport",)

‎packages/google-cloud-network-management/google/cloud/network_management_v1/types/connectivity_test.py‎

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -28,6 +28,7 @@
2828

2929
class ConnectivityTest(proto.Message):
3030
r"""A Connectivity Test for a network reachability analysis.
31+
3132
Attributes:
3233
name (str):
3334
Required. Unique name of the resource using the form:
@@ -134,6 +135,7 @@ class ConnectivityTest(proto.Message):
134135

135136
class Endpoint(proto.Message):
136137
r"""Source or destination of the Connectivity Test.
138+
137139
Attributes:
138140
ip_address (str):
139141
The IP address of the endpoint, which can be an external or

‎packages/google-cloud-network-management/google/cloud/network_management_v1/types/reachability.py‎

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -37,6 +37,7 @@
3737

3838
class ListConnectivityTestsRequest(proto.Message):
3939
r"""Request for the ``ListConnectivityTests`` method.
40+
4041
Attributes:
4142
parent (str):
4243
Required. The parent resource of the Connectivity Tests:
@@ -80,6 +81,7 @@ class ListConnectivityTestsRequest(proto.Message):
8081

8182
class ListConnectivityTestsResponse(proto.Message):
8283
r"""Response for the ``ListConnectivityTests`` method.
84+
8385
Attributes:
8486
resources (Sequence[google.cloud.network_management_v1.types.ConnectivityTest]):
8587
List of Connectivity Tests.
@@ -104,6 +106,7 @@ def raw_page(self):
104106

105107
class GetConnectivityTestRequest(proto.Message):
106108
r"""Request for the ``GetConnectivityTest`` method.
109+
107110
Attributes:
108111
name (str):
109112
Required. ``ConnectivityTest`` resource name using the form:
@@ -115,6 +118,7 @@ class GetConnectivityTestRequest(proto.Message):
115118

116119
class CreateConnectivityTestRequest(proto.Message):
117120
r"""Request for the ``CreateConnectivityTest`` method.
121+
118122
Attributes:
119123
parent (str):
120124
Required. The parent resource of the Connectivity Test to
@@ -142,6 +146,7 @@ class CreateConnectivityTestRequest(proto.Message):
142146

143147
class UpdateConnectivityTestRequest(proto.Message):
144148
r"""Request for the ``UpdateConnectivityTest`` method.
149+
145150
Attributes:
146151
update_mask (google.protobuf.field_mask_pb2.FieldMask):
147152
Required. Mask of fields to update. At least
@@ -160,6 +165,7 @@ class UpdateConnectivityTestRequest(proto.Message):
160165

161166
class DeleteConnectivityTestRequest(proto.Message):
162167
r"""Request for the ``DeleteConnectivityTest`` method.
168+
163169
Attributes:
164170
name (str):
165171
Required. Connectivity Test resource name using the form:
@@ -171,6 +177,7 @@ class DeleteConnectivityTestRequest(proto.Message):
171177

172178
class RerunConnectivityTestRequest(proto.Message):
173179
r"""Request for the ``RerunConnectivityTest`` method.
180+
174181
Attributes:
175182
name (str):
176183
Required. Connectivity Test resource name using the form:
@@ -182,6 +189,7 @@ class RerunConnectivityTestRequest(proto.Message):
182189

183190
class OperationMetadata(proto.Message):
184191
r"""Metadata describing an [Operation][google.longrunning.Operation]
192+
185193
Attributes:
186194
create_time (google.protobuf.timestamp_pb2.Timestamp):
187195
The time the operation was created.

‎packages/google-cloud-network-management/google/cloud/network_management_v1/types/trace.py‎

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -428,6 +428,7 @@ class ForwardingRuleInfo(proto.Message):
428428

429429
class LoadBalancerInfo(proto.Message):
430430
r"""For display only. Metadata associated with a load balancer.
431+
431432
Attributes:
432433
load_balancer_type (google.cloud.network_management_v1.types.LoadBalancerInfo.LoadBalancerType):
433434
Type of the load balancer.
@@ -626,6 +627,7 @@ class EndpointInfo(proto.Message):
626627

627628
class DeliverInfo(proto.Message):
628629
r"""Details of the final state "deliver" and associated resource.
630+
629631
Attributes:
630632
target (google.cloud.network_management_v1.types.DeliverInfo.Target):
631633
Target type where the packet is delivered to.
@@ -649,6 +651,7 @@ class Target(proto.Enum):
649651

650652
class ForwardInfo(proto.Message):
651653
r"""Details of the final state "forward" and associated resource.
654+
652655
Attributes:
653656
target (google.cloud.network_management_v1.types.ForwardInfo.Target):
654657
Target type where this packet is forwarded
@@ -674,6 +677,7 @@ class Target(proto.Enum):
674677

675678
class AbortInfo(proto.Message):
676679
r"""Details of the final state "abort" and associated resource.
680+
677681
Attributes:
678682
cause (google.cloud.network_management_v1.types.AbortInfo.Cause):
679683
Causes that the analysis is aborted.
@@ -705,6 +709,7 @@ class Cause(proto.Enum):
705709

706710
class DropInfo(proto.Message):
707711
r"""Details of the final state "drop" and associated resource.
712+
708713
Attributes:
709714
cause (google.cloud.network_management_v1.types.DropInfo.Cause):
710715
Cause that the packet is dropped.

‎packages/google-cloud-network-management/tests/unit/gapic/network_management_v1/test_reachability_service.py‎

Lines changed: 50 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -32,6 +32,7 @@
3232
from google.api_core import grpc_helpers_async
3333
from google.api_core import operation_async # type: ignore
3434
from google.api_core import operations_v1
35+
from google.api_core import path_template
3536
from google.auth import credentials as ga_credentials
3637
from google.auth.exceptions import MutualTLSChannelError
3738
from google.cloud.network_management_v1.services.reachability_service import (
@@ -2130,6 +2131,9 @@ def test_reachability_service_base_transport():
21302131
with pytest.raises(NotImplementedError):
21312132
getattr(transport, method)(request=object())
21322133

2134+
with pytest.raises(NotImplementedError):
2135+
transport.close()
2136+
21332137
# Additionally, the LRO client (a property) should
21342138
# also raise NotImplementedError
21352139
with pytest.raises(NotImplementedError):
@@ -2643,3 +2647,49 @@ def test_client_withDEFAULT_CLIENT_INFO():
26432647
credentials=ga_credentials.AnonymousCredentials(), client_info=client_info,
26442648
)
26452649
prep.assert_called_once_with(client_info)
2650+
2651+
2652+
@pytest.mark.asyncio
2653+
async def test_transport_close_async():
2654+
client = ReachabilityServiceAsyncClient(
2655+
credentials=ga_credentials.AnonymousCredentials(), transport="grpc_asyncio",
2656+
)
2657+
with mock.patch.object(
2658+
type(getattr(client.transport, "grpc_channel")), "close"
2659+
) as close:
2660+
async with client:
2661+
close.assert_not_called()
2662+
close.assert_called_once()
2663+
2664+
2665+
def test_transport_close():
2666+
transports = {
2667+
"grpc": "_grpc_channel",
2668+
}
2669+
2670+
for transport, close_name in transports.items():
2671+
client = ReachabilityServiceClient(
2672+
credentials=ga_credentials.AnonymousCredentials(), transport=transport
2673+
)
2674+
with mock.patch.object(
2675+
type(getattr(client.transport, close_name)), "close"
2676+
) as close:
2677+
with client:
2678+
close.assert_not_called()
2679+
close.assert_called_once()
2680+
2681+
2682+
def test_client_ctx():
2683+
transports = [
2684+
"grpc",
2685+
]
2686+
for transport in transports:
2687+
client = ReachabilityServiceClient(
2688+
credentials=ga_credentials.AnonymousCredentials(), transport=transport
2689+
)
2690+
# Test client calls underlying transport.
2691+
with mock.patch.object(type(client.transport), "close") as close:
2692+
close.assert_not_called()
2693+
with client:
2694+
pass
2695+
close.assert_called()

0 commit comments

Comments
 (0)