Skip to content

Commit

Permalink
feat: add context manager support in client (#175)
Browse files Browse the repository at this point in the history
- [ ] 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
  • Loading branch information
gcf-owl-bot[bot] authored Oct 8, 2021
1 parent ddb4813 commit f458433
Show file tree
Hide file tree
Showing 7 changed files with 88 additions and 4 deletions.
Original file line number Diff line number Diff line change
Expand Up @@ -2119,6 +2119,12 @@ async def update_bi_reservation(
# 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(
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -423,10 +423,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_reservation(
Expand Down Expand Up @@ -2262,6 +2259,19 @@ def update_bi_reservation(
# 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(
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -353,6 +353,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_reservation(
self,
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -950,5 +950,8 @@ def update_bi_reservation(
)
return self._stubs["update_bi_reservation"]

def close(self):
self.grpc_channel.close()


__all__ = ("ReservationServiceGrpcTransport",)
Original file line number Diff line number Diff line change
Expand Up @@ -974,5 +974,8 @@ def update_bi_reservation(
)
return self._stubs["update_bi_reservation"]

def close(self):
return self.grpc_channel.close()


__all__ = ("ReservationServiceGrpcAsyncIOTransport",)
Original file line number Diff line number Diff line change
Expand Up @@ -732,6 +732,7 @@ class MoveAssignmentRequest(proto.Message):

class BiReservation(proto.Message):
r"""Represents a BI Reservation.
Attributes:
name (str):
The resource name of the singleton BI reservation.
Expand All @@ -751,6 +752,7 @@ class BiReservation(proto.Message):

class GetBiReservationRequest(proto.Message):
r"""A request to get a singleton BI reservation.
Attributes:
name (str):
Required. Name of the requested reservation, for example:
Expand All @@ -762,6 +764,7 @@ class GetBiReservationRequest(proto.Message):

class UpdateBiReservationRequest(proto.Message):
r"""A request to update a BI reservation.
Attributes:
bi_reservation (google.cloud.bigquery_reservation_v1.types.BiReservation):
A reservation to update.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -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.bigquery_reservation_v1.services.reservation_service import (
Expand Down Expand Up @@ -6122,6 +6123,9 @@ def test_reservation_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_reservation_service_base_transport_with_credentials_file():
Expand Down Expand Up @@ -6706,3 +6710,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 = ReservationServiceAsyncClient(
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 = ReservationServiceClient(
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 = ReservationServiceClient(
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()

0 comments on commit f458433

Please sign in to comment.