diff --git a/.github/.OwlBot.lock.yaml b/.github/.OwlBot.lock.yaml index 2567653..ee94722 100644 --- a/.github/.OwlBot.lock.yaml +++ b/.github/.OwlBot.lock.yaml @@ -1,3 +1,3 @@ docker: image: gcr.io/cloud-devrel-public-resources/owlbot-python:latest - digest: sha256:87eee22d276554e4e52863ec9b1cb6a7245815dfae20439712bf644348215a5a + digest: sha256:6e7328583be8edd3ba8f35311c76a1ecbc823010279ccb6ab46b7a76e25eafcc diff --git a/.kokoro/samples/lint/common.cfg b/.kokoro/samples/lint/common.cfg index 11358a2..11a1f8e 100644 --- a/.kokoro/samples/lint/common.cfg +++ b/.kokoro/samples/lint/common.cfg @@ -31,4 +31,4 @@ gfile_resources: "/bigstore/cloud-devrel-kokoro-resources/python-docs-samples" gfile_resources: "/bigstore/cloud-devrel-kokoro-resources/trampoline" # Use the trampoline script to run in docker. -build_file: "python-service-usage/.kokoro/trampoline.sh" \ No newline at end of file +build_file: "python-service-usage/.kokoro/trampoline_v2.sh" \ No newline at end of file diff --git a/.kokoro/samples/python3.6/common.cfg b/.kokoro/samples/python3.6/common.cfg index 76fcea3..d8dc40a 100644 --- a/.kokoro/samples/python3.6/common.cfg +++ b/.kokoro/samples/python3.6/common.cfg @@ -37,4 +37,4 @@ gfile_resources: "/bigstore/cloud-devrel-kokoro-resources/python-docs-samples" gfile_resources: "/bigstore/cloud-devrel-kokoro-resources/trampoline" # Use the trampoline script to run in docker. -build_file: "python-service-usage/.kokoro/trampoline.sh" \ No newline at end of file +build_file: "python-service-usage/.kokoro/trampoline_v2.sh" \ No newline at end of file diff --git a/.kokoro/samples/python3.6/periodic.cfg b/.kokoro/samples/python3.6/periodic.cfg index 50fec96..71cd1e5 100644 --- a/.kokoro/samples/python3.6/periodic.cfg +++ b/.kokoro/samples/python3.6/periodic.cfg @@ -3,4 +3,4 @@ env_vars: { key: "INSTALL_LIBRARY_FROM_SOURCE" value: "False" -} \ No newline at end of file +} diff --git a/.kokoro/samples/python3.7/common.cfg b/.kokoro/samples/python3.7/common.cfg index a87e883..cf179fb 100644 --- a/.kokoro/samples/python3.7/common.cfg +++ b/.kokoro/samples/python3.7/common.cfg @@ -37,4 +37,4 @@ gfile_resources: "/bigstore/cloud-devrel-kokoro-resources/python-docs-samples" gfile_resources: "/bigstore/cloud-devrel-kokoro-resources/trampoline" # Use the trampoline script to run in docker. -build_file: "python-service-usage/.kokoro/trampoline.sh" \ No newline at end of file +build_file: "python-service-usage/.kokoro/trampoline_v2.sh" \ No newline at end of file diff --git a/.kokoro/samples/python3.7/periodic.cfg b/.kokoro/samples/python3.7/periodic.cfg index 50fec96..71cd1e5 100644 --- a/.kokoro/samples/python3.7/periodic.cfg +++ b/.kokoro/samples/python3.7/periodic.cfg @@ -3,4 +3,4 @@ env_vars: { key: "INSTALL_LIBRARY_FROM_SOURCE" value: "False" -} \ No newline at end of file +} diff --git a/.kokoro/samples/python3.8/common.cfg b/.kokoro/samples/python3.8/common.cfg index 2967995..63e589f 100644 --- a/.kokoro/samples/python3.8/common.cfg +++ b/.kokoro/samples/python3.8/common.cfg @@ -37,4 +37,4 @@ gfile_resources: "/bigstore/cloud-devrel-kokoro-resources/python-docs-samples" gfile_resources: "/bigstore/cloud-devrel-kokoro-resources/trampoline" # Use the trampoline script to run in docker. -build_file: "python-service-usage/.kokoro/trampoline.sh" \ No newline at end of file +build_file: "python-service-usage/.kokoro/trampoline_v2.sh" \ No newline at end of file diff --git a/.kokoro/samples/python3.8/periodic.cfg b/.kokoro/samples/python3.8/periodic.cfg index 50fec96..71cd1e5 100644 --- a/.kokoro/samples/python3.8/periodic.cfg +++ b/.kokoro/samples/python3.8/periodic.cfg @@ -3,4 +3,4 @@ env_vars: { key: "INSTALL_LIBRARY_FROM_SOURCE" value: "False" -} \ No newline at end of file +} diff --git a/.kokoro/samples/python3.9/common.cfg b/.kokoro/samples/python3.9/common.cfg index 1399c3d..a6755bc 100644 --- a/.kokoro/samples/python3.9/common.cfg +++ b/.kokoro/samples/python3.9/common.cfg @@ -37,4 +37,4 @@ gfile_resources: "/bigstore/cloud-devrel-kokoro-resources/python-docs-samples" gfile_resources: "/bigstore/cloud-devrel-kokoro-resources/trampoline" # Use the trampoline script to run in docker. -build_file: "python-service-usage/.kokoro/trampoline.sh" \ No newline at end of file +build_file: "python-service-usage/.kokoro/trampoline_v2.sh" \ No newline at end of file diff --git a/.kokoro/samples/python3.9/periodic.cfg b/.kokoro/samples/python3.9/periodic.cfg index 50fec96..71cd1e5 100644 --- a/.kokoro/samples/python3.9/periodic.cfg +++ b/.kokoro/samples/python3.9/periodic.cfg @@ -3,4 +3,4 @@ env_vars: { key: "INSTALL_LIBRARY_FROM_SOURCE" value: "False" -} \ No newline at end of file +} diff --git a/.kokoro/test-samples-against-head.sh b/.kokoro/test-samples-against-head.sh index 982e17f..ba3a707 100755 --- a/.kokoro/test-samples-against-head.sh +++ b/.kokoro/test-samples-against-head.sh @@ -23,6 +23,4 @@ set -eo pipefail # Enables `**` to include files nested inside sub-folders shopt -s globstar -cd github/python-service-usage - exec .kokoro/test-samples-impl.sh diff --git a/.kokoro/test-samples.sh b/.kokoro/test-samples.sh index fbc1643..11c042d 100755 --- a/.kokoro/test-samples.sh +++ b/.kokoro/test-samples.sh @@ -24,8 +24,6 @@ set -eo pipefail # Enables `**` to include files nested inside sub-folders shopt -s globstar -cd github/python-service-usage - # Run periodic samples tests at latest release if [[ $KOKORO_BUILD_ARTIFACTS_SUBDIR = *"periodic"* ]]; then # preserving the test runner implementation. diff --git a/.repo-metadata.json b/.repo-metadata.json index 433ce6b..9a9c58e 100644 --- a/.repo-metadata.json +++ b/.repo-metadata.json @@ -9,5 +9,7 @@ "library_type": "GAPIC_AUTO", "repo": "googleapis/python-service-usage", "distribution_name": "google-cloud-service-usage", - "api_id": "serviceusage.googleapis.com" -} \ No newline at end of file + "api_id": "serviceusage.googleapis.com", + "default_version": "v1", + "codeowner_team": "" +} diff --git a/.trampolinerc b/.trampolinerc index 383b6ec..0eee72a 100644 --- a/.trampolinerc +++ b/.trampolinerc @@ -16,15 +16,26 @@ # Add required env vars here. required_envvars+=( - "STAGING_BUCKET" - "V2_STAGING_BUCKET" ) # Add env vars which are passed down into the container here. pass_down_envvars+=( + "NOX_SESSION" + ############### + # Docs builds + ############### "STAGING_BUCKET" "V2_STAGING_BUCKET" - "NOX_SESSION" + ################## + # Samples builds + ################## + "INSTALL_LIBRARY_FROM_SOURCE" + "RUN_TESTS_SESSION" + "BUILD_SPECIFIC_GCLOUD_PROJECT" + # Target directories. + "RUN_TESTS_DIRS" + # The nox session to run. + "RUN_TESTS_SESSION" ) # Prevent unintentional override on the default image. diff --git a/CHANGELOG.md b/CHANGELOG.md index 6fde9c9..01d7a24 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -1,5 +1,17 @@ # Changelog +## [1.1.0](https://www.github.com/googleapis/python-service-usage/compare/v1.0.1...v1.1.0) (2021-10-07) + + +### Features + +* add context manager support in client ([#49](https://www.github.com/googleapis/python-service-usage/issues/49)) ([b50e7cb](https://www.github.com/googleapis/python-service-usage/commit/b50e7cbbf53e0efb6809bce5c25cdc7369e65f5d)) + + +### Bug Fixes + +* improper types in pagers generation ([b230f5f](https://www.github.com/googleapis/python-service-usage/commit/b230f5fd83f21b7ac86bb01dac85ce403d694228)) + ### [1.0.1](https://www.github.com/googleapis/python-service-usage/compare/v1.0.0...v1.0.1) (2021-09-24) diff --git a/google/cloud/service_usage_v1/services/service_usage/async_client.py b/google/cloud/service_usage_v1/services/service_usage/async_client.py index bd605a7..ca54c71 100644 --- a/google/cloud/service_usage_v1/services/service_usage/async_client.py +++ b/google/cloud/service_usage_v1/services/service_usage/async_client.py @@ -526,6 +526,12 @@ async def batch_get_services( # 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/service_usage_v1/services/service_usage/client.py b/google/cloud/service_usage_v1/services/service_usage/client.py index d748959..ef34892 100644 --- a/google/cloud/service_usage_v1/services/service_usage/client.py +++ b/google/cloud/service_usage_v1/services/service_usage/client.py @@ -335,10 +335,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 enable_service( @@ -709,6 +706,19 @@ def batch_get_services( # 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/service_usage_v1/services/service_usage/pagers.py b/google/cloud/service_usage_v1/services/service_usage/pagers.py index 0ec5411..854acd3 100644 --- a/google/cloud/service_usage_v1/services/service_usage/pagers.py +++ b/google/cloud/service_usage_v1/services/service_usage/pagers.py @@ -15,13 +15,13 @@ # from typing import ( Any, - AsyncIterable, + AsyncIterator, Awaitable, Callable, - Iterable, Sequence, Tuple, Optional, + Iterator, ) from google.cloud.service_usage_v1.types import resources @@ -75,14 +75,14 @@ def __getattr__(self, name: str) -> Any: return getattr(self._response, name) @property - def pages(self) -> Iterable[serviceusage.ListServicesResponse]: + def pages(self) -> Iterator[serviceusage.ListServicesResponse]: yield self._response while self._response.next_page_token: self._request.page_token = self._response.next_page_token self._response = self._method(self._request, metadata=self._metadata) yield self._response - def __iter__(self) -> Iterable[resources.Service]: + def __iter__(self) -> Iterator[resources.Service]: for page in self.pages: yield from page.services @@ -137,14 +137,14 @@ def __getattr__(self, name: str) -> Any: return getattr(self._response, name) @property - async def pages(self) -> AsyncIterable[serviceusage.ListServicesResponse]: + async def pages(self) -> AsyncIterator[serviceusage.ListServicesResponse]: yield self._response while self._response.next_page_token: self._request.page_token = self._response.next_page_token self._response = await self._method(self._request, metadata=self._metadata) yield self._response - def __aiter__(self) -> AsyncIterable[resources.Service]: + def __aiter__(self) -> AsyncIterator[resources.Service]: async def async_generator(): async for page in self.pages: for response in page.services: diff --git a/google/cloud/service_usage_v1/services/service_usage/transports/base.py b/google/cloud/service_usage_v1/services/service_usage/transports/base.py index f8f27ed..aef3be4 100644 --- a/google/cloud/service_usage_v1/services/service_usage/transports/base.py +++ b/google/cloud/service_usage_v1/services/service_usage/transports/base.py @@ -183,6 +183,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/service_usage_v1/services/service_usage/transports/grpc.py b/google/cloud/service_usage_v1/services/service_usage/transports/grpc.py index 4ffc10c..66e6bf6 100644 --- a/google/cloud/service_usage_v1/services/service_usage/transports/grpc.py +++ b/google/cloud/service_usage_v1/services/service_usage/transports/grpc.py @@ -434,5 +434,8 @@ def batch_get_services( ) return self._stubs["batch_get_services"] + def close(self): + self.grpc_channel.close() + __all__ = ("ServiceUsageGrpcTransport",) diff --git a/google/cloud/service_usage_v1/services/service_usage/transports/grpc_asyncio.py b/google/cloud/service_usage_v1/services/service_usage/transports/grpc_asyncio.py index be3338f..895a3b0 100644 --- a/google/cloud/service_usage_v1/services/service_usage/transports/grpc_asyncio.py +++ b/google/cloud/service_usage_v1/services/service_usage/transports/grpc_asyncio.py @@ -446,5 +446,8 @@ def batch_get_services( ) return self._stubs["batch_get_services"] + def close(self): + return self.grpc_channel.close() + __all__ = ("ServiceUsageGrpcAsyncIOTransport",) diff --git a/google/cloud/service_usage_v1/types/resources.py b/google/cloud/service_usage_v1/types/resources.py index 39820dc..9e46bdd 100644 --- a/google/cloud/service_usage_v1/types/resources.py +++ b/google/cloud/service_usage_v1/types/resources.py @@ -42,6 +42,7 @@ class State(proto.Enum): class Service(proto.Message): r"""A service that is available for use by the consumer. + Attributes: name (str): The resource name of the consumer and @@ -71,6 +72,7 @@ class Service(proto.Message): class ServiceConfig(proto.Message): r"""The configuration of the service. + Attributes: name (str): The DNS address at which this service is available. diff --git a/google/cloud/service_usage_v1/types/serviceusage.py b/google/cloud/service_usage_v1/types/serviceusage.py index b05ec0e..fc5a12c 100644 --- a/google/cloud/service_usage_v1/types/serviceusage.py +++ b/google/cloud/service_usage_v1/types/serviceusage.py @@ -236,6 +236,7 @@ class BatchEnableServicesResponse(proto.Message): class EnableFailure(proto.Message): r"""Provides error messages for the failing services. + Attributes: service_id (str): The service id of a service that could not be diff --git a/setup.py b/setup.py index 2d6511d..07e999e 100644 --- a/setup.py +++ b/setup.py @@ -22,7 +22,7 @@ name = "google-cloud-service-usage" description = "Service Usage API client library" -version = "1.0.1" +version = "1.1.0" release_status = "Development Status :: 5 - Production/Stable" url = "https://github.com/googleapis/python-service-usage" dependencies = [ diff --git a/tests/unit/gapic/service_usage_v1/test_service_usage.py b/tests/unit/gapic/service_usage_v1/test_service_usage.py index ad64637..8d91ee9 100644 --- a/tests/unit/gapic/service_usage_v1/test_service_usage.py +++ b/tests/unit/gapic/service_usage_v1/test_service_usage.py @@ -32,6 +32,7 @@ from google.api_core import grpc_helpers_async from google.api_core import operation_async # type: ignore from google.api_core import operations_v1 +from google.api_core import path_template from google.auth import credentials as ga_credentials from google.auth.exceptions import MutualTLSChannelError from google.cloud.service_usage_v1.services.service_usage import ServiceUsageAsyncClient @@ -1547,6 +1548,9 @@ def test_service_usage_base_transport(): with pytest.raises(NotImplementedError): getattr(transport, method)(request=object()) + with pytest.raises(NotImplementedError): + transport.close() + # Additionally, the LRO client (a property) should # also raise NotImplementedError with pytest.raises(NotImplementedError): @@ -2053,3 +2057,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 = ServiceUsageAsyncClient( + 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 = ServiceUsageClient( + 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 = ServiceUsageClient( + 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()