Skip to content

Commit

Permalink
Browse files Browse the repository at this point in the history
feat: add context manager support in client (#516)
- [ ] 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] committed Oct 9, 2021
1 parent 5224c46 commit 51eae67
Show file tree
Hide file tree
Showing 20 changed files with 263 additions and 16 deletions.
6 changes: 6 additions & 0 deletions google/pubsub_v1/services/publisher/async_client.py
Expand Up @@ -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(
Expand Down
18 changes: 14 additions & 4 deletions google/pubsub_v1/services/publisher/client.py
Expand Up @@ -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(
Expand Down Expand Up @@ -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,
Expand Down
9 changes: 9 additions & 0 deletions google/pubsub_v1/services/publisher/transports/base.py
Expand Up @@ -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,
Expand Down
3 changes: 3 additions & 0 deletions google/pubsub_v1/services/publisher/transports/grpc.py
Expand Up @@ -559,5 +559,8 @@ def test_iam_permissions(
)
return self._stubs["test_iam_permissions"]

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


__all__ = ("PublisherGrpcTransport",)
Expand Up @@ -569,5 +569,8 @@ def test_iam_permissions(
)
return self._stubs["test_iam_permissions"]

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


__all__ = ("PublisherGrpcAsyncIOTransport",)
6 changes: 6 additions & 0 deletions google/pubsub_v1/services/schema_service/async_client.py
Expand Up @@ -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(
Expand Down
18 changes: 14 additions & 4 deletions google/pubsub_v1/services/schema_service/client.py
Expand Up @@ -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(
Expand Down Expand Up @@ -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,
Expand Down
9 changes: 9 additions & 0 deletions google/pubsub_v1/services/schema_service/transports/base.py
Expand Up @@ -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,
Expand Down
3 changes: 3 additions & 0 deletions google/pubsub_v1/services/schema_service/transports/grpc.py
Expand Up @@ -462,5 +462,8 @@ def test_iam_permissions(
)
return self._stubs["test_iam_permissions"]

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


__all__ = ("SchemaServiceGrpcTransport",)
Expand Up @@ -473,5 +473,8 @@ def test_iam_permissions(
)
return self._stubs["test_iam_permissions"]

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


__all__ = ("SchemaServiceGrpcAsyncIOTransport",)
6 changes: 6 additions & 0 deletions google/pubsub_v1/services/subscriber/async_client.py
Expand Up @@ -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(
Expand Down
18 changes: 14 additions & 4 deletions google/pubsub_v1/services/subscriber/client.py
Expand Up @@ -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(
Expand Down Expand Up @@ -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,
Expand Down
9 changes: 9 additions & 0 deletions google/pubsub_v1/services/subscriber/transports/base.py
Expand Up @@ -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,
Expand Down
3 changes: 3 additions & 0 deletions google/pubsub_v1/services/subscriber/transports/grpc.py
Expand Up @@ -817,5 +817,8 @@ def test_iam_permissions(
)
return self._stubs["test_iam_permissions"]

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


__all__ = ("SubscriberGrpcTransport",)
Expand Up @@ -830,5 +830,8 @@ def test_iam_permissions(
)
return self._stubs["test_iam_permissions"]

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


__all__ = ("SubscriberGrpcAsyncIOTransport",)
6 changes: 4 additions & 2 deletions google/pubsub_v1/types/pubsub.py
Expand Up @@ -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):
Expand Down Expand Up @@ -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))
6 changes: 4 additions & 2 deletions google/pubsub_v1/types/schema.py
Expand Up @@ -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):
Expand Down Expand Up @@ -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))
50 changes: 50 additions & 0 deletions tests/unit/gapic/pubsub_v1/test_publisher.py
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.iam.v1 import iam_policy_pb2 # type: ignore
Expand Down Expand Up @@ -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():
Expand Down Expand Up @@ -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()

0 comments on commit 51eae67

Please sign in to comment.