From f509558fe1967d7b0fc65c27a1a0f498bddaa915 Mon Sep 17 00:00:00 2001 From: "gcf-owl-bot[bot]" <78513119+gcf-owl-bot[bot]@users.noreply.github.com> Date: Mon, 1 Nov 2021 00:16:13 +0000 Subject: [PATCH] chore: use gapic-generator-python 0.53.4 (#52) - [ ] Regenerate this pull request now. docs: list oneofs in docstring fix(deps): require google-api-core >= 1.28.0 fix(deps): drop packaging dependency committer: busunkim96@ PiperOrigin-RevId: 406468269 Source-Link: https://github.com/googleapis/googleapis/commit/83d81b0c8fc22291a13398d6d77f02dc97a5b6f4 Source-Link: https://github.com/googleapis/googleapis-gen/commit/2ff001fbacb9e77e71d734de5f955c05fdae8526 Copy-Tag: eyJwIjoiLmdpdGh1Yi8uT3dsQm90LnlhbWwiLCJoIjoiMmZmMDAxZmJhY2I5ZTc3ZTcxZDczNGRlNWY5NTVjMDVmZGFlODUyNiJ9 --- .../services/eventarc/async_client.py | 34 +++---- .../eventarc_v1/services/eventarc/client.py | 12 +-- .../services/eventarc/transports/base.py | 37 +------- .../services/eventarc/transports/grpc.py | 2 +- .../eventarc/transports/grpc_asyncio.py | 3 +- google/cloud/eventarc_v1/types/trigger.py | 7 ++ setup.py | 3 +- testing/constraints-3.6.txt | 4 +- tests/unit/gapic/eventarc_v1/test_eventarc.py | 88 ++----------------- 9 files changed, 47 insertions(+), 143 deletions(-) diff --git a/google/cloud/eventarc_v1/services/eventarc/async_client.py b/google/cloud/eventarc_v1/services/eventarc/async_client.py index fc61090..3545caf 100644 --- a/google/cloud/eventarc_v1/services/eventarc/async_client.py +++ b/google/cloud/eventarc_v1/services/eventarc/async_client.py @@ -19,13 +19,15 @@ from typing import Dict, Sequence, Tuple, Type, Union import pkg_resources -import google.api_core.client_options as ClientOptions # type: ignore +from google.api_core.client_options import ClientOptions # type: ignore from google.api_core import exceptions as core_exceptions # type: ignore from google.api_core import gapic_v1 # type: ignore from google.api_core import retry as retries # type: ignore from google.auth import credentials as ga_credentials # type: ignore from google.oauth2 import service_account # type: ignore +OptionalRetry = Union[retries.Retry, object] + from google.api_core import operation # type: ignore from google.api_core import operation_async # type: ignore from google.cloud.eventarc_v1.services.eventarc import pagers @@ -168,17 +170,17 @@ def __init__( async def get_trigger( self, - request: eventarc.GetTriggerRequest = None, + request: Union[eventarc.GetTriggerRequest, dict] = None, *, name: str = None, - retry: retries.Retry = gapic_v1.method.DEFAULT, + retry: OptionalRetry = gapic_v1.method.DEFAULT, timeout: float = None, metadata: Sequence[Tuple[str, str]] = (), ) -> trigger.Trigger: r"""Get a single trigger. Args: - request (:class:`google.cloud.eventarc_v1.types.GetTriggerRequest`): + request (Union[google.cloud.eventarc_v1.types.GetTriggerRequest, dict]): The request object. The request message for the GetTrigger method. name (:class:`str`): @@ -239,17 +241,17 @@ async def get_trigger( async def list_triggers( self, - request: eventarc.ListTriggersRequest = None, + request: Union[eventarc.ListTriggersRequest, dict] = None, *, parent: str = None, - retry: retries.Retry = gapic_v1.method.DEFAULT, + retry: OptionalRetry = gapic_v1.method.DEFAULT, timeout: float = None, metadata: Sequence[Tuple[str, str]] = (), ) -> pagers.ListTriggersAsyncPager: r"""List triggers. Args: - request (:class:`google.cloud.eventarc_v1.types.ListTriggersRequest`): + request (Union[google.cloud.eventarc_v1.types.ListTriggersRequest, dict]): The request object. The request message for the ListTriggers method. parent (:class:`str`): @@ -319,12 +321,12 @@ async def list_triggers( async def create_trigger( self, - request: eventarc.CreateTriggerRequest = None, + request: Union[eventarc.CreateTriggerRequest, dict] = None, *, parent: str = None, trigger: gce_trigger.Trigger = None, trigger_id: str = None, - retry: retries.Retry = gapic_v1.method.DEFAULT, + retry: OptionalRetry = gapic_v1.method.DEFAULT, timeout: float = None, metadata: Sequence[Tuple[str, str]] = (), ) -> operation_async.AsyncOperation: @@ -332,7 +334,7 @@ async def create_trigger( location. Args: - request (:class:`google.cloud.eventarc_v1.types.CreateTriggerRequest`): + request (Union[google.cloud.eventarc_v1.types.CreateTriggerRequest, dict]): The request object. The request message for the CreateTrigger method. parent (:class:`str`): @@ -420,19 +422,19 @@ async def create_trigger( async def update_trigger( self, - request: eventarc.UpdateTriggerRequest = None, + request: Union[eventarc.UpdateTriggerRequest, dict] = None, *, trigger: gce_trigger.Trigger = None, update_mask: field_mask_pb2.FieldMask = None, allow_missing: bool = None, - retry: retries.Retry = gapic_v1.method.DEFAULT, + retry: OptionalRetry = gapic_v1.method.DEFAULT, timeout: float = None, metadata: Sequence[Tuple[str, str]] = (), ) -> operation_async.AsyncOperation: r"""Update a single trigger. Args: - request (:class:`google.cloud.eventarc_v1.types.UpdateTriggerRequest`): + request (Union[google.cloud.eventarc_v1.types.UpdateTriggerRequest, dict]): The request object. The request message for the UpdateTrigger method. trigger (:class:`google.cloud.eventarc_v1.types.Trigger`): @@ -525,18 +527,18 @@ async def update_trigger( async def delete_trigger( self, - request: eventarc.DeleteTriggerRequest = None, + request: Union[eventarc.DeleteTriggerRequest, dict] = None, *, name: str = None, allow_missing: bool = None, - retry: retries.Retry = gapic_v1.method.DEFAULT, + retry: OptionalRetry = gapic_v1.method.DEFAULT, timeout: float = None, metadata: Sequence[Tuple[str, str]] = (), ) -> operation_async.AsyncOperation: r"""Delete a single trigger. Args: - request (:class:`google.cloud.eventarc_v1.types.DeleteTriggerRequest`): + request (Union[google.cloud.eventarc_v1.types.DeleteTriggerRequest, dict]): The request object. The request message for the DeleteTrigger method. name (:class:`str`): diff --git a/google/cloud/eventarc_v1/services/eventarc/client.py b/google/cloud/eventarc_v1/services/eventarc/client.py index 5c708c6..502528e 100644 --- a/google/cloud/eventarc_v1/services/eventarc/client.py +++ b/google/cloud/eventarc_v1/services/eventarc/client.py @@ -30,6 +30,8 @@ from google.auth.exceptions import MutualTLSChannelError # type: ignore from google.oauth2 import service_account # type: ignore +OptionalRetry = Union[retries.Retry, object] + from google.api_core import operation # type: ignore from google.api_core import operation_async # type: ignore from google.cloud.eventarc_v1.services.eventarc import pagers @@ -380,7 +382,7 @@ def get_trigger( request: Union[eventarc.GetTriggerRequest, dict] = None, *, name: str = None, - retry: retries.Retry = gapic_v1.method.DEFAULT, + retry: OptionalRetry = gapic_v1.method.DEFAULT, timeout: float = None, metadata: Sequence[Tuple[str, str]] = (), ) -> trigger.Trigger: @@ -451,7 +453,7 @@ def list_triggers( request: Union[eventarc.ListTriggersRequest, dict] = None, *, parent: str = None, - retry: retries.Retry = gapic_v1.method.DEFAULT, + retry: OptionalRetry = gapic_v1.method.DEFAULT, timeout: float = None, metadata: Sequence[Tuple[str, str]] = (), ) -> pagers.ListTriggersPager: @@ -533,7 +535,7 @@ def create_trigger( parent: str = None, trigger: gce_trigger.Trigger = None, trigger_id: str = None, - retry: retries.Retry = gapic_v1.method.DEFAULT, + retry: OptionalRetry = gapic_v1.method.DEFAULT, timeout: float = None, metadata: Sequence[Tuple[str, str]] = (), ) -> operation.Operation: @@ -634,7 +636,7 @@ def update_trigger( trigger: gce_trigger.Trigger = None, update_mask: field_mask_pb2.FieldMask = None, allow_missing: bool = None, - retry: retries.Retry = gapic_v1.method.DEFAULT, + retry: OptionalRetry = gapic_v1.method.DEFAULT, timeout: float = None, metadata: Sequence[Tuple[str, str]] = (), ) -> operation.Operation: @@ -738,7 +740,7 @@ def delete_trigger( *, name: str = None, allow_missing: bool = None, - retry: retries.Retry = gapic_v1.method.DEFAULT, + retry: OptionalRetry = gapic_v1.method.DEFAULT, timeout: float = None, metadata: Sequence[Tuple[str, str]] = (), ) -> operation.Operation: diff --git a/google/cloud/eventarc_v1/services/eventarc/transports/base.py b/google/cloud/eventarc_v1/services/eventarc/transports/base.py index a04ad25..17c76ee 100644 --- a/google/cloud/eventarc_v1/services/eventarc/transports/base.py +++ b/google/cloud/eventarc_v1/services/eventarc/transports/base.py @@ -15,7 +15,6 @@ # import abc from typing import Awaitable, Callable, Dict, Optional, Sequence, Union -import packaging.version import pkg_resources import google.auth # type: ignore @@ -38,15 +37,6 @@ except pkg_resources.DistributionNotFound: DEFAULT_CLIENT_INFO = gapic_v1.client_info.ClientInfo() -try: - # google.auth.__version__ was added in 1.26.0 - _GOOGLE_AUTH_VERSION = google.auth.__version__ -except AttributeError: - try: # try pkg_resources if it is available - _GOOGLE_AUTH_VERSION = pkg_resources.get_distribution("google-auth").version - except pkg_resources.DistributionNotFound: # pragma: NO COVER - _GOOGLE_AUTH_VERSION = None - class EventarcTransport(abc.ABC): """Abstract transport class for Eventarc.""" @@ -96,7 +86,7 @@ def __init__( host += ":443" self._host = host - scopes_kwargs = self._get_scopes_kwargs(self._host, scopes) + scopes_kwargs = {"scopes": scopes, "default_scopes": self.AUTH_SCOPES} # Save the scopes. self._scopes = scopes @@ -129,29 +119,6 @@ def __init__( # Save the credentials. self._credentials = credentials - # TODO(busunkim): This method is in the base transport - # to avoid duplicating code across the transport classes. These functions - # should be deleted once the minimum required versions of google-auth is increased. - - # TODO: Remove this function once google-auth >= 1.25.0 is required - @classmethod - def _get_scopes_kwargs( - cls, host: str, scopes: Optional[Sequence[str]] - ) -> Dict[str, Optional[Sequence[str]]]: - """Returns scopes kwargs to pass to google-auth methods depending on the google-auth version""" - - scopes_kwargs = {} - - if _GOOGLE_AUTH_VERSION and ( - packaging.version.parse(_GOOGLE_AUTH_VERSION) - >= packaging.version.parse("1.25.0") - ): - scopes_kwargs = {"scopes": scopes, "default_scopes": cls.AUTH_SCOPES} - else: - scopes_kwargs = {"scopes": scopes or cls.AUTH_SCOPES} - - return scopes_kwargs - def _prep_wrapped_messages(self, client_info): # Precompute the wrapped methods. self._wrapped_methods = { @@ -182,7 +149,7 @@ def close(self): raise NotImplementedError() @property - def operations_client(self) -> operations_v1.OperationsClient: + def operations_client(self): """Return the client designed to process long-running operations.""" raise NotImplementedError() diff --git a/google/cloud/eventarc_v1/services/eventarc/transports/grpc.py b/google/cloud/eventarc_v1/services/eventarc/transports/grpc.py index e8fe191..2dcdfc5 100644 --- a/google/cloud/eventarc_v1/services/eventarc/transports/grpc.py +++ b/google/cloud/eventarc_v1/services/eventarc/transports/grpc.py @@ -115,7 +115,7 @@ def __init__( self._grpc_channel = None self._ssl_channel_credentials = ssl_channel_credentials self._stubs: Dict[str, Callable] = {} - self._operations_client = None + self._operations_client: Optional[operations_v1.OperationsClient] = None if api_mtls_endpoint: warnings.warn("api_mtls_endpoint is deprecated", DeprecationWarning) diff --git a/google/cloud/eventarc_v1/services/eventarc/transports/grpc_asyncio.py b/google/cloud/eventarc_v1/services/eventarc/transports/grpc_asyncio.py index c4a88d2..a6f1c15 100644 --- a/google/cloud/eventarc_v1/services/eventarc/transports/grpc_asyncio.py +++ b/google/cloud/eventarc_v1/services/eventarc/transports/grpc_asyncio.py @@ -21,7 +21,6 @@ from google.api_core import operations_v1 # type: ignore from google.auth import credentials as ga_credentials # type: ignore from google.auth.transport.grpc import SslCredentials # type: ignore -import packaging.version import grpc # type: ignore from grpc.experimental import aio # type: ignore @@ -162,7 +161,7 @@ def __init__( self._grpc_channel = None self._ssl_channel_credentials = ssl_channel_credentials self._stubs: Dict[str, Callable] = {} - self._operations_client = None + self._operations_client: Optional[operations_v1.OperationsAsyncClient] = None if api_mtls_endpoint: warnings.warn("api_mtls_endpoint is deprecated", DeprecationWarning) diff --git a/google/cloud/eventarc_v1/types/trigger.py b/google/cloud/eventarc_v1/types/trigger.py index 595244f..8a85b39 100644 --- a/google/cloud/eventarc_v1/types/trigger.py +++ b/google/cloud/eventarc_v1/types/trigger.py @@ -126,11 +126,14 @@ class EventFilter(proto.Message): class Destination(proto.Message): r"""Represents a target of an invocation over HTTP. + .. _oneof: https://proto-plus-python.readthedocs.io/en/stable/fields.html#oneofs-mutually-exclusive-fields + Attributes: cloud_run (google.cloud.eventarc_v1.types.CloudRun): Cloud Run fully-managed service that receives the events. The service should be running in the same project of the trigger. + This field is a member of `oneof`_ ``descriptor``. """ cloud_run = proto.Field( @@ -142,10 +145,14 @@ class Transport(proto.Message): r"""Represents the transport intermediaries created for the trigger in order to deliver events. + + .. _oneof: https://proto-plus-python.readthedocs.io/en/stable/fields.html#oneofs-mutually-exclusive-fields + Attributes: pubsub (google.cloud.eventarc_v1.types.Pubsub): The Pub/Sub topic and subscription used by Eventarc as delivery intermediary. + This field is a member of `oneof`_ ``intermediary``. """ pubsub = proto.Field( diff --git a/setup.py b/setup.py index 7a7c4bf..1d3ade9 100644 --- a/setup.py +++ b/setup.py @@ -29,9 +29,8 @@ # NOTE: Maintainers, please do not require google-api-core>=2.x.x # Until this issue is closed # https://github.com/googleapis/google-cloud-python/issues/10566 - "google-api-core[grpc] >= 1.26.0, <3.0.0dev", + "google-api-core[grpc] >= 1.28.0, <3.0.0dev", "proto-plus >= 1.15.0", - "packaging >= 14.3", ] package_root = os.path.abspath(os.path.dirname(__file__)) diff --git a/testing/constraints-3.6.txt b/testing/constraints-3.6.txt index fe11de2..1e3ec8b 100644 --- a/testing/constraints-3.6.txt +++ b/testing/constraints-3.6.txt @@ -4,7 +4,5 @@ # Pin the version to the lower bound. # e.g., if setup.py has "google-cloud-foo >= 1.14.0, < 2.0.0dev", # Then this file should have google-cloud-foo==1.14.0 -google-api-core==1.26.0 +google-api-core==1.28.0 proto-plus==1.15.0 -packaging==14.3 -google-auth==1.24.0 # TODO: remove when google-auth>=1.25.0 si transitively required through google-api-core \ No newline at end of file diff --git a/tests/unit/gapic/eventarc_v1/test_eventarc.py b/tests/unit/gapic/eventarc_v1/test_eventarc.py index 76c91e6..860e659 100644 --- a/tests/unit/gapic/eventarc_v1/test_eventarc.py +++ b/tests/unit/gapic/eventarc_v1/test_eventarc.py @@ -15,7 +15,6 @@ # import os import mock -import packaging.version import grpc from grpc.experimental import aio @@ -39,9 +38,6 @@ from google.cloud.eventarc_v1.services.eventarc import EventarcClient from google.cloud.eventarc_v1.services.eventarc import pagers from google.cloud.eventarc_v1.services.eventarc import transports -from google.cloud.eventarc_v1.services.eventarc.transports.base import ( - _GOOGLE_AUTH_VERSION, -) from google.cloud.eventarc_v1.types import eventarc from google.cloud.eventarc_v1.types import trigger from google.cloud.eventarc_v1.types import trigger as gce_trigger @@ -52,20 +48,6 @@ import google.auth -# TODO(busunkim): Once google-auth >= 1.25.0 is required transitively -# through google-api-core: -# - Delete the auth "less than" test cases -# - Delete these pytest markers (Make the "greater than or equal to" tests the default). -requires_google_auth_lt_1_25_0 = pytest.mark.skipif( - packaging.version.parse(_GOOGLE_AUTH_VERSION) >= packaging.version.parse("1.25.0"), - reason="This test requires google-auth < 1.25.0", -) -requires_google_auth_gte_1_25_0 = pytest.mark.skipif( - packaging.version.parse(_GOOGLE_AUTH_VERSION) < packaging.version.parse("1.25.0"), - reason="This test requires google-auth >= 1.25.0", -) - - def client_cert_source_callback(): return b"cert bytes", b"key bytes" @@ -205,7 +187,7 @@ def test_eventarc_client_client_options(client_class, transport_class, transport options = client_options.ClientOptions(api_endpoint="squid.clam.whelk") with mock.patch.object(transport_class, "__init__") as patched: patched.return_value = None - client = client_class(client_options=options) + client = client_class(transport=transport_name, client_options=options) patched.assert_called_once_with( credentials=None, credentials_file=None, @@ -222,7 +204,7 @@ def test_eventarc_client_client_options(client_class, transport_class, transport with mock.patch.dict(os.environ, {"GOOGLE_API_USE_MTLS_ENDPOINT": "never"}): with mock.patch.object(transport_class, "__init__") as patched: patched.return_value = None - client = client_class() + client = client_class(transport=transport_name) patched.assert_called_once_with( credentials=None, credentials_file=None, @@ -239,7 +221,7 @@ def test_eventarc_client_client_options(client_class, transport_class, transport with mock.patch.dict(os.environ, {"GOOGLE_API_USE_MTLS_ENDPOINT": "always"}): with mock.patch.object(transport_class, "__init__") as patched: patched.return_value = None - client = client_class() + client = client_class(transport=transport_name) patched.assert_called_once_with( credentials=None, credentials_file=None, @@ -268,7 +250,7 @@ def test_eventarc_client_client_options(client_class, transport_class, transport options = client_options.ClientOptions(quota_project_id="octopus") with mock.patch.object(transport_class, "__init__") as patched: patched.return_value = None - client = client_class(client_options=options) + client = client_class(transport=transport_name, client_options=options) patched.assert_called_once_with( credentials=None, credentials_file=None, @@ -325,7 +307,7 @@ def test_eventarc_client_mtls_env_auto( ) with mock.patch.object(transport_class, "__init__") as patched: patched.return_value = None - client = client_class(client_options=options) + client = client_class(transport=transport_name, client_options=options) if use_client_cert_env == "false": expected_client_cert_source = None @@ -367,7 +349,7 @@ def test_eventarc_client_mtls_env_auto( expected_client_cert_source = client_cert_source_callback patched.return_value = None - client = client_class() + client = client_class(transport=transport_name) patched.assert_called_once_with( credentials=None, credentials_file=None, @@ -389,7 +371,7 @@ def test_eventarc_client_mtls_env_auto( return_value=False, ): patched.return_value = None - client = client_class() + client = client_class(transport=transport_name) patched.assert_called_once_with( credentials=None, credentials_file=None, @@ -416,7 +398,7 @@ def test_eventarc_client_client_options_scopes( options = client_options.ClientOptions(scopes=["1", "2"],) with mock.patch.object(transport_class, "__init__") as patched: patched.return_value = None - client = client_class(client_options=options) + client = client_class(transport=transport_name, client_options=options) patched.assert_called_once_with( credentials=None, credentials_file=None, @@ -443,7 +425,7 @@ def test_eventarc_client_client_options_credentials_file( options = client_options.ClientOptions(credentials_file="credentials.json") with mock.patch.object(transport_class, "__init__") as patched: patched.return_value = None - client = client_class(client_options=options) + client = client_class(transport=transport_name, client_options=options) patched.assert_called_once_with( credentials=None, credentials_file="credentials.json", @@ -1744,7 +1726,6 @@ def test_eventarc_base_transport(): transport.operations_client -@requires_google_auth_gte_1_25_0 def test_eventarc_base_transport_with_credentials_file(): # Instantiate the base transport with a credentials file with mock.patch.object( @@ -1765,26 +1746,6 @@ def test_eventarc_base_transport_with_credentials_file(): ) -@requires_google_auth_lt_1_25_0 -def test_eventarc_base_transport_with_credentials_file_old_google_auth(): - # Instantiate the base transport with a credentials file - with mock.patch.object( - google.auth, "load_credentials_from_file", autospec=True - ) as load_creds, mock.patch( - "google.cloud.eventarc_v1.services.eventarc.transports.EventarcTransport._prep_wrapped_messages" - ) as Transport: - Transport.return_value = None - load_creds.return_value = (ga_credentials.AnonymousCredentials(), None) - transport = transports.EventarcTransport( - credentials_file="credentials.json", quota_project_id="octopus", - ) - load_creds.assert_called_once_with( - "credentials.json", - scopes=("https://www.googleapis.com/auth/cloud-platform",), - quota_project_id="octopus", - ) - - def test_eventarc_base_transport_with_adc(): # Test the default credentials are used if credentials and credentials_file are None. with mock.patch.object(google.auth, "default", autospec=True) as adc, mock.patch( @@ -1796,7 +1757,6 @@ def test_eventarc_base_transport_with_adc(): adc.assert_called_once() -@requires_google_auth_gte_1_25_0 def test_eventarc_auth_adc(): # If no credentials are provided, we should use ADC credentials. with mock.patch.object(google.auth, "default", autospec=True) as adc: @@ -1809,23 +1769,10 @@ def test_eventarc_auth_adc(): ) -@requires_google_auth_lt_1_25_0 -def test_eventarc_auth_adc_old_google_auth(): - # If no credentials are provided, we should use ADC credentials. - with mock.patch.object(google.auth, "default", autospec=True) as adc: - adc.return_value = (ga_credentials.AnonymousCredentials(), None) - EventarcClient() - adc.assert_called_once_with( - scopes=("https://www.googleapis.com/auth/cloud-platform",), - quota_project_id=None, - ) - - @pytest.mark.parametrize( "transport_class", [transports.EventarcGrpcTransport, transports.EventarcGrpcAsyncIOTransport,], ) -@requires_google_auth_gte_1_25_0 def test_eventarc_transport_auth_adc(transport_class): # If credentials and host are not provided, the transport class should use # ADC credentials. @@ -1839,23 +1786,6 @@ def test_eventarc_transport_auth_adc(transport_class): ) -@pytest.mark.parametrize( - "transport_class", - [transports.EventarcGrpcTransport, transports.EventarcGrpcAsyncIOTransport,], -) -@requires_google_auth_lt_1_25_0 -def test_eventarc_transport_auth_adc_old_google_auth(transport_class): - # If credentials and host are not provided, the transport class should use - # ADC credentials. - with mock.patch.object(google.auth, "default", autospec=True) as adc: - adc.return_value = (ga_credentials.AnonymousCredentials(), None) - transport_class(quota_project_id="octopus") - adc.assert_called_once_with( - scopes=("https://www.googleapis.com/auth/cloud-platform",), - quota_project_id="octopus", - ) - - @pytest.mark.parametrize( "transport_class,grpc_helpers", [