diff --git a/.coveragerc b/.coveragerc index 94110993..cbf0b85a 100644 --- a/.coveragerc +++ b/.coveragerc @@ -5,6 +5,7 @@ branch = True show_missing = True omit = google/cloud/vision/__init__.py + google/cloud/vision/gapic_version.py exclude_lines = # Re-enable the standard pragma pragma: NO COVER diff --git a/.github/.OwlBot.lock.yaml b/.github/.OwlBot.lock.yaml index 889f77df..5fc5daa3 100644 --- a/.github/.OwlBot.lock.yaml +++ b/.github/.OwlBot.lock.yaml @@ -13,4 +13,4 @@ # limitations under the License. docker: image: gcr.io/cloud-devrel-public-resources/owlbot-python:latest - digest: sha256:c43f1d918bcf817d337aa29ff833439494a158a0831508fda4ec75dc4c0d0320 + digest: sha256:8555f0e37e6261408f792bfd6635102d2da5ad73f8f09bcb24f25e6afb5fac97 diff --git a/.kokoro/requirements.in b/.kokoro/requirements.in index cbd7e77f..882178ce 100644 --- a/.kokoro/requirements.in +++ b/.kokoro/requirements.in @@ -1,5 +1,5 @@ gcp-docuploader -gcp-releasetool +gcp-releasetool>=1.10.5 # required for compatibility with cryptography>=39.x importlib-metadata typing-extensions twine diff --git a/.kokoro/requirements.txt b/.kokoro/requirements.txt index 05dc4672..fa99c129 100644 --- a/.kokoro/requirements.txt +++ b/.kokoro/requirements.txt @@ -113,33 +113,28 @@ commonmark==0.9.1 \ --hash=sha256:452f9dc859be7f06631ddcb328b6919c67984aca654e5fefb3914d54691aed60 \ --hash=sha256:da2f38c92590f83de410ba1a3cbceafbc74fee9def35f9251ba9a971d6d66fd9 # via rich -cryptography==38.0.3 \ - --hash=sha256:068147f32fa662c81aebab95c74679b401b12b57494872886eb5c1139250ec5d \ - --hash=sha256:06fc3cc7b6f6cca87bd56ec80a580c88f1da5306f505876a71c8cfa7050257dd \ - --hash=sha256:25c1d1f19729fb09d42e06b4bf9895212292cb27bb50229f5aa64d039ab29146 \ - --hash=sha256:402852a0aea73833d982cabb6d0c3bb582c15483d29fb7085ef2c42bfa7e38d7 \ - --hash=sha256:4e269dcd9b102c5a3d72be3c45d8ce20377b8076a43cbed6f660a1afe365e436 \ - --hash=sha256:5419a127426084933076132d317911e3c6eb77568a1ce23c3ac1e12d111e61e0 \ - --hash=sha256:554bec92ee7d1e9d10ded2f7e92a5d70c1f74ba9524947c0ba0c850c7b011828 \ - --hash=sha256:5e89468fbd2fcd733b5899333bc54d0d06c80e04cd23d8c6f3e0542358c6060b \ - --hash=sha256:65535bc550b70bd6271984d9863a37741352b4aad6fb1b3344a54e6950249b55 \ - --hash=sha256:6ab9516b85bebe7aa83f309bacc5f44a61eeb90d0b4ec125d2d003ce41932d36 \ - --hash=sha256:6addc3b6d593cd980989261dc1cce38263c76954d758c3c94de51f1e010c9a50 \ - --hash=sha256:728f2694fa743a996d7784a6194da430f197d5c58e2f4e278612b359f455e4a2 \ - --hash=sha256:785e4056b5a8b28f05a533fab69febf5004458e20dad7e2e13a3120d8ecec75a \ - --hash=sha256:78cf5eefac2b52c10398a42765bfa981ce2372cbc0457e6bf9658f41ec3c41d8 \ - --hash=sha256:7f836217000342d448e1c9a342e9163149e45d5b5eca76a30e84503a5a96cab0 \ - --hash=sha256:8d41a46251bf0634e21fac50ffd643216ccecfaf3701a063257fe0b2be1b6548 \ - --hash=sha256:984fe150f350a3c91e84de405fe49e688aa6092b3525f407a18b9646f6612320 \ - --hash=sha256:9b24bcff7853ed18a63cfb0c2b008936a9554af24af2fb146e16d8e1aed75748 \ - --hash=sha256:b1b35d9d3a65542ed2e9d90115dfd16bbc027b3f07ee3304fc83580f26e43249 \ - --hash=sha256:b1b52c9e5f8aa2b802d48bd693190341fae201ea51c7a167d69fc48b60e8a959 \ - --hash=sha256:bbf203f1a814007ce24bd4d51362991d5cb90ba0c177a9c08825f2cc304d871f \ - --hash=sha256:be243c7e2bfcf6cc4cb350c0d5cdf15ca6383bbcb2a8ef51d3c9411a9d4386f0 \ - --hash=sha256:bfbe6ee19615b07a98b1d2287d6a6073f734735b49ee45b11324d85efc4d5cbd \ - --hash=sha256:c46837ea467ed1efea562bbeb543994c2d1f6e800785bd5a2c98bc096f5cb220 \ - --hash=sha256:dfb4f4dd568de1b6af9f4cda334adf7d72cf5bc052516e1b2608b683375dd95c \ - --hash=sha256:ed7b00096790213e09eb11c97cc6e2b757f15f3d2f85833cd2d3ec3fe37c1722 +cryptography==39.0.1 \ + --hash=sha256:0f8da300b5c8af9f98111ffd512910bc792b4c77392a9523624680f7956a99d4 \ + --hash=sha256:35f7c7d015d474f4011e859e93e789c87d21f6f4880ebdc29896a60403328f1f \ + --hash=sha256:5aa67414fcdfa22cf052e640cb5ddc461924a045cacf325cd164e65312d99502 \ + --hash=sha256:5d2d8b87a490bfcd407ed9d49093793d0f75198a35e6eb1a923ce1ee86c62b41 \ + --hash=sha256:6687ef6d0a6497e2b58e7c5b852b53f62142cfa7cd1555795758934da363a965 \ + --hash=sha256:6f8ba7f0328b79f08bdacc3e4e66fb4d7aab0c3584e0bd41328dce5262e26b2e \ + --hash=sha256:706843b48f9a3f9b9911979761c91541e3d90db1ca905fd63fee540a217698bc \ + --hash=sha256:807ce09d4434881ca3a7594733669bd834f5b2c6d5c7e36f8c00f691887042ad \ + --hash=sha256:83e17b26de248c33f3acffb922748151d71827d6021d98c70e6c1a25ddd78505 \ + --hash=sha256:96f1157a7c08b5b189b16b47bc9db2332269d6680a196341bf30046330d15388 \ + --hash=sha256:aec5a6c9864be7df2240c382740fcf3b96928c46604eaa7f3091f58b878c0bb6 \ + --hash=sha256:b0afd054cd42f3d213bf82c629efb1ee5f22eba35bf0eec88ea9ea7304f511a2 \ + --hash=sha256:ced4e447ae29ca194449a3f1ce132ded8fcab06971ef5f618605aacaa612beac \ + --hash=sha256:d1f6198ee6d9148405e49887803907fe8962a23e6c6f83ea7d98f1c0de375695 \ + --hash=sha256:e124352fd3db36a9d4a21c1aa27fd5d051e621845cb87fb851c08f4f75ce8be6 \ + --hash=sha256:e422abdec8b5fa8462aa016786680720d78bdce7a30c652b7fadf83a4ba35336 \ + --hash=sha256:ef8b72fa70b348724ff1218267e7f7375b8de4e8194d1636ee60510aae104cd0 \ + --hash=sha256:f0c64d1bd842ca2633e74a1a28033d139368ad959872533b1bab8c80e8240a0c \ + --hash=sha256:f24077a3b5298a5a06a8e0536e3ea9ec60e4c7ac486755e5fb6e6ea9b3500106 \ + --hash=sha256:fdd188c8a6ef8769f148f88f859884507b954cc64db6b52f66ef199bb9ad660a \ + --hash=sha256:fe913f20024eb2cb2f323e42a64bdf2911bb9738a15dba7d3cce48151034e3a8 # via # gcp-releasetool # secretstorage @@ -159,9 +154,9 @@ gcp-docuploader==0.6.4 \ --hash=sha256:01486419e24633af78fd0167db74a2763974765ee8078ca6eb6964d0ebd388af \ --hash=sha256:70861190c123d907b3b067da896265ead2eeb9263969d6955c9e0bb091b5ccbf # via -r requirements.in -gcp-releasetool==1.10.0 \ - --hash=sha256:72a38ca91b59c24f7e699e9227c90cbe4dd71b789383cb0164b088abae294c83 \ - --hash=sha256:8c7c99320208383d4bb2b808c6880eb7a81424afe7cdba3c8d84b25f4f0e097d +gcp-releasetool==1.10.5 \ + --hash=sha256:174b7b102d704b254f2a26a3eda2c684fd3543320ec239baf771542a2e58e109 \ + --hash=sha256:e29d29927fe2ca493105a82958c6873bb2b90d503acac56be2c229e74de0eec9 # via -r requirements.in google-api-core==2.10.2 \ --hash=sha256:10c06f7739fe57781f87523375e8e1a3a4674bf6392cd6131a3222182b971320 \ diff --git a/.release-please-manifest.json b/.release-please-manifest.json index 1e585527..5af4e6d5 100644 --- a/.release-please-manifest.json +++ b/.release-please-manifest.json @@ -1,4 +1,4 @@ { - ".": "3.3.1" + ".": "3.4.0" } \ No newline at end of file diff --git a/CHANGELOG.md b/CHANGELOG.md index 6f1fb624..5a4cb1ea 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -4,6 +4,13 @@ [1]: https://pypi.org/project/google-cloud-vision/#history +## [3.4.0](https://github.com/googleapis/python-vision/compare/v3.3.1...v3.4.0) (2023-02-28) + + +### Features + +* Enable "rest" transport in Python for services supporting numeric enums ([#520](https://github.com/googleapis/python-vision/issues/520)) ([faf6d6b](https://github.com/googleapis/python-vision/commit/faf6d6b7d564fb18c21438d58a8122d085db8908)) + ## [3.3.1](https://github.com/googleapis/python-vision/compare/v3.3.0...v3.3.1) (2023-01-23) diff --git a/google/cloud/vision/gapic_version.py b/google/cloud/vision/gapic_version.py index c443818a..431567aa 100644 --- a/google/cloud/vision/gapic_version.py +++ b/google/cloud/vision/gapic_version.py @@ -13,4 +13,4 @@ # See the License for the specific language governing permissions and # limitations under the License. # -__version__ = "3.3.1" # {x-release-please-version} +__version__ = "3.4.0" # {x-release-please-version} diff --git a/google/cloud/vision_v1/__init__.py b/google/cloud/vision_v1/__init__.py index 402f1a2e..19fe49bb 100644 --- a/google/cloud/vision_v1/__init__.py +++ b/google/cloud/vision_v1/__init__.py @@ -13,7 +13,7 @@ # See the License for the specific language governing permissions and # limitations under the License. # -from google.cloud.vision import gapic_version as package_version +from google.cloud.vision_v1 import gapic_version as package_version __version__ = package_version.__version__ diff --git a/google/cloud/vision_v1/gapic_metadata.json b/google/cloud/vision_v1/gapic_metadata.json index 71b189b5..3d64633b 100644 --- a/google/cloud/vision_v1/gapic_metadata.json +++ b/google/cloud/vision_v1/gapic_metadata.json @@ -56,6 +56,31 @@ ] } } + }, + "rest": { + "libraryClient": "ImageAnnotatorClient", + "rpcs": { + "AsyncBatchAnnotateFiles": { + "methods": [ + "async_batch_annotate_files" + ] + }, + "AsyncBatchAnnotateImages": { + "methods": [ + "async_batch_annotate_images" + ] + }, + "BatchAnnotateFiles": { + "methods": [ + "batch_annotate_files" + ] + }, + "BatchAnnotateImages": { + "methods": [ + "batch_annotate_images" + ] + } + } } } }, @@ -260,6 +285,106 @@ ] } } + }, + "rest": { + "libraryClient": "ProductSearchClient", + "rpcs": { + "AddProductToProductSet": { + "methods": [ + "add_product_to_product_set" + ] + }, + "CreateProduct": { + "methods": [ + "create_product" + ] + }, + "CreateProductSet": { + "methods": [ + "create_product_set" + ] + }, + "CreateReferenceImage": { + "methods": [ + "create_reference_image" + ] + }, + "DeleteProduct": { + "methods": [ + "delete_product" + ] + }, + "DeleteProductSet": { + "methods": [ + "delete_product_set" + ] + }, + "DeleteReferenceImage": { + "methods": [ + "delete_reference_image" + ] + }, + "GetProduct": { + "methods": [ + "get_product" + ] + }, + "GetProductSet": { + "methods": [ + "get_product_set" + ] + }, + "GetReferenceImage": { + "methods": [ + "get_reference_image" + ] + }, + "ImportProductSets": { + "methods": [ + "import_product_sets" + ] + }, + "ListProductSets": { + "methods": [ + "list_product_sets" + ] + }, + "ListProducts": { + "methods": [ + "list_products" + ] + }, + "ListProductsInProductSet": { + "methods": [ + "list_products_in_product_set" + ] + }, + "ListReferenceImages": { + "methods": [ + "list_reference_images" + ] + }, + "PurgeProducts": { + "methods": [ + "purge_products" + ] + }, + "RemoveProductFromProductSet": { + "methods": [ + "remove_product_from_product_set" + ] + }, + "UpdateProduct": { + "methods": [ + "update_product" + ] + }, + "UpdateProductSet": { + "methods": [ + "update_product_set" + ] + } + } } } } diff --git a/google/cloud/vision_v1/gapic_version.py b/google/cloud/vision_v1/gapic_version.py index c443818a..431567aa 100644 --- a/google/cloud/vision_v1/gapic_version.py +++ b/google/cloud/vision_v1/gapic_version.py @@ -13,4 +13,4 @@ # See the License for the specific language governing permissions and # limitations under the License. # -__version__ = "3.3.1" # {x-release-please-version} +__version__ = "3.4.0" # {x-release-please-version} diff --git a/google/cloud/vision_v1/services/image_annotator/client.py b/google/cloud/vision_v1/services/image_annotator/client.py index aa3ca435..8f658cf0 100644 --- a/google/cloud/vision_v1/services/image_annotator/client.py +++ b/google/cloud/vision_v1/services/image_annotator/client.py @@ -52,6 +52,7 @@ from .transports.base import ImageAnnotatorTransport, DEFAULT_CLIENT_INFO from .transports.grpc import ImageAnnotatorGrpcTransport from .transports.grpc_asyncio import ImageAnnotatorGrpcAsyncIOTransport +from .transports.rest import ImageAnnotatorRestTransport class ImageAnnotatorClientMeta(type): @@ -67,6 +68,7 @@ class ImageAnnotatorClientMeta(type): ) # type: Dict[str, Type[ImageAnnotatorTransport]] _transport_registry["grpc"] = ImageAnnotatorGrpcTransport _transport_registry["grpc_asyncio"] = ImageAnnotatorGrpcAsyncIOTransport + _transport_registry["rest"] = ImageAnnotatorRestTransport def get_transport_class( cls, diff --git a/google/cloud/vision_v1/services/image_annotator/transports/__init__.py b/google/cloud/vision_v1/services/image_annotator/transports/__init__.py index bb856540..e959448a 100644 --- a/google/cloud/vision_v1/services/image_annotator/transports/__init__.py +++ b/google/cloud/vision_v1/services/image_annotator/transports/__init__.py @@ -19,15 +19,20 @@ from .base import ImageAnnotatorTransport from .grpc import ImageAnnotatorGrpcTransport from .grpc_asyncio import ImageAnnotatorGrpcAsyncIOTransport +from .rest import ImageAnnotatorRestTransport +from .rest import ImageAnnotatorRestInterceptor # Compile a registry of transports. _transport_registry = OrderedDict() # type: Dict[str, Type[ImageAnnotatorTransport]] _transport_registry["grpc"] = ImageAnnotatorGrpcTransport _transport_registry["grpc_asyncio"] = ImageAnnotatorGrpcAsyncIOTransport +_transport_registry["rest"] = ImageAnnotatorRestTransport __all__ = ( "ImageAnnotatorTransport", "ImageAnnotatorGrpcTransport", "ImageAnnotatorGrpcAsyncIOTransport", + "ImageAnnotatorRestTransport", + "ImageAnnotatorRestInterceptor", ) diff --git a/google/cloud/vision_v1/services/image_annotator/transports/rest.py b/google/cloud/vision_v1/services/image_annotator/transports/rest.py new file mode 100644 index 00000000..f991e59e --- /dev/null +++ b/google/cloud/vision_v1/services/image_annotator/transports/rest.py @@ -0,0 +1,848 @@ +# -*- coding: utf-8 -*- +# Copyright 2022 Google LLC +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. +# + +from google.auth.transport.requests import AuthorizedSession # type: ignore +import json # type: ignore +import grpc # type: ignore +from google.auth.transport.grpc import SslCredentials # type: ignore +from google.auth import credentials as ga_credentials # type: ignore +from google.api_core import exceptions as core_exceptions +from google.api_core import retry as retries +from google.api_core import rest_helpers +from google.api_core import rest_streaming +from google.api_core import path_template +from google.api_core import gapic_v1 + +from google.protobuf import json_format +from google.api_core import operations_v1 +from requests import __version__ as requests_version +import dataclasses +import re +from typing import Any, Callable, Dict, List, Optional, Sequence, Tuple, Union +import warnings + +try: + OptionalRetry = Union[retries.Retry, gapic_v1.method._MethodDefault] +except AttributeError: # pragma: NO COVER + OptionalRetry = Union[retries.Retry, object] # type: ignore + + +from google.cloud.vision_v1.types import image_annotator +from google.longrunning import operations_pb2 # type: ignore + +from .base import ( + ImageAnnotatorTransport, + DEFAULT_CLIENT_INFO as BASE_DEFAULT_CLIENT_INFO, +) + + +DEFAULT_CLIENT_INFO = gapic_v1.client_info.ClientInfo( + gapic_version=BASE_DEFAULT_CLIENT_INFO.gapic_version, + grpc_version=None, + rest_version=requests_version, +) + + +class ImageAnnotatorRestInterceptor: + """Interceptor for ImageAnnotator. + + Interceptors are used to manipulate requests, request metadata, and responses + in arbitrary ways. + Example use cases include: + * Logging + * Verifying requests according to service or custom semantics + * Stripping extraneous information from responses + + These use cases and more can be enabled by injecting an + instance of a custom subclass when constructing the ImageAnnotatorRestTransport. + + .. code-block:: python + class MyCustomImageAnnotatorInterceptor(ImageAnnotatorRestInterceptor): + def pre_async_batch_annotate_files(self, request, metadata): + logging.log(f"Received request: {request}") + return request, metadata + + def post_async_batch_annotate_files(self, response): + logging.log(f"Received response: {response}") + return response + + def pre_async_batch_annotate_images(self, request, metadata): + logging.log(f"Received request: {request}") + return request, metadata + + def post_async_batch_annotate_images(self, response): + logging.log(f"Received response: {response}") + return response + + def pre_batch_annotate_files(self, request, metadata): + logging.log(f"Received request: {request}") + return request, metadata + + def post_batch_annotate_files(self, response): + logging.log(f"Received response: {response}") + return response + + def pre_batch_annotate_images(self, request, metadata): + logging.log(f"Received request: {request}") + return request, metadata + + def post_batch_annotate_images(self, response): + logging.log(f"Received response: {response}") + return response + + transport = ImageAnnotatorRestTransport(interceptor=MyCustomImageAnnotatorInterceptor()) + client = ImageAnnotatorClient(transport=transport) + + + """ + + def pre_async_batch_annotate_files( + self, + request: image_annotator.AsyncBatchAnnotateFilesRequest, + metadata: Sequence[Tuple[str, str]], + ) -> Tuple[ + image_annotator.AsyncBatchAnnotateFilesRequest, Sequence[Tuple[str, str]] + ]: + """Pre-rpc interceptor for async_batch_annotate_files + + Override in a subclass to manipulate the request or metadata + before they are sent to the ImageAnnotator server. + """ + return request, metadata + + def post_async_batch_annotate_files( + self, response: operations_pb2.Operation + ) -> operations_pb2.Operation: + """Post-rpc interceptor for async_batch_annotate_files + + Override in a subclass to manipulate the response + after it is returned by the ImageAnnotator server but before + it is returned to user code. + """ + return response + + def pre_async_batch_annotate_images( + self, + request: image_annotator.AsyncBatchAnnotateImagesRequest, + metadata: Sequence[Tuple[str, str]], + ) -> Tuple[ + image_annotator.AsyncBatchAnnotateImagesRequest, Sequence[Tuple[str, str]] + ]: + """Pre-rpc interceptor for async_batch_annotate_images + + Override in a subclass to manipulate the request or metadata + before they are sent to the ImageAnnotator server. + """ + return request, metadata + + def post_async_batch_annotate_images( + self, response: operations_pb2.Operation + ) -> operations_pb2.Operation: + """Post-rpc interceptor for async_batch_annotate_images + + Override in a subclass to manipulate the response + after it is returned by the ImageAnnotator server but before + it is returned to user code. + """ + return response + + def pre_batch_annotate_files( + self, + request: image_annotator.BatchAnnotateFilesRequest, + metadata: Sequence[Tuple[str, str]], + ) -> Tuple[image_annotator.BatchAnnotateFilesRequest, Sequence[Tuple[str, str]]]: + """Pre-rpc interceptor for batch_annotate_files + + Override in a subclass to manipulate the request or metadata + before they are sent to the ImageAnnotator server. + """ + return request, metadata + + def post_batch_annotate_files( + self, response: image_annotator.BatchAnnotateFilesResponse + ) -> image_annotator.BatchAnnotateFilesResponse: + """Post-rpc interceptor for batch_annotate_files + + Override in a subclass to manipulate the response + after it is returned by the ImageAnnotator server but before + it is returned to user code. + """ + return response + + def pre_batch_annotate_images( + self, + request: image_annotator.BatchAnnotateImagesRequest, + metadata: Sequence[Tuple[str, str]], + ) -> Tuple[image_annotator.BatchAnnotateImagesRequest, Sequence[Tuple[str, str]]]: + """Pre-rpc interceptor for batch_annotate_images + + Override in a subclass to manipulate the request or metadata + before they are sent to the ImageAnnotator server. + """ + return request, metadata + + def post_batch_annotate_images( + self, response: image_annotator.BatchAnnotateImagesResponse + ) -> image_annotator.BatchAnnotateImagesResponse: + """Post-rpc interceptor for batch_annotate_images + + Override in a subclass to manipulate the response + after it is returned by the ImageAnnotator server but before + it is returned to user code. + """ + return response + + +@dataclasses.dataclass +class ImageAnnotatorRestStub: + _session: AuthorizedSession + _host: str + _interceptor: ImageAnnotatorRestInterceptor + + +class ImageAnnotatorRestTransport(ImageAnnotatorTransport): + """REST backend transport for ImageAnnotator. + + Service that performs Google Cloud Vision API detection tasks + over client images, such as face, landmark, logo, label, and + text detection. The ImageAnnotator service returns detected + entities from the images. + + This class defines the same methods as the primary client, so the + primary client can load the underlying transport implementation + and call it. + + It sends JSON representations of protocol buffers over HTTP/1.1 + + """ + + def __init__( + self, + *, + host: str = "vision.googleapis.com", + credentials: Optional[ga_credentials.Credentials] = None, + credentials_file: Optional[str] = None, + scopes: Optional[Sequence[str]] = None, + client_cert_source_for_mtls: Optional[Callable[[], Tuple[bytes, bytes]]] = None, + quota_project_id: Optional[str] = None, + client_info: gapic_v1.client_info.ClientInfo = DEFAULT_CLIENT_INFO, + always_use_jwt_access: Optional[bool] = False, + url_scheme: str = "https", + interceptor: Optional[ImageAnnotatorRestInterceptor] = None, + api_audience: Optional[str] = None, + ) -> None: + """Instantiate the transport. + + Args: + host (Optional[str]): + The hostname to connect to. + credentials (Optional[google.auth.credentials.Credentials]): The + authorization credentials to attach to requests. These + credentials identify the application to the service; if none + are specified, the client will attempt to ascertain the + credentials from the environment. + + credentials_file (Optional[str]): A file with credentials that can + be loaded with :func:`google.auth.load_credentials_from_file`. + This argument is ignored if ``channel`` is provided. + scopes (Optional(Sequence[str])): A list of scopes. This argument is + ignored if ``channel`` is provided. + client_cert_source_for_mtls (Callable[[], Tuple[bytes, bytes]]): Client + certificate to configure mutual TLS HTTP channel. It is ignored + if ``channel`` is provided. + quota_project_id (Optional[str]): An optional project to use for billing + and quota. + client_info (google.api_core.gapic_v1.client_info.ClientInfo): + The client info used to send a user-agent string along with + API requests. If ``None``, then default info will be used. + Generally, you only need to set this if you are developing + your own client library. + always_use_jwt_access (Optional[bool]): Whether self signed JWT should + be used for service account credentials. + url_scheme: the protocol scheme for the API endpoint. Normally + "https", but for testing or local servers, + "http" can be specified. + """ + # Run the base constructor + # TODO(yon-mg): resolve other ctor params i.e. scopes, quota, etc. + # TODO: When custom host (api_endpoint) is set, `scopes` must *also* be set on the + # credentials object + maybe_url_match = re.match("^(?Phttp(?:s)?://)?(?P.*)$", host) + if maybe_url_match is None: + raise ValueError( + f"Unexpected hostname structure: {host}" + ) # pragma: NO COVER + + url_match_items = maybe_url_match.groupdict() + + host = f"{url_scheme}://{host}" if not url_match_items["scheme"] else host + + super().__init__( + host=host, + credentials=credentials, + client_info=client_info, + always_use_jwt_access=always_use_jwt_access, + api_audience=api_audience, + ) + self._session = AuthorizedSession( + self._credentials, default_host=self.DEFAULT_HOST + ) + self._operations_client: Optional[operations_v1.AbstractOperationsClient] = None + if client_cert_source_for_mtls: + self._session.configure_mtls_channel(client_cert_source_for_mtls) + self._interceptor = interceptor or ImageAnnotatorRestInterceptor() + self._prep_wrapped_messages(client_info) + + @property + def operations_client(self) -> operations_v1.AbstractOperationsClient: + """Create the client designed to process long-running operations. + + This property caches on the instance; repeated calls return the same + client. + """ + # Only create a new client if we do not already have one. + if self._operations_client is None: + http_options: Dict[str, List[Dict[str, str]]] = { + "google.longrunning.Operations.GetOperation": [ + { + "method": "get", + "uri": "/v1/{name=projects/*/operations/*}", + }, + { + "method": "get", + "uri": "/v1/{name=projects/*/locations/*/operations/*}", + }, + { + "method": "get", + "uri": "/v1/{name=operations/*}", + }, + { + "method": "get", + "uri": "/v1/{name=locations/*/operations/*}", + }, + ], + } + + rest_transport = operations_v1.OperationsRestTransport( + host=self._host, + # use the credentials which are saved + credentials=self._credentials, + scopes=self._scopes, + http_options=http_options, + path_prefix="v1", + ) + + self._operations_client = operations_v1.AbstractOperationsClient( + transport=rest_transport + ) + + # Return the client from cache. + return self._operations_client + + class _AsyncBatchAnnotateFiles(ImageAnnotatorRestStub): + def __hash__(self): + return hash("AsyncBatchAnnotateFiles") + + __REQUIRED_FIELDS_DEFAULT_VALUES: Dict[str, Any] = {} + + @classmethod + def _get_unset_required_fields(cls, message_dict): + return { + k: v + for k, v in cls.__REQUIRED_FIELDS_DEFAULT_VALUES.items() + if k not in message_dict + } + + def __call__( + self, + request: image_annotator.AsyncBatchAnnotateFilesRequest, + *, + retry: OptionalRetry = gapic_v1.method.DEFAULT, + timeout: Optional[float] = None, + metadata: Sequence[Tuple[str, str]] = (), + ) -> operations_pb2.Operation: + r"""Call the async batch annotate + files method over HTTP. + + Args: + request (~.image_annotator.AsyncBatchAnnotateFilesRequest): + The request object. Multiple async file annotation + requests are batched into a single + service call. + + retry (google.api_core.retry.Retry): Designation of what errors, if any, + should be retried. + timeout (float): The timeout for this request. + metadata (Sequence[Tuple[str, str]]): Strings which should be + sent along with the request as metadata. + + Returns: + ~.operations_pb2.Operation: + This resource represents a + long-running operation that is the + result of a network API call. + + """ + + http_options: List[Dict[str, str]] = [ + { + "method": "post", + "uri": "/v1/files:asyncBatchAnnotate", + "body": "*", + }, + { + "method": "post", + "uri": "/v1/{parent=projects/*/locations/*}/files:asyncBatchAnnotate", + "body": "*", + }, + { + "method": "post", + "uri": "/v1/{parent=projects/*}/files:asyncBatchAnnotate", + "body": "*", + }, + ] + request, metadata = self._interceptor.pre_async_batch_annotate_files( + request, metadata + ) + pb_request = image_annotator.AsyncBatchAnnotateFilesRequest.pb(request) + transcoded_request = path_template.transcode(http_options, pb_request) + + # Jsonify the request body + + body = json_format.MessageToJson( + transcoded_request["body"], + including_default_value_fields=False, + use_integers_for_enums=True, + ) + uri = transcoded_request["uri"] + method = transcoded_request["method"] + + # Jsonify the query params + query_params = json.loads( + json_format.MessageToJson( + transcoded_request["query_params"], + including_default_value_fields=False, + use_integers_for_enums=True, + ) + ) + query_params.update(self._get_unset_required_fields(query_params)) + + query_params["$alt"] = "json;enum-encoding=int" + + # Send the request + headers = dict(metadata) + headers["Content-Type"] = "application/json" + response = getattr(self._session, method)( + "{host}{uri}".format(host=self._host, uri=uri), + timeout=timeout, + headers=headers, + params=rest_helpers.flatten_query_params(query_params, strict=True), + data=body, + ) + + # In case of error, raise the appropriate core_exceptions.GoogleAPICallError exception + # subclass. + if response.status_code >= 400: + raise core_exceptions.from_http_response(response) + + # Return the response + resp = operations_pb2.Operation() + json_format.Parse(response.content, resp, ignore_unknown_fields=True) + resp = self._interceptor.post_async_batch_annotate_files(resp) + return resp + + class _AsyncBatchAnnotateImages(ImageAnnotatorRestStub): + def __hash__(self): + return hash("AsyncBatchAnnotateImages") + + __REQUIRED_FIELDS_DEFAULT_VALUES: Dict[str, Any] = {} + + @classmethod + def _get_unset_required_fields(cls, message_dict): + return { + k: v + for k, v in cls.__REQUIRED_FIELDS_DEFAULT_VALUES.items() + if k not in message_dict + } + + def __call__( + self, + request: image_annotator.AsyncBatchAnnotateImagesRequest, + *, + retry: OptionalRetry = gapic_v1.method.DEFAULT, + timeout: Optional[float] = None, + metadata: Sequence[Tuple[str, str]] = (), + ) -> operations_pb2.Operation: + r"""Call the async batch annotate + images method over HTTP. + + Args: + request (~.image_annotator.AsyncBatchAnnotateImagesRequest): + The request object. Request for async image annotation + for a list of images. + + retry (google.api_core.retry.Retry): Designation of what errors, if any, + should be retried. + timeout (float): The timeout for this request. + metadata (Sequence[Tuple[str, str]]): Strings which should be + sent along with the request as metadata. + + Returns: + ~.operations_pb2.Operation: + This resource represents a + long-running operation that is the + result of a network API call. + + """ + + http_options: List[Dict[str, str]] = [ + { + "method": "post", + "uri": "/v1/images:asyncBatchAnnotate", + "body": "*", + }, + { + "method": "post", + "uri": "/v1/{parent=projects/*/locations/*}/images:asyncBatchAnnotate", + "body": "*", + }, + { + "method": "post", + "uri": "/v1/{parent=projects/*}/images:asyncBatchAnnotate", + "body": "*", + }, + ] + request, metadata = self._interceptor.pre_async_batch_annotate_images( + request, metadata + ) + pb_request = image_annotator.AsyncBatchAnnotateImagesRequest.pb(request) + transcoded_request = path_template.transcode(http_options, pb_request) + + # Jsonify the request body + + body = json_format.MessageToJson( + transcoded_request["body"], + including_default_value_fields=False, + use_integers_for_enums=True, + ) + uri = transcoded_request["uri"] + method = transcoded_request["method"] + + # Jsonify the query params + query_params = json.loads( + json_format.MessageToJson( + transcoded_request["query_params"], + including_default_value_fields=False, + use_integers_for_enums=True, + ) + ) + query_params.update(self._get_unset_required_fields(query_params)) + + query_params["$alt"] = "json;enum-encoding=int" + + # Send the request + headers = dict(metadata) + headers["Content-Type"] = "application/json" + response = getattr(self._session, method)( + "{host}{uri}".format(host=self._host, uri=uri), + timeout=timeout, + headers=headers, + params=rest_helpers.flatten_query_params(query_params, strict=True), + data=body, + ) + + # In case of error, raise the appropriate core_exceptions.GoogleAPICallError exception + # subclass. + if response.status_code >= 400: + raise core_exceptions.from_http_response(response) + + # Return the response + resp = operations_pb2.Operation() + json_format.Parse(response.content, resp, ignore_unknown_fields=True) + resp = self._interceptor.post_async_batch_annotate_images(resp) + return resp + + class _BatchAnnotateFiles(ImageAnnotatorRestStub): + def __hash__(self): + return hash("BatchAnnotateFiles") + + __REQUIRED_FIELDS_DEFAULT_VALUES: Dict[str, Any] = {} + + @classmethod + def _get_unset_required_fields(cls, message_dict): + return { + k: v + for k, v in cls.__REQUIRED_FIELDS_DEFAULT_VALUES.items() + if k not in message_dict + } + + def __call__( + self, + request: image_annotator.BatchAnnotateFilesRequest, + *, + retry: OptionalRetry = gapic_v1.method.DEFAULT, + timeout: Optional[float] = None, + metadata: Sequence[Tuple[str, str]] = (), + ) -> image_annotator.BatchAnnotateFilesResponse: + r"""Call the batch annotate files method over HTTP. + + Args: + request (~.image_annotator.BatchAnnotateFilesRequest): + The request object. A list of requests to annotate files + using the BatchAnnotateFiles API. + + retry (google.api_core.retry.Retry): Designation of what errors, if any, + should be retried. + timeout (float): The timeout for this request. + metadata (Sequence[Tuple[str, str]]): Strings which should be + sent along with the request as metadata. + + Returns: + ~.image_annotator.BatchAnnotateFilesResponse: + A list of file annotation responses. + """ + + http_options: List[Dict[str, str]] = [ + { + "method": "post", + "uri": "/v1/files:annotate", + "body": "*", + }, + { + "method": "post", + "uri": "/v1/{parent=projects/*/locations/*}/files:annotate", + "body": "*", + }, + { + "method": "post", + "uri": "/v1/{parent=projects/*}/files:annotate", + "body": "*", + }, + ] + request, metadata = self._interceptor.pre_batch_annotate_files( + request, metadata + ) + pb_request = image_annotator.BatchAnnotateFilesRequest.pb(request) + transcoded_request = path_template.transcode(http_options, pb_request) + + # Jsonify the request body + + body = json_format.MessageToJson( + transcoded_request["body"], + including_default_value_fields=False, + use_integers_for_enums=True, + ) + uri = transcoded_request["uri"] + method = transcoded_request["method"] + + # Jsonify the query params + query_params = json.loads( + json_format.MessageToJson( + transcoded_request["query_params"], + including_default_value_fields=False, + use_integers_for_enums=True, + ) + ) + query_params.update(self._get_unset_required_fields(query_params)) + + query_params["$alt"] = "json;enum-encoding=int" + + # Send the request + headers = dict(metadata) + headers["Content-Type"] = "application/json" + response = getattr(self._session, method)( + "{host}{uri}".format(host=self._host, uri=uri), + timeout=timeout, + headers=headers, + params=rest_helpers.flatten_query_params(query_params, strict=True), + data=body, + ) + + # In case of error, raise the appropriate core_exceptions.GoogleAPICallError exception + # subclass. + if response.status_code >= 400: + raise core_exceptions.from_http_response(response) + + # Return the response + resp = image_annotator.BatchAnnotateFilesResponse() + pb_resp = image_annotator.BatchAnnotateFilesResponse.pb(resp) + + json_format.Parse(response.content, pb_resp, ignore_unknown_fields=True) + resp = self._interceptor.post_batch_annotate_files(resp) + return resp + + class _BatchAnnotateImages(ImageAnnotatorRestStub): + def __hash__(self): + return hash("BatchAnnotateImages") + + __REQUIRED_FIELDS_DEFAULT_VALUES: Dict[str, Any] = {} + + @classmethod + def _get_unset_required_fields(cls, message_dict): + return { + k: v + for k, v in cls.__REQUIRED_FIELDS_DEFAULT_VALUES.items() + if k not in message_dict + } + + def __call__( + self, + request: image_annotator.BatchAnnotateImagesRequest, + *, + retry: OptionalRetry = gapic_v1.method.DEFAULT, + timeout: Optional[float] = None, + metadata: Sequence[Tuple[str, str]] = (), + ) -> image_annotator.BatchAnnotateImagesResponse: + r"""Call the batch annotate images method over HTTP. + + Args: + request (~.image_annotator.BatchAnnotateImagesRequest): + The request object. Multiple image annotation requests + are batched into a single service call. + + retry (google.api_core.retry.Retry): Designation of what errors, if any, + should be retried. + timeout (float): The timeout for this request. + metadata (Sequence[Tuple[str, str]]): Strings which should be + sent along with the request as metadata. + + Returns: + ~.image_annotator.BatchAnnotateImagesResponse: + Response to a batch image annotation + request. + + """ + + http_options: List[Dict[str, str]] = [ + { + "method": "post", + "uri": "/v1/images:annotate", + "body": "*", + }, + { + "method": "post", + "uri": "/v1/{parent=projects/*/locations/*}/images:annotate", + "body": "*", + }, + { + "method": "post", + "uri": "/v1/{parent=projects/*}/images:annotate", + "body": "*", + }, + ] + request, metadata = self._interceptor.pre_batch_annotate_images( + request, metadata + ) + pb_request = image_annotator.BatchAnnotateImagesRequest.pb(request) + transcoded_request = path_template.transcode(http_options, pb_request) + + # Jsonify the request body + + body = json_format.MessageToJson( + transcoded_request["body"], + including_default_value_fields=False, + use_integers_for_enums=True, + ) + uri = transcoded_request["uri"] + method = transcoded_request["method"] + + # Jsonify the query params + query_params = json.loads( + json_format.MessageToJson( + transcoded_request["query_params"], + including_default_value_fields=False, + use_integers_for_enums=True, + ) + ) + query_params.update(self._get_unset_required_fields(query_params)) + + query_params["$alt"] = "json;enum-encoding=int" + + # Send the request + headers = dict(metadata) + headers["Content-Type"] = "application/json" + response = getattr(self._session, method)( + "{host}{uri}".format(host=self._host, uri=uri), + timeout=timeout, + headers=headers, + params=rest_helpers.flatten_query_params(query_params, strict=True), + data=body, + ) + + # In case of error, raise the appropriate core_exceptions.GoogleAPICallError exception + # subclass. + if response.status_code >= 400: + raise core_exceptions.from_http_response(response) + + # Return the response + resp = image_annotator.BatchAnnotateImagesResponse() + pb_resp = image_annotator.BatchAnnotateImagesResponse.pb(resp) + + json_format.Parse(response.content, pb_resp, ignore_unknown_fields=True) + resp = self._interceptor.post_batch_annotate_images(resp) + return resp + + @property + def async_batch_annotate_files( + self, + ) -> Callable[ + [image_annotator.AsyncBatchAnnotateFilesRequest], operations_pb2.Operation + ]: + # The return type is fine, but mypy isn't sophisticated enough to determine what's going on here. + # In C++ this would require a dynamic_cast + return self._AsyncBatchAnnotateFiles(self._session, self._host, self._interceptor) # type: ignore + + @property + def async_batch_annotate_images( + self, + ) -> Callable[ + [image_annotator.AsyncBatchAnnotateImagesRequest], operations_pb2.Operation + ]: + # The return type is fine, but mypy isn't sophisticated enough to determine what's going on here. + # In C++ this would require a dynamic_cast + return self._AsyncBatchAnnotateImages(self._session, self._host, self._interceptor) # type: ignore + + @property + def batch_annotate_files( + self, + ) -> Callable[ + [image_annotator.BatchAnnotateFilesRequest], + image_annotator.BatchAnnotateFilesResponse, + ]: + # The return type is fine, but mypy isn't sophisticated enough to determine what's going on here. + # In C++ this would require a dynamic_cast + return self._BatchAnnotateFiles(self._session, self._host, self._interceptor) # type: ignore + + @property + def batch_annotate_images( + self, + ) -> Callable[ + [image_annotator.BatchAnnotateImagesRequest], + image_annotator.BatchAnnotateImagesResponse, + ]: + # The return type is fine, but mypy isn't sophisticated enough to determine what's going on here. + # In C++ this would require a dynamic_cast + return self._BatchAnnotateImages(self._session, self._host, self._interceptor) # type: ignore + + @property + def kind(self) -> str: + return "rest" + + def close(self): + self._session.close() + + +__all__ = ("ImageAnnotatorRestTransport",) diff --git a/google/cloud/vision_v1/services/product_search/client.py b/google/cloud/vision_v1/services/product_search/client.py index ccb04876..c2514da1 100644 --- a/google/cloud/vision_v1/services/product_search/client.py +++ b/google/cloud/vision_v1/services/product_search/client.py @@ -58,6 +58,7 @@ from .transports.base import ProductSearchTransport, DEFAULT_CLIENT_INFO from .transports.grpc import ProductSearchGrpcTransport from .transports.grpc_asyncio import ProductSearchGrpcAsyncIOTransport +from .transports.rest import ProductSearchRestTransport class ProductSearchClientMeta(type): @@ -71,6 +72,7 @@ class ProductSearchClientMeta(type): _transport_registry = OrderedDict() # type: Dict[str, Type[ProductSearchTransport]] _transport_registry["grpc"] = ProductSearchGrpcTransport _transport_registry["grpc_asyncio"] = ProductSearchGrpcAsyncIOTransport + _transport_registry["rest"] = ProductSearchRestTransport def get_transport_class( cls, diff --git a/google/cloud/vision_v1/services/product_search/transports/__init__.py b/google/cloud/vision_v1/services/product_search/transports/__init__.py index 40a758f5..2878a076 100644 --- a/google/cloud/vision_v1/services/product_search/transports/__init__.py +++ b/google/cloud/vision_v1/services/product_search/transports/__init__.py @@ -19,15 +19,20 @@ from .base import ProductSearchTransport from .grpc import ProductSearchGrpcTransport from .grpc_asyncio import ProductSearchGrpcAsyncIOTransport +from .rest import ProductSearchRestTransport +from .rest import ProductSearchRestInterceptor # Compile a registry of transports. _transport_registry = OrderedDict() # type: Dict[str, Type[ProductSearchTransport]] _transport_registry["grpc"] = ProductSearchGrpcTransport _transport_registry["grpc_asyncio"] = ProductSearchGrpcAsyncIOTransport +_transport_registry["rest"] = ProductSearchRestTransport __all__ = ( "ProductSearchTransport", "ProductSearchGrpcTransport", "ProductSearchGrpcAsyncIOTransport", + "ProductSearchRestTransport", + "ProductSearchRestInterceptor", ) diff --git a/google/cloud/vision_v1/services/product_search/transports/rest.py b/google/cloud/vision_v1/services/product_search/transports/rest.py new file mode 100644 index 00000000..56b9704b --- /dev/null +++ b/google/cloud/vision_v1/services/product_search/transports/rest.py @@ -0,0 +1,2701 @@ +# -*- coding: utf-8 -*- +# Copyright 2022 Google LLC +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. +# + +from google.auth.transport.requests import AuthorizedSession # type: ignore +import json # type: ignore +import grpc # type: ignore +from google.auth.transport.grpc import SslCredentials # type: ignore +from google.auth import credentials as ga_credentials # type: ignore +from google.api_core import exceptions as core_exceptions +from google.api_core import retry as retries +from google.api_core import rest_helpers +from google.api_core import rest_streaming +from google.api_core import path_template +from google.api_core import gapic_v1 + +from google.protobuf import json_format +from google.api_core import operations_v1 +from requests import __version__ as requests_version +import dataclasses +import re +from typing import Any, Callable, Dict, List, Optional, Sequence, Tuple, Union +import warnings + +try: + OptionalRetry = Union[retries.Retry, gapic_v1.method._MethodDefault] +except AttributeError: # pragma: NO COVER + OptionalRetry = Union[retries.Retry, object] # type: ignore + + +from google.cloud.vision_v1.types import product_search_service +from google.longrunning import operations_pb2 # type: ignore +from google.protobuf import empty_pb2 # type: ignore + +from .base import ( + ProductSearchTransport, + DEFAULT_CLIENT_INFO as BASE_DEFAULT_CLIENT_INFO, +) + + +DEFAULT_CLIENT_INFO = gapic_v1.client_info.ClientInfo( + gapic_version=BASE_DEFAULT_CLIENT_INFO.gapic_version, + grpc_version=None, + rest_version=requests_version, +) + + +class ProductSearchRestInterceptor: + """Interceptor for ProductSearch. + + Interceptors are used to manipulate requests, request metadata, and responses + in arbitrary ways. + Example use cases include: + * Logging + * Verifying requests according to service or custom semantics + * Stripping extraneous information from responses + + These use cases and more can be enabled by injecting an + instance of a custom subclass when constructing the ProductSearchRestTransport. + + .. code-block:: python + class MyCustomProductSearchInterceptor(ProductSearchRestInterceptor): + def pre_add_product_to_product_set(self, request, metadata): + logging.log(f"Received request: {request}") + return request, metadata + + def pre_create_product(self, request, metadata): + logging.log(f"Received request: {request}") + return request, metadata + + def post_create_product(self, response): + logging.log(f"Received response: {response}") + return response + + def pre_create_product_set(self, request, metadata): + logging.log(f"Received request: {request}") + return request, metadata + + def post_create_product_set(self, response): + logging.log(f"Received response: {response}") + return response + + def pre_create_reference_image(self, request, metadata): + logging.log(f"Received request: {request}") + return request, metadata + + def post_create_reference_image(self, response): + logging.log(f"Received response: {response}") + return response + + def pre_delete_product(self, request, metadata): + logging.log(f"Received request: {request}") + return request, metadata + + def pre_delete_product_set(self, request, metadata): + logging.log(f"Received request: {request}") + return request, metadata + + def pre_delete_reference_image(self, request, metadata): + logging.log(f"Received request: {request}") + return request, metadata + + def pre_get_product(self, request, metadata): + logging.log(f"Received request: {request}") + return request, metadata + + def post_get_product(self, response): + logging.log(f"Received response: {response}") + return response + + def pre_get_product_set(self, request, metadata): + logging.log(f"Received request: {request}") + return request, metadata + + def post_get_product_set(self, response): + logging.log(f"Received response: {response}") + return response + + def pre_get_reference_image(self, request, metadata): + logging.log(f"Received request: {request}") + return request, metadata + + def post_get_reference_image(self, response): + logging.log(f"Received response: {response}") + return response + + def pre_import_product_sets(self, request, metadata): + logging.log(f"Received request: {request}") + return request, metadata + + def post_import_product_sets(self, response): + logging.log(f"Received response: {response}") + return response + + def pre_list_products(self, request, metadata): + logging.log(f"Received request: {request}") + return request, metadata + + def post_list_products(self, response): + logging.log(f"Received response: {response}") + return response + + def pre_list_product_sets(self, request, metadata): + logging.log(f"Received request: {request}") + return request, metadata + + def post_list_product_sets(self, response): + logging.log(f"Received response: {response}") + return response + + def pre_list_products_in_product_set(self, request, metadata): + logging.log(f"Received request: {request}") + return request, metadata + + def post_list_products_in_product_set(self, response): + logging.log(f"Received response: {response}") + return response + + def pre_list_reference_images(self, request, metadata): + logging.log(f"Received request: {request}") + return request, metadata + + def post_list_reference_images(self, response): + logging.log(f"Received response: {response}") + return response + + def pre_purge_products(self, request, metadata): + logging.log(f"Received request: {request}") + return request, metadata + + def post_purge_products(self, response): + logging.log(f"Received response: {response}") + return response + + def pre_remove_product_from_product_set(self, request, metadata): + logging.log(f"Received request: {request}") + return request, metadata + + def pre_update_product(self, request, metadata): + logging.log(f"Received request: {request}") + return request, metadata + + def post_update_product(self, response): + logging.log(f"Received response: {response}") + return response + + def pre_update_product_set(self, request, metadata): + logging.log(f"Received request: {request}") + return request, metadata + + def post_update_product_set(self, response): + logging.log(f"Received response: {response}") + return response + + transport = ProductSearchRestTransport(interceptor=MyCustomProductSearchInterceptor()) + client = ProductSearchClient(transport=transport) + + + """ + + def pre_add_product_to_product_set( + self, + request: product_search_service.AddProductToProductSetRequest, + metadata: Sequence[Tuple[str, str]], + ) -> Tuple[ + product_search_service.AddProductToProductSetRequest, Sequence[Tuple[str, str]] + ]: + """Pre-rpc interceptor for add_product_to_product_set + + Override in a subclass to manipulate the request or metadata + before they are sent to the ProductSearch server. + """ + return request, metadata + + def pre_create_product( + self, + request: product_search_service.CreateProductRequest, + metadata: Sequence[Tuple[str, str]], + ) -> Tuple[product_search_service.CreateProductRequest, Sequence[Tuple[str, str]]]: + """Pre-rpc interceptor for create_product + + Override in a subclass to manipulate the request or metadata + before they are sent to the ProductSearch server. + """ + return request, metadata + + def post_create_product( + self, response: product_search_service.Product + ) -> product_search_service.Product: + """Post-rpc interceptor for create_product + + Override in a subclass to manipulate the response + after it is returned by the ProductSearch server but before + it is returned to user code. + """ + return response + + def pre_create_product_set( + self, + request: product_search_service.CreateProductSetRequest, + metadata: Sequence[Tuple[str, str]], + ) -> Tuple[ + product_search_service.CreateProductSetRequest, Sequence[Tuple[str, str]] + ]: + """Pre-rpc interceptor for create_product_set + + Override in a subclass to manipulate the request or metadata + before they are sent to the ProductSearch server. + """ + return request, metadata + + def post_create_product_set( + self, response: product_search_service.ProductSet + ) -> product_search_service.ProductSet: + """Post-rpc interceptor for create_product_set + + Override in a subclass to manipulate the response + after it is returned by the ProductSearch server but before + it is returned to user code. + """ + return response + + def pre_create_reference_image( + self, + request: product_search_service.CreateReferenceImageRequest, + metadata: Sequence[Tuple[str, str]], + ) -> Tuple[ + product_search_service.CreateReferenceImageRequest, Sequence[Tuple[str, str]] + ]: + """Pre-rpc interceptor for create_reference_image + + Override in a subclass to manipulate the request or metadata + before they are sent to the ProductSearch server. + """ + return request, metadata + + def post_create_reference_image( + self, response: product_search_service.ReferenceImage + ) -> product_search_service.ReferenceImage: + """Post-rpc interceptor for create_reference_image + + Override in a subclass to manipulate the response + after it is returned by the ProductSearch server but before + it is returned to user code. + """ + return response + + def pre_delete_product( + self, + request: product_search_service.DeleteProductRequest, + metadata: Sequence[Tuple[str, str]], + ) -> Tuple[product_search_service.DeleteProductRequest, Sequence[Tuple[str, str]]]: + """Pre-rpc interceptor for delete_product + + Override in a subclass to manipulate the request or metadata + before they are sent to the ProductSearch server. + """ + return request, metadata + + def pre_delete_product_set( + self, + request: product_search_service.DeleteProductSetRequest, + metadata: Sequence[Tuple[str, str]], + ) -> Tuple[ + product_search_service.DeleteProductSetRequest, Sequence[Tuple[str, str]] + ]: + """Pre-rpc interceptor for delete_product_set + + Override in a subclass to manipulate the request or metadata + before they are sent to the ProductSearch server. + """ + return request, metadata + + def pre_delete_reference_image( + self, + request: product_search_service.DeleteReferenceImageRequest, + metadata: Sequence[Tuple[str, str]], + ) -> Tuple[ + product_search_service.DeleteReferenceImageRequest, Sequence[Tuple[str, str]] + ]: + """Pre-rpc interceptor for delete_reference_image + + Override in a subclass to manipulate the request or metadata + before they are sent to the ProductSearch server. + """ + return request, metadata + + def pre_get_product( + self, + request: product_search_service.GetProductRequest, + metadata: Sequence[Tuple[str, str]], + ) -> Tuple[product_search_service.GetProductRequest, Sequence[Tuple[str, str]]]: + """Pre-rpc interceptor for get_product + + Override in a subclass to manipulate the request or metadata + before they are sent to the ProductSearch server. + """ + return request, metadata + + def post_get_product( + self, response: product_search_service.Product + ) -> product_search_service.Product: + """Post-rpc interceptor for get_product + + Override in a subclass to manipulate the response + after it is returned by the ProductSearch server but before + it is returned to user code. + """ + return response + + def pre_get_product_set( + self, + request: product_search_service.GetProductSetRequest, + metadata: Sequence[Tuple[str, str]], + ) -> Tuple[product_search_service.GetProductSetRequest, Sequence[Tuple[str, str]]]: + """Pre-rpc interceptor for get_product_set + + Override in a subclass to manipulate the request or metadata + before they are sent to the ProductSearch server. + """ + return request, metadata + + def post_get_product_set( + self, response: product_search_service.ProductSet + ) -> product_search_service.ProductSet: + """Post-rpc interceptor for get_product_set + + Override in a subclass to manipulate the response + after it is returned by the ProductSearch server but before + it is returned to user code. + """ + return response + + def pre_get_reference_image( + self, + request: product_search_service.GetReferenceImageRequest, + metadata: Sequence[Tuple[str, str]], + ) -> Tuple[ + product_search_service.GetReferenceImageRequest, Sequence[Tuple[str, str]] + ]: + """Pre-rpc interceptor for get_reference_image + + Override in a subclass to manipulate the request or metadata + before they are sent to the ProductSearch server. + """ + return request, metadata + + def post_get_reference_image( + self, response: product_search_service.ReferenceImage + ) -> product_search_service.ReferenceImage: + """Post-rpc interceptor for get_reference_image + + Override in a subclass to manipulate the response + after it is returned by the ProductSearch server but before + it is returned to user code. + """ + return response + + def pre_import_product_sets( + self, + request: product_search_service.ImportProductSetsRequest, + metadata: Sequence[Tuple[str, str]], + ) -> Tuple[ + product_search_service.ImportProductSetsRequest, Sequence[Tuple[str, str]] + ]: + """Pre-rpc interceptor for import_product_sets + + Override in a subclass to manipulate the request or metadata + before they are sent to the ProductSearch server. + """ + return request, metadata + + def post_import_product_sets( + self, response: operations_pb2.Operation + ) -> operations_pb2.Operation: + """Post-rpc interceptor for import_product_sets + + Override in a subclass to manipulate the response + after it is returned by the ProductSearch server but before + it is returned to user code. + """ + return response + + def pre_list_products( + self, + request: product_search_service.ListProductsRequest, + metadata: Sequence[Tuple[str, str]], + ) -> Tuple[product_search_service.ListProductsRequest, Sequence[Tuple[str, str]]]: + """Pre-rpc interceptor for list_products + + Override in a subclass to manipulate the request or metadata + before they are sent to the ProductSearch server. + """ + return request, metadata + + def post_list_products( + self, response: product_search_service.ListProductsResponse + ) -> product_search_service.ListProductsResponse: + """Post-rpc interceptor for list_products + + Override in a subclass to manipulate the response + after it is returned by the ProductSearch server but before + it is returned to user code. + """ + return response + + def pre_list_product_sets( + self, + request: product_search_service.ListProductSetsRequest, + metadata: Sequence[Tuple[str, str]], + ) -> Tuple[ + product_search_service.ListProductSetsRequest, Sequence[Tuple[str, str]] + ]: + """Pre-rpc interceptor for list_product_sets + + Override in a subclass to manipulate the request or metadata + before they are sent to the ProductSearch server. + """ + return request, metadata + + def post_list_product_sets( + self, response: product_search_service.ListProductSetsResponse + ) -> product_search_service.ListProductSetsResponse: + """Post-rpc interceptor for list_product_sets + + Override in a subclass to manipulate the response + after it is returned by the ProductSearch server but before + it is returned to user code. + """ + return response + + def pre_list_products_in_product_set( + self, + request: product_search_service.ListProductsInProductSetRequest, + metadata: Sequence[Tuple[str, str]], + ) -> Tuple[ + product_search_service.ListProductsInProductSetRequest, + Sequence[Tuple[str, str]], + ]: + """Pre-rpc interceptor for list_products_in_product_set + + Override in a subclass to manipulate the request or metadata + before they are sent to the ProductSearch server. + """ + return request, metadata + + def post_list_products_in_product_set( + self, response: product_search_service.ListProductsInProductSetResponse + ) -> product_search_service.ListProductsInProductSetResponse: + """Post-rpc interceptor for list_products_in_product_set + + Override in a subclass to manipulate the response + after it is returned by the ProductSearch server but before + it is returned to user code. + """ + return response + + def pre_list_reference_images( + self, + request: product_search_service.ListReferenceImagesRequest, + metadata: Sequence[Tuple[str, str]], + ) -> Tuple[ + product_search_service.ListReferenceImagesRequest, Sequence[Tuple[str, str]] + ]: + """Pre-rpc interceptor for list_reference_images + + Override in a subclass to manipulate the request or metadata + before they are sent to the ProductSearch server. + """ + return request, metadata + + def post_list_reference_images( + self, response: product_search_service.ListReferenceImagesResponse + ) -> product_search_service.ListReferenceImagesResponse: + """Post-rpc interceptor for list_reference_images + + Override in a subclass to manipulate the response + after it is returned by the ProductSearch server but before + it is returned to user code. + """ + return response + + def pre_purge_products( + self, + request: product_search_service.PurgeProductsRequest, + metadata: Sequence[Tuple[str, str]], + ) -> Tuple[product_search_service.PurgeProductsRequest, Sequence[Tuple[str, str]]]: + """Pre-rpc interceptor for purge_products + + Override in a subclass to manipulate the request or metadata + before they are sent to the ProductSearch server. + """ + return request, metadata + + def post_purge_products( + self, response: operations_pb2.Operation + ) -> operations_pb2.Operation: + """Post-rpc interceptor for purge_products + + Override in a subclass to manipulate the response + after it is returned by the ProductSearch server but before + it is returned to user code. + """ + return response + + def pre_remove_product_from_product_set( + self, + request: product_search_service.RemoveProductFromProductSetRequest, + metadata: Sequence[Tuple[str, str]], + ) -> Tuple[ + product_search_service.RemoveProductFromProductSetRequest, + Sequence[Tuple[str, str]], + ]: + """Pre-rpc interceptor for remove_product_from_product_set + + Override in a subclass to manipulate the request or metadata + before they are sent to the ProductSearch server. + """ + return request, metadata + + def pre_update_product( + self, + request: product_search_service.UpdateProductRequest, + metadata: Sequence[Tuple[str, str]], + ) -> Tuple[product_search_service.UpdateProductRequest, Sequence[Tuple[str, str]]]: + """Pre-rpc interceptor for update_product + + Override in a subclass to manipulate the request or metadata + before they are sent to the ProductSearch server. + """ + return request, metadata + + def post_update_product( + self, response: product_search_service.Product + ) -> product_search_service.Product: + """Post-rpc interceptor for update_product + + Override in a subclass to manipulate the response + after it is returned by the ProductSearch server but before + it is returned to user code. + """ + return response + + def pre_update_product_set( + self, + request: product_search_service.UpdateProductSetRequest, + metadata: Sequence[Tuple[str, str]], + ) -> Tuple[ + product_search_service.UpdateProductSetRequest, Sequence[Tuple[str, str]] + ]: + """Pre-rpc interceptor for update_product_set + + Override in a subclass to manipulate the request or metadata + before they are sent to the ProductSearch server. + """ + return request, metadata + + def post_update_product_set( + self, response: product_search_service.ProductSet + ) -> product_search_service.ProductSet: + """Post-rpc interceptor for update_product_set + + Override in a subclass to manipulate the response + after it is returned by the ProductSearch server but before + it is returned to user code. + """ + return response + + +@dataclasses.dataclass +class ProductSearchRestStub: + _session: AuthorizedSession + _host: str + _interceptor: ProductSearchRestInterceptor + + +class ProductSearchRestTransport(ProductSearchTransport): + """REST backend transport for ProductSearch. + + Manages Products and ProductSets of reference images for use in + product search. It uses the following resource model: + + - The API has a collection of + [ProductSet][google.cloud.vision.v1.ProductSet] resources, named + ``projects/*/locations/*/productSets/*``, which acts as a way to + put different products into groups to limit identification. + + In parallel, + + - The API has a collection of + [Product][google.cloud.vision.v1.Product] resources, named + ``projects/*/locations/*/products/*`` + + - Each [Product][google.cloud.vision.v1.Product] has a collection + of [ReferenceImage][google.cloud.vision.v1.ReferenceImage] + resources, named + ``projects/*/locations/*/products/*/referenceImages/*`` + + This class defines the same methods as the primary client, so the + primary client can load the underlying transport implementation + and call it. + + It sends JSON representations of protocol buffers over HTTP/1.1 + + """ + + def __init__( + self, + *, + host: str = "vision.googleapis.com", + credentials: Optional[ga_credentials.Credentials] = None, + credentials_file: Optional[str] = None, + scopes: Optional[Sequence[str]] = None, + client_cert_source_for_mtls: Optional[Callable[[], Tuple[bytes, bytes]]] = None, + quota_project_id: Optional[str] = None, + client_info: gapic_v1.client_info.ClientInfo = DEFAULT_CLIENT_INFO, + always_use_jwt_access: Optional[bool] = False, + url_scheme: str = "https", + interceptor: Optional[ProductSearchRestInterceptor] = None, + api_audience: Optional[str] = None, + ) -> None: + """Instantiate the transport. + + Args: + host (Optional[str]): + The hostname to connect to. + credentials (Optional[google.auth.credentials.Credentials]): The + authorization credentials to attach to requests. These + credentials identify the application to the service; if none + are specified, the client will attempt to ascertain the + credentials from the environment. + + credentials_file (Optional[str]): A file with credentials that can + be loaded with :func:`google.auth.load_credentials_from_file`. + This argument is ignored if ``channel`` is provided. + scopes (Optional(Sequence[str])): A list of scopes. This argument is + ignored if ``channel`` is provided. + client_cert_source_for_mtls (Callable[[], Tuple[bytes, bytes]]): Client + certificate to configure mutual TLS HTTP channel. It is ignored + if ``channel`` is provided. + quota_project_id (Optional[str]): An optional project to use for billing + and quota. + client_info (google.api_core.gapic_v1.client_info.ClientInfo): + The client info used to send a user-agent string along with + API requests. If ``None``, then default info will be used. + Generally, you only need to set this if you are developing + your own client library. + always_use_jwt_access (Optional[bool]): Whether self signed JWT should + be used for service account credentials. + url_scheme: the protocol scheme for the API endpoint. Normally + "https", but for testing or local servers, + "http" can be specified. + """ + # Run the base constructor + # TODO(yon-mg): resolve other ctor params i.e. scopes, quota, etc. + # TODO: When custom host (api_endpoint) is set, `scopes` must *also* be set on the + # credentials object + maybe_url_match = re.match("^(?Phttp(?:s)?://)?(?P.*)$", host) + if maybe_url_match is None: + raise ValueError( + f"Unexpected hostname structure: {host}" + ) # pragma: NO COVER + + url_match_items = maybe_url_match.groupdict() + + host = f"{url_scheme}://{host}" if not url_match_items["scheme"] else host + + super().__init__( + host=host, + credentials=credentials, + client_info=client_info, + always_use_jwt_access=always_use_jwt_access, + api_audience=api_audience, + ) + self._session = AuthorizedSession( + self._credentials, default_host=self.DEFAULT_HOST + ) + self._operations_client: Optional[operations_v1.AbstractOperationsClient] = None + if client_cert_source_for_mtls: + self._session.configure_mtls_channel(client_cert_source_for_mtls) + self._interceptor = interceptor or ProductSearchRestInterceptor() + self._prep_wrapped_messages(client_info) + + @property + def operations_client(self) -> operations_v1.AbstractOperationsClient: + """Create the client designed to process long-running operations. + + This property caches on the instance; repeated calls return the same + client. + """ + # Only create a new client if we do not already have one. + if self._operations_client is None: + http_options: Dict[str, List[Dict[str, str]]] = { + "google.longrunning.Operations.GetOperation": [ + { + "method": "get", + "uri": "/v1/{name=projects/*/operations/*}", + }, + { + "method": "get", + "uri": "/v1/{name=projects/*/locations/*/operations/*}", + }, + { + "method": "get", + "uri": "/v1/{name=operations/*}", + }, + { + "method": "get", + "uri": "/v1/{name=locations/*/operations/*}", + }, + ], + } + + rest_transport = operations_v1.OperationsRestTransport( + host=self._host, + # use the credentials which are saved + credentials=self._credentials, + scopes=self._scopes, + http_options=http_options, + path_prefix="v1", + ) + + self._operations_client = operations_v1.AbstractOperationsClient( + transport=rest_transport + ) + + # Return the client from cache. + return self._operations_client + + class _AddProductToProductSet(ProductSearchRestStub): + def __hash__(self): + return hash("AddProductToProductSet") + + __REQUIRED_FIELDS_DEFAULT_VALUES: Dict[str, Any] = {} + + @classmethod + def _get_unset_required_fields(cls, message_dict): + return { + k: v + for k, v in cls.__REQUIRED_FIELDS_DEFAULT_VALUES.items() + if k not in message_dict + } + + def __call__( + self, + request: product_search_service.AddProductToProductSetRequest, + *, + retry: OptionalRetry = gapic_v1.method.DEFAULT, + timeout: Optional[float] = None, + metadata: Sequence[Tuple[str, str]] = (), + ): + r"""Call the add product to product + set method over HTTP. + + Args: + request (~.product_search_service.AddProductToProductSetRequest): + The request object. Request message for the ``AddProductToProductSet`` + method. + + retry (google.api_core.retry.Retry): Designation of what errors, if any, + should be retried. + timeout (float): The timeout for this request. + metadata (Sequence[Tuple[str, str]]): Strings which should be + sent along with the request as metadata. + """ + + http_options: List[Dict[str, str]] = [ + { + "method": "post", + "uri": "/v1/{name=projects/*/locations/*/productSets/*}:addProduct", + "body": "*", + }, + ] + request, metadata = self._interceptor.pre_add_product_to_product_set( + request, metadata + ) + pb_request = product_search_service.AddProductToProductSetRequest.pb( + request + ) + transcoded_request = path_template.transcode(http_options, pb_request) + + # Jsonify the request body + + body = json_format.MessageToJson( + transcoded_request["body"], + including_default_value_fields=False, + use_integers_for_enums=True, + ) + uri = transcoded_request["uri"] + method = transcoded_request["method"] + + # Jsonify the query params + query_params = json.loads( + json_format.MessageToJson( + transcoded_request["query_params"], + including_default_value_fields=False, + use_integers_for_enums=True, + ) + ) + query_params.update(self._get_unset_required_fields(query_params)) + + query_params["$alt"] = "json;enum-encoding=int" + + # Send the request + headers = dict(metadata) + headers["Content-Type"] = "application/json" + response = getattr(self._session, method)( + "{host}{uri}".format(host=self._host, uri=uri), + timeout=timeout, + headers=headers, + params=rest_helpers.flatten_query_params(query_params, strict=True), + data=body, + ) + + # In case of error, raise the appropriate core_exceptions.GoogleAPICallError exception + # subclass. + if response.status_code >= 400: + raise core_exceptions.from_http_response(response) + + class _CreateProduct(ProductSearchRestStub): + def __hash__(self): + return hash("CreateProduct") + + __REQUIRED_FIELDS_DEFAULT_VALUES: Dict[str, Any] = {} + + @classmethod + def _get_unset_required_fields(cls, message_dict): + return { + k: v + for k, v in cls.__REQUIRED_FIELDS_DEFAULT_VALUES.items() + if k not in message_dict + } + + def __call__( + self, + request: product_search_service.CreateProductRequest, + *, + retry: OptionalRetry = gapic_v1.method.DEFAULT, + timeout: Optional[float] = None, + metadata: Sequence[Tuple[str, str]] = (), + ) -> product_search_service.Product: + r"""Call the create product method over HTTP. + + Args: + request (~.product_search_service.CreateProductRequest): + The request object. Request message for the ``CreateProduct`` method. + retry (google.api_core.retry.Retry): Designation of what errors, if any, + should be retried. + timeout (float): The timeout for this request. + metadata (Sequence[Tuple[str, str]]): Strings which should be + sent along with the request as metadata. + + Returns: + ~.product_search_service.Product: + A Product contains ReferenceImages. + """ + + http_options: List[Dict[str, str]] = [ + { + "method": "post", + "uri": "/v1/{parent=projects/*/locations/*}/products", + "body": "product", + }, + ] + request, metadata = self._interceptor.pre_create_product(request, metadata) + pb_request = product_search_service.CreateProductRequest.pb(request) + transcoded_request = path_template.transcode(http_options, pb_request) + + # Jsonify the request body + + body = json_format.MessageToJson( + transcoded_request["body"], + including_default_value_fields=False, + use_integers_for_enums=True, + ) + uri = transcoded_request["uri"] + method = transcoded_request["method"] + + # Jsonify the query params + query_params = json.loads( + json_format.MessageToJson( + transcoded_request["query_params"], + including_default_value_fields=False, + use_integers_for_enums=True, + ) + ) + query_params.update(self._get_unset_required_fields(query_params)) + + query_params["$alt"] = "json;enum-encoding=int" + + # Send the request + headers = dict(metadata) + headers["Content-Type"] = "application/json" + response = getattr(self._session, method)( + "{host}{uri}".format(host=self._host, uri=uri), + timeout=timeout, + headers=headers, + params=rest_helpers.flatten_query_params(query_params, strict=True), + data=body, + ) + + # In case of error, raise the appropriate core_exceptions.GoogleAPICallError exception + # subclass. + if response.status_code >= 400: + raise core_exceptions.from_http_response(response) + + # Return the response + resp = product_search_service.Product() + pb_resp = product_search_service.Product.pb(resp) + + json_format.Parse(response.content, pb_resp, ignore_unknown_fields=True) + resp = self._interceptor.post_create_product(resp) + return resp + + class _CreateProductSet(ProductSearchRestStub): + def __hash__(self): + return hash("CreateProductSet") + + __REQUIRED_FIELDS_DEFAULT_VALUES: Dict[str, Any] = {} + + @classmethod + def _get_unset_required_fields(cls, message_dict): + return { + k: v + for k, v in cls.__REQUIRED_FIELDS_DEFAULT_VALUES.items() + if k not in message_dict + } + + def __call__( + self, + request: product_search_service.CreateProductSetRequest, + *, + retry: OptionalRetry = gapic_v1.method.DEFAULT, + timeout: Optional[float] = None, + metadata: Sequence[Tuple[str, str]] = (), + ) -> product_search_service.ProductSet: + r"""Call the create product set method over HTTP. + + Args: + request (~.product_search_service.CreateProductSetRequest): + The request object. Request message for the ``CreateProductSet`` method. + retry (google.api_core.retry.Retry): Designation of what errors, if any, + should be retried. + timeout (float): The timeout for this request. + metadata (Sequence[Tuple[str, str]]): Strings which should be + sent along with the request as metadata. + + Returns: + ~.product_search_service.ProductSet: + A ProductSet contains Products. A + ProductSet can contain a maximum of 1 + million reference images. If the limit + is exceeded, periodic indexing will + fail. + + """ + + http_options: List[Dict[str, str]] = [ + { + "method": "post", + "uri": "/v1/{parent=projects/*/locations/*}/productSets", + "body": "product_set", + }, + ] + request, metadata = self._interceptor.pre_create_product_set( + request, metadata + ) + pb_request = product_search_service.CreateProductSetRequest.pb(request) + transcoded_request = path_template.transcode(http_options, pb_request) + + # Jsonify the request body + + body = json_format.MessageToJson( + transcoded_request["body"], + including_default_value_fields=False, + use_integers_for_enums=True, + ) + uri = transcoded_request["uri"] + method = transcoded_request["method"] + + # Jsonify the query params + query_params = json.loads( + json_format.MessageToJson( + transcoded_request["query_params"], + including_default_value_fields=False, + use_integers_for_enums=True, + ) + ) + query_params.update(self._get_unset_required_fields(query_params)) + + query_params["$alt"] = "json;enum-encoding=int" + + # Send the request + headers = dict(metadata) + headers["Content-Type"] = "application/json" + response = getattr(self._session, method)( + "{host}{uri}".format(host=self._host, uri=uri), + timeout=timeout, + headers=headers, + params=rest_helpers.flatten_query_params(query_params, strict=True), + data=body, + ) + + # In case of error, raise the appropriate core_exceptions.GoogleAPICallError exception + # subclass. + if response.status_code >= 400: + raise core_exceptions.from_http_response(response) + + # Return the response + resp = product_search_service.ProductSet() + pb_resp = product_search_service.ProductSet.pb(resp) + + json_format.Parse(response.content, pb_resp, ignore_unknown_fields=True) + resp = self._interceptor.post_create_product_set(resp) + return resp + + class _CreateReferenceImage(ProductSearchRestStub): + def __hash__(self): + return hash("CreateReferenceImage") + + __REQUIRED_FIELDS_DEFAULT_VALUES: Dict[str, Any] = {} + + @classmethod + def _get_unset_required_fields(cls, message_dict): + return { + k: v + for k, v in cls.__REQUIRED_FIELDS_DEFAULT_VALUES.items() + if k not in message_dict + } + + def __call__( + self, + request: product_search_service.CreateReferenceImageRequest, + *, + retry: OptionalRetry = gapic_v1.method.DEFAULT, + timeout: Optional[float] = None, + metadata: Sequence[Tuple[str, str]] = (), + ) -> product_search_service.ReferenceImage: + r"""Call the create reference image method over HTTP. + + Args: + request (~.product_search_service.CreateReferenceImageRequest): + The request object. Request message for the ``CreateReferenceImage`` method. + retry (google.api_core.retry.Retry): Designation of what errors, if any, + should be retried. + timeout (float): The timeout for this request. + metadata (Sequence[Tuple[str, str]]): Strings which should be + sent along with the request as metadata. + + Returns: + ~.product_search_service.ReferenceImage: + A ``ReferenceImage`` represents a product image and its + associated metadata, such as bounding boxes. + + """ + + http_options: List[Dict[str, str]] = [ + { + "method": "post", + "uri": "/v1/{parent=projects/*/locations/*/products/*}/referenceImages", + "body": "reference_image", + }, + ] + request, metadata = self._interceptor.pre_create_reference_image( + request, metadata + ) + pb_request = product_search_service.CreateReferenceImageRequest.pb(request) + transcoded_request = path_template.transcode(http_options, pb_request) + + # Jsonify the request body + + body = json_format.MessageToJson( + transcoded_request["body"], + including_default_value_fields=False, + use_integers_for_enums=True, + ) + uri = transcoded_request["uri"] + method = transcoded_request["method"] + + # Jsonify the query params + query_params = json.loads( + json_format.MessageToJson( + transcoded_request["query_params"], + including_default_value_fields=False, + use_integers_for_enums=True, + ) + ) + query_params.update(self._get_unset_required_fields(query_params)) + + query_params["$alt"] = "json;enum-encoding=int" + + # Send the request + headers = dict(metadata) + headers["Content-Type"] = "application/json" + response = getattr(self._session, method)( + "{host}{uri}".format(host=self._host, uri=uri), + timeout=timeout, + headers=headers, + params=rest_helpers.flatten_query_params(query_params, strict=True), + data=body, + ) + + # In case of error, raise the appropriate core_exceptions.GoogleAPICallError exception + # subclass. + if response.status_code >= 400: + raise core_exceptions.from_http_response(response) + + # Return the response + resp = product_search_service.ReferenceImage() + pb_resp = product_search_service.ReferenceImage.pb(resp) + + json_format.Parse(response.content, pb_resp, ignore_unknown_fields=True) + resp = self._interceptor.post_create_reference_image(resp) + return resp + + class _DeleteProduct(ProductSearchRestStub): + def __hash__(self): + return hash("DeleteProduct") + + __REQUIRED_FIELDS_DEFAULT_VALUES: Dict[str, Any] = {} + + @classmethod + def _get_unset_required_fields(cls, message_dict): + return { + k: v + for k, v in cls.__REQUIRED_FIELDS_DEFAULT_VALUES.items() + if k not in message_dict + } + + def __call__( + self, + request: product_search_service.DeleteProductRequest, + *, + retry: OptionalRetry = gapic_v1.method.DEFAULT, + timeout: Optional[float] = None, + metadata: Sequence[Tuple[str, str]] = (), + ): + r"""Call the delete product method over HTTP. + + Args: + request (~.product_search_service.DeleteProductRequest): + The request object. Request message for the ``DeleteProduct`` method. + retry (google.api_core.retry.Retry): Designation of what errors, if any, + should be retried. + timeout (float): The timeout for this request. + metadata (Sequence[Tuple[str, str]]): Strings which should be + sent along with the request as metadata. + """ + + http_options: List[Dict[str, str]] = [ + { + "method": "delete", + "uri": "/v1/{name=projects/*/locations/*/products/*}", + }, + ] + request, metadata = self._interceptor.pre_delete_product(request, metadata) + pb_request = product_search_service.DeleteProductRequest.pb(request) + transcoded_request = path_template.transcode(http_options, pb_request) + + uri = transcoded_request["uri"] + method = transcoded_request["method"] + + # Jsonify the query params + query_params = json.loads( + json_format.MessageToJson( + transcoded_request["query_params"], + including_default_value_fields=False, + use_integers_for_enums=True, + ) + ) + query_params.update(self._get_unset_required_fields(query_params)) + + query_params["$alt"] = "json;enum-encoding=int" + + # Send the request + headers = dict(metadata) + headers["Content-Type"] = "application/json" + response = getattr(self._session, method)( + "{host}{uri}".format(host=self._host, uri=uri), + timeout=timeout, + headers=headers, + params=rest_helpers.flatten_query_params(query_params, strict=True), + ) + + # In case of error, raise the appropriate core_exceptions.GoogleAPICallError exception + # subclass. + if response.status_code >= 400: + raise core_exceptions.from_http_response(response) + + class _DeleteProductSet(ProductSearchRestStub): + def __hash__(self): + return hash("DeleteProductSet") + + __REQUIRED_FIELDS_DEFAULT_VALUES: Dict[str, Any] = {} + + @classmethod + def _get_unset_required_fields(cls, message_dict): + return { + k: v + for k, v in cls.__REQUIRED_FIELDS_DEFAULT_VALUES.items() + if k not in message_dict + } + + def __call__( + self, + request: product_search_service.DeleteProductSetRequest, + *, + retry: OptionalRetry = gapic_v1.method.DEFAULT, + timeout: Optional[float] = None, + metadata: Sequence[Tuple[str, str]] = (), + ): + r"""Call the delete product set method over HTTP. + + Args: + request (~.product_search_service.DeleteProductSetRequest): + The request object. Request message for the ``DeleteProductSet`` method. + retry (google.api_core.retry.Retry): Designation of what errors, if any, + should be retried. + timeout (float): The timeout for this request. + metadata (Sequence[Tuple[str, str]]): Strings which should be + sent along with the request as metadata. + """ + + http_options: List[Dict[str, str]] = [ + { + "method": "delete", + "uri": "/v1/{name=projects/*/locations/*/productSets/*}", + }, + ] + request, metadata = self._interceptor.pre_delete_product_set( + request, metadata + ) + pb_request = product_search_service.DeleteProductSetRequest.pb(request) + transcoded_request = path_template.transcode(http_options, pb_request) + + uri = transcoded_request["uri"] + method = transcoded_request["method"] + + # Jsonify the query params + query_params = json.loads( + json_format.MessageToJson( + transcoded_request["query_params"], + including_default_value_fields=False, + use_integers_for_enums=True, + ) + ) + query_params.update(self._get_unset_required_fields(query_params)) + + query_params["$alt"] = "json;enum-encoding=int" + + # Send the request + headers = dict(metadata) + headers["Content-Type"] = "application/json" + response = getattr(self._session, method)( + "{host}{uri}".format(host=self._host, uri=uri), + timeout=timeout, + headers=headers, + params=rest_helpers.flatten_query_params(query_params, strict=True), + ) + + # In case of error, raise the appropriate core_exceptions.GoogleAPICallError exception + # subclass. + if response.status_code >= 400: + raise core_exceptions.from_http_response(response) + + class _DeleteReferenceImage(ProductSearchRestStub): + def __hash__(self): + return hash("DeleteReferenceImage") + + __REQUIRED_FIELDS_DEFAULT_VALUES: Dict[str, Any] = {} + + @classmethod + def _get_unset_required_fields(cls, message_dict): + return { + k: v + for k, v in cls.__REQUIRED_FIELDS_DEFAULT_VALUES.items() + if k not in message_dict + } + + def __call__( + self, + request: product_search_service.DeleteReferenceImageRequest, + *, + retry: OptionalRetry = gapic_v1.method.DEFAULT, + timeout: Optional[float] = None, + metadata: Sequence[Tuple[str, str]] = (), + ): + r"""Call the delete reference image method over HTTP. + + Args: + request (~.product_search_service.DeleteReferenceImageRequest): + The request object. Request message for the ``DeleteReferenceImage`` method. + retry (google.api_core.retry.Retry): Designation of what errors, if any, + should be retried. + timeout (float): The timeout for this request. + metadata (Sequence[Tuple[str, str]]): Strings which should be + sent along with the request as metadata. + """ + + http_options: List[Dict[str, str]] = [ + { + "method": "delete", + "uri": "/v1/{name=projects/*/locations/*/products/*/referenceImages/*}", + }, + ] + request, metadata = self._interceptor.pre_delete_reference_image( + request, metadata + ) + pb_request = product_search_service.DeleteReferenceImageRequest.pb(request) + transcoded_request = path_template.transcode(http_options, pb_request) + + uri = transcoded_request["uri"] + method = transcoded_request["method"] + + # Jsonify the query params + query_params = json.loads( + json_format.MessageToJson( + transcoded_request["query_params"], + including_default_value_fields=False, + use_integers_for_enums=True, + ) + ) + query_params.update(self._get_unset_required_fields(query_params)) + + query_params["$alt"] = "json;enum-encoding=int" + + # Send the request + headers = dict(metadata) + headers["Content-Type"] = "application/json" + response = getattr(self._session, method)( + "{host}{uri}".format(host=self._host, uri=uri), + timeout=timeout, + headers=headers, + params=rest_helpers.flatten_query_params(query_params, strict=True), + ) + + # In case of error, raise the appropriate core_exceptions.GoogleAPICallError exception + # subclass. + if response.status_code >= 400: + raise core_exceptions.from_http_response(response) + + class _GetProduct(ProductSearchRestStub): + def __hash__(self): + return hash("GetProduct") + + __REQUIRED_FIELDS_DEFAULT_VALUES: Dict[str, Any] = {} + + @classmethod + def _get_unset_required_fields(cls, message_dict): + return { + k: v + for k, v in cls.__REQUIRED_FIELDS_DEFAULT_VALUES.items() + if k not in message_dict + } + + def __call__( + self, + request: product_search_service.GetProductRequest, + *, + retry: OptionalRetry = gapic_v1.method.DEFAULT, + timeout: Optional[float] = None, + metadata: Sequence[Tuple[str, str]] = (), + ) -> product_search_service.Product: + r"""Call the get product method over HTTP. + + Args: + request (~.product_search_service.GetProductRequest): + The request object. Request message for the ``GetProduct`` method. + retry (google.api_core.retry.Retry): Designation of what errors, if any, + should be retried. + timeout (float): The timeout for this request. + metadata (Sequence[Tuple[str, str]]): Strings which should be + sent along with the request as metadata. + + Returns: + ~.product_search_service.Product: + A Product contains ReferenceImages. + """ + + http_options: List[Dict[str, str]] = [ + { + "method": "get", + "uri": "/v1/{name=projects/*/locations/*/products/*}", + }, + ] + request, metadata = self._interceptor.pre_get_product(request, metadata) + pb_request = product_search_service.GetProductRequest.pb(request) + transcoded_request = path_template.transcode(http_options, pb_request) + + uri = transcoded_request["uri"] + method = transcoded_request["method"] + + # Jsonify the query params + query_params = json.loads( + json_format.MessageToJson( + transcoded_request["query_params"], + including_default_value_fields=False, + use_integers_for_enums=True, + ) + ) + query_params.update(self._get_unset_required_fields(query_params)) + + query_params["$alt"] = "json;enum-encoding=int" + + # Send the request + headers = dict(metadata) + headers["Content-Type"] = "application/json" + response = getattr(self._session, method)( + "{host}{uri}".format(host=self._host, uri=uri), + timeout=timeout, + headers=headers, + params=rest_helpers.flatten_query_params(query_params, strict=True), + ) + + # In case of error, raise the appropriate core_exceptions.GoogleAPICallError exception + # subclass. + if response.status_code >= 400: + raise core_exceptions.from_http_response(response) + + # Return the response + resp = product_search_service.Product() + pb_resp = product_search_service.Product.pb(resp) + + json_format.Parse(response.content, pb_resp, ignore_unknown_fields=True) + resp = self._interceptor.post_get_product(resp) + return resp + + class _GetProductSet(ProductSearchRestStub): + def __hash__(self): + return hash("GetProductSet") + + __REQUIRED_FIELDS_DEFAULT_VALUES: Dict[str, Any] = {} + + @classmethod + def _get_unset_required_fields(cls, message_dict): + return { + k: v + for k, v in cls.__REQUIRED_FIELDS_DEFAULT_VALUES.items() + if k not in message_dict + } + + def __call__( + self, + request: product_search_service.GetProductSetRequest, + *, + retry: OptionalRetry = gapic_v1.method.DEFAULT, + timeout: Optional[float] = None, + metadata: Sequence[Tuple[str, str]] = (), + ) -> product_search_service.ProductSet: + r"""Call the get product set method over HTTP. + + Args: + request (~.product_search_service.GetProductSetRequest): + The request object. Request message for the ``GetProductSet`` method. + retry (google.api_core.retry.Retry): Designation of what errors, if any, + should be retried. + timeout (float): The timeout for this request. + metadata (Sequence[Tuple[str, str]]): Strings which should be + sent along with the request as metadata. + + Returns: + ~.product_search_service.ProductSet: + A ProductSet contains Products. A + ProductSet can contain a maximum of 1 + million reference images. If the limit + is exceeded, periodic indexing will + fail. + + """ + + http_options: List[Dict[str, str]] = [ + { + "method": "get", + "uri": "/v1/{name=projects/*/locations/*/productSets/*}", + }, + ] + request, metadata = self._interceptor.pre_get_product_set(request, metadata) + pb_request = product_search_service.GetProductSetRequest.pb(request) + transcoded_request = path_template.transcode(http_options, pb_request) + + uri = transcoded_request["uri"] + method = transcoded_request["method"] + + # Jsonify the query params + query_params = json.loads( + json_format.MessageToJson( + transcoded_request["query_params"], + including_default_value_fields=False, + use_integers_for_enums=True, + ) + ) + query_params.update(self._get_unset_required_fields(query_params)) + + query_params["$alt"] = "json;enum-encoding=int" + + # Send the request + headers = dict(metadata) + headers["Content-Type"] = "application/json" + response = getattr(self._session, method)( + "{host}{uri}".format(host=self._host, uri=uri), + timeout=timeout, + headers=headers, + params=rest_helpers.flatten_query_params(query_params, strict=True), + ) + + # In case of error, raise the appropriate core_exceptions.GoogleAPICallError exception + # subclass. + if response.status_code >= 400: + raise core_exceptions.from_http_response(response) + + # Return the response + resp = product_search_service.ProductSet() + pb_resp = product_search_service.ProductSet.pb(resp) + + json_format.Parse(response.content, pb_resp, ignore_unknown_fields=True) + resp = self._interceptor.post_get_product_set(resp) + return resp + + class _GetReferenceImage(ProductSearchRestStub): + def __hash__(self): + return hash("GetReferenceImage") + + __REQUIRED_FIELDS_DEFAULT_VALUES: Dict[str, Any] = {} + + @classmethod + def _get_unset_required_fields(cls, message_dict): + return { + k: v + for k, v in cls.__REQUIRED_FIELDS_DEFAULT_VALUES.items() + if k not in message_dict + } + + def __call__( + self, + request: product_search_service.GetReferenceImageRequest, + *, + retry: OptionalRetry = gapic_v1.method.DEFAULT, + timeout: Optional[float] = None, + metadata: Sequence[Tuple[str, str]] = (), + ) -> product_search_service.ReferenceImage: + r"""Call the get reference image method over HTTP. + + Args: + request (~.product_search_service.GetReferenceImageRequest): + The request object. Request message for the ``GetReferenceImage`` method. + retry (google.api_core.retry.Retry): Designation of what errors, if any, + should be retried. + timeout (float): The timeout for this request. + metadata (Sequence[Tuple[str, str]]): Strings which should be + sent along with the request as metadata. + + Returns: + ~.product_search_service.ReferenceImage: + A ``ReferenceImage`` represents a product image and its + associated metadata, such as bounding boxes. + + """ + + http_options: List[Dict[str, str]] = [ + { + "method": "get", + "uri": "/v1/{name=projects/*/locations/*/products/*/referenceImages/*}", + }, + ] + request, metadata = self._interceptor.pre_get_reference_image( + request, metadata + ) + pb_request = product_search_service.GetReferenceImageRequest.pb(request) + transcoded_request = path_template.transcode(http_options, pb_request) + + uri = transcoded_request["uri"] + method = transcoded_request["method"] + + # Jsonify the query params + query_params = json.loads( + json_format.MessageToJson( + transcoded_request["query_params"], + including_default_value_fields=False, + use_integers_for_enums=True, + ) + ) + query_params.update(self._get_unset_required_fields(query_params)) + + query_params["$alt"] = "json;enum-encoding=int" + + # Send the request + headers = dict(metadata) + headers["Content-Type"] = "application/json" + response = getattr(self._session, method)( + "{host}{uri}".format(host=self._host, uri=uri), + timeout=timeout, + headers=headers, + params=rest_helpers.flatten_query_params(query_params, strict=True), + ) + + # In case of error, raise the appropriate core_exceptions.GoogleAPICallError exception + # subclass. + if response.status_code >= 400: + raise core_exceptions.from_http_response(response) + + # Return the response + resp = product_search_service.ReferenceImage() + pb_resp = product_search_service.ReferenceImage.pb(resp) + + json_format.Parse(response.content, pb_resp, ignore_unknown_fields=True) + resp = self._interceptor.post_get_reference_image(resp) + return resp + + class _ImportProductSets(ProductSearchRestStub): + def __hash__(self): + return hash("ImportProductSets") + + __REQUIRED_FIELDS_DEFAULT_VALUES: Dict[str, Any] = {} + + @classmethod + def _get_unset_required_fields(cls, message_dict): + return { + k: v + for k, v in cls.__REQUIRED_FIELDS_DEFAULT_VALUES.items() + if k not in message_dict + } + + def __call__( + self, + request: product_search_service.ImportProductSetsRequest, + *, + retry: OptionalRetry = gapic_v1.method.DEFAULT, + timeout: Optional[float] = None, + metadata: Sequence[Tuple[str, str]] = (), + ) -> operations_pb2.Operation: + r"""Call the import product sets method over HTTP. + + Args: + request (~.product_search_service.ImportProductSetsRequest): + The request object. Request message for the ``ImportProductSets`` method. + retry (google.api_core.retry.Retry): Designation of what errors, if any, + should be retried. + timeout (float): The timeout for this request. + metadata (Sequence[Tuple[str, str]]): Strings which should be + sent along with the request as metadata. + + Returns: + ~.operations_pb2.Operation: + This resource represents a + long-running operation that is the + result of a network API call. + + """ + + http_options: List[Dict[str, str]] = [ + { + "method": "post", + "uri": "/v1/{parent=projects/*/locations/*}/productSets:import", + "body": "*", + }, + ] + request, metadata = self._interceptor.pre_import_product_sets( + request, metadata + ) + pb_request = product_search_service.ImportProductSetsRequest.pb(request) + transcoded_request = path_template.transcode(http_options, pb_request) + + # Jsonify the request body + + body = json_format.MessageToJson( + transcoded_request["body"], + including_default_value_fields=False, + use_integers_for_enums=True, + ) + uri = transcoded_request["uri"] + method = transcoded_request["method"] + + # Jsonify the query params + query_params = json.loads( + json_format.MessageToJson( + transcoded_request["query_params"], + including_default_value_fields=False, + use_integers_for_enums=True, + ) + ) + query_params.update(self._get_unset_required_fields(query_params)) + + query_params["$alt"] = "json;enum-encoding=int" + + # Send the request + headers = dict(metadata) + headers["Content-Type"] = "application/json" + response = getattr(self._session, method)( + "{host}{uri}".format(host=self._host, uri=uri), + timeout=timeout, + headers=headers, + params=rest_helpers.flatten_query_params(query_params, strict=True), + data=body, + ) + + # In case of error, raise the appropriate core_exceptions.GoogleAPICallError exception + # subclass. + if response.status_code >= 400: + raise core_exceptions.from_http_response(response) + + # Return the response + resp = operations_pb2.Operation() + json_format.Parse(response.content, resp, ignore_unknown_fields=True) + resp = self._interceptor.post_import_product_sets(resp) + return resp + + class _ListProducts(ProductSearchRestStub): + def __hash__(self): + return hash("ListProducts") + + __REQUIRED_FIELDS_DEFAULT_VALUES: Dict[str, Any] = {} + + @classmethod + def _get_unset_required_fields(cls, message_dict): + return { + k: v + for k, v in cls.__REQUIRED_FIELDS_DEFAULT_VALUES.items() + if k not in message_dict + } + + def __call__( + self, + request: product_search_service.ListProductsRequest, + *, + retry: OptionalRetry = gapic_v1.method.DEFAULT, + timeout: Optional[float] = None, + metadata: Sequence[Tuple[str, str]] = (), + ) -> product_search_service.ListProductsResponse: + r"""Call the list products method over HTTP. + + Args: + request (~.product_search_service.ListProductsRequest): + The request object. Request message for the ``ListProducts`` method. + retry (google.api_core.retry.Retry): Designation of what errors, if any, + should be retried. + timeout (float): The timeout for this request. + metadata (Sequence[Tuple[str, str]]): Strings which should be + sent along with the request as metadata. + + Returns: + ~.product_search_service.ListProductsResponse: + Response message for the ``ListProducts`` method. + """ + + http_options: List[Dict[str, str]] = [ + { + "method": "get", + "uri": "/v1/{parent=projects/*/locations/*}/products", + }, + ] + request, metadata = self._interceptor.pre_list_products(request, metadata) + pb_request = product_search_service.ListProductsRequest.pb(request) + transcoded_request = path_template.transcode(http_options, pb_request) + + uri = transcoded_request["uri"] + method = transcoded_request["method"] + + # Jsonify the query params + query_params = json.loads( + json_format.MessageToJson( + transcoded_request["query_params"], + including_default_value_fields=False, + use_integers_for_enums=True, + ) + ) + query_params.update(self._get_unset_required_fields(query_params)) + + query_params["$alt"] = "json;enum-encoding=int" + + # Send the request + headers = dict(metadata) + headers["Content-Type"] = "application/json" + response = getattr(self._session, method)( + "{host}{uri}".format(host=self._host, uri=uri), + timeout=timeout, + headers=headers, + params=rest_helpers.flatten_query_params(query_params, strict=True), + ) + + # In case of error, raise the appropriate core_exceptions.GoogleAPICallError exception + # subclass. + if response.status_code >= 400: + raise core_exceptions.from_http_response(response) + + # Return the response + resp = product_search_service.ListProductsResponse() + pb_resp = product_search_service.ListProductsResponse.pb(resp) + + json_format.Parse(response.content, pb_resp, ignore_unknown_fields=True) + resp = self._interceptor.post_list_products(resp) + return resp + + class _ListProductSets(ProductSearchRestStub): + def __hash__(self): + return hash("ListProductSets") + + __REQUIRED_FIELDS_DEFAULT_VALUES: Dict[str, Any] = {} + + @classmethod + def _get_unset_required_fields(cls, message_dict): + return { + k: v + for k, v in cls.__REQUIRED_FIELDS_DEFAULT_VALUES.items() + if k not in message_dict + } + + def __call__( + self, + request: product_search_service.ListProductSetsRequest, + *, + retry: OptionalRetry = gapic_v1.method.DEFAULT, + timeout: Optional[float] = None, + metadata: Sequence[Tuple[str, str]] = (), + ) -> product_search_service.ListProductSetsResponse: + r"""Call the list product sets method over HTTP. + + Args: + request (~.product_search_service.ListProductSetsRequest): + The request object. Request message for the ``ListProductSets`` method. + retry (google.api_core.retry.Retry): Designation of what errors, if any, + should be retried. + timeout (float): The timeout for this request. + metadata (Sequence[Tuple[str, str]]): Strings which should be + sent along with the request as metadata. + + Returns: + ~.product_search_service.ListProductSetsResponse: + Response message for the ``ListProductSets`` method. + """ + + http_options: List[Dict[str, str]] = [ + { + "method": "get", + "uri": "/v1/{parent=projects/*/locations/*}/productSets", + }, + ] + request, metadata = self._interceptor.pre_list_product_sets( + request, metadata + ) + pb_request = product_search_service.ListProductSetsRequest.pb(request) + transcoded_request = path_template.transcode(http_options, pb_request) + + uri = transcoded_request["uri"] + method = transcoded_request["method"] + + # Jsonify the query params + query_params = json.loads( + json_format.MessageToJson( + transcoded_request["query_params"], + including_default_value_fields=False, + use_integers_for_enums=True, + ) + ) + query_params.update(self._get_unset_required_fields(query_params)) + + query_params["$alt"] = "json;enum-encoding=int" + + # Send the request + headers = dict(metadata) + headers["Content-Type"] = "application/json" + response = getattr(self._session, method)( + "{host}{uri}".format(host=self._host, uri=uri), + timeout=timeout, + headers=headers, + params=rest_helpers.flatten_query_params(query_params, strict=True), + ) + + # In case of error, raise the appropriate core_exceptions.GoogleAPICallError exception + # subclass. + if response.status_code >= 400: + raise core_exceptions.from_http_response(response) + + # Return the response + resp = product_search_service.ListProductSetsResponse() + pb_resp = product_search_service.ListProductSetsResponse.pb(resp) + + json_format.Parse(response.content, pb_resp, ignore_unknown_fields=True) + resp = self._interceptor.post_list_product_sets(resp) + return resp + + class _ListProductsInProductSet(ProductSearchRestStub): + def __hash__(self): + return hash("ListProductsInProductSet") + + __REQUIRED_FIELDS_DEFAULT_VALUES: Dict[str, Any] = {} + + @classmethod + def _get_unset_required_fields(cls, message_dict): + return { + k: v + for k, v in cls.__REQUIRED_FIELDS_DEFAULT_VALUES.items() + if k not in message_dict + } + + def __call__( + self, + request: product_search_service.ListProductsInProductSetRequest, + *, + retry: OptionalRetry = gapic_v1.method.DEFAULT, + timeout: Optional[float] = None, + metadata: Sequence[Tuple[str, str]] = (), + ) -> product_search_service.ListProductsInProductSetResponse: + r"""Call the list products in product + set method over HTTP. + + Args: + request (~.product_search_service.ListProductsInProductSetRequest): + The request object. Request message for the ``ListProductsInProductSet`` + method. + + retry (google.api_core.retry.Retry): Designation of what errors, if any, + should be retried. + timeout (float): The timeout for this request. + metadata (Sequence[Tuple[str, str]]): Strings which should be + sent along with the request as metadata. + + Returns: + ~.product_search_service.ListProductsInProductSetResponse: + Response message for the ``ListProductsInProductSet`` + method. + + """ + + http_options: List[Dict[str, str]] = [ + { + "method": "get", + "uri": "/v1/{name=projects/*/locations/*/productSets/*}/products", + }, + ] + request, metadata = self._interceptor.pre_list_products_in_product_set( + request, metadata + ) + pb_request = product_search_service.ListProductsInProductSetRequest.pb( + request + ) + transcoded_request = path_template.transcode(http_options, pb_request) + + uri = transcoded_request["uri"] + method = transcoded_request["method"] + + # Jsonify the query params + query_params = json.loads( + json_format.MessageToJson( + transcoded_request["query_params"], + including_default_value_fields=False, + use_integers_for_enums=True, + ) + ) + query_params.update(self._get_unset_required_fields(query_params)) + + query_params["$alt"] = "json;enum-encoding=int" + + # Send the request + headers = dict(metadata) + headers["Content-Type"] = "application/json" + response = getattr(self._session, method)( + "{host}{uri}".format(host=self._host, uri=uri), + timeout=timeout, + headers=headers, + params=rest_helpers.flatten_query_params(query_params, strict=True), + ) + + # In case of error, raise the appropriate core_exceptions.GoogleAPICallError exception + # subclass. + if response.status_code >= 400: + raise core_exceptions.from_http_response(response) + + # Return the response + resp = product_search_service.ListProductsInProductSetResponse() + pb_resp = product_search_service.ListProductsInProductSetResponse.pb(resp) + + json_format.Parse(response.content, pb_resp, ignore_unknown_fields=True) + resp = self._interceptor.post_list_products_in_product_set(resp) + return resp + + class _ListReferenceImages(ProductSearchRestStub): + def __hash__(self): + return hash("ListReferenceImages") + + __REQUIRED_FIELDS_DEFAULT_VALUES: Dict[str, Any] = {} + + @classmethod + def _get_unset_required_fields(cls, message_dict): + return { + k: v + for k, v in cls.__REQUIRED_FIELDS_DEFAULT_VALUES.items() + if k not in message_dict + } + + def __call__( + self, + request: product_search_service.ListReferenceImagesRequest, + *, + retry: OptionalRetry = gapic_v1.method.DEFAULT, + timeout: Optional[float] = None, + metadata: Sequence[Tuple[str, str]] = (), + ) -> product_search_service.ListReferenceImagesResponse: + r"""Call the list reference images method over HTTP. + + Args: + request (~.product_search_service.ListReferenceImagesRequest): + The request object. Request message for the ``ListReferenceImages`` method. + retry (google.api_core.retry.Retry): Designation of what errors, if any, + should be retried. + timeout (float): The timeout for this request. + metadata (Sequence[Tuple[str, str]]): Strings which should be + sent along with the request as metadata. + + Returns: + ~.product_search_service.ListReferenceImagesResponse: + Response message for the ``ListReferenceImages`` method. + """ + + http_options: List[Dict[str, str]] = [ + { + "method": "get", + "uri": "/v1/{parent=projects/*/locations/*/products/*}/referenceImages", + }, + ] + request, metadata = self._interceptor.pre_list_reference_images( + request, metadata + ) + pb_request = product_search_service.ListReferenceImagesRequest.pb(request) + transcoded_request = path_template.transcode(http_options, pb_request) + + uri = transcoded_request["uri"] + method = transcoded_request["method"] + + # Jsonify the query params + query_params = json.loads( + json_format.MessageToJson( + transcoded_request["query_params"], + including_default_value_fields=False, + use_integers_for_enums=True, + ) + ) + query_params.update(self._get_unset_required_fields(query_params)) + + query_params["$alt"] = "json;enum-encoding=int" + + # Send the request + headers = dict(metadata) + headers["Content-Type"] = "application/json" + response = getattr(self._session, method)( + "{host}{uri}".format(host=self._host, uri=uri), + timeout=timeout, + headers=headers, + params=rest_helpers.flatten_query_params(query_params, strict=True), + ) + + # In case of error, raise the appropriate core_exceptions.GoogleAPICallError exception + # subclass. + if response.status_code >= 400: + raise core_exceptions.from_http_response(response) + + # Return the response + resp = product_search_service.ListReferenceImagesResponse() + pb_resp = product_search_service.ListReferenceImagesResponse.pb(resp) + + json_format.Parse(response.content, pb_resp, ignore_unknown_fields=True) + resp = self._interceptor.post_list_reference_images(resp) + return resp + + class _PurgeProducts(ProductSearchRestStub): + def __hash__(self): + return hash("PurgeProducts") + + __REQUIRED_FIELDS_DEFAULT_VALUES: Dict[str, Any] = {} + + @classmethod + def _get_unset_required_fields(cls, message_dict): + return { + k: v + for k, v in cls.__REQUIRED_FIELDS_DEFAULT_VALUES.items() + if k not in message_dict + } + + def __call__( + self, + request: product_search_service.PurgeProductsRequest, + *, + retry: OptionalRetry = gapic_v1.method.DEFAULT, + timeout: Optional[float] = None, + metadata: Sequence[Tuple[str, str]] = (), + ) -> operations_pb2.Operation: + r"""Call the purge products method over HTTP. + + Args: + request (~.product_search_service.PurgeProductsRequest): + The request object. Request message for the ``PurgeProducts`` method. + retry (google.api_core.retry.Retry): Designation of what errors, if any, + should be retried. + timeout (float): The timeout for this request. + metadata (Sequence[Tuple[str, str]]): Strings which should be + sent along with the request as metadata. + + Returns: + ~.operations_pb2.Operation: + This resource represents a + long-running operation that is the + result of a network API call. + + """ + + http_options: List[Dict[str, str]] = [ + { + "method": "post", + "uri": "/v1/{parent=projects/*/locations/*}/products:purge", + "body": "*", + }, + ] + request, metadata = self._interceptor.pre_purge_products(request, metadata) + pb_request = product_search_service.PurgeProductsRequest.pb(request) + transcoded_request = path_template.transcode(http_options, pb_request) + + # Jsonify the request body + + body = json_format.MessageToJson( + transcoded_request["body"], + including_default_value_fields=False, + use_integers_for_enums=True, + ) + uri = transcoded_request["uri"] + method = transcoded_request["method"] + + # Jsonify the query params + query_params = json.loads( + json_format.MessageToJson( + transcoded_request["query_params"], + including_default_value_fields=False, + use_integers_for_enums=True, + ) + ) + query_params.update(self._get_unset_required_fields(query_params)) + + query_params["$alt"] = "json;enum-encoding=int" + + # Send the request + headers = dict(metadata) + headers["Content-Type"] = "application/json" + response = getattr(self._session, method)( + "{host}{uri}".format(host=self._host, uri=uri), + timeout=timeout, + headers=headers, + params=rest_helpers.flatten_query_params(query_params, strict=True), + data=body, + ) + + # In case of error, raise the appropriate core_exceptions.GoogleAPICallError exception + # subclass. + if response.status_code >= 400: + raise core_exceptions.from_http_response(response) + + # Return the response + resp = operations_pb2.Operation() + json_format.Parse(response.content, resp, ignore_unknown_fields=True) + resp = self._interceptor.post_purge_products(resp) + return resp + + class _RemoveProductFromProductSet(ProductSearchRestStub): + def __hash__(self): + return hash("RemoveProductFromProductSet") + + __REQUIRED_FIELDS_DEFAULT_VALUES: Dict[str, Any] = {} + + @classmethod + def _get_unset_required_fields(cls, message_dict): + return { + k: v + for k, v in cls.__REQUIRED_FIELDS_DEFAULT_VALUES.items() + if k not in message_dict + } + + def __call__( + self, + request: product_search_service.RemoveProductFromProductSetRequest, + *, + retry: OptionalRetry = gapic_v1.method.DEFAULT, + timeout: Optional[float] = None, + metadata: Sequence[Tuple[str, str]] = (), + ): + r"""Call the remove product from + product set method over HTTP. + + Args: + request (~.product_search_service.RemoveProductFromProductSetRequest): + The request object. Request message for the ``RemoveProductFromProductSet`` + method. + + retry (google.api_core.retry.Retry): Designation of what errors, if any, + should be retried. + timeout (float): The timeout for this request. + metadata (Sequence[Tuple[str, str]]): Strings which should be + sent along with the request as metadata. + """ + + http_options: List[Dict[str, str]] = [ + { + "method": "post", + "uri": "/v1/{name=projects/*/locations/*/productSets/*}:removeProduct", + "body": "*", + }, + ] + request, metadata = self._interceptor.pre_remove_product_from_product_set( + request, metadata + ) + pb_request = product_search_service.RemoveProductFromProductSetRequest.pb( + request + ) + transcoded_request = path_template.transcode(http_options, pb_request) + + # Jsonify the request body + + body = json_format.MessageToJson( + transcoded_request["body"], + including_default_value_fields=False, + use_integers_for_enums=True, + ) + uri = transcoded_request["uri"] + method = transcoded_request["method"] + + # Jsonify the query params + query_params = json.loads( + json_format.MessageToJson( + transcoded_request["query_params"], + including_default_value_fields=False, + use_integers_for_enums=True, + ) + ) + query_params.update(self._get_unset_required_fields(query_params)) + + query_params["$alt"] = "json;enum-encoding=int" + + # Send the request + headers = dict(metadata) + headers["Content-Type"] = "application/json" + response = getattr(self._session, method)( + "{host}{uri}".format(host=self._host, uri=uri), + timeout=timeout, + headers=headers, + params=rest_helpers.flatten_query_params(query_params, strict=True), + data=body, + ) + + # In case of error, raise the appropriate core_exceptions.GoogleAPICallError exception + # subclass. + if response.status_code >= 400: + raise core_exceptions.from_http_response(response) + + class _UpdateProduct(ProductSearchRestStub): + def __hash__(self): + return hash("UpdateProduct") + + __REQUIRED_FIELDS_DEFAULT_VALUES: Dict[str, Any] = {} + + @classmethod + def _get_unset_required_fields(cls, message_dict): + return { + k: v + for k, v in cls.__REQUIRED_FIELDS_DEFAULT_VALUES.items() + if k not in message_dict + } + + def __call__( + self, + request: product_search_service.UpdateProductRequest, + *, + retry: OptionalRetry = gapic_v1.method.DEFAULT, + timeout: Optional[float] = None, + metadata: Sequence[Tuple[str, str]] = (), + ) -> product_search_service.Product: + r"""Call the update product method over HTTP. + + Args: + request (~.product_search_service.UpdateProductRequest): + The request object. Request message for the ``UpdateProduct`` method. + retry (google.api_core.retry.Retry): Designation of what errors, if any, + should be retried. + timeout (float): The timeout for this request. + metadata (Sequence[Tuple[str, str]]): Strings which should be + sent along with the request as metadata. + + Returns: + ~.product_search_service.Product: + A Product contains ReferenceImages. + """ + + http_options: List[Dict[str, str]] = [ + { + "method": "patch", + "uri": "/v1/{product.name=projects/*/locations/*/products/*}", + "body": "product", + }, + ] + request, metadata = self._interceptor.pre_update_product(request, metadata) + pb_request = product_search_service.UpdateProductRequest.pb(request) + transcoded_request = path_template.transcode(http_options, pb_request) + + # Jsonify the request body + + body = json_format.MessageToJson( + transcoded_request["body"], + including_default_value_fields=False, + use_integers_for_enums=True, + ) + uri = transcoded_request["uri"] + method = transcoded_request["method"] + + # Jsonify the query params + query_params = json.loads( + json_format.MessageToJson( + transcoded_request["query_params"], + including_default_value_fields=False, + use_integers_for_enums=True, + ) + ) + query_params.update(self._get_unset_required_fields(query_params)) + + query_params["$alt"] = "json;enum-encoding=int" + + # Send the request + headers = dict(metadata) + headers["Content-Type"] = "application/json" + response = getattr(self._session, method)( + "{host}{uri}".format(host=self._host, uri=uri), + timeout=timeout, + headers=headers, + params=rest_helpers.flatten_query_params(query_params, strict=True), + data=body, + ) + + # In case of error, raise the appropriate core_exceptions.GoogleAPICallError exception + # subclass. + if response.status_code >= 400: + raise core_exceptions.from_http_response(response) + + # Return the response + resp = product_search_service.Product() + pb_resp = product_search_service.Product.pb(resp) + + json_format.Parse(response.content, pb_resp, ignore_unknown_fields=True) + resp = self._interceptor.post_update_product(resp) + return resp + + class _UpdateProductSet(ProductSearchRestStub): + def __hash__(self): + return hash("UpdateProductSet") + + __REQUIRED_FIELDS_DEFAULT_VALUES: Dict[str, Any] = {} + + @classmethod + def _get_unset_required_fields(cls, message_dict): + return { + k: v + for k, v in cls.__REQUIRED_FIELDS_DEFAULT_VALUES.items() + if k not in message_dict + } + + def __call__( + self, + request: product_search_service.UpdateProductSetRequest, + *, + retry: OptionalRetry = gapic_v1.method.DEFAULT, + timeout: Optional[float] = None, + metadata: Sequence[Tuple[str, str]] = (), + ) -> product_search_service.ProductSet: + r"""Call the update product set method over HTTP. + + Args: + request (~.product_search_service.UpdateProductSetRequest): + The request object. Request message for the ``UpdateProductSet`` method. + retry (google.api_core.retry.Retry): Designation of what errors, if any, + should be retried. + timeout (float): The timeout for this request. + metadata (Sequence[Tuple[str, str]]): Strings which should be + sent along with the request as metadata. + + Returns: + ~.product_search_service.ProductSet: + A ProductSet contains Products. A + ProductSet can contain a maximum of 1 + million reference images. If the limit + is exceeded, periodic indexing will + fail. + + """ + + http_options: List[Dict[str, str]] = [ + { + "method": "patch", + "uri": "/v1/{product_set.name=projects/*/locations/*/productSets/*}", + "body": "product_set", + }, + ] + request, metadata = self._interceptor.pre_update_product_set( + request, metadata + ) + pb_request = product_search_service.UpdateProductSetRequest.pb(request) + transcoded_request = path_template.transcode(http_options, pb_request) + + # Jsonify the request body + + body = json_format.MessageToJson( + transcoded_request["body"], + including_default_value_fields=False, + use_integers_for_enums=True, + ) + uri = transcoded_request["uri"] + method = transcoded_request["method"] + + # Jsonify the query params + query_params = json.loads( + json_format.MessageToJson( + transcoded_request["query_params"], + including_default_value_fields=False, + use_integers_for_enums=True, + ) + ) + query_params.update(self._get_unset_required_fields(query_params)) + + query_params["$alt"] = "json;enum-encoding=int" + + # Send the request + headers = dict(metadata) + headers["Content-Type"] = "application/json" + response = getattr(self._session, method)( + "{host}{uri}".format(host=self._host, uri=uri), + timeout=timeout, + headers=headers, + params=rest_helpers.flatten_query_params(query_params, strict=True), + data=body, + ) + + # In case of error, raise the appropriate core_exceptions.GoogleAPICallError exception + # subclass. + if response.status_code >= 400: + raise core_exceptions.from_http_response(response) + + # Return the response + resp = product_search_service.ProductSet() + pb_resp = product_search_service.ProductSet.pb(resp) + + json_format.Parse(response.content, pb_resp, ignore_unknown_fields=True) + resp = self._interceptor.post_update_product_set(resp) + return resp + + @property + def add_product_to_product_set( + self, + ) -> Callable[ + [product_search_service.AddProductToProductSetRequest], empty_pb2.Empty + ]: + # The return type is fine, but mypy isn't sophisticated enough to determine what's going on here. + # In C++ this would require a dynamic_cast + return self._AddProductToProductSet(self._session, self._host, self._interceptor) # type: ignore + + @property + def create_product( + self, + ) -> Callable[ + [product_search_service.CreateProductRequest], product_search_service.Product + ]: + # The return type is fine, but mypy isn't sophisticated enough to determine what's going on here. + # In C++ this would require a dynamic_cast + return self._CreateProduct(self._session, self._host, self._interceptor) # type: ignore + + @property + def create_product_set( + self, + ) -> Callable[ + [product_search_service.CreateProductSetRequest], + product_search_service.ProductSet, + ]: + # The return type is fine, but mypy isn't sophisticated enough to determine what's going on here. + # In C++ this would require a dynamic_cast + return self._CreateProductSet(self._session, self._host, self._interceptor) # type: ignore + + @property + def create_reference_image( + self, + ) -> Callable[ + [product_search_service.CreateReferenceImageRequest], + product_search_service.ReferenceImage, + ]: + # The return type is fine, but mypy isn't sophisticated enough to determine what's going on here. + # In C++ this would require a dynamic_cast + return self._CreateReferenceImage(self._session, self._host, self._interceptor) # type: ignore + + @property + def delete_product( + self, + ) -> Callable[[product_search_service.DeleteProductRequest], empty_pb2.Empty]: + # The return type is fine, but mypy isn't sophisticated enough to determine what's going on here. + # In C++ this would require a dynamic_cast + return self._DeleteProduct(self._session, self._host, self._interceptor) # type: ignore + + @property + def delete_product_set( + self, + ) -> Callable[[product_search_service.DeleteProductSetRequest], empty_pb2.Empty]: + # The return type is fine, but mypy isn't sophisticated enough to determine what's going on here. + # In C++ this would require a dynamic_cast + return self._DeleteProductSet(self._session, self._host, self._interceptor) # type: ignore + + @property + def delete_reference_image( + self, + ) -> Callable[ + [product_search_service.DeleteReferenceImageRequest], empty_pb2.Empty + ]: + # The return type is fine, but mypy isn't sophisticated enough to determine what's going on here. + # In C++ this would require a dynamic_cast + return self._DeleteReferenceImage(self._session, self._host, self._interceptor) # type: ignore + + @property + def get_product( + self, + ) -> Callable[ + [product_search_service.GetProductRequest], product_search_service.Product + ]: + # The return type is fine, but mypy isn't sophisticated enough to determine what's going on here. + # In C++ this would require a dynamic_cast + return self._GetProduct(self._session, self._host, self._interceptor) # type: ignore + + @property + def get_product_set( + self, + ) -> Callable[ + [product_search_service.GetProductSetRequest], product_search_service.ProductSet + ]: + # The return type is fine, but mypy isn't sophisticated enough to determine what's going on here. + # In C++ this would require a dynamic_cast + return self._GetProductSet(self._session, self._host, self._interceptor) # type: ignore + + @property + def get_reference_image( + self, + ) -> Callable[ + [product_search_service.GetReferenceImageRequest], + product_search_service.ReferenceImage, + ]: + # The return type is fine, but mypy isn't sophisticated enough to determine what's going on here. + # In C++ this would require a dynamic_cast + return self._GetReferenceImage(self._session, self._host, self._interceptor) # type: ignore + + @property + def import_product_sets( + self, + ) -> Callable[ + [product_search_service.ImportProductSetsRequest], operations_pb2.Operation + ]: + # The return type is fine, but mypy isn't sophisticated enough to determine what's going on here. + # In C++ this would require a dynamic_cast + return self._ImportProductSets(self._session, self._host, self._interceptor) # type: ignore + + @property + def list_products( + self, + ) -> Callable[ + [product_search_service.ListProductsRequest], + product_search_service.ListProductsResponse, + ]: + # The return type is fine, but mypy isn't sophisticated enough to determine what's going on here. + # In C++ this would require a dynamic_cast + return self._ListProducts(self._session, self._host, self._interceptor) # type: ignore + + @property + def list_product_sets( + self, + ) -> Callable[ + [product_search_service.ListProductSetsRequest], + product_search_service.ListProductSetsResponse, + ]: + # The return type is fine, but mypy isn't sophisticated enough to determine what's going on here. + # In C++ this would require a dynamic_cast + return self._ListProductSets(self._session, self._host, self._interceptor) # type: ignore + + @property + def list_products_in_product_set( + self, + ) -> Callable[ + [product_search_service.ListProductsInProductSetRequest], + product_search_service.ListProductsInProductSetResponse, + ]: + # The return type is fine, but mypy isn't sophisticated enough to determine what's going on here. + # In C++ this would require a dynamic_cast + return self._ListProductsInProductSet(self._session, self._host, self._interceptor) # type: ignore + + @property + def list_reference_images( + self, + ) -> Callable[ + [product_search_service.ListReferenceImagesRequest], + product_search_service.ListReferenceImagesResponse, + ]: + # The return type is fine, but mypy isn't sophisticated enough to determine what's going on here. + # In C++ this would require a dynamic_cast + return self._ListReferenceImages(self._session, self._host, self._interceptor) # type: ignore + + @property + def purge_products( + self, + ) -> Callable[ + [product_search_service.PurgeProductsRequest], operations_pb2.Operation + ]: + # The return type is fine, but mypy isn't sophisticated enough to determine what's going on here. + # In C++ this would require a dynamic_cast + return self._PurgeProducts(self._session, self._host, self._interceptor) # type: ignore + + @property + def remove_product_from_product_set( + self, + ) -> Callable[ + [product_search_service.RemoveProductFromProductSetRequest], empty_pb2.Empty + ]: + # The return type is fine, but mypy isn't sophisticated enough to determine what's going on here. + # In C++ this would require a dynamic_cast + return self._RemoveProductFromProductSet(self._session, self._host, self._interceptor) # type: ignore + + @property + def update_product( + self, + ) -> Callable[ + [product_search_service.UpdateProductRequest], product_search_service.Product + ]: + # The return type is fine, but mypy isn't sophisticated enough to determine what's going on here. + # In C++ this would require a dynamic_cast + return self._UpdateProduct(self._session, self._host, self._interceptor) # type: ignore + + @property + def update_product_set( + self, + ) -> Callable[ + [product_search_service.UpdateProductSetRequest], + product_search_service.ProductSet, + ]: + # The return type is fine, but mypy isn't sophisticated enough to determine what's going on here. + # In C++ this would require a dynamic_cast + return self._UpdateProductSet(self._session, self._host, self._interceptor) # type: ignore + + @property + def kind(self) -> str: + return "rest" + + def close(self): + self._session.close() + + +__all__ = ("ProductSearchRestTransport",) diff --git a/google/cloud/vision_v1/types/geometry.py b/google/cloud/vision_v1/types/geometry.py index 800f18bd..bb26fadc 100644 --- a/google/cloud/vision_v1/types/geometry.py +++ b/google/cloud/vision_v1/types/geometry.py @@ -13,6 +13,8 @@ # See the License for the specific language governing permissions and # limitations under the License. # +from __future__ import annotations + from typing import MutableMapping, MutableSequence import proto # type: ignore diff --git a/google/cloud/vision_v1/types/image_annotator.py b/google/cloud/vision_v1/types/image_annotator.py index 76790bc0..6e5f7b6d 100644 --- a/google/cloud/vision_v1/types/image_annotator.py +++ b/google/cloud/vision_v1/types/image_annotator.py @@ -13,6 +13,8 @@ # See the License for the specific language governing permissions and # limitations under the License. # +from __future__ import annotations + from typing import MutableMapping, MutableSequence import proto # type: ignore diff --git a/google/cloud/vision_v1/types/product_search.py b/google/cloud/vision_v1/types/product_search.py index 425de883..674e10aa 100644 --- a/google/cloud/vision_v1/types/product_search.py +++ b/google/cloud/vision_v1/types/product_search.py @@ -13,6 +13,8 @@ # See the License for the specific language governing permissions and # limitations under the License. # +from __future__ import annotations + from typing import MutableMapping, MutableSequence import proto # type: ignore diff --git a/google/cloud/vision_v1/types/product_search_service.py b/google/cloud/vision_v1/types/product_search_service.py index 24f715c3..5e027197 100644 --- a/google/cloud/vision_v1/types/product_search_service.py +++ b/google/cloud/vision_v1/types/product_search_service.py @@ -13,6 +13,8 @@ # See the License for the specific language governing permissions and # limitations under the License. # +from __future__ import annotations + from typing import MutableMapping, MutableSequence import proto # type: ignore diff --git a/google/cloud/vision_v1/types/text_annotation.py b/google/cloud/vision_v1/types/text_annotation.py index febc9963..5932080d 100644 --- a/google/cloud/vision_v1/types/text_annotation.py +++ b/google/cloud/vision_v1/types/text_annotation.py @@ -13,6 +13,8 @@ # See the License for the specific language governing permissions and # limitations under the License. # +from __future__ import annotations + from typing import MutableMapping, MutableSequence import proto # type: ignore diff --git a/google/cloud/vision_v1/types/web_detection.py b/google/cloud/vision_v1/types/web_detection.py index 83e72d60..a4b0da79 100644 --- a/google/cloud/vision_v1/types/web_detection.py +++ b/google/cloud/vision_v1/types/web_detection.py @@ -13,6 +13,8 @@ # See the License for the specific language governing permissions and # limitations under the License. # +from __future__ import annotations + from typing import MutableMapping, MutableSequence import proto # type: ignore diff --git a/google/cloud/vision_v1p1beta1/__init__.py b/google/cloud/vision_v1p1beta1/__init__.py index 7821a449..5db8a591 100644 --- a/google/cloud/vision_v1p1beta1/__init__.py +++ b/google/cloud/vision_v1p1beta1/__init__.py @@ -13,7 +13,7 @@ # See the License for the specific language governing permissions and # limitations under the License. # -from google.cloud.vision import gapic_version as package_version +from google.cloud.vision_v1p1beta1 import gapic_version as package_version __version__ = package_version.__version__ diff --git a/google/cloud/vision_v1p1beta1/gapic_metadata.json b/google/cloud/vision_v1p1beta1/gapic_metadata.json index b198d92f..b60375c4 100644 --- a/google/cloud/vision_v1p1beta1/gapic_metadata.json +++ b/google/cloud/vision_v1p1beta1/gapic_metadata.json @@ -26,6 +26,16 @@ ] } } + }, + "rest": { + "libraryClient": "ImageAnnotatorClient", + "rpcs": { + "BatchAnnotateImages": { + "methods": [ + "batch_annotate_images" + ] + } + } } } } diff --git a/google/cloud/vision_v1p1beta1/gapic_version.py b/google/cloud/vision_v1p1beta1/gapic_version.py index c443818a..431567aa 100644 --- a/google/cloud/vision_v1p1beta1/gapic_version.py +++ b/google/cloud/vision_v1p1beta1/gapic_version.py @@ -13,4 +13,4 @@ # See the License for the specific language governing permissions and # limitations under the License. # -__version__ = "3.3.1" # {x-release-please-version} +__version__ = "3.4.0" # {x-release-please-version} diff --git a/google/cloud/vision_v1p1beta1/services/image_annotator/client.py b/google/cloud/vision_v1p1beta1/services/image_annotator/client.py index bb3945a7..1b42e920 100644 --- a/google/cloud/vision_v1p1beta1/services/image_annotator/client.py +++ b/google/cloud/vision_v1p1beta1/services/image_annotator/client.py @@ -50,6 +50,7 @@ from .transports.base import ImageAnnotatorTransport, DEFAULT_CLIENT_INFO from .transports.grpc import ImageAnnotatorGrpcTransport from .transports.grpc_asyncio import ImageAnnotatorGrpcAsyncIOTransport +from .transports.rest import ImageAnnotatorRestTransport class ImageAnnotatorClientMeta(type): @@ -65,6 +66,7 @@ class ImageAnnotatorClientMeta(type): ) # type: Dict[str, Type[ImageAnnotatorTransport]] _transport_registry["grpc"] = ImageAnnotatorGrpcTransport _transport_registry["grpc_asyncio"] = ImageAnnotatorGrpcAsyncIOTransport + _transport_registry["rest"] = ImageAnnotatorRestTransport def get_transport_class( cls, diff --git a/google/cloud/vision_v1p1beta1/services/image_annotator/transports/__init__.py b/google/cloud/vision_v1p1beta1/services/image_annotator/transports/__init__.py index bb856540..e959448a 100644 --- a/google/cloud/vision_v1p1beta1/services/image_annotator/transports/__init__.py +++ b/google/cloud/vision_v1p1beta1/services/image_annotator/transports/__init__.py @@ -19,15 +19,20 @@ from .base import ImageAnnotatorTransport from .grpc import ImageAnnotatorGrpcTransport from .grpc_asyncio import ImageAnnotatorGrpcAsyncIOTransport +from .rest import ImageAnnotatorRestTransport +from .rest import ImageAnnotatorRestInterceptor # Compile a registry of transports. _transport_registry = OrderedDict() # type: Dict[str, Type[ImageAnnotatorTransport]] _transport_registry["grpc"] = ImageAnnotatorGrpcTransport _transport_registry["grpc_asyncio"] = ImageAnnotatorGrpcAsyncIOTransport +_transport_registry["rest"] = ImageAnnotatorRestTransport __all__ = ( "ImageAnnotatorTransport", "ImageAnnotatorGrpcTransport", "ImageAnnotatorGrpcAsyncIOTransport", + "ImageAnnotatorRestTransport", + "ImageAnnotatorRestInterceptor", ) diff --git a/google/cloud/vision_v1p1beta1/services/image_annotator/transports/rest.py b/google/cloud/vision_v1p1beta1/services/image_annotator/transports/rest.py new file mode 100644 index 00000000..a98f3bce --- /dev/null +++ b/google/cloud/vision_v1p1beta1/services/image_annotator/transports/rest.py @@ -0,0 +1,329 @@ +# -*- coding: utf-8 -*- +# Copyright 2022 Google LLC +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. +# + +from google.auth.transport.requests import AuthorizedSession # type: ignore +import json # type: ignore +import grpc # type: ignore +from google.auth.transport.grpc import SslCredentials # type: ignore +from google.auth import credentials as ga_credentials # type: ignore +from google.api_core import exceptions as core_exceptions +from google.api_core import retry as retries +from google.api_core import rest_helpers +from google.api_core import rest_streaming +from google.api_core import path_template +from google.api_core import gapic_v1 + +from google.protobuf import json_format +from requests import __version__ as requests_version +import dataclasses +import re +from typing import Any, Callable, Dict, List, Optional, Sequence, Tuple, Union +import warnings + +try: + OptionalRetry = Union[retries.Retry, gapic_v1.method._MethodDefault] +except AttributeError: # pragma: NO COVER + OptionalRetry = Union[retries.Retry, object] # type: ignore + + +from google.cloud.vision_v1p1beta1.types import image_annotator + +from .base import ( + ImageAnnotatorTransport, + DEFAULT_CLIENT_INFO as BASE_DEFAULT_CLIENT_INFO, +) + + +DEFAULT_CLIENT_INFO = gapic_v1.client_info.ClientInfo( + gapic_version=BASE_DEFAULT_CLIENT_INFO.gapic_version, + grpc_version=None, + rest_version=requests_version, +) + + +class ImageAnnotatorRestInterceptor: + """Interceptor for ImageAnnotator. + + Interceptors are used to manipulate requests, request metadata, and responses + in arbitrary ways. + Example use cases include: + * Logging + * Verifying requests according to service or custom semantics + * Stripping extraneous information from responses + + These use cases and more can be enabled by injecting an + instance of a custom subclass when constructing the ImageAnnotatorRestTransport. + + .. code-block:: python + class MyCustomImageAnnotatorInterceptor(ImageAnnotatorRestInterceptor): + def pre_batch_annotate_images(self, request, metadata): + logging.log(f"Received request: {request}") + return request, metadata + + def post_batch_annotate_images(self, response): + logging.log(f"Received response: {response}") + return response + + transport = ImageAnnotatorRestTransport(interceptor=MyCustomImageAnnotatorInterceptor()) + client = ImageAnnotatorClient(transport=transport) + + + """ + + def pre_batch_annotate_images( + self, + request: image_annotator.BatchAnnotateImagesRequest, + metadata: Sequence[Tuple[str, str]], + ) -> Tuple[image_annotator.BatchAnnotateImagesRequest, Sequence[Tuple[str, str]]]: + """Pre-rpc interceptor for batch_annotate_images + + Override in a subclass to manipulate the request or metadata + before they are sent to the ImageAnnotator server. + """ + return request, metadata + + def post_batch_annotate_images( + self, response: image_annotator.BatchAnnotateImagesResponse + ) -> image_annotator.BatchAnnotateImagesResponse: + """Post-rpc interceptor for batch_annotate_images + + Override in a subclass to manipulate the response + after it is returned by the ImageAnnotator server but before + it is returned to user code. + """ + return response + + +@dataclasses.dataclass +class ImageAnnotatorRestStub: + _session: AuthorizedSession + _host: str + _interceptor: ImageAnnotatorRestInterceptor + + +class ImageAnnotatorRestTransport(ImageAnnotatorTransport): + """REST backend transport for ImageAnnotator. + + Service that performs Google Cloud Vision API detection tasks + over client images, such as face, landmark, logo, label, and + text detection. The ImageAnnotator service returns detected + entities from the images. + + This class defines the same methods as the primary client, so the + primary client can load the underlying transport implementation + and call it. + + It sends JSON representations of protocol buffers over HTTP/1.1 + + """ + + def __init__( + self, + *, + host: str = "vision.googleapis.com", + credentials: Optional[ga_credentials.Credentials] = None, + credentials_file: Optional[str] = None, + scopes: Optional[Sequence[str]] = None, + client_cert_source_for_mtls: Optional[Callable[[], Tuple[bytes, bytes]]] = None, + quota_project_id: Optional[str] = None, + client_info: gapic_v1.client_info.ClientInfo = DEFAULT_CLIENT_INFO, + always_use_jwt_access: Optional[bool] = False, + url_scheme: str = "https", + interceptor: Optional[ImageAnnotatorRestInterceptor] = None, + api_audience: Optional[str] = None, + ) -> None: + """Instantiate the transport. + + Args: + host (Optional[str]): + The hostname to connect to. + credentials (Optional[google.auth.credentials.Credentials]): The + authorization credentials to attach to requests. These + credentials identify the application to the service; if none + are specified, the client will attempt to ascertain the + credentials from the environment. + + credentials_file (Optional[str]): A file with credentials that can + be loaded with :func:`google.auth.load_credentials_from_file`. + This argument is ignored if ``channel`` is provided. + scopes (Optional(Sequence[str])): A list of scopes. This argument is + ignored if ``channel`` is provided. + client_cert_source_for_mtls (Callable[[], Tuple[bytes, bytes]]): Client + certificate to configure mutual TLS HTTP channel. It is ignored + if ``channel`` is provided. + quota_project_id (Optional[str]): An optional project to use for billing + and quota. + client_info (google.api_core.gapic_v1.client_info.ClientInfo): + The client info used to send a user-agent string along with + API requests. If ``None``, then default info will be used. + Generally, you only need to set this if you are developing + your own client library. + always_use_jwt_access (Optional[bool]): Whether self signed JWT should + be used for service account credentials. + url_scheme: the protocol scheme for the API endpoint. Normally + "https", but for testing or local servers, + "http" can be specified. + """ + # Run the base constructor + # TODO(yon-mg): resolve other ctor params i.e. scopes, quota, etc. + # TODO: When custom host (api_endpoint) is set, `scopes` must *also* be set on the + # credentials object + maybe_url_match = re.match("^(?Phttp(?:s)?://)?(?P.*)$", host) + if maybe_url_match is None: + raise ValueError( + f"Unexpected hostname structure: {host}" + ) # pragma: NO COVER + + url_match_items = maybe_url_match.groupdict() + + host = f"{url_scheme}://{host}" if not url_match_items["scheme"] else host + + super().__init__( + host=host, + credentials=credentials, + client_info=client_info, + always_use_jwt_access=always_use_jwt_access, + api_audience=api_audience, + ) + self._session = AuthorizedSession( + self._credentials, default_host=self.DEFAULT_HOST + ) + if client_cert_source_for_mtls: + self._session.configure_mtls_channel(client_cert_source_for_mtls) + self._interceptor = interceptor or ImageAnnotatorRestInterceptor() + self._prep_wrapped_messages(client_info) + + class _BatchAnnotateImages(ImageAnnotatorRestStub): + def __hash__(self): + return hash("BatchAnnotateImages") + + __REQUIRED_FIELDS_DEFAULT_VALUES: Dict[str, Any] = {} + + @classmethod + def _get_unset_required_fields(cls, message_dict): + return { + k: v + for k, v in cls.__REQUIRED_FIELDS_DEFAULT_VALUES.items() + if k not in message_dict + } + + def __call__( + self, + request: image_annotator.BatchAnnotateImagesRequest, + *, + retry: OptionalRetry = gapic_v1.method.DEFAULT, + timeout: Optional[float] = None, + metadata: Sequence[Tuple[str, str]] = (), + ) -> image_annotator.BatchAnnotateImagesResponse: + r"""Call the batch annotate images method over HTTP. + + Args: + request (~.image_annotator.BatchAnnotateImagesRequest): + The request object. Multiple image annotation requests + are batched into a single service call. + + retry (google.api_core.retry.Retry): Designation of what errors, if any, + should be retried. + timeout (float): The timeout for this request. + metadata (Sequence[Tuple[str, str]]): Strings which should be + sent along with the request as metadata. + + Returns: + ~.image_annotator.BatchAnnotateImagesResponse: + Response to a batch image annotation + request. + + """ + + http_options: List[Dict[str, str]] = [ + { + "method": "post", + "uri": "/v1p1beta1/images:annotate", + "body": "*", + }, + ] + request, metadata = self._interceptor.pre_batch_annotate_images( + request, metadata + ) + pb_request = image_annotator.BatchAnnotateImagesRequest.pb(request) + transcoded_request = path_template.transcode(http_options, pb_request) + + # Jsonify the request body + + body = json_format.MessageToJson( + transcoded_request["body"], + including_default_value_fields=False, + use_integers_for_enums=True, + ) + uri = transcoded_request["uri"] + method = transcoded_request["method"] + + # Jsonify the query params + query_params = json.loads( + json_format.MessageToJson( + transcoded_request["query_params"], + including_default_value_fields=False, + use_integers_for_enums=True, + ) + ) + query_params.update(self._get_unset_required_fields(query_params)) + + query_params["$alt"] = "json;enum-encoding=int" + + # Send the request + headers = dict(metadata) + headers["Content-Type"] = "application/json" + response = getattr(self._session, method)( + "{host}{uri}".format(host=self._host, uri=uri), + timeout=timeout, + headers=headers, + params=rest_helpers.flatten_query_params(query_params, strict=True), + data=body, + ) + + # In case of error, raise the appropriate core_exceptions.GoogleAPICallError exception + # subclass. + if response.status_code >= 400: + raise core_exceptions.from_http_response(response) + + # Return the response + resp = image_annotator.BatchAnnotateImagesResponse() + pb_resp = image_annotator.BatchAnnotateImagesResponse.pb(resp) + + json_format.Parse(response.content, pb_resp, ignore_unknown_fields=True) + resp = self._interceptor.post_batch_annotate_images(resp) + return resp + + @property + def batch_annotate_images( + self, + ) -> Callable[ + [image_annotator.BatchAnnotateImagesRequest], + image_annotator.BatchAnnotateImagesResponse, + ]: + # The return type is fine, but mypy isn't sophisticated enough to determine what's going on here. + # In C++ this would require a dynamic_cast + return self._BatchAnnotateImages(self._session, self._host, self._interceptor) # type: ignore + + @property + def kind(self) -> str: + return "rest" + + def close(self): + self._session.close() + + +__all__ = ("ImageAnnotatorRestTransport",) diff --git a/google/cloud/vision_v1p1beta1/types/geometry.py b/google/cloud/vision_v1p1beta1/types/geometry.py index 235d97d1..1fb14237 100644 --- a/google/cloud/vision_v1p1beta1/types/geometry.py +++ b/google/cloud/vision_v1p1beta1/types/geometry.py @@ -13,6 +13,8 @@ # See the License for the specific language governing permissions and # limitations under the License. # +from __future__ import annotations + from typing import MutableMapping, MutableSequence import proto # type: ignore diff --git a/google/cloud/vision_v1p1beta1/types/image_annotator.py b/google/cloud/vision_v1p1beta1/types/image_annotator.py index e68965ac..663d5f82 100644 --- a/google/cloud/vision_v1p1beta1/types/image_annotator.py +++ b/google/cloud/vision_v1p1beta1/types/image_annotator.py @@ -13,6 +13,8 @@ # See the License for the specific language governing permissions and # limitations under the License. # +from __future__ import annotations + from typing import MutableMapping, MutableSequence import proto # type: ignore diff --git a/google/cloud/vision_v1p1beta1/types/text_annotation.py b/google/cloud/vision_v1p1beta1/types/text_annotation.py index 294fdbe1..3ced4972 100644 --- a/google/cloud/vision_v1p1beta1/types/text_annotation.py +++ b/google/cloud/vision_v1p1beta1/types/text_annotation.py @@ -13,6 +13,8 @@ # See the License for the specific language governing permissions and # limitations under the License. # +from __future__ import annotations + from typing import MutableMapping, MutableSequence import proto # type: ignore diff --git a/google/cloud/vision_v1p1beta1/types/web_detection.py b/google/cloud/vision_v1p1beta1/types/web_detection.py index 8602736b..6848216b 100644 --- a/google/cloud/vision_v1p1beta1/types/web_detection.py +++ b/google/cloud/vision_v1p1beta1/types/web_detection.py @@ -13,6 +13,8 @@ # See the License for the specific language governing permissions and # limitations under the License. # +from __future__ import annotations + from typing import MutableMapping, MutableSequence import proto # type: ignore diff --git a/google/cloud/vision_v1p2beta1/__init__.py b/google/cloud/vision_v1p2beta1/__init__.py index 2fd7224f..509d7ba2 100644 --- a/google/cloud/vision_v1p2beta1/__init__.py +++ b/google/cloud/vision_v1p2beta1/__init__.py @@ -13,7 +13,7 @@ # See the License for the specific language governing permissions and # limitations under the License. # -from google.cloud.vision import gapic_version as package_version +from google.cloud.vision_v1p2beta1 import gapic_version as package_version __version__ = package_version.__version__ diff --git a/google/cloud/vision_v1p2beta1/gapic_metadata.json b/google/cloud/vision_v1p2beta1/gapic_metadata.json index 3e166a99..43257e5d 100644 --- a/google/cloud/vision_v1p2beta1/gapic_metadata.json +++ b/google/cloud/vision_v1p2beta1/gapic_metadata.json @@ -36,6 +36,21 @@ ] } } + }, + "rest": { + "libraryClient": "ImageAnnotatorClient", + "rpcs": { + "AsyncBatchAnnotateFiles": { + "methods": [ + "async_batch_annotate_files" + ] + }, + "BatchAnnotateImages": { + "methods": [ + "batch_annotate_images" + ] + } + } } } } diff --git a/google/cloud/vision_v1p2beta1/gapic_version.py b/google/cloud/vision_v1p2beta1/gapic_version.py index c443818a..431567aa 100644 --- a/google/cloud/vision_v1p2beta1/gapic_version.py +++ b/google/cloud/vision_v1p2beta1/gapic_version.py @@ -13,4 +13,4 @@ # See the License for the specific language governing permissions and # limitations under the License. # -__version__ = "3.3.1" # {x-release-please-version} +__version__ = "3.4.0" # {x-release-please-version} diff --git a/google/cloud/vision_v1p2beta1/services/image_annotator/client.py b/google/cloud/vision_v1p2beta1/services/image_annotator/client.py index ea05405e..dec09b15 100644 --- a/google/cloud/vision_v1p2beta1/services/image_annotator/client.py +++ b/google/cloud/vision_v1p2beta1/services/image_annotator/client.py @@ -52,6 +52,7 @@ from .transports.base import ImageAnnotatorTransport, DEFAULT_CLIENT_INFO from .transports.grpc import ImageAnnotatorGrpcTransport from .transports.grpc_asyncio import ImageAnnotatorGrpcAsyncIOTransport +from .transports.rest import ImageAnnotatorRestTransport class ImageAnnotatorClientMeta(type): @@ -67,6 +68,7 @@ class ImageAnnotatorClientMeta(type): ) # type: Dict[str, Type[ImageAnnotatorTransport]] _transport_registry["grpc"] = ImageAnnotatorGrpcTransport _transport_registry["grpc_asyncio"] = ImageAnnotatorGrpcAsyncIOTransport + _transport_registry["rest"] = ImageAnnotatorRestTransport def get_transport_class( cls, diff --git a/google/cloud/vision_v1p2beta1/services/image_annotator/transports/__init__.py b/google/cloud/vision_v1p2beta1/services/image_annotator/transports/__init__.py index bb856540..e959448a 100644 --- a/google/cloud/vision_v1p2beta1/services/image_annotator/transports/__init__.py +++ b/google/cloud/vision_v1p2beta1/services/image_annotator/transports/__init__.py @@ -19,15 +19,20 @@ from .base import ImageAnnotatorTransport from .grpc import ImageAnnotatorGrpcTransport from .grpc_asyncio import ImageAnnotatorGrpcAsyncIOTransport +from .rest import ImageAnnotatorRestTransport +from .rest import ImageAnnotatorRestInterceptor # Compile a registry of transports. _transport_registry = OrderedDict() # type: Dict[str, Type[ImageAnnotatorTransport]] _transport_registry["grpc"] = ImageAnnotatorGrpcTransport _transport_registry["grpc_asyncio"] = ImageAnnotatorGrpcAsyncIOTransport +_transport_registry["rest"] = ImageAnnotatorRestTransport __all__ = ( "ImageAnnotatorTransport", "ImageAnnotatorGrpcTransport", "ImageAnnotatorGrpcAsyncIOTransport", + "ImageAnnotatorRestTransport", + "ImageAnnotatorRestInterceptor", ) diff --git a/google/cloud/vision_v1p2beta1/services/image_annotator/transports/rest.py b/google/cloud/vision_v1p2beta1/services/image_annotator/transports/rest.py new file mode 100644 index 00000000..f0da74e4 --- /dev/null +++ b/google/cloud/vision_v1p2beta1/services/image_annotator/transports/rest.py @@ -0,0 +1,504 @@ +# -*- coding: utf-8 -*- +# Copyright 2022 Google LLC +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. +# + +from google.auth.transport.requests import AuthorizedSession # type: ignore +import json # type: ignore +import grpc # type: ignore +from google.auth.transport.grpc import SslCredentials # type: ignore +from google.auth import credentials as ga_credentials # type: ignore +from google.api_core import exceptions as core_exceptions +from google.api_core import retry as retries +from google.api_core import rest_helpers +from google.api_core import rest_streaming +from google.api_core import path_template +from google.api_core import gapic_v1 + +from google.protobuf import json_format +from google.api_core import operations_v1 +from requests import __version__ as requests_version +import dataclasses +import re +from typing import Any, Callable, Dict, List, Optional, Sequence, Tuple, Union +import warnings + +try: + OptionalRetry = Union[retries.Retry, gapic_v1.method._MethodDefault] +except AttributeError: # pragma: NO COVER + OptionalRetry = Union[retries.Retry, object] # type: ignore + + +from google.cloud.vision_v1p2beta1.types import image_annotator +from google.longrunning import operations_pb2 # type: ignore + +from .base import ( + ImageAnnotatorTransport, + DEFAULT_CLIENT_INFO as BASE_DEFAULT_CLIENT_INFO, +) + + +DEFAULT_CLIENT_INFO = gapic_v1.client_info.ClientInfo( + gapic_version=BASE_DEFAULT_CLIENT_INFO.gapic_version, + grpc_version=None, + rest_version=requests_version, +) + + +class ImageAnnotatorRestInterceptor: + """Interceptor for ImageAnnotator. + + Interceptors are used to manipulate requests, request metadata, and responses + in arbitrary ways. + Example use cases include: + * Logging + * Verifying requests according to service or custom semantics + * Stripping extraneous information from responses + + These use cases and more can be enabled by injecting an + instance of a custom subclass when constructing the ImageAnnotatorRestTransport. + + .. code-block:: python + class MyCustomImageAnnotatorInterceptor(ImageAnnotatorRestInterceptor): + def pre_async_batch_annotate_files(self, request, metadata): + logging.log(f"Received request: {request}") + return request, metadata + + def post_async_batch_annotate_files(self, response): + logging.log(f"Received response: {response}") + return response + + def pre_batch_annotate_images(self, request, metadata): + logging.log(f"Received request: {request}") + return request, metadata + + def post_batch_annotate_images(self, response): + logging.log(f"Received response: {response}") + return response + + transport = ImageAnnotatorRestTransport(interceptor=MyCustomImageAnnotatorInterceptor()) + client = ImageAnnotatorClient(transport=transport) + + + """ + + def pre_async_batch_annotate_files( + self, + request: image_annotator.AsyncBatchAnnotateFilesRequest, + metadata: Sequence[Tuple[str, str]], + ) -> Tuple[ + image_annotator.AsyncBatchAnnotateFilesRequest, Sequence[Tuple[str, str]] + ]: + """Pre-rpc interceptor for async_batch_annotate_files + + Override in a subclass to manipulate the request or metadata + before they are sent to the ImageAnnotator server. + """ + return request, metadata + + def post_async_batch_annotate_files( + self, response: operations_pb2.Operation + ) -> operations_pb2.Operation: + """Post-rpc interceptor for async_batch_annotate_files + + Override in a subclass to manipulate the response + after it is returned by the ImageAnnotator server but before + it is returned to user code. + """ + return response + + def pre_batch_annotate_images( + self, + request: image_annotator.BatchAnnotateImagesRequest, + metadata: Sequence[Tuple[str, str]], + ) -> Tuple[image_annotator.BatchAnnotateImagesRequest, Sequence[Tuple[str, str]]]: + """Pre-rpc interceptor for batch_annotate_images + + Override in a subclass to manipulate the request or metadata + before they are sent to the ImageAnnotator server. + """ + return request, metadata + + def post_batch_annotate_images( + self, response: image_annotator.BatchAnnotateImagesResponse + ) -> image_annotator.BatchAnnotateImagesResponse: + """Post-rpc interceptor for batch_annotate_images + + Override in a subclass to manipulate the response + after it is returned by the ImageAnnotator server but before + it is returned to user code. + """ + return response + + +@dataclasses.dataclass +class ImageAnnotatorRestStub: + _session: AuthorizedSession + _host: str + _interceptor: ImageAnnotatorRestInterceptor + + +class ImageAnnotatorRestTransport(ImageAnnotatorTransport): + """REST backend transport for ImageAnnotator. + + Service that performs Google Cloud Vision API detection tasks + over client images, such as face, landmark, logo, label, and + text detection. The ImageAnnotator service returns detected + entities from the images. + + This class defines the same methods as the primary client, so the + primary client can load the underlying transport implementation + and call it. + + It sends JSON representations of protocol buffers over HTTP/1.1 + + """ + + def __init__( + self, + *, + host: str = "vision.googleapis.com", + credentials: Optional[ga_credentials.Credentials] = None, + credentials_file: Optional[str] = None, + scopes: Optional[Sequence[str]] = None, + client_cert_source_for_mtls: Optional[Callable[[], Tuple[bytes, bytes]]] = None, + quota_project_id: Optional[str] = None, + client_info: gapic_v1.client_info.ClientInfo = DEFAULT_CLIENT_INFO, + always_use_jwt_access: Optional[bool] = False, + url_scheme: str = "https", + interceptor: Optional[ImageAnnotatorRestInterceptor] = None, + api_audience: Optional[str] = None, + ) -> None: + """Instantiate the transport. + + Args: + host (Optional[str]): + The hostname to connect to. + credentials (Optional[google.auth.credentials.Credentials]): The + authorization credentials to attach to requests. These + credentials identify the application to the service; if none + are specified, the client will attempt to ascertain the + credentials from the environment. + + credentials_file (Optional[str]): A file with credentials that can + be loaded with :func:`google.auth.load_credentials_from_file`. + This argument is ignored if ``channel`` is provided. + scopes (Optional(Sequence[str])): A list of scopes. This argument is + ignored if ``channel`` is provided. + client_cert_source_for_mtls (Callable[[], Tuple[bytes, bytes]]): Client + certificate to configure mutual TLS HTTP channel. It is ignored + if ``channel`` is provided. + quota_project_id (Optional[str]): An optional project to use for billing + and quota. + client_info (google.api_core.gapic_v1.client_info.ClientInfo): + The client info used to send a user-agent string along with + API requests. If ``None``, then default info will be used. + Generally, you only need to set this if you are developing + your own client library. + always_use_jwt_access (Optional[bool]): Whether self signed JWT should + be used for service account credentials. + url_scheme: the protocol scheme for the API endpoint. Normally + "https", but for testing or local servers, + "http" can be specified. + """ + # Run the base constructor + # TODO(yon-mg): resolve other ctor params i.e. scopes, quota, etc. + # TODO: When custom host (api_endpoint) is set, `scopes` must *also* be set on the + # credentials object + maybe_url_match = re.match("^(?Phttp(?:s)?://)?(?P.*)$", host) + if maybe_url_match is None: + raise ValueError( + f"Unexpected hostname structure: {host}" + ) # pragma: NO COVER + + url_match_items = maybe_url_match.groupdict() + + host = f"{url_scheme}://{host}" if not url_match_items["scheme"] else host + + super().__init__( + host=host, + credentials=credentials, + client_info=client_info, + always_use_jwt_access=always_use_jwt_access, + api_audience=api_audience, + ) + self._session = AuthorizedSession( + self._credentials, default_host=self.DEFAULT_HOST + ) + self._operations_client: Optional[operations_v1.AbstractOperationsClient] = None + if client_cert_source_for_mtls: + self._session.configure_mtls_channel(client_cert_source_for_mtls) + self._interceptor = interceptor or ImageAnnotatorRestInterceptor() + self._prep_wrapped_messages(client_info) + + @property + def operations_client(self) -> operations_v1.AbstractOperationsClient: + """Create the client designed to process long-running operations. + + This property caches on the instance; repeated calls return the same + client. + """ + # Only create a new client if we do not already have one. + if self._operations_client is None: + http_options: Dict[str, List[Dict[str, str]]] = {} + + rest_transport = operations_v1.OperationsRestTransport( + host=self._host, + # use the credentials which are saved + credentials=self._credentials, + scopes=self._scopes, + http_options=http_options, + path_prefix="v1p2beta1", + ) + + self._operations_client = operations_v1.AbstractOperationsClient( + transport=rest_transport + ) + + # Return the client from cache. + return self._operations_client + + class _AsyncBatchAnnotateFiles(ImageAnnotatorRestStub): + def __hash__(self): + return hash("AsyncBatchAnnotateFiles") + + __REQUIRED_FIELDS_DEFAULT_VALUES: Dict[str, Any] = {} + + @classmethod + def _get_unset_required_fields(cls, message_dict): + return { + k: v + for k, v in cls.__REQUIRED_FIELDS_DEFAULT_VALUES.items() + if k not in message_dict + } + + def __call__( + self, + request: image_annotator.AsyncBatchAnnotateFilesRequest, + *, + retry: OptionalRetry = gapic_v1.method.DEFAULT, + timeout: Optional[float] = None, + metadata: Sequence[Tuple[str, str]] = (), + ) -> operations_pb2.Operation: + r"""Call the async batch annotate + files method over HTTP. + + Args: + request (~.image_annotator.AsyncBatchAnnotateFilesRequest): + The request object. Multiple async file annotation + requests are batched into a single + service call. + + retry (google.api_core.retry.Retry): Designation of what errors, if any, + should be retried. + timeout (float): The timeout for this request. + metadata (Sequence[Tuple[str, str]]): Strings which should be + sent along with the request as metadata. + + Returns: + ~.operations_pb2.Operation: + This resource represents a + long-running operation that is the + result of a network API call. + + """ + + http_options: List[Dict[str, str]] = [ + { + "method": "post", + "uri": "/v1p2beta1/files:asyncBatchAnnotate", + "body": "*", + }, + ] + request, metadata = self._interceptor.pre_async_batch_annotate_files( + request, metadata + ) + pb_request = image_annotator.AsyncBatchAnnotateFilesRequest.pb(request) + transcoded_request = path_template.transcode(http_options, pb_request) + + # Jsonify the request body + + body = json_format.MessageToJson( + transcoded_request["body"], + including_default_value_fields=False, + use_integers_for_enums=True, + ) + uri = transcoded_request["uri"] + method = transcoded_request["method"] + + # Jsonify the query params + query_params = json.loads( + json_format.MessageToJson( + transcoded_request["query_params"], + including_default_value_fields=False, + use_integers_for_enums=True, + ) + ) + query_params.update(self._get_unset_required_fields(query_params)) + + query_params["$alt"] = "json;enum-encoding=int" + + # Send the request + headers = dict(metadata) + headers["Content-Type"] = "application/json" + response = getattr(self._session, method)( + "{host}{uri}".format(host=self._host, uri=uri), + timeout=timeout, + headers=headers, + params=rest_helpers.flatten_query_params(query_params, strict=True), + data=body, + ) + + # In case of error, raise the appropriate core_exceptions.GoogleAPICallError exception + # subclass. + if response.status_code >= 400: + raise core_exceptions.from_http_response(response) + + # Return the response + resp = operations_pb2.Operation() + json_format.Parse(response.content, resp, ignore_unknown_fields=True) + resp = self._interceptor.post_async_batch_annotate_files(resp) + return resp + + class _BatchAnnotateImages(ImageAnnotatorRestStub): + def __hash__(self): + return hash("BatchAnnotateImages") + + __REQUIRED_FIELDS_DEFAULT_VALUES: Dict[str, Any] = {} + + @classmethod + def _get_unset_required_fields(cls, message_dict): + return { + k: v + for k, v in cls.__REQUIRED_FIELDS_DEFAULT_VALUES.items() + if k not in message_dict + } + + def __call__( + self, + request: image_annotator.BatchAnnotateImagesRequest, + *, + retry: OptionalRetry = gapic_v1.method.DEFAULT, + timeout: Optional[float] = None, + metadata: Sequence[Tuple[str, str]] = (), + ) -> image_annotator.BatchAnnotateImagesResponse: + r"""Call the batch annotate images method over HTTP. + + Args: + request (~.image_annotator.BatchAnnotateImagesRequest): + The request object. Multiple image annotation requests + are batched into a single service call. + + retry (google.api_core.retry.Retry): Designation of what errors, if any, + should be retried. + timeout (float): The timeout for this request. + metadata (Sequence[Tuple[str, str]]): Strings which should be + sent along with the request as metadata. + + Returns: + ~.image_annotator.BatchAnnotateImagesResponse: + Response to a batch image annotation + request. + + """ + + http_options: List[Dict[str, str]] = [ + { + "method": "post", + "uri": "/v1p2beta1/images:annotate", + "body": "*", + }, + ] + request, metadata = self._interceptor.pre_batch_annotate_images( + request, metadata + ) + pb_request = image_annotator.BatchAnnotateImagesRequest.pb(request) + transcoded_request = path_template.transcode(http_options, pb_request) + + # Jsonify the request body + + body = json_format.MessageToJson( + transcoded_request["body"], + including_default_value_fields=False, + use_integers_for_enums=True, + ) + uri = transcoded_request["uri"] + method = transcoded_request["method"] + + # Jsonify the query params + query_params = json.loads( + json_format.MessageToJson( + transcoded_request["query_params"], + including_default_value_fields=False, + use_integers_for_enums=True, + ) + ) + query_params.update(self._get_unset_required_fields(query_params)) + + query_params["$alt"] = "json;enum-encoding=int" + + # Send the request + headers = dict(metadata) + headers["Content-Type"] = "application/json" + response = getattr(self._session, method)( + "{host}{uri}".format(host=self._host, uri=uri), + timeout=timeout, + headers=headers, + params=rest_helpers.flatten_query_params(query_params, strict=True), + data=body, + ) + + # In case of error, raise the appropriate core_exceptions.GoogleAPICallError exception + # subclass. + if response.status_code >= 400: + raise core_exceptions.from_http_response(response) + + # Return the response + resp = image_annotator.BatchAnnotateImagesResponse() + pb_resp = image_annotator.BatchAnnotateImagesResponse.pb(resp) + + json_format.Parse(response.content, pb_resp, ignore_unknown_fields=True) + resp = self._interceptor.post_batch_annotate_images(resp) + return resp + + @property + def async_batch_annotate_files( + self, + ) -> Callable[ + [image_annotator.AsyncBatchAnnotateFilesRequest], operations_pb2.Operation + ]: + # The return type is fine, but mypy isn't sophisticated enough to determine what's going on here. + # In C++ this would require a dynamic_cast + return self._AsyncBatchAnnotateFiles(self._session, self._host, self._interceptor) # type: ignore + + @property + def batch_annotate_images( + self, + ) -> Callable[ + [image_annotator.BatchAnnotateImagesRequest], + image_annotator.BatchAnnotateImagesResponse, + ]: + # The return type is fine, but mypy isn't sophisticated enough to determine what's going on here. + # In C++ this would require a dynamic_cast + return self._BatchAnnotateImages(self._session, self._host, self._interceptor) # type: ignore + + @property + def kind(self) -> str: + return "rest" + + def close(self): + self._session.close() + + +__all__ = ("ImageAnnotatorRestTransport",) diff --git a/google/cloud/vision_v1p2beta1/types/geometry.py b/google/cloud/vision_v1p2beta1/types/geometry.py index f5343d4b..5e46824a 100644 --- a/google/cloud/vision_v1p2beta1/types/geometry.py +++ b/google/cloud/vision_v1p2beta1/types/geometry.py @@ -13,6 +13,8 @@ # See the License for the specific language governing permissions and # limitations under the License. # +from __future__ import annotations + from typing import MutableMapping, MutableSequence import proto # type: ignore diff --git a/google/cloud/vision_v1p2beta1/types/image_annotator.py b/google/cloud/vision_v1p2beta1/types/image_annotator.py index 929c7648..fa567642 100644 --- a/google/cloud/vision_v1p2beta1/types/image_annotator.py +++ b/google/cloud/vision_v1p2beta1/types/image_annotator.py @@ -13,6 +13,8 @@ # See the License for the specific language governing permissions and # limitations under the License. # +from __future__ import annotations + from typing import MutableMapping, MutableSequence import proto # type: ignore diff --git a/google/cloud/vision_v1p2beta1/types/text_annotation.py b/google/cloud/vision_v1p2beta1/types/text_annotation.py index 71c2bab1..0e984214 100644 --- a/google/cloud/vision_v1p2beta1/types/text_annotation.py +++ b/google/cloud/vision_v1p2beta1/types/text_annotation.py @@ -13,6 +13,8 @@ # See the License for the specific language governing permissions and # limitations under the License. # +from __future__ import annotations + from typing import MutableMapping, MutableSequence import proto # type: ignore diff --git a/google/cloud/vision_v1p2beta1/types/web_detection.py b/google/cloud/vision_v1p2beta1/types/web_detection.py index d5b0db7b..425123de 100644 --- a/google/cloud/vision_v1p2beta1/types/web_detection.py +++ b/google/cloud/vision_v1p2beta1/types/web_detection.py @@ -13,6 +13,8 @@ # See the License for the specific language governing permissions and # limitations under the License. # +from __future__ import annotations + from typing import MutableMapping, MutableSequence import proto # type: ignore diff --git a/google/cloud/vision_v1p3beta1/__init__.py b/google/cloud/vision_v1p3beta1/__init__.py index ff480b2a..5cbe0978 100644 --- a/google/cloud/vision_v1p3beta1/__init__.py +++ b/google/cloud/vision_v1p3beta1/__init__.py @@ -13,7 +13,7 @@ # See the License for the specific language governing permissions and # limitations under the License. # -from google.cloud.vision import gapic_version as package_version +from google.cloud.vision_v1p3beta1 import gapic_version as package_version __version__ = package_version.__version__ diff --git a/google/cloud/vision_v1p3beta1/gapic_metadata.json b/google/cloud/vision_v1p3beta1/gapic_metadata.json index a1425044..5c3d49fd 100644 --- a/google/cloud/vision_v1p3beta1/gapic_metadata.json +++ b/google/cloud/vision_v1p3beta1/gapic_metadata.json @@ -36,6 +36,21 @@ ] } } + }, + "rest": { + "libraryClient": "ImageAnnotatorClient", + "rpcs": { + "AsyncBatchAnnotateFiles": { + "methods": [ + "async_batch_annotate_files" + ] + }, + "BatchAnnotateImages": { + "methods": [ + "batch_annotate_images" + ] + } + } } } }, @@ -230,6 +245,101 @@ ] } } + }, + "rest": { + "libraryClient": "ProductSearchClient", + "rpcs": { + "AddProductToProductSet": { + "methods": [ + "add_product_to_product_set" + ] + }, + "CreateProduct": { + "methods": [ + "create_product" + ] + }, + "CreateProductSet": { + "methods": [ + "create_product_set" + ] + }, + "CreateReferenceImage": { + "methods": [ + "create_reference_image" + ] + }, + "DeleteProduct": { + "methods": [ + "delete_product" + ] + }, + "DeleteProductSet": { + "methods": [ + "delete_product_set" + ] + }, + "DeleteReferenceImage": { + "methods": [ + "delete_reference_image" + ] + }, + "GetProduct": { + "methods": [ + "get_product" + ] + }, + "GetProductSet": { + "methods": [ + "get_product_set" + ] + }, + "GetReferenceImage": { + "methods": [ + "get_reference_image" + ] + }, + "ImportProductSets": { + "methods": [ + "import_product_sets" + ] + }, + "ListProductSets": { + "methods": [ + "list_product_sets" + ] + }, + "ListProducts": { + "methods": [ + "list_products" + ] + }, + "ListProductsInProductSet": { + "methods": [ + "list_products_in_product_set" + ] + }, + "ListReferenceImages": { + "methods": [ + "list_reference_images" + ] + }, + "RemoveProductFromProductSet": { + "methods": [ + "remove_product_from_product_set" + ] + }, + "UpdateProduct": { + "methods": [ + "update_product" + ] + }, + "UpdateProductSet": { + "methods": [ + "update_product_set" + ] + } + } } } } diff --git a/google/cloud/vision_v1p3beta1/gapic_version.py b/google/cloud/vision_v1p3beta1/gapic_version.py index c443818a..431567aa 100644 --- a/google/cloud/vision_v1p3beta1/gapic_version.py +++ b/google/cloud/vision_v1p3beta1/gapic_version.py @@ -13,4 +13,4 @@ # See the License for the specific language governing permissions and # limitations under the License. # -__version__ = "3.3.1" # {x-release-please-version} +__version__ = "3.4.0" # {x-release-please-version} diff --git a/google/cloud/vision_v1p3beta1/services/image_annotator/client.py b/google/cloud/vision_v1p3beta1/services/image_annotator/client.py index 8dc71ced..32e18e08 100644 --- a/google/cloud/vision_v1p3beta1/services/image_annotator/client.py +++ b/google/cloud/vision_v1p3beta1/services/image_annotator/client.py @@ -52,6 +52,7 @@ from .transports.base import ImageAnnotatorTransport, DEFAULT_CLIENT_INFO from .transports.grpc import ImageAnnotatorGrpcTransport from .transports.grpc_asyncio import ImageAnnotatorGrpcAsyncIOTransport +from .transports.rest import ImageAnnotatorRestTransport class ImageAnnotatorClientMeta(type): @@ -67,6 +68,7 @@ class ImageAnnotatorClientMeta(type): ) # type: Dict[str, Type[ImageAnnotatorTransport]] _transport_registry["grpc"] = ImageAnnotatorGrpcTransport _transport_registry["grpc_asyncio"] = ImageAnnotatorGrpcAsyncIOTransport + _transport_registry["rest"] = ImageAnnotatorRestTransport def get_transport_class( cls, diff --git a/google/cloud/vision_v1p3beta1/services/image_annotator/transports/__init__.py b/google/cloud/vision_v1p3beta1/services/image_annotator/transports/__init__.py index bb856540..e959448a 100644 --- a/google/cloud/vision_v1p3beta1/services/image_annotator/transports/__init__.py +++ b/google/cloud/vision_v1p3beta1/services/image_annotator/transports/__init__.py @@ -19,15 +19,20 @@ from .base import ImageAnnotatorTransport from .grpc import ImageAnnotatorGrpcTransport from .grpc_asyncio import ImageAnnotatorGrpcAsyncIOTransport +from .rest import ImageAnnotatorRestTransport +from .rest import ImageAnnotatorRestInterceptor # Compile a registry of transports. _transport_registry = OrderedDict() # type: Dict[str, Type[ImageAnnotatorTransport]] _transport_registry["grpc"] = ImageAnnotatorGrpcTransport _transport_registry["grpc_asyncio"] = ImageAnnotatorGrpcAsyncIOTransport +_transport_registry["rest"] = ImageAnnotatorRestTransport __all__ = ( "ImageAnnotatorTransport", "ImageAnnotatorGrpcTransport", "ImageAnnotatorGrpcAsyncIOTransport", + "ImageAnnotatorRestTransport", + "ImageAnnotatorRestInterceptor", ) diff --git a/google/cloud/vision_v1p3beta1/services/image_annotator/transports/rest.py b/google/cloud/vision_v1p3beta1/services/image_annotator/transports/rest.py new file mode 100644 index 00000000..31713963 --- /dev/null +++ b/google/cloud/vision_v1p3beta1/services/image_annotator/transports/rest.py @@ -0,0 +1,504 @@ +# -*- coding: utf-8 -*- +# Copyright 2022 Google LLC +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. +# + +from google.auth.transport.requests import AuthorizedSession # type: ignore +import json # type: ignore +import grpc # type: ignore +from google.auth.transport.grpc import SslCredentials # type: ignore +from google.auth import credentials as ga_credentials # type: ignore +from google.api_core import exceptions as core_exceptions +from google.api_core import retry as retries +from google.api_core import rest_helpers +from google.api_core import rest_streaming +from google.api_core import path_template +from google.api_core import gapic_v1 + +from google.protobuf import json_format +from google.api_core import operations_v1 +from requests import __version__ as requests_version +import dataclasses +import re +from typing import Any, Callable, Dict, List, Optional, Sequence, Tuple, Union +import warnings + +try: + OptionalRetry = Union[retries.Retry, gapic_v1.method._MethodDefault] +except AttributeError: # pragma: NO COVER + OptionalRetry = Union[retries.Retry, object] # type: ignore + + +from google.cloud.vision_v1p3beta1.types import image_annotator +from google.longrunning import operations_pb2 # type: ignore + +from .base import ( + ImageAnnotatorTransport, + DEFAULT_CLIENT_INFO as BASE_DEFAULT_CLIENT_INFO, +) + + +DEFAULT_CLIENT_INFO = gapic_v1.client_info.ClientInfo( + gapic_version=BASE_DEFAULT_CLIENT_INFO.gapic_version, + grpc_version=None, + rest_version=requests_version, +) + + +class ImageAnnotatorRestInterceptor: + """Interceptor for ImageAnnotator. + + Interceptors are used to manipulate requests, request metadata, and responses + in arbitrary ways. + Example use cases include: + * Logging + * Verifying requests according to service or custom semantics + * Stripping extraneous information from responses + + These use cases and more can be enabled by injecting an + instance of a custom subclass when constructing the ImageAnnotatorRestTransport. + + .. code-block:: python + class MyCustomImageAnnotatorInterceptor(ImageAnnotatorRestInterceptor): + def pre_async_batch_annotate_files(self, request, metadata): + logging.log(f"Received request: {request}") + return request, metadata + + def post_async_batch_annotate_files(self, response): + logging.log(f"Received response: {response}") + return response + + def pre_batch_annotate_images(self, request, metadata): + logging.log(f"Received request: {request}") + return request, metadata + + def post_batch_annotate_images(self, response): + logging.log(f"Received response: {response}") + return response + + transport = ImageAnnotatorRestTransport(interceptor=MyCustomImageAnnotatorInterceptor()) + client = ImageAnnotatorClient(transport=transport) + + + """ + + def pre_async_batch_annotate_files( + self, + request: image_annotator.AsyncBatchAnnotateFilesRequest, + metadata: Sequence[Tuple[str, str]], + ) -> Tuple[ + image_annotator.AsyncBatchAnnotateFilesRequest, Sequence[Tuple[str, str]] + ]: + """Pre-rpc interceptor for async_batch_annotate_files + + Override in a subclass to manipulate the request or metadata + before they are sent to the ImageAnnotator server. + """ + return request, metadata + + def post_async_batch_annotate_files( + self, response: operations_pb2.Operation + ) -> operations_pb2.Operation: + """Post-rpc interceptor for async_batch_annotate_files + + Override in a subclass to manipulate the response + after it is returned by the ImageAnnotator server but before + it is returned to user code. + """ + return response + + def pre_batch_annotate_images( + self, + request: image_annotator.BatchAnnotateImagesRequest, + metadata: Sequence[Tuple[str, str]], + ) -> Tuple[image_annotator.BatchAnnotateImagesRequest, Sequence[Tuple[str, str]]]: + """Pre-rpc interceptor for batch_annotate_images + + Override in a subclass to manipulate the request or metadata + before they are sent to the ImageAnnotator server. + """ + return request, metadata + + def post_batch_annotate_images( + self, response: image_annotator.BatchAnnotateImagesResponse + ) -> image_annotator.BatchAnnotateImagesResponse: + """Post-rpc interceptor for batch_annotate_images + + Override in a subclass to manipulate the response + after it is returned by the ImageAnnotator server but before + it is returned to user code. + """ + return response + + +@dataclasses.dataclass +class ImageAnnotatorRestStub: + _session: AuthorizedSession + _host: str + _interceptor: ImageAnnotatorRestInterceptor + + +class ImageAnnotatorRestTransport(ImageAnnotatorTransport): + """REST backend transport for ImageAnnotator. + + Service that performs Google Cloud Vision API detection tasks + over client images, such as face, landmark, logo, label, and + text detection. The ImageAnnotator service returns detected + entities from the images. + + This class defines the same methods as the primary client, so the + primary client can load the underlying transport implementation + and call it. + + It sends JSON representations of protocol buffers over HTTP/1.1 + + """ + + def __init__( + self, + *, + host: str = "vision.googleapis.com", + credentials: Optional[ga_credentials.Credentials] = None, + credentials_file: Optional[str] = None, + scopes: Optional[Sequence[str]] = None, + client_cert_source_for_mtls: Optional[Callable[[], Tuple[bytes, bytes]]] = None, + quota_project_id: Optional[str] = None, + client_info: gapic_v1.client_info.ClientInfo = DEFAULT_CLIENT_INFO, + always_use_jwt_access: Optional[bool] = False, + url_scheme: str = "https", + interceptor: Optional[ImageAnnotatorRestInterceptor] = None, + api_audience: Optional[str] = None, + ) -> None: + """Instantiate the transport. + + Args: + host (Optional[str]): + The hostname to connect to. + credentials (Optional[google.auth.credentials.Credentials]): The + authorization credentials to attach to requests. These + credentials identify the application to the service; if none + are specified, the client will attempt to ascertain the + credentials from the environment. + + credentials_file (Optional[str]): A file with credentials that can + be loaded with :func:`google.auth.load_credentials_from_file`. + This argument is ignored if ``channel`` is provided. + scopes (Optional(Sequence[str])): A list of scopes. This argument is + ignored if ``channel`` is provided. + client_cert_source_for_mtls (Callable[[], Tuple[bytes, bytes]]): Client + certificate to configure mutual TLS HTTP channel. It is ignored + if ``channel`` is provided. + quota_project_id (Optional[str]): An optional project to use for billing + and quota. + client_info (google.api_core.gapic_v1.client_info.ClientInfo): + The client info used to send a user-agent string along with + API requests. If ``None``, then default info will be used. + Generally, you only need to set this if you are developing + your own client library. + always_use_jwt_access (Optional[bool]): Whether self signed JWT should + be used for service account credentials. + url_scheme: the protocol scheme for the API endpoint. Normally + "https", but for testing or local servers, + "http" can be specified. + """ + # Run the base constructor + # TODO(yon-mg): resolve other ctor params i.e. scopes, quota, etc. + # TODO: When custom host (api_endpoint) is set, `scopes` must *also* be set on the + # credentials object + maybe_url_match = re.match("^(?Phttp(?:s)?://)?(?P.*)$", host) + if maybe_url_match is None: + raise ValueError( + f"Unexpected hostname structure: {host}" + ) # pragma: NO COVER + + url_match_items = maybe_url_match.groupdict() + + host = f"{url_scheme}://{host}" if not url_match_items["scheme"] else host + + super().__init__( + host=host, + credentials=credentials, + client_info=client_info, + always_use_jwt_access=always_use_jwt_access, + api_audience=api_audience, + ) + self._session = AuthorizedSession( + self._credentials, default_host=self.DEFAULT_HOST + ) + self._operations_client: Optional[operations_v1.AbstractOperationsClient] = None + if client_cert_source_for_mtls: + self._session.configure_mtls_channel(client_cert_source_for_mtls) + self._interceptor = interceptor or ImageAnnotatorRestInterceptor() + self._prep_wrapped_messages(client_info) + + @property + def operations_client(self) -> operations_v1.AbstractOperationsClient: + """Create the client designed to process long-running operations. + + This property caches on the instance; repeated calls return the same + client. + """ + # Only create a new client if we do not already have one. + if self._operations_client is None: + http_options: Dict[str, List[Dict[str, str]]] = {} + + rest_transport = operations_v1.OperationsRestTransport( + host=self._host, + # use the credentials which are saved + credentials=self._credentials, + scopes=self._scopes, + http_options=http_options, + path_prefix="v1p3beta1", + ) + + self._operations_client = operations_v1.AbstractOperationsClient( + transport=rest_transport + ) + + # Return the client from cache. + return self._operations_client + + class _AsyncBatchAnnotateFiles(ImageAnnotatorRestStub): + def __hash__(self): + return hash("AsyncBatchAnnotateFiles") + + __REQUIRED_FIELDS_DEFAULT_VALUES: Dict[str, Any] = {} + + @classmethod + def _get_unset_required_fields(cls, message_dict): + return { + k: v + for k, v in cls.__REQUIRED_FIELDS_DEFAULT_VALUES.items() + if k not in message_dict + } + + def __call__( + self, + request: image_annotator.AsyncBatchAnnotateFilesRequest, + *, + retry: OptionalRetry = gapic_v1.method.DEFAULT, + timeout: Optional[float] = None, + metadata: Sequence[Tuple[str, str]] = (), + ) -> operations_pb2.Operation: + r"""Call the async batch annotate + files method over HTTP. + + Args: + request (~.image_annotator.AsyncBatchAnnotateFilesRequest): + The request object. Multiple async file annotation + requests are batched into a single + service call. + + retry (google.api_core.retry.Retry): Designation of what errors, if any, + should be retried. + timeout (float): The timeout for this request. + metadata (Sequence[Tuple[str, str]]): Strings which should be + sent along with the request as metadata. + + Returns: + ~.operations_pb2.Operation: + This resource represents a + long-running operation that is the + result of a network API call. + + """ + + http_options: List[Dict[str, str]] = [ + { + "method": "post", + "uri": "/v1p3beta1/files:asyncBatchAnnotate", + "body": "*", + }, + ] + request, metadata = self._interceptor.pre_async_batch_annotate_files( + request, metadata + ) + pb_request = image_annotator.AsyncBatchAnnotateFilesRequest.pb(request) + transcoded_request = path_template.transcode(http_options, pb_request) + + # Jsonify the request body + + body = json_format.MessageToJson( + transcoded_request["body"], + including_default_value_fields=False, + use_integers_for_enums=True, + ) + uri = transcoded_request["uri"] + method = transcoded_request["method"] + + # Jsonify the query params + query_params = json.loads( + json_format.MessageToJson( + transcoded_request["query_params"], + including_default_value_fields=False, + use_integers_for_enums=True, + ) + ) + query_params.update(self._get_unset_required_fields(query_params)) + + query_params["$alt"] = "json;enum-encoding=int" + + # Send the request + headers = dict(metadata) + headers["Content-Type"] = "application/json" + response = getattr(self._session, method)( + "{host}{uri}".format(host=self._host, uri=uri), + timeout=timeout, + headers=headers, + params=rest_helpers.flatten_query_params(query_params, strict=True), + data=body, + ) + + # In case of error, raise the appropriate core_exceptions.GoogleAPICallError exception + # subclass. + if response.status_code >= 400: + raise core_exceptions.from_http_response(response) + + # Return the response + resp = operations_pb2.Operation() + json_format.Parse(response.content, resp, ignore_unknown_fields=True) + resp = self._interceptor.post_async_batch_annotate_files(resp) + return resp + + class _BatchAnnotateImages(ImageAnnotatorRestStub): + def __hash__(self): + return hash("BatchAnnotateImages") + + __REQUIRED_FIELDS_DEFAULT_VALUES: Dict[str, Any] = {} + + @classmethod + def _get_unset_required_fields(cls, message_dict): + return { + k: v + for k, v in cls.__REQUIRED_FIELDS_DEFAULT_VALUES.items() + if k not in message_dict + } + + def __call__( + self, + request: image_annotator.BatchAnnotateImagesRequest, + *, + retry: OptionalRetry = gapic_v1.method.DEFAULT, + timeout: Optional[float] = None, + metadata: Sequence[Tuple[str, str]] = (), + ) -> image_annotator.BatchAnnotateImagesResponse: + r"""Call the batch annotate images method over HTTP. + + Args: + request (~.image_annotator.BatchAnnotateImagesRequest): + The request object. Multiple image annotation requests + are batched into a single service call. + + retry (google.api_core.retry.Retry): Designation of what errors, if any, + should be retried. + timeout (float): The timeout for this request. + metadata (Sequence[Tuple[str, str]]): Strings which should be + sent along with the request as metadata. + + Returns: + ~.image_annotator.BatchAnnotateImagesResponse: + Response to a batch image annotation + request. + + """ + + http_options: List[Dict[str, str]] = [ + { + "method": "post", + "uri": "/v1p3beta1/images:annotate", + "body": "*", + }, + ] + request, metadata = self._interceptor.pre_batch_annotate_images( + request, metadata + ) + pb_request = image_annotator.BatchAnnotateImagesRequest.pb(request) + transcoded_request = path_template.transcode(http_options, pb_request) + + # Jsonify the request body + + body = json_format.MessageToJson( + transcoded_request["body"], + including_default_value_fields=False, + use_integers_for_enums=True, + ) + uri = transcoded_request["uri"] + method = transcoded_request["method"] + + # Jsonify the query params + query_params = json.loads( + json_format.MessageToJson( + transcoded_request["query_params"], + including_default_value_fields=False, + use_integers_for_enums=True, + ) + ) + query_params.update(self._get_unset_required_fields(query_params)) + + query_params["$alt"] = "json;enum-encoding=int" + + # Send the request + headers = dict(metadata) + headers["Content-Type"] = "application/json" + response = getattr(self._session, method)( + "{host}{uri}".format(host=self._host, uri=uri), + timeout=timeout, + headers=headers, + params=rest_helpers.flatten_query_params(query_params, strict=True), + data=body, + ) + + # In case of error, raise the appropriate core_exceptions.GoogleAPICallError exception + # subclass. + if response.status_code >= 400: + raise core_exceptions.from_http_response(response) + + # Return the response + resp = image_annotator.BatchAnnotateImagesResponse() + pb_resp = image_annotator.BatchAnnotateImagesResponse.pb(resp) + + json_format.Parse(response.content, pb_resp, ignore_unknown_fields=True) + resp = self._interceptor.post_batch_annotate_images(resp) + return resp + + @property + def async_batch_annotate_files( + self, + ) -> Callable[ + [image_annotator.AsyncBatchAnnotateFilesRequest], operations_pb2.Operation + ]: + # The return type is fine, but mypy isn't sophisticated enough to determine what's going on here. + # In C++ this would require a dynamic_cast + return self._AsyncBatchAnnotateFiles(self._session, self._host, self._interceptor) # type: ignore + + @property + def batch_annotate_images( + self, + ) -> Callable[ + [image_annotator.BatchAnnotateImagesRequest], + image_annotator.BatchAnnotateImagesResponse, + ]: + # The return type is fine, but mypy isn't sophisticated enough to determine what's going on here. + # In C++ this would require a dynamic_cast + return self._BatchAnnotateImages(self._session, self._host, self._interceptor) # type: ignore + + @property + def kind(self) -> str: + return "rest" + + def close(self): + self._session.close() + + +__all__ = ("ImageAnnotatorRestTransport",) diff --git a/google/cloud/vision_v1p3beta1/services/product_search/client.py b/google/cloud/vision_v1p3beta1/services/product_search/client.py index e05cf1e2..eeb128e6 100644 --- a/google/cloud/vision_v1p3beta1/services/product_search/client.py +++ b/google/cloud/vision_v1p3beta1/services/product_search/client.py @@ -57,6 +57,7 @@ from .transports.base import ProductSearchTransport, DEFAULT_CLIENT_INFO from .transports.grpc import ProductSearchGrpcTransport from .transports.grpc_asyncio import ProductSearchGrpcAsyncIOTransport +from .transports.rest import ProductSearchRestTransport class ProductSearchClientMeta(type): @@ -70,6 +71,7 @@ class ProductSearchClientMeta(type): _transport_registry = OrderedDict() # type: Dict[str, Type[ProductSearchTransport]] _transport_registry["grpc"] = ProductSearchGrpcTransport _transport_registry["grpc_asyncio"] = ProductSearchGrpcAsyncIOTransport + _transport_registry["rest"] = ProductSearchRestTransport def get_transport_class( cls, diff --git a/google/cloud/vision_v1p3beta1/services/product_search/transports/__init__.py b/google/cloud/vision_v1p3beta1/services/product_search/transports/__init__.py index 40a758f5..2878a076 100644 --- a/google/cloud/vision_v1p3beta1/services/product_search/transports/__init__.py +++ b/google/cloud/vision_v1p3beta1/services/product_search/transports/__init__.py @@ -19,15 +19,20 @@ from .base import ProductSearchTransport from .grpc import ProductSearchGrpcTransport from .grpc_asyncio import ProductSearchGrpcAsyncIOTransport +from .rest import ProductSearchRestTransport +from .rest import ProductSearchRestInterceptor # Compile a registry of transports. _transport_registry = OrderedDict() # type: Dict[str, Type[ProductSearchTransport]] _transport_registry["grpc"] = ProductSearchGrpcTransport _transport_registry["grpc_asyncio"] = ProductSearchGrpcAsyncIOTransport +_transport_registry["rest"] = ProductSearchRestTransport __all__ = ( "ProductSearchTransport", "ProductSearchGrpcTransport", "ProductSearchGrpcAsyncIOTransport", + "ProductSearchRestTransport", + "ProductSearchRestInterceptor", ) diff --git a/google/cloud/vision_v1p3beta1/services/product_search/transports/rest.py b/google/cloud/vision_v1p3beta1/services/product_search/transports/rest.py new file mode 100644 index 00000000..18182622 --- /dev/null +++ b/google/cloud/vision_v1p3beta1/services/product_search/transports/rest.py @@ -0,0 +1,2547 @@ +# -*- coding: utf-8 -*- +# Copyright 2022 Google LLC +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. +# + +from google.auth.transport.requests import AuthorizedSession # type: ignore +import json # type: ignore +import grpc # type: ignore +from google.auth.transport.grpc import SslCredentials # type: ignore +from google.auth import credentials as ga_credentials # type: ignore +from google.api_core import exceptions as core_exceptions +from google.api_core import retry as retries +from google.api_core import rest_helpers +from google.api_core import rest_streaming +from google.api_core import path_template +from google.api_core import gapic_v1 + +from google.protobuf import json_format +from google.api_core import operations_v1 +from requests import __version__ as requests_version +import dataclasses +import re +from typing import Any, Callable, Dict, List, Optional, Sequence, Tuple, Union +import warnings + +try: + OptionalRetry = Union[retries.Retry, gapic_v1.method._MethodDefault] +except AttributeError: # pragma: NO COVER + OptionalRetry = Union[retries.Retry, object] # type: ignore + + +from google.cloud.vision_v1p3beta1.types import product_search_service +from google.longrunning import operations_pb2 # type: ignore +from google.protobuf import empty_pb2 # type: ignore + +from .base import ( + ProductSearchTransport, + DEFAULT_CLIENT_INFO as BASE_DEFAULT_CLIENT_INFO, +) + + +DEFAULT_CLIENT_INFO = gapic_v1.client_info.ClientInfo( + gapic_version=BASE_DEFAULT_CLIENT_INFO.gapic_version, + grpc_version=None, + rest_version=requests_version, +) + + +class ProductSearchRestInterceptor: + """Interceptor for ProductSearch. + + Interceptors are used to manipulate requests, request metadata, and responses + in arbitrary ways. + Example use cases include: + * Logging + * Verifying requests according to service or custom semantics + * Stripping extraneous information from responses + + These use cases and more can be enabled by injecting an + instance of a custom subclass when constructing the ProductSearchRestTransport. + + .. code-block:: python + class MyCustomProductSearchInterceptor(ProductSearchRestInterceptor): + def pre_add_product_to_product_set(self, request, metadata): + logging.log(f"Received request: {request}") + return request, metadata + + def pre_create_product(self, request, metadata): + logging.log(f"Received request: {request}") + return request, metadata + + def post_create_product(self, response): + logging.log(f"Received response: {response}") + return response + + def pre_create_product_set(self, request, metadata): + logging.log(f"Received request: {request}") + return request, metadata + + def post_create_product_set(self, response): + logging.log(f"Received response: {response}") + return response + + def pre_create_reference_image(self, request, metadata): + logging.log(f"Received request: {request}") + return request, metadata + + def post_create_reference_image(self, response): + logging.log(f"Received response: {response}") + return response + + def pre_delete_product(self, request, metadata): + logging.log(f"Received request: {request}") + return request, metadata + + def pre_delete_product_set(self, request, metadata): + logging.log(f"Received request: {request}") + return request, metadata + + def pre_delete_reference_image(self, request, metadata): + logging.log(f"Received request: {request}") + return request, metadata + + def pre_get_product(self, request, metadata): + logging.log(f"Received request: {request}") + return request, metadata + + def post_get_product(self, response): + logging.log(f"Received response: {response}") + return response + + def pre_get_product_set(self, request, metadata): + logging.log(f"Received request: {request}") + return request, metadata + + def post_get_product_set(self, response): + logging.log(f"Received response: {response}") + return response + + def pre_get_reference_image(self, request, metadata): + logging.log(f"Received request: {request}") + return request, metadata + + def post_get_reference_image(self, response): + logging.log(f"Received response: {response}") + return response + + def pre_import_product_sets(self, request, metadata): + logging.log(f"Received request: {request}") + return request, metadata + + def post_import_product_sets(self, response): + logging.log(f"Received response: {response}") + return response + + def pre_list_products(self, request, metadata): + logging.log(f"Received request: {request}") + return request, metadata + + def post_list_products(self, response): + logging.log(f"Received response: {response}") + return response + + def pre_list_product_sets(self, request, metadata): + logging.log(f"Received request: {request}") + return request, metadata + + def post_list_product_sets(self, response): + logging.log(f"Received response: {response}") + return response + + def pre_list_products_in_product_set(self, request, metadata): + logging.log(f"Received request: {request}") + return request, metadata + + def post_list_products_in_product_set(self, response): + logging.log(f"Received response: {response}") + return response + + def pre_list_reference_images(self, request, metadata): + logging.log(f"Received request: {request}") + return request, metadata + + def post_list_reference_images(self, response): + logging.log(f"Received response: {response}") + return response + + def pre_remove_product_from_product_set(self, request, metadata): + logging.log(f"Received request: {request}") + return request, metadata + + def pre_update_product(self, request, metadata): + logging.log(f"Received request: {request}") + return request, metadata + + def post_update_product(self, response): + logging.log(f"Received response: {response}") + return response + + def pre_update_product_set(self, request, metadata): + logging.log(f"Received request: {request}") + return request, metadata + + def post_update_product_set(self, response): + logging.log(f"Received response: {response}") + return response + + transport = ProductSearchRestTransport(interceptor=MyCustomProductSearchInterceptor()) + client = ProductSearchClient(transport=transport) + + + """ + + def pre_add_product_to_product_set( + self, + request: product_search_service.AddProductToProductSetRequest, + metadata: Sequence[Tuple[str, str]], + ) -> Tuple[ + product_search_service.AddProductToProductSetRequest, Sequence[Tuple[str, str]] + ]: + """Pre-rpc interceptor for add_product_to_product_set + + Override in a subclass to manipulate the request or metadata + before they are sent to the ProductSearch server. + """ + return request, metadata + + def pre_create_product( + self, + request: product_search_service.CreateProductRequest, + metadata: Sequence[Tuple[str, str]], + ) -> Tuple[product_search_service.CreateProductRequest, Sequence[Tuple[str, str]]]: + """Pre-rpc interceptor for create_product + + Override in a subclass to manipulate the request or metadata + before they are sent to the ProductSearch server. + """ + return request, metadata + + def post_create_product( + self, response: product_search_service.Product + ) -> product_search_service.Product: + """Post-rpc interceptor for create_product + + Override in a subclass to manipulate the response + after it is returned by the ProductSearch server but before + it is returned to user code. + """ + return response + + def pre_create_product_set( + self, + request: product_search_service.CreateProductSetRequest, + metadata: Sequence[Tuple[str, str]], + ) -> Tuple[ + product_search_service.CreateProductSetRequest, Sequence[Tuple[str, str]] + ]: + """Pre-rpc interceptor for create_product_set + + Override in a subclass to manipulate the request or metadata + before they are sent to the ProductSearch server. + """ + return request, metadata + + def post_create_product_set( + self, response: product_search_service.ProductSet + ) -> product_search_service.ProductSet: + """Post-rpc interceptor for create_product_set + + Override in a subclass to manipulate the response + after it is returned by the ProductSearch server but before + it is returned to user code. + """ + return response + + def pre_create_reference_image( + self, + request: product_search_service.CreateReferenceImageRequest, + metadata: Sequence[Tuple[str, str]], + ) -> Tuple[ + product_search_service.CreateReferenceImageRequest, Sequence[Tuple[str, str]] + ]: + """Pre-rpc interceptor for create_reference_image + + Override in a subclass to manipulate the request or metadata + before they are sent to the ProductSearch server. + """ + return request, metadata + + def post_create_reference_image( + self, response: product_search_service.ReferenceImage + ) -> product_search_service.ReferenceImage: + """Post-rpc interceptor for create_reference_image + + Override in a subclass to manipulate the response + after it is returned by the ProductSearch server but before + it is returned to user code. + """ + return response + + def pre_delete_product( + self, + request: product_search_service.DeleteProductRequest, + metadata: Sequence[Tuple[str, str]], + ) -> Tuple[product_search_service.DeleteProductRequest, Sequence[Tuple[str, str]]]: + """Pre-rpc interceptor for delete_product + + Override in a subclass to manipulate the request or metadata + before they are sent to the ProductSearch server. + """ + return request, metadata + + def pre_delete_product_set( + self, + request: product_search_service.DeleteProductSetRequest, + metadata: Sequence[Tuple[str, str]], + ) -> Tuple[ + product_search_service.DeleteProductSetRequest, Sequence[Tuple[str, str]] + ]: + """Pre-rpc interceptor for delete_product_set + + Override in a subclass to manipulate the request or metadata + before they are sent to the ProductSearch server. + """ + return request, metadata + + def pre_delete_reference_image( + self, + request: product_search_service.DeleteReferenceImageRequest, + metadata: Sequence[Tuple[str, str]], + ) -> Tuple[ + product_search_service.DeleteReferenceImageRequest, Sequence[Tuple[str, str]] + ]: + """Pre-rpc interceptor for delete_reference_image + + Override in a subclass to manipulate the request or metadata + before they are sent to the ProductSearch server. + """ + return request, metadata + + def pre_get_product( + self, + request: product_search_service.GetProductRequest, + metadata: Sequence[Tuple[str, str]], + ) -> Tuple[product_search_service.GetProductRequest, Sequence[Tuple[str, str]]]: + """Pre-rpc interceptor for get_product + + Override in a subclass to manipulate the request or metadata + before they are sent to the ProductSearch server. + """ + return request, metadata + + def post_get_product( + self, response: product_search_service.Product + ) -> product_search_service.Product: + """Post-rpc interceptor for get_product + + Override in a subclass to manipulate the response + after it is returned by the ProductSearch server but before + it is returned to user code. + """ + return response + + def pre_get_product_set( + self, + request: product_search_service.GetProductSetRequest, + metadata: Sequence[Tuple[str, str]], + ) -> Tuple[product_search_service.GetProductSetRequest, Sequence[Tuple[str, str]]]: + """Pre-rpc interceptor for get_product_set + + Override in a subclass to manipulate the request or metadata + before they are sent to the ProductSearch server. + """ + return request, metadata + + def post_get_product_set( + self, response: product_search_service.ProductSet + ) -> product_search_service.ProductSet: + """Post-rpc interceptor for get_product_set + + Override in a subclass to manipulate the response + after it is returned by the ProductSearch server but before + it is returned to user code. + """ + return response + + def pre_get_reference_image( + self, + request: product_search_service.GetReferenceImageRequest, + metadata: Sequence[Tuple[str, str]], + ) -> Tuple[ + product_search_service.GetReferenceImageRequest, Sequence[Tuple[str, str]] + ]: + """Pre-rpc interceptor for get_reference_image + + Override in a subclass to manipulate the request or metadata + before they are sent to the ProductSearch server. + """ + return request, metadata + + def post_get_reference_image( + self, response: product_search_service.ReferenceImage + ) -> product_search_service.ReferenceImage: + """Post-rpc interceptor for get_reference_image + + Override in a subclass to manipulate the response + after it is returned by the ProductSearch server but before + it is returned to user code. + """ + return response + + def pre_import_product_sets( + self, + request: product_search_service.ImportProductSetsRequest, + metadata: Sequence[Tuple[str, str]], + ) -> Tuple[ + product_search_service.ImportProductSetsRequest, Sequence[Tuple[str, str]] + ]: + """Pre-rpc interceptor for import_product_sets + + Override in a subclass to manipulate the request or metadata + before they are sent to the ProductSearch server. + """ + return request, metadata + + def post_import_product_sets( + self, response: operations_pb2.Operation + ) -> operations_pb2.Operation: + """Post-rpc interceptor for import_product_sets + + Override in a subclass to manipulate the response + after it is returned by the ProductSearch server but before + it is returned to user code. + """ + return response + + def pre_list_products( + self, + request: product_search_service.ListProductsRequest, + metadata: Sequence[Tuple[str, str]], + ) -> Tuple[product_search_service.ListProductsRequest, Sequence[Tuple[str, str]]]: + """Pre-rpc interceptor for list_products + + Override in a subclass to manipulate the request or metadata + before they are sent to the ProductSearch server. + """ + return request, metadata + + def post_list_products( + self, response: product_search_service.ListProductsResponse + ) -> product_search_service.ListProductsResponse: + """Post-rpc interceptor for list_products + + Override in a subclass to manipulate the response + after it is returned by the ProductSearch server but before + it is returned to user code. + """ + return response + + def pre_list_product_sets( + self, + request: product_search_service.ListProductSetsRequest, + metadata: Sequence[Tuple[str, str]], + ) -> Tuple[ + product_search_service.ListProductSetsRequest, Sequence[Tuple[str, str]] + ]: + """Pre-rpc interceptor for list_product_sets + + Override in a subclass to manipulate the request or metadata + before they are sent to the ProductSearch server. + """ + return request, metadata + + def post_list_product_sets( + self, response: product_search_service.ListProductSetsResponse + ) -> product_search_service.ListProductSetsResponse: + """Post-rpc interceptor for list_product_sets + + Override in a subclass to manipulate the response + after it is returned by the ProductSearch server but before + it is returned to user code. + """ + return response + + def pre_list_products_in_product_set( + self, + request: product_search_service.ListProductsInProductSetRequest, + metadata: Sequence[Tuple[str, str]], + ) -> Tuple[ + product_search_service.ListProductsInProductSetRequest, + Sequence[Tuple[str, str]], + ]: + """Pre-rpc interceptor for list_products_in_product_set + + Override in a subclass to manipulate the request or metadata + before they are sent to the ProductSearch server. + """ + return request, metadata + + def post_list_products_in_product_set( + self, response: product_search_service.ListProductsInProductSetResponse + ) -> product_search_service.ListProductsInProductSetResponse: + """Post-rpc interceptor for list_products_in_product_set + + Override in a subclass to manipulate the response + after it is returned by the ProductSearch server but before + it is returned to user code. + """ + return response + + def pre_list_reference_images( + self, + request: product_search_service.ListReferenceImagesRequest, + metadata: Sequence[Tuple[str, str]], + ) -> Tuple[ + product_search_service.ListReferenceImagesRequest, Sequence[Tuple[str, str]] + ]: + """Pre-rpc interceptor for list_reference_images + + Override in a subclass to manipulate the request or metadata + before they are sent to the ProductSearch server. + """ + return request, metadata + + def post_list_reference_images( + self, response: product_search_service.ListReferenceImagesResponse + ) -> product_search_service.ListReferenceImagesResponse: + """Post-rpc interceptor for list_reference_images + + Override in a subclass to manipulate the response + after it is returned by the ProductSearch server but before + it is returned to user code. + """ + return response + + def pre_remove_product_from_product_set( + self, + request: product_search_service.RemoveProductFromProductSetRequest, + metadata: Sequence[Tuple[str, str]], + ) -> Tuple[ + product_search_service.RemoveProductFromProductSetRequest, + Sequence[Tuple[str, str]], + ]: + """Pre-rpc interceptor for remove_product_from_product_set + + Override in a subclass to manipulate the request or metadata + before they are sent to the ProductSearch server. + """ + return request, metadata + + def pre_update_product( + self, + request: product_search_service.UpdateProductRequest, + metadata: Sequence[Tuple[str, str]], + ) -> Tuple[product_search_service.UpdateProductRequest, Sequence[Tuple[str, str]]]: + """Pre-rpc interceptor for update_product + + Override in a subclass to manipulate the request or metadata + before they are sent to the ProductSearch server. + """ + return request, metadata + + def post_update_product( + self, response: product_search_service.Product + ) -> product_search_service.Product: + """Post-rpc interceptor for update_product + + Override in a subclass to manipulate the response + after it is returned by the ProductSearch server but before + it is returned to user code. + """ + return response + + def pre_update_product_set( + self, + request: product_search_service.UpdateProductSetRequest, + metadata: Sequence[Tuple[str, str]], + ) -> Tuple[ + product_search_service.UpdateProductSetRequest, Sequence[Tuple[str, str]] + ]: + """Pre-rpc interceptor for update_product_set + + Override in a subclass to manipulate the request or metadata + before they are sent to the ProductSearch server. + """ + return request, metadata + + def post_update_product_set( + self, response: product_search_service.ProductSet + ) -> product_search_service.ProductSet: + """Post-rpc interceptor for update_product_set + + Override in a subclass to manipulate the response + after it is returned by the ProductSearch server but before + it is returned to user code. + """ + return response + + +@dataclasses.dataclass +class ProductSearchRestStub: + _session: AuthorizedSession + _host: str + _interceptor: ProductSearchRestInterceptor + + +class ProductSearchRestTransport(ProductSearchTransport): + """REST backend transport for ProductSearch. + + Manages Products and ProductSets of reference images for use in + product search. It uses the following resource model: + + - The API has a collection of + [ProductSet][google.cloud.vision.v1p3beta1.ProductSet] resources, + named ``projects/*/locations/*/productSets/*``, which acts as a + way to put different products into groups to limit + identification. + + In parallel, + + - The API has a collection of + [Product][google.cloud.vision.v1p3beta1.Product] resources, named + ``projects/*/locations/*/products/*`` + + - Each [Product][google.cloud.vision.v1p3beta1.Product] has a + collection of + [ReferenceImage][google.cloud.vision.v1p3beta1.ReferenceImage] + resources, named + ``projects/*/locations/*/products/*/referenceImages/*`` + + This class defines the same methods as the primary client, so the + primary client can load the underlying transport implementation + and call it. + + It sends JSON representations of protocol buffers over HTTP/1.1 + + """ + + def __init__( + self, + *, + host: str = "vision.googleapis.com", + credentials: Optional[ga_credentials.Credentials] = None, + credentials_file: Optional[str] = None, + scopes: Optional[Sequence[str]] = None, + client_cert_source_for_mtls: Optional[Callable[[], Tuple[bytes, bytes]]] = None, + quota_project_id: Optional[str] = None, + client_info: gapic_v1.client_info.ClientInfo = DEFAULT_CLIENT_INFO, + always_use_jwt_access: Optional[bool] = False, + url_scheme: str = "https", + interceptor: Optional[ProductSearchRestInterceptor] = None, + api_audience: Optional[str] = None, + ) -> None: + """Instantiate the transport. + + Args: + host (Optional[str]): + The hostname to connect to. + credentials (Optional[google.auth.credentials.Credentials]): The + authorization credentials to attach to requests. These + credentials identify the application to the service; if none + are specified, the client will attempt to ascertain the + credentials from the environment. + + credentials_file (Optional[str]): A file with credentials that can + be loaded with :func:`google.auth.load_credentials_from_file`. + This argument is ignored if ``channel`` is provided. + scopes (Optional(Sequence[str])): A list of scopes. This argument is + ignored if ``channel`` is provided. + client_cert_source_for_mtls (Callable[[], Tuple[bytes, bytes]]): Client + certificate to configure mutual TLS HTTP channel. It is ignored + if ``channel`` is provided. + quota_project_id (Optional[str]): An optional project to use for billing + and quota. + client_info (google.api_core.gapic_v1.client_info.ClientInfo): + The client info used to send a user-agent string along with + API requests. If ``None``, then default info will be used. + Generally, you only need to set this if you are developing + your own client library. + always_use_jwt_access (Optional[bool]): Whether self signed JWT should + be used for service account credentials. + url_scheme: the protocol scheme for the API endpoint. Normally + "https", but for testing or local servers, + "http" can be specified. + """ + # Run the base constructor + # TODO(yon-mg): resolve other ctor params i.e. scopes, quota, etc. + # TODO: When custom host (api_endpoint) is set, `scopes` must *also* be set on the + # credentials object + maybe_url_match = re.match("^(?Phttp(?:s)?://)?(?P.*)$", host) + if maybe_url_match is None: + raise ValueError( + f"Unexpected hostname structure: {host}" + ) # pragma: NO COVER + + url_match_items = maybe_url_match.groupdict() + + host = f"{url_scheme}://{host}" if not url_match_items["scheme"] else host + + super().__init__( + host=host, + credentials=credentials, + client_info=client_info, + always_use_jwt_access=always_use_jwt_access, + api_audience=api_audience, + ) + self._session = AuthorizedSession( + self._credentials, default_host=self.DEFAULT_HOST + ) + self._operations_client: Optional[operations_v1.AbstractOperationsClient] = None + if client_cert_source_for_mtls: + self._session.configure_mtls_channel(client_cert_source_for_mtls) + self._interceptor = interceptor or ProductSearchRestInterceptor() + self._prep_wrapped_messages(client_info) + + @property + def operations_client(self) -> operations_v1.AbstractOperationsClient: + """Create the client designed to process long-running operations. + + This property caches on the instance; repeated calls return the same + client. + """ + # Only create a new client if we do not already have one. + if self._operations_client is None: + http_options: Dict[str, List[Dict[str, str]]] = {} + + rest_transport = operations_v1.OperationsRestTransport( + host=self._host, + # use the credentials which are saved + credentials=self._credentials, + scopes=self._scopes, + http_options=http_options, + path_prefix="v1p3beta1", + ) + + self._operations_client = operations_v1.AbstractOperationsClient( + transport=rest_transport + ) + + # Return the client from cache. + return self._operations_client + + class _AddProductToProductSet(ProductSearchRestStub): + def __hash__(self): + return hash("AddProductToProductSet") + + __REQUIRED_FIELDS_DEFAULT_VALUES: Dict[str, Any] = {} + + @classmethod + def _get_unset_required_fields(cls, message_dict): + return { + k: v + for k, v in cls.__REQUIRED_FIELDS_DEFAULT_VALUES.items() + if k not in message_dict + } + + def __call__( + self, + request: product_search_service.AddProductToProductSetRequest, + *, + retry: OptionalRetry = gapic_v1.method.DEFAULT, + timeout: Optional[float] = None, + metadata: Sequence[Tuple[str, str]] = (), + ): + r"""Call the add product to product + set method over HTTP. + + Args: + request (~.product_search_service.AddProductToProductSetRequest): + The request object. Request message for the ``AddProductToProductSet`` + method. + + retry (google.api_core.retry.Retry): Designation of what errors, if any, + should be retried. + timeout (float): The timeout for this request. + metadata (Sequence[Tuple[str, str]]): Strings which should be + sent along with the request as metadata. + """ + + http_options: List[Dict[str, str]] = [ + { + "method": "post", + "uri": "/v1p3beta1/{name=projects/*/locations/*/productSets/*}:addProduct", + "body": "*", + }, + ] + request, metadata = self._interceptor.pre_add_product_to_product_set( + request, metadata + ) + pb_request = product_search_service.AddProductToProductSetRequest.pb( + request + ) + transcoded_request = path_template.transcode(http_options, pb_request) + + # Jsonify the request body + + body = json_format.MessageToJson( + transcoded_request["body"], + including_default_value_fields=False, + use_integers_for_enums=True, + ) + uri = transcoded_request["uri"] + method = transcoded_request["method"] + + # Jsonify the query params + query_params = json.loads( + json_format.MessageToJson( + transcoded_request["query_params"], + including_default_value_fields=False, + use_integers_for_enums=True, + ) + ) + query_params.update(self._get_unset_required_fields(query_params)) + + query_params["$alt"] = "json;enum-encoding=int" + + # Send the request + headers = dict(metadata) + headers["Content-Type"] = "application/json" + response = getattr(self._session, method)( + "{host}{uri}".format(host=self._host, uri=uri), + timeout=timeout, + headers=headers, + params=rest_helpers.flatten_query_params(query_params, strict=True), + data=body, + ) + + # In case of error, raise the appropriate core_exceptions.GoogleAPICallError exception + # subclass. + if response.status_code >= 400: + raise core_exceptions.from_http_response(response) + + class _CreateProduct(ProductSearchRestStub): + def __hash__(self): + return hash("CreateProduct") + + __REQUIRED_FIELDS_DEFAULT_VALUES: Dict[str, Any] = {} + + @classmethod + def _get_unset_required_fields(cls, message_dict): + return { + k: v + for k, v in cls.__REQUIRED_FIELDS_DEFAULT_VALUES.items() + if k not in message_dict + } + + def __call__( + self, + request: product_search_service.CreateProductRequest, + *, + retry: OptionalRetry = gapic_v1.method.DEFAULT, + timeout: Optional[float] = None, + metadata: Sequence[Tuple[str, str]] = (), + ) -> product_search_service.Product: + r"""Call the create product method over HTTP. + + Args: + request (~.product_search_service.CreateProductRequest): + The request object. Request message for the ``CreateProduct`` method. + retry (google.api_core.retry.Retry): Designation of what errors, if any, + should be retried. + timeout (float): The timeout for this request. + metadata (Sequence[Tuple[str, str]]): Strings which should be + sent along with the request as metadata. + + Returns: + ~.product_search_service.Product: + A Product contains ReferenceImages. + """ + + http_options: List[Dict[str, str]] = [ + { + "method": "post", + "uri": "/v1p3beta1/{parent=projects/*/locations/*}/products", + "body": "product", + }, + ] + request, metadata = self._interceptor.pre_create_product(request, metadata) + pb_request = product_search_service.CreateProductRequest.pb(request) + transcoded_request = path_template.transcode(http_options, pb_request) + + # Jsonify the request body + + body = json_format.MessageToJson( + transcoded_request["body"], + including_default_value_fields=False, + use_integers_for_enums=True, + ) + uri = transcoded_request["uri"] + method = transcoded_request["method"] + + # Jsonify the query params + query_params = json.loads( + json_format.MessageToJson( + transcoded_request["query_params"], + including_default_value_fields=False, + use_integers_for_enums=True, + ) + ) + query_params.update(self._get_unset_required_fields(query_params)) + + query_params["$alt"] = "json;enum-encoding=int" + + # Send the request + headers = dict(metadata) + headers["Content-Type"] = "application/json" + response = getattr(self._session, method)( + "{host}{uri}".format(host=self._host, uri=uri), + timeout=timeout, + headers=headers, + params=rest_helpers.flatten_query_params(query_params, strict=True), + data=body, + ) + + # In case of error, raise the appropriate core_exceptions.GoogleAPICallError exception + # subclass. + if response.status_code >= 400: + raise core_exceptions.from_http_response(response) + + # Return the response + resp = product_search_service.Product() + pb_resp = product_search_service.Product.pb(resp) + + json_format.Parse(response.content, pb_resp, ignore_unknown_fields=True) + resp = self._interceptor.post_create_product(resp) + return resp + + class _CreateProductSet(ProductSearchRestStub): + def __hash__(self): + return hash("CreateProductSet") + + __REQUIRED_FIELDS_DEFAULT_VALUES: Dict[str, Any] = {} + + @classmethod + def _get_unset_required_fields(cls, message_dict): + return { + k: v + for k, v in cls.__REQUIRED_FIELDS_DEFAULT_VALUES.items() + if k not in message_dict + } + + def __call__( + self, + request: product_search_service.CreateProductSetRequest, + *, + retry: OptionalRetry = gapic_v1.method.DEFAULT, + timeout: Optional[float] = None, + metadata: Sequence[Tuple[str, str]] = (), + ) -> product_search_service.ProductSet: + r"""Call the create product set method over HTTP. + + Args: + request (~.product_search_service.CreateProductSetRequest): + The request object. Request message for the ``CreateProductSet`` method. + retry (google.api_core.retry.Retry): Designation of what errors, if any, + should be retried. + timeout (float): The timeout for this request. + metadata (Sequence[Tuple[str, str]]): Strings which should be + sent along with the request as metadata. + + Returns: + ~.product_search_service.ProductSet: + A ProductSet contains Products. A + ProductSet can contain a maximum of 1 + million reference images. If the limit + is exceeded, periodic indexing will + fail. + + """ + + http_options: List[Dict[str, str]] = [ + { + "method": "post", + "uri": "/v1p3beta1/{parent=projects/*/locations/*}/productSets", + "body": "product_set", + }, + ] + request, metadata = self._interceptor.pre_create_product_set( + request, metadata + ) + pb_request = product_search_service.CreateProductSetRequest.pb(request) + transcoded_request = path_template.transcode(http_options, pb_request) + + # Jsonify the request body + + body = json_format.MessageToJson( + transcoded_request["body"], + including_default_value_fields=False, + use_integers_for_enums=True, + ) + uri = transcoded_request["uri"] + method = transcoded_request["method"] + + # Jsonify the query params + query_params = json.loads( + json_format.MessageToJson( + transcoded_request["query_params"], + including_default_value_fields=False, + use_integers_for_enums=True, + ) + ) + query_params.update(self._get_unset_required_fields(query_params)) + + query_params["$alt"] = "json;enum-encoding=int" + + # Send the request + headers = dict(metadata) + headers["Content-Type"] = "application/json" + response = getattr(self._session, method)( + "{host}{uri}".format(host=self._host, uri=uri), + timeout=timeout, + headers=headers, + params=rest_helpers.flatten_query_params(query_params, strict=True), + data=body, + ) + + # In case of error, raise the appropriate core_exceptions.GoogleAPICallError exception + # subclass. + if response.status_code >= 400: + raise core_exceptions.from_http_response(response) + + # Return the response + resp = product_search_service.ProductSet() + pb_resp = product_search_service.ProductSet.pb(resp) + + json_format.Parse(response.content, pb_resp, ignore_unknown_fields=True) + resp = self._interceptor.post_create_product_set(resp) + return resp + + class _CreateReferenceImage(ProductSearchRestStub): + def __hash__(self): + return hash("CreateReferenceImage") + + __REQUIRED_FIELDS_DEFAULT_VALUES: Dict[str, Any] = {} + + @classmethod + def _get_unset_required_fields(cls, message_dict): + return { + k: v + for k, v in cls.__REQUIRED_FIELDS_DEFAULT_VALUES.items() + if k not in message_dict + } + + def __call__( + self, + request: product_search_service.CreateReferenceImageRequest, + *, + retry: OptionalRetry = gapic_v1.method.DEFAULT, + timeout: Optional[float] = None, + metadata: Sequence[Tuple[str, str]] = (), + ) -> product_search_service.ReferenceImage: + r"""Call the create reference image method over HTTP. + + Args: + request (~.product_search_service.CreateReferenceImageRequest): + The request object. Request message for the ``CreateReferenceImage`` method. + retry (google.api_core.retry.Retry): Designation of what errors, if any, + should be retried. + timeout (float): The timeout for this request. + metadata (Sequence[Tuple[str, str]]): Strings which should be + sent along with the request as metadata. + + Returns: + ~.product_search_service.ReferenceImage: + A ``ReferenceImage`` represents a product image and its + associated metadata, such as bounding boxes. + + """ + + http_options: List[Dict[str, str]] = [ + { + "method": "post", + "uri": "/v1p3beta1/{parent=projects/*/locations/*/products/*}/referenceImages", + "body": "reference_image", + }, + ] + request, metadata = self._interceptor.pre_create_reference_image( + request, metadata + ) + pb_request = product_search_service.CreateReferenceImageRequest.pb(request) + transcoded_request = path_template.transcode(http_options, pb_request) + + # Jsonify the request body + + body = json_format.MessageToJson( + transcoded_request["body"], + including_default_value_fields=False, + use_integers_for_enums=True, + ) + uri = transcoded_request["uri"] + method = transcoded_request["method"] + + # Jsonify the query params + query_params = json.loads( + json_format.MessageToJson( + transcoded_request["query_params"], + including_default_value_fields=False, + use_integers_for_enums=True, + ) + ) + query_params.update(self._get_unset_required_fields(query_params)) + + query_params["$alt"] = "json;enum-encoding=int" + + # Send the request + headers = dict(metadata) + headers["Content-Type"] = "application/json" + response = getattr(self._session, method)( + "{host}{uri}".format(host=self._host, uri=uri), + timeout=timeout, + headers=headers, + params=rest_helpers.flatten_query_params(query_params, strict=True), + data=body, + ) + + # In case of error, raise the appropriate core_exceptions.GoogleAPICallError exception + # subclass. + if response.status_code >= 400: + raise core_exceptions.from_http_response(response) + + # Return the response + resp = product_search_service.ReferenceImage() + pb_resp = product_search_service.ReferenceImage.pb(resp) + + json_format.Parse(response.content, pb_resp, ignore_unknown_fields=True) + resp = self._interceptor.post_create_reference_image(resp) + return resp + + class _DeleteProduct(ProductSearchRestStub): + def __hash__(self): + return hash("DeleteProduct") + + __REQUIRED_FIELDS_DEFAULT_VALUES: Dict[str, Any] = {} + + @classmethod + def _get_unset_required_fields(cls, message_dict): + return { + k: v + for k, v in cls.__REQUIRED_FIELDS_DEFAULT_VALUES.items() + if k not in message_dict + } + + def __call__( + self, + request: product_search_service.DeleteProductRequest, + *, + retry: OptionalRetry = gapic_v1.method.DEFAULT, + timeout: Optional[float] = None, + metadata: Sequence[Tuple[str, str]] = (), + ): + r"""Call the delete product method over HTTP. + + Args: + request (~.product_search_service.DeleteProductRequest): + The request object. Request message for the ``DeleteProduct`` method. + retry (google.api_core.retry.Retry): Designation of what errors, if any, + should be retried. + timeout (float): The timeout for this request. + metadata (Sequence[Tuple[str, str]]): Strings which should be + sent along with the request as metadata. + """ + + http_options: List[Dict[str, str]] = [ + { + "method": "delete", + "uri": "/v1p3beta1/{name=projects/*/locations/*/products/*}", + }, + ] + request, metadata = self._interceptor.pre_delete_product(request, metadata) + pb_request = product_search_service.DeleteProductRequest.pb(request) + transcoded_request = path_template.transcode(http_options, pb_request) + + uri = transcoded_request["uri"] + method = transcoded_request["method"] + + # Jsonify the query params + query_params = json.loads( + json_format.MessageToJson( + transcoded_request["query_params"], + including_default_value_fields=False, + use_integers_for_enums=True, + ) + ) + query_params.update(self._get_unset_required_fields(query_params)) + + query_params["$alt"] = "json;enum-encoding=int" + + # Send the request + headers = dict(metadata) + headers["Content-Type"] = "application/json" + response = getattr(self._session, method)( + "{host}{uri}".format(host=self._host, uri=uri), + timeout=timeout, + headers=headers, + params=rest_helpers.flatten_query_params(query_params, strict=True), + ) + + # In case of error, raise the appropriate core_exceptions.GoogleAPICallError exception + # subclass. + if response.status_code >= 400: + raise core_exceptions.from_http_response(response) + + class _DeleteProductSet(ProductSearchRestStub): + def __hash__(self): + return hash("DeleteProductSet") + + __REQUIRED_FIELDS_DEFAULT_VALUES: Dict[str, Any] = {} + + @classmethod + def _get_unset_required_fields(cls, message_dict): + return { + k: v + for k, v in cls.__REQUIRED_FIELDS_DEFAULT_VALUES.items() + if k not in message_dict + } + + def __call__( + self, + request: product_search_service.DeleteProductSetRequest, + *, + retry: OptionalRetry = gapic_v1.method.DEFAULT, + timeout: Optional[float] = None, + metadata: Sequence[Tuple[str, str]] = (), + ): + r"""Call the delete product set method over HTTP. + + Args: + request (~.product_search_service.DeleteProductSetRequest): + The request object. Request message for the ``DeleteProductSet`` method. + retry (google.api_core.retry.Retry): Designation of what errors, if any, + should be retried. + timeout (float): The timeout for this request. + metadata (Sequence[Tuple[str, str]]): Strings which should be + sent along with the request as metadata. + """ + + http_options: List[Dict[str, str]] = [ + { + "method": "delete", + "uri": "/v1p3beta1/{name=projects/*/locations/*/productSets/*}", + }, + ] + request, metadata = self._interceptor.pre_delete_product_set( + request, metadata + ) + pb_request = product_search_service.DeleteProductSetRequest.pb(request) + transcoded_request = path_template.transcode(http_options, pb_request) + + uri = transcoded_request["uri"] + method = transcoded_request["method"] + + # Jsonify the query params + query_params = json.loads( + json_format.MessageToJson( + transcoded_request["query_params"], + including_default_value_fields=False, + use_integers_for_enums=True, + ) + ) + query_params.update(self._get_unset_required_fields(query_params)) + + query_params["$alt"] = "json;enum-encoding=int" + + # Send the request + headers = dict(metadata) + headers["Content-Type"] = "application/json" + response = getattr(self._session, method)( + "{host}{uri}".format(host=self._host, uri=uri), + timeout=timeout, + headers=headers, + params=rest_helpers.flatten_query_params(query_params, strict=True), + ) + + # In case of error, raise the appropriate core_exceptions.GoogleAPICallError exception + # subclass. + if response.status_code >= 400: + raise core_exceptions.from_http_response(response) + + class _DeleteReferenceImage(ProductSearchRestStub): + def __hash__(self): + return hash("DeleteReferenceImage") + + __REQUIRED_FIELDS_DEFAULT_VALUES: Dict[str, Any] = {} + + @classmethod + def _get_unset_required_fields(cls, message_dict): + return { + k: v + for k, v in cls.__REQUIRED_FIELDS_DEFAULT_VALUES.items() + if k not in message_dict + } + + def __call__( + self, + request: product_search_service.DeleteReferenceImageRequest, + *, + retry: OptionalRetry = gapic_v1.method.DEFAULT, + timeout: Optional[float] = None, + metadata: Sequence[Tuple[str, str]] = (), + ): + r"""Call the delete reference image method over HTTP. + + Args: + request (~.product_search_service.DeleteReferenceImageRequest): + The request object. Request message for the ``DeleteReferenceImage`` method. + retry (google.api_core.retry.Retry): Designation of what errors, if any, + should be retried. + timeout (float): The timeout for this request. + metadata (Sequence[Tuple[str, str]]): Strings which should be + sent along with the request as metadata. + """ + + http_options: List[Dict[str, str]] = [ + { + "method": "delete", + "uri": "/v1p3beta1/{name=projects/*/locations/*/products/*/referenceImages/*}", + }, + ] + request, metadata = self._interceptor.pre_delete_reference_image( + request, metadata + ) + pb_request = product_search_service.DeleteReferenceImageRequest.pb(request) + transcoded_request = path_template.transcode(http_options, pb_request) + + uri = transcoded_request["uri"] + method = transcoded_request["method"] + + # Jsonify the query params + query_params = json.loads( + json_format.MessageToJson( + transcoded_request["query_params"], + including_default_value_fields=False, + use_integers_for_enums=True, + ) + ) + query_params.update(self._get_unset_required_fields(query_params)) + + query_params["$alt"] = "json;enum-encoding=int" + + # Send the request + headers = dict(metadata) + headers["Content-Type"] = "application/json" + response = getattr(self._session, method)( + "{host}{uri}".format(host=self._host, uri=uri), + timeout=timeout, + headers=headers, + params=rest_helpers.flatten_query_params(query_params, strict=True), + ) + + # In case of error, raise the appropriate core_exceptions.GoogleAPICallError exception + # subclass. + if response.status_code >= 400: + raise core_exceptions.from_http_response(response) + + class _GetProduct(ProductSearchRestStub): + def __hash__(self): + return hash("GetProduct") + + __REQUIRED_FIELDS_DEFAULT_VALUES: Dict[str, Any] = {} + + @classmethod + def _get_unset_required_fields(cls, message_dict): + return { + k: v + for k, v in cls.__REQUIRED_FIELDS_DEFAULT_VALUES.items() + if k not in message_dict + } + + def __call__( + self, + request: product_search_service.GetProductRequest, + *, + retry: OptionalRetry = gapic_v1.method.DEFAULT, + timeout: Optional[float] = None, + metadata: Sequence[Tuple[str, str]] = (), + ) -> product_search_service.Product: + r"""Call the get product method over HTTP. + + Args: + request (~.product_search_service.GetProductRequest): + The request object. Request message for the ``GetProduct`` method. + retry (google.api_core.retry.Retry): Designation of what errors, if any, + should be retried. + timeout (float): The timeout for this request. + metadata (Sequence[Tuple[str, str]]): Strings which should be + sent along with the request as metadata. + + Returns: + ~.product_search_service.Product: + A Product contains ReferenceImages. + """ + + http_options: List[Dict[str, str]] = [ + { + "method": "get", + "uri": "/v1p3beta1/{name=projects/*/locations/*/products/*}", + }, + ] + request, metadata = self._interceptor.pre_get_product(request, metadata) + pb_request = product_search_service.GetProductRequest.pb(request) + transcoded_request = path_template.transcode(http_options, pb_request) + + uri = transcoded_request["uri"] + method = transcoded_request["method"] + + # Jsonify the query params + query_params = json.loads( + json_format.MessageToJson( + transcoded_request["query_params"], + including_default_value_fields=False, + use_integers_for_enums=True, + ) + ) + query_params.update(self._get_unset_required_fields(query_params)) + + query_params["$alt"] = "json;enum-encoding=int" + + # Send the request + headers = dict(metadata) + headers["Content-Type"] = "application/json" + response = getattr(self._session, method)( + "{host}{uri}".format(host=self._host, uri=uri), + timeout=timeout, + headers=headers, + params=rest_helpers.flatten_query_params(query_params, strict=True), + ) + + # In case of error, raise the appropriate core_exceptions.GoogleAPICallError exception + # subclass. + if response.status_code >= 400: + raise core_exceptions.from_http_response(response) + + # Return the response + resp = product_search_service.Product() + pb_resp = product_search_service.Product.pb(resp) + + json_format.Parse(response.content, pb_resp, ignore_unknown_fields=True) + resp = self._interceptor.post_get_product(resp) + return resp + + class _GetProductSet(ProductSearchRestStub): + def __hash__(self): + return hash("GetProductSet") + + __REQUIRED_FIELDS_DEFAULT_VALUES: Dict[str, Any] = {} + + @classmethod + def _get_unset_required_fields(cls, message_dict): + return { + k: v + for k, v in cls.__REQUIRED_FIELDS_DEFAULT_VALUES.items() + if k not in message_dict + } + + def __call__( + self, + request: product_search_service.GetProductSetRequest, + *, + retry: OptionalRetry = gapic_v1.method.DEFAULT, + timeout: Optional[float] = None, + metadata: Sequence[Tuple[str, str]] = (), + ) -> product_search_service.ProductSet: + r"""Call the get product set method over HTTP. + + Args: + request (~.product_search_service.GetProductSetRequest): + The request object. Request message for the ``GetProductSet`` method. + retry (google.api_core.retry.Retry): Designation of what errors, if any, + should be retried. + timeout (float): The timeout for this request. + metadata (Sequence[Tuple[str, str]]): Strings which should be + sent along with the request as metadata. + + Returns: + ~.product_search_service.ProductSet: + A ProductSet contains Products. A + ProductSet can contain a maximum of 1 + million reference images. If the limit + is exceeded, periodic indexing will + fail. + + """ + + http_options: List[Dict[str, str]] = [ + { + "method": "get", + "uri": "/v1p3beta1/{name=projects/*/locations/*/productSets/*}", + }, + ] + request, metadata = self._interceptor.pre_get_product_set(request, metadata) + pb_request = product_search_service.GetProductSetRequest.pb(request) + transcoded_request = path_template.transcode(http_options, pb_request) + + uri = transcoded_request["uri"] + method = transcoded_request["method"] + + # Jsonify the query params + query_params = json.loads( + json_format.MessageToJson( + transcoded_request["query_params"], + including_default_value_fields=False, + use_integers_for_enums=True, + ) + ) + query_params.update(self._get_unset_required_fields(query_params)) + + query_params["$alt"] = "json;enum-encoding=int" + + # Send the request + headers = dict(metadata) + headers["Content-Type"] = "application/json" + response = getattr(self._session, method)( + "{host}{uri}".format(host=self._host, uri=uri), + timeout=timeout, + headers=headers, + params=rest_helpers.flatten_query_params(query_params, strict=True), + ) + + # In case of error, raise the appropriate core_exceptions.GoogleAPICallError exception + # subclass. + if response.status_code >= 400: + raise core_exceptions.from_http_response(response) + + # Return the response + resp = product_search_service.ProductSet() + pb_resp = product_search_service.ProductSet.pb(resp) + + json_format.Parse(response.content, pb_resp, ignore_unknown_fields=True) + resp = self._interceptor.post_get_product_set(resp) + return resp + + class _GetReferenceImage(ProductSearchRestStub): + def __hash__(self): + return hash("GetReferenceImage") + + __REQUIRED_FIELDS_DEFAULT_VALUES: Dict[str, Any] = {} + + @classmethod + def _get_unset_required_fields(cls, message_dict): + return { + k: v + for k, v in cls.__REQUIRED_FIELDS_DEFAULT_VALUES.items() + if k not in message_dict + } + + def __call__( + self, + request: product_search_service.GetReferenceImageRequest, + *, + retry: OptionalRetry = gapic_v1.method.DEFAULT, + timeout: Optional[float] = None, + metadata: Sequence[Tuple[str, str]] = (), + ) -> product_search_service.ReferenceImage: + r"""Call the get reference image method over HTTP. + + Args: + request (~.product_search_service.GetReferenceImageRequest): + The request object. Request message for the ``GetReferenceImage`` method. + retry (google.api_core.retry.Retry): Designation of what errors, if any, + should be retried. + timeout (float): The timeout for this request. + metadata (Sequence[Tuple[str, str]]): Strings which should be + sent along with the request as metadata. + + Returns: + ~.product_search_service.ReferenceImage: + A ``ReferenceImage`` represents a product image and its + associated metadata, such as bounding boxes. + + """ + + http_options: List[Dict[str, str]] = [ + { + "method": "get", + "uri": "/v1p3beta1/{name=projects/*/locations/*/products/*/referenceImages/*}", + }, + ] + request, metadata = self._interceptor.pre_get_reference_image( + request, metadata + ) + pb_request = product_search_service.GetReferenceImageRequest.pb(request) + transcoded_request = path_template.transcode(http_options, pb_request) + + uri = transcoded_request["uri"] + method = transcoded_request["method"] + + # Jsonify the query params + query_params = json.loads( + json_format.MessageToJson( + transcoded_request["query_params"], + including_default_value_fields=False, + use_integers_for_enums=True, + ) + ) + query_params.update(self._get_unset_required_fields(query_params)) + + query_params["$alt"] = "json;enum-encoding=int" + + # Send the request + headers = dict(metadata) + headers["Content-Type"] = "application/json" + response = getattr(self._session, method)( + "{host}{uri}".format(host=self._host, uri=uri), + timeout=timeout, + headers=headers, + params=rest_helpers.flatten_query_params(query_params, strict=True), + ) + + # In case of error, raise the appropriate core_exceptions.GoogleAPICallError exception + # subclass. + if response.status_code >= 400: + raise core_exceptions.from_http_response(response) + + # Return the response + resp = product_search_service.ReferenceImage() + pb_resp = product_search_service.ReferenceImage.pb(resp) + + json_format.Parse(response.content, pb_resp, ignore_unknown_fields=True) + resp = self._interceptor.post_get_reference_image(resp) + return resp + + class _ImportProductSets(ProductSearchRestStub): + def __hash__(self): + return hash("ImportProductSets") + + __REQUIRED_FIELDS_DEFAULT_VALUES: Dict[str, Any] = {} + + @classmethod + def _get_unset_required_fields(cls, message_dict): + return { + k: v + for k, v in cls.__REQUIRED_FIELDS_DEFAULT_VALUES.items() + if k not in message_dict + } + + def __call__( + self, + request: product_search_service.ImportProductSetsRequest, + *, + retry: OptionalRetry = gapic_v1.method.DEFAULT, + timeout: Optional[float] = None, + metadata: Sequence[Tuple[str, str]] = (), + ) -> operations_pb2.Operation: + r"""Call the import product sets method over HTTP. + + Args: + request (~.product_search_service.ImportProductSetsRequest): + The request object. Request message for the ``ImportProductSets`` method. + retry (google.api_core.retry.Retry): Designation of what errors, if any, + should be retried. + timeout (float): The timeout for this request. + metadata (Sequence[Tuple[str, str]]): Strings which should be + sent along with the request as metadata. + + Returns: + ~.operations_pb2.Operation: + This resource represents a + long-running operation that is the + result of a network API call. + + """ + + http_options: List[Dict[str, str]] = [ + { + "method": "post", + "uri": "/v1p3beta1/{parent=projects/*/locations/*}/productSets:import", + "body": "*", + }, + ] + request, metadata = self._interceptor.pre_import_product_sets( + request, metadata + ) + pb_request = product_search_service.ImportProductSetsRequest.pb(request) + transcoded_request = path_template.transcode(http_options, pb_request) + + # Jsonify the request body + + body = json_format.MessageToJson( + transcoded_request["body"], + including_default_value_fields=False, + use_integers_for_enums=True, + ) + uri = transcoded_request["uri"] + method = transcoded_request["method"] + + # Jsonify the query params + query_params = json.loads( + json_format.MessageToJson( + transcoded_request["query_params"], + including_default_value_fields=False, + use_integers_for_enums=True, + ) + ) + query_params.update(self._get_unset_required_fields(query_params)) + + query_params["$alt"] = "json;enum-encoding=int" + + # Send the request + headers = dict(metadata) + headers["Content-Type"] = "application/json" + response = getattr(self._session, method)( + "{host}{uri}".format(host=self._host, uri=uri), + timeout=timeout, + headers=headers, + params=rest_helpers.flatten_query_params(query_params, strict=True), + data=body, + ) + + # In case of error, raise the appropriate core_exceptions.GoogleAPICallError exception + # subclass. + if response.status_code >= 400: + raise core_exceptions.from_http_response(response) + + # Return the response + resp = operations_pb2.Operation() + json_format.Parse(response.content, resp, ignore_unknown_fields=True) + resp = self._interceptor.post_import_product_sets(resp) + return resp + + class _ListProducts(ProductSearchRestStub): + def __hash__(self): + return hash("ListProducts") + + __REQUIRED_FIELDS_DEFAULT_VALUES: Dict[str, Any] = {} + + @classmethod + def _get_unset_required_fields(cls, message_dict): + return { + k: v + for k, v in cls.__REQUIRED_FIELDS_DEFAULT_VALUES.items() + if k not in message_dict + } + + def __call__( + self, + request: product_search_service.ListProductsRequest, + *, + retry: OptionalRetry = gapic_v1.method.DEFAULT, + timeout: Optional[float] = None, + metadata: Sequence[Tuple[str, str]] = (), + ) -> product_search_service.ListProductsResponse: + r"""Call the list products method over HTTP. + + Args: + request (~.product_search_service.ListProductsRequest): + The request object. Request message for the ``ListProducts`` method. + retry (google.api_core.retry.Retry): Designation of what errors, if any, + should be retried. + timeout (float): The timeout for this request. + metadata (Sequence[Tuple[str, str]]): Strings which should be + sent along with the request as metadata. + + Returns: + ~.product_search_service.ListProductsResponse: + Response message for the ``ListProducts`` method. + """ + + http_options: List[Dict[str, str]] = [ + { + "method": "get", + "uri": "/v1p3beta1/{parent=projects/*/locations/*}/products", + }, + ] + request, metadata = self._interceptor.pre_list_products(request, metadata) + pb_request = product_search_service.ListProductsRequest.pb(request) + transcoded_request = path_template.transcode(http_options, pb_request) + + uri = transcoded_request["uri"] + method = transcoded_request["method"] + + # Jsonify the query params + query_params = json.loads( + json_format.MessageToJson( + transcoded_request["query_params"], + including_default_value_fields=False, + use_integers_for_enums=True, + ) + ) + query_params.update(self._get_unset_required_fields(query_params)) + + query_params["$alt"] = "json;enum-encoding=int" + + # Send the request + headers = dict(metadata) + headers["Content-Type"] = "application/json" + response = getattr(self._session, method)( + "{host}{uri}".format(host=self._host, uri=uri), + timeout=timeout, + headers=headers, + params=rest_helpers.flatten_query_params(query_params, strict=True), + ) + + # In case of error, raise the appropriate core_exceptions.GoogleAPICallError exception + # subclass. + if response.status_code >= 400: + raise core_exceptions.from_http_response(response) + + # Return the response + resp = product_search_service.ListProductsResponse() + pb_resp = product_search_service.ListProductsResponse.pb(resp) + + json_format.Parse(response.content, pb_resp, ignore_unknown_fields=True) + resp = self._interceptor.post_list_products(resp) + return resp + + class _ListProductSets(ProductSearchRestStub): + def __hash__(self): + return hash("ListProductSets") + + __REQUIRED_FIELDS_DEFAULT_VALUES: Dict[str, Any] = {} + + @classmethod + def _get_unset_required_fields(cls, message_dict): + return { + k: v + for k, v in cls.__REQUIRED_FIELDS_DEFAULT_VALUES.items() + if k not in message_dict + } + + def __call__( + self, + request: product_search_service.ListProductSetsRequest, + *, + retry: OptionalRetry = gapic_v1.method.DEFAULT, + timeout: Optional[float] = None, + metadata: Sequence[Tuple[str, str]] = (), + ) -> product_search_service.ListProductSetsResponse: + r"""Call the list product sets method over HTTP. + + Args: + request (~.product_search_service.ListProductSetsRequest): + The request object. Request message for the ``ListProductSets`` method. + retry (google.api_core.retry.Retry): Designation of what errors, if any, + should be retried. + timeout (float): The timeout for this request. + metadata (Sequence[Tuple[str, str]]): Strings which should be + sent along with the request as metadata. + + Returns: + ~.product_search_service.ListProductSetsResponse: + Response message for the ``ListProductSets`` method. + """ + + http_options: List[Dict[str, str]] = [ + { + "method": "get", + "uri": "/v1p3beta1/{parent=projects/*/locations/*}/productSets", + }, + ] + request, metadata = self._interceptor.pre_list_product_sets( + request, metadata + ) + pb_request = product_search_service.ListProductSetsRequest.pb(request) + transcoded_request = path_template.transcode(http_options, pb_request) + + uri = transcoded_request["uri"] + method = transcoded_request["method"] + + # Jsonify the query params + query_params = json.loads( + json_format.MessageToJson( + transcoded_request["query_params"], + including_default_value_fields=False, + use_integers_for_enums=True, + ) + ) + query_params.update(self._get_unset_required_fields(query_params)) + + query_params["$alt"] = "json;enum-encoding=int" + + # Send the request + headers = dict(metadata) + headers["Content-Type"] = "application/json" + response = getattr(self._session, method)( + "{host}{uri}".format(host=self._host, uri=uri), + timeout=timeout, + headers=headers, + params=rest_helpers.flatten_query_params(query_params, strict=True), + ) + + # In case of error, raise the appropriate core_exceptions.GoogleAPICallError exception + # subclass. + if response.status_code >= 400: + raise core_exceptions.from_http_response(response) + + # Return the response + resp = product_search_service.ListProductSetsResponse() + pb_resp = product_search_service.ListProductSetsResponse.pb(resp) + + json_format.Parse(response.content, pb_resp, ignore_unknown_fields=True) + resp = self._interceptor.post_list_product_sets(resp) + return resp + + class _ListProductsInProductSet(ProductSearchRestStub): + def __hash__(self): + return hash("ListProductsInProductSet") + + __REQUIRED_FIELDS_DEFAULT_VALUES: Dict[str, Any] = {} + + @classmethod + def _get_unset_required_fields(cls, message_dict): + return { + k: v + for k, v in cls.__REQUIRED_FIELDS_DEFAULT_VALUES.items() + if k not in message_dict + } + + def __call__( + self, + request: product_search_service.ListProductsInProductSetRequest, + *, + retry: OptionalRetry = gapic_v1.method.DEFAULT, + timeout: Optional[float] = None, + metadata: Sequence[Tuple[str, str]] = (), + ) -> product_search_service.ListProductsInProductSetResponse: + r"""Call the list products in product + set method over HTTP. + + Args: + request (~.product_search_service.ListProductsInProductSetRequest): + The request object. Request message for the ``ListProductsInProductSet`` + method. + + retry (google.api_core.retry.Retry): Designation of what errors, if any, + should be retried. + timeout (float): The timeout for this request. + metadata (Sequence[Tuple[str, str]]): Strings which should be + sent along with the request as metadata. + + Returns: + ~.product_search_service.ListProductsInProductSetResponse: + Response message for the ``ListProductsInProductSet`` + method. + + """ + + http_options: List[Dict[str, str]] = [ + { + "method": "get", + "uri": "/v1p3beta1/{name=projects/*/locations/*/productSets/*}/products", + }, + ] + request, metadata = self._interceptor.pre_list_products_in_product_set( + request, metadata + ) + pb_request = product_search_service.ListProductsInProductSetRequest.pb( + request + ) + transcoded_request = path_template.transcode(http_options, pb_request) + + uri = transcoded_request["uri"] + method = transcoded_request["method"] + + # Jsonify the query params + query_params = json.loads( + json_format.MessageToJson( + transcoded_request["query_params"], + including_default_value_fields=False, + use_integers_for_enums=True, + ) + ) + query_params.update(self._get_unset_required_fields(query_params)) + + query_params["$alt"] = "json;enum-encoding=int" + + # Send the request + headers = dict(metadata) + headers["Content-Type"] = "application/json" + response = getattr(self._session, method)( + "{host}{uri}".format(host=self._host, uri=uri), + timeout=timeout, + headers=headers, + params=rest_helpers.flatten_query_params(query_params, strict=True), + ) + + # In case of error, raise the appropriate core_exceptions.GoogleAPICallError exception + # subclass. + if response.status_code >= 400: + raise core_exceptions.from_http_response(response) + + # Return the response + resp = product_search_service.ListProductsInProductSetResponse() + pb_resp = product_search_service.ListProductsInProductSetResponse.pb(resp) + + json_format.Parse(response.content, pb_resp, ignore_unknown_fields=True) + resp = self._interceptor.post_list_products_in_product_set(resp) + return resp + + class _ListReferenceImages(ProductSearchRestStub): + def __hash__(self): + return hash("ListReferenceImages") + + __REQUIRED_FIELDS_DEFAULT_VALUES: Dict[str, Any] = {} + + @classmethod + def _get_unset_required_fields(cls, message_dict): + return { + k: v + for k, v in cls.__REQUIRED_FIELDS_DEFAULT_VALUES.items() + if k not in message_dict + } + + def __call__( + self, + request: product_search_service.ListReferenceImagesRequest, + *, + retry: OptionalRetry = gapic_v1.method.DEFAULT, + timeout: Optional[float] = None, + metadata: Sequence[Tuple[str, str]] = (), + ) -> product_search_service.ListReferenceImagesResponse: + r"""Call the list reference images method over HTTP. + + Args: + request (~.product_search_service.ListReferenceImagesRequest): + The request object. Request message for the ``ListReferenceImages`` method. + retry (google.api_core.retry.Retry): Designation of what errors, if any, + should be retried. + timeout (float): The timeout for this request. + metadata (Sequence[Tuple[str, str]]): Strings which should be + sent along with the request as metadata. + + Returns: + ~.product_search_service.ListReferenceImagesResponse: + Response message for the ``ListReferenceImages`` method. + """ + + http_options: List[Dict[str, str]] = [ + { + "method": "get", + "uri": "/v1p3beta1/{parent=projects/*/locations/*/products/*}/referenceImages", + }, + ] + request, metadata = self._interceptor.pre_list_reference_images( + request, metadata + ) + pb_request = product_search_service.ListReferenceImagesRequest.pb(request) + transcoded_request = path_template.transcode(http_options, pb_request) + + uri = transcoded_request["uri"] + method = transcoded_request["method"] + + # Jsonify the query params + query_params = json.loads( + json_format.MessageToJson( + transcoded_request["query_params"], + including_default_value_fields=False, + use_integers_for_enums=True, + ) + ) + query_params.update(self._get_unset_required_fields(query_params)) + + query_params["$alt"] = "json;enum-encoding=int" + + # Send the request + headers = dict(metadata) + headers["Content-Type"] = "application/json" + response = getattr(self._session, method)( + "{host}{uri}".format(host=self._host, uri=uri), + timeout=timeout, + headers=headers, + params=rest_helpers.flatten_query_params(query_params, strict=True), + ) + + # In case of error, raise the appropriate core_exceptions.GoogleAPICallError exception + # subclass. + if response.status_code >= 400: + raise core_exceptions.from_http_response(response) + + # Return the response + resp = product_search_service.ListReferenceImagesResponse() + pb_resp = product_search_service.ListReferenceImagesResponse.pb(resp) + + json_format.Parse(response.content, pb_resp, ignore_unknown_fields=True) + resp = self._interceptor.post_list_reference_images(resp) + return resp + + class _RemoveProductFromProductSet(ProductSearchRestStub): + def __hash__(self): + return hash("RemoveProductFromProductSet") + + __REQUIRED_FIELDS_DEFAULT_VALUES: Dict[str, Any] = {} + + @classmethod + def _get_unset_required_fields(cls, message_dict): + return { + k: v + for k, v in cls.__REQUIRED_FIELDS_DEFAULT_VALUES.items() + if k not in message_dict + } + + def __call__( + self, + request: product_search_service.RemoveProductFromProductSetRequest, + *, + retry: OptionalRetry = gapic_v1.method.DEFAULT, + timeout: Optional[float] = None, + metadata: Sequence[Tuple[str, str]] = (), + ): + r"""Call the remove product from + product set method over HTTP. + + Args: + request (~.product_search_service.RemoveProductFromProductSetRequest): + The request object. Request message for the ``RemoveProductFromProductSet`` + method. + + retry (google.api_core.retry.Retry): Designation of what errors, if any, + should be retried. + timeout (float): The timeout for this request. + metadata (Sequence[Tuple[str, str]]): Strings which should be + sent along with the request as metadata. + """ + + http_options: List[Dict[str, str]] = [ + { + "method": "post", + "uri": "/v1p3beta1/{name=projects/*/locations/*/productSets/*}:removeProduct", + "body": "*", + }, + ] + request, metadata = self._interceptor.pre_remove_product_from_product_set( + request, metadata + ) + pb_request = product_search_service.RemoveProductFromProductSetRequest.pb( + request + ) + transcoded_request = path_template.transcode(http_options, pb_request) + + # Jsonify the request body + + body = json_format.MessageToJson( + transcoded_request["body"], + including_default_value_fields=False, + use_integers_for_enums=True, + ) + uri = transcoded_request["uri"] + method = transcoded_request["method"] + + # Jsonify the query params + query_params = json.loads( + json_format.MessageToJson( + transcoded_request["query_params"], + including_default_value_fields=False, + use_integers_for_enums=True, + ) + ) + query_params.update(self._get_unset_required_fields(query_params)) + + query_params["$alt"] = "json;enum-encoding=int" + + # Send the request + headers = dict(metadata) + headers["Content-Type"] = "application/json" + response = getattr(self._session, method)( + "{host}{uri}".format(host=self._host, uri=uri), + timeout=timeout, + headers=headers, + params=rest_helpers.flatten_query_params(query_params, strict=True), + data=body, + ) + + # In case of error, raise the appropriate core_exceptions.GoogleAPICallError exception + # subclass. + if response.status_code >= 400: + raise core_exceptions.from_http_response(response) + + class _UpdateProduct(ProductSearchRestStub): + def __hash__(self): + return hash("UpdateProduct") + + __REQUIRED_FIELDS_DEFAULT_VALUES: Dict[str, Any] = {} + + @classmethod + def _get_unset_required_fields(cls, message_dict): + return { + k: v + for k, v in cls.__REQUIRED_FIELDS_DEFAULT_VALUES.items() + if k not in message_dict + } + + def __call__( + self, + request: product_search_service.UpdateProductRequest, + *, + retry: OptionalRetry = gapic_v1.method.DEFAULT, + timeout: Optional[float] = None, + metadata: Sequence[Tuple[str, str]] = (), + ) -> product_search_service.Product: + r"""Call the update product method over HTTP. + + Args: + request (~.product_search_service.UpdateProductRequest): + The request object. Request message for the ``UpdateProduct`` method. + retry (google.api_core.retry.Retry): Designation of what errors, if any, + should be retried. + timeout (float): The timeout for this request. + metadata (Sequence[Tuple[str, str]]): Strings which should be + sent along with the request as metadata. + + Returns: + ~.product_search_service.Product: + A Product contains ReferenceImages. + """ + + http_options: List[Dict[str, str]] = [ + { + "method": "patch", + "uri": "/v1p3beta1/{product.name=projects/*/locations/*/products/*}", + "body": "product", + }, + ] + request, metadata = self._interceptor.pre_update_product(request, metadata) + pb_request = product_search_service.UpdateProductRequest.pb(request) + transcoded_request = path_template.transcode(http_options, pb_request) + + # Jsonify the request body + + body = json_format.MessageToJson( + transcoded_request["body"], + including_default_value_fields=False, + use_integers_for_enums=True, + ) + uri = transcoded_request["uri"] + method = transcoded_request["method"] + + # Jsonify the query params + query_params = json.loads( + json_format.MessageToJson( + transcoded_request["query_params"], + including_default_value_fields=False, + use_integers_for_enums=True, + ) + ) + query_params.update(self._get_unset_required_fields(query_params)) + + query_params["$alt"] = "json;enum-encoding=int" + + # Send the request + headers = dict(metadata) + headers["Content-Type"] = "application/json" + response = getattr(self._session, method)( + "{host}{uri}".format(host=self._host, uri=uri), + timeout=timeout, + headers=headers, + params=rest_helpers.flatten_query_params(query_params, strict=True), + data=body, + ) + + # In case of error, raise the appropriate core_exceptions.GoogleAPICallError exception + # subclass. + if response.status_code >= 400: + raise core_exceptions.from_http_response(response) + + # Return the response + resp = product_search_service.Product() + pb_resp = product_search_service.Product.pb(resp) + + json_format.Parse(response.content, pb_resp, ignore_unknown_fields=True) + resp = self._interceptor.post_update_product(resp) + return resp + + class _UpdateProductSet(ProductSearchRestStub): + def __hash__(self): + return hash("UpdateProductSet") + + __REQUIRED_FIELDS_DEFAULT_VALUES: Dict[str, Any] = {} + + @classmethod + def _get_unset_required_fields(cls, message_dict): + return { + k: v + for k, v in cls.__REQUIRED_FIELDS_DEFAULT_VALUES.items() + if k not in message_dict + } + + def __call__( + self, + request: product_search_service.UpdateProductSetRequest, + *, + retry: OptionalRetry = gapic_v1.method.DEFAULT, + timeout: Optional[float] = None, + metadata: Sequence[Tuple[str, str]] = (), + ) -> product_search_service.ProductSet: + r"""Call the update product set method over HTTP. + + Args: + request (~.product_search_service.UpdateProductSetRequest): + The request object. Request message for the ``UpdateProductSet`` method. + retry (google.api_core.retry.Retry): Designation of what errors, if any, + should be retried. + timeout (float): The timeout for this request. + metadata (Sequence[Tuple[str, str]]): Strings which should be + sent along with the request as metadata. + + Returns: + ~.product_search_service.ProductSet: + A ProductSet contains Products. A + ProductSet can contain a maximum of 1 + million reference images. If the limit + is exceeded, periodic indexing will + fail. + + """ + + http_options: List[Dict[str, str]] = [ + { + "method": "patch", + "uri": "/v1p3beta1/{product_set.name=projects/*/locations/*/productSets/*}", + "body": "product_set", + }, + ] + request, metadata = self._interceptor.pre_update_product_set( + request, metadata + ) + pb_request = product_search_service.UpdateProductSetRequest.pb(request) + transcoded_request = path_template.transcode(http_options, pb_request) + + # Jsonify the request body + + body = json_format.MessageToJson( + transcoded_request["body"], + including_default_value_fields=False, + use_integers_for_enums=True, + ) + uri = transcoded_request["uri"] + method = transcoded_request["method"] + + # Jsonify the query params + query_params = json.loads( + json_format.MessageToJson( + transcoded_request["query_params"], + including_default_value_fields=False, + use_integers_for_enums=True, + ) + ) + query_params.update(self._get_unset_required_fields(query_params)) + + query_params["$alt"] = "json;enum-encoding=int" + + # Send the request + headers = dict(metadata) + headers["Content-Type"] = "application/json" + response = getattr(self._session, method)( + "{host}{uri}".format(host=self._host, uri=uri), + timeout=timeout, + headers=headers, + params=rest_helpers.flatten_query_params(query_params, strict=True), + data=body, + ) + + # In case of error, raise the appropriate core_exceptions.GoogleAPICallError exception + # subclass. + if response.status_code >= 400: + raise core_exceptions.from_http_response(response) + + # Return the response + resp = product_search_service.ProductSet() + pb_resp = product_search_service.ProductSet.pb(resp) + + json_format.Parse(response.content, pb_resp, ignore_unknown_fields=True) + resp = self._interceptor.post_update_product_set(resp) + return resp + + @property + def add_product_to_product_set( + self, + ) -> Callable[ + [product_search_service.AddProductToProductSetRequest], empty_pb2.Empty + ]: + # The return type is fine, but mypy isn't sophisticated enough to determine what's going on here. + # In C++ this would require a dynamic_cast + return self._AddProductToProductSet(self._session, self._host, self._interceptor) # type: ignore + + @property + def create_product( + self, + ) -> Callable[ + [product_search_service.CreateProductRequest], product_search_service.Product + ]: + # The return type is fine, but mypy isn't sophisticated enough to determine what's going on here. + # In C++ this would require a dynamic_cast + return self._CreateProduct(self._session, self._host, self._interceptor) # type: ignore + + @property + def create_product_set( + self, + ) -> Callable[ + [product_search_service.CreateProductSetRequest], + product_search_service.ProductSet, + ]: + # The return type is fine, but mypy isn't sophisticated enough to determine what's going on here. + # In C++ this would require a dynamic_cast + return self._CreateProductSet(self._session, self._host, self._interceptor) # type: ignore + + @property + def create_reference_image( + self, + ) -> Callable[ + [product_search_service.CreateReferenceImageRequest], + product_search_service.ReferenceImage, + ]: + # The return type is fine, but mypy isn't sophisticated enough to determine what's going on here. + # In C++ this would require a dynamic_cast + return self._CreateReferenceImage(self._session, self._host, self._interceptor) # type: ignore + + @property + def delete_product( + self, + ) -> Callable[[product_search_service.DeleteProductRequest], empty_pb2.Empty]: + # The return type is fine, but mypy isn't sophisticated enough to determine what's going on here. + # In C++ this would require a dynamic_cast + return self._DeleteProduct(self._session, self._host, self._interceptor) # type: ignore + + @property + def delete_product_set( + self, + ) -> Callable[[product_search_service.DeleteProductSetRequest], empty_pb2.Empty]: + # The return type is fine, but mypy isn't sophisticated enough to determine what's going on here. + # In C++ this would require a dynamic_cast + return self._DeleteProductSet(self._session, self._host, self._interceptor) # type: ignore + + @property + def delete_reference_image( + self, + ) -> Callable[ + [product_search_service.DeleteReferenceImageRequest], empty_pb2.Empty + ]: + # The return type is fine, but mypy isn't sophisticated enough to determine what's going on here. + # In C++ this would require a dynamic_cast + return self._DeleteReferenceImage(self._session, self._host, self._interceptor) # type: ignore + + @property + def get_product( + self, + ) -> Callable[ + [product_search_service.GetProductRequest], product_search_service.Product + ]: + # The return type is fine, but mypy isn't sophisticated enough to determine what's going on here. + # In C++ this would require a dynamic_cast + return self._GetProduct(self._session, self._host, self._interceptor) # type: ignore + + @property + def get_product_set( + self, + ) -> Callable[ + [product_search_service.GetProductSetRequest], product_search_service.ProductSet + ]: + # The return type is fine, but mypy isn't sophisticated enough to determine what's going on here. + # In C++ this would require a dynamic_cast + return self._GetProductSet(self._session, self._host, self._interceptor) # type: ignore + + @property + def get_reference_image( + self, + ) -> Callable[ + [product_search_service.GetReferenceImageRequest], + product_search_service.ReferenceImage, + ]: + # The return type is fine, but mypy isn't sophisticated enough to determine what's going on here. + # In C++ this would require a dynamic_cast + return self._GetReferenceImage(self._session, self._host, self._interceptor) # type: ignore + + @property + def import_product_sets( + self, + ) -> Callable[ + [product_search_service.ImportProductSetsRequest], operations_pb2.Operation + ]: + # The return type is fine, but mypy isn't sophisticated enough to determine what's going on here. + # In C++ this would require a dynamic_cast + return self._ImportProductSets(self._session, self._host, self._interceptor) # type: ignore + + @property + def list_products( + self, + ) -> Callable[ + [product_search_service.ListProductsRequest], + product_search_service.ListProductsResponse, + ]: + # The return type is fine, but mypy isn't sophisticated enough to determine what's going on here. + # In C++ this would require a dynamic_cast + return self._ListProducts(self._session, self._host, self._interceptor) # type: ignore + + @property + def list_product_sets( + self, + ) -> Callable[ + [product_search_service.ListProductSetsRequest], + product_search_service.ListProductSetsResponse, + ]: + # The return type is fine, but mypy isn't sophisticated enough to determine what's going on here. + # In C++ this would require a dynamic_cast + return self._ListProductSets(self._session, self._host, self._interceptor) # type: ignore + + @property + def list_products_in_product_set( + self, + ) -> Callable[ + [product_search_service.ListProductsInProductSetRequest], + product_search_service.ListProductsInProductSetResponse, + ]: + # The return type is fine, but mypy isn't sophisticated enough to determine what's going on here. + # In C++ this would require a dynamic_cast + return self._ListProductsInProductSet(self._session, self._host, self._interceptor) # type: ignore + + @property + def list_reference_images( + self, + ) -> Callable[ + [product_search_service.ListReferenceImagesRequest], + product_search_service.ListReferenceImagesResponse, + ]: + # The return type is fine, but mypy isn't sophisticated enough to determine what's going on here. + # In C++ this would require a dynamic_cast + return self._ListReferenceImages(self._session, self._host, self._interceptor) # type: ignore + + @property + def remove_product_from_product_set( + self, + ) -> Callable[ + [product_search_service.RemoveProductFromProductSetRequest], empty_pb2.Empty + ]: + # The return type is fine, but mypy isn't sophisticated enough to determine what's going on here. + # In C++ this would require a dynamic_cast + return self._RemoveProductFromProductSet(self._session, self._host, self._interceptor) # type: ignore + + @property + def update_product( + self, + ) -> Callable[ + [product_search_service.UpdateProductRequest], product_search_service.Product + ]: + # The return type is fine, but mypy isn't sophisticated enough to determine what's going on here. + # In C++ this would require a dynamic_cast + return self._UpdateProduct(self._session, self._host, self._interceptor) # type: ignore + + @property + def update_product_set( + self, + ) -> Callable[ + [product_search_service.UpdateProductSetRequest], + product_search_service.ProductSet, + ]: + # The return type is fine, but mypy isn't sophisticated enough to determine what's going on here. + # In C++ this would require a dynamic_cast + return self._UpdateProductSet(self._session, self._host, self._interceptor) # type: ignore + + @property + def kind(self) -> str: + return "rest" + + def close(self): + self._session.close() + + +__all__ = ("ProductSearchRestTransport",) diff --git a/google/cloud/vision_v1p3beta1/types/geometry.py b/google/cloud/vision_v1p3beta1/types/geometry.py index 2bec30f7..d8ac3b2c 100644 --- a/google/cloud/vision_v1p3beta1/types/geometry.py +++ b/google/cloud/vision_v1p3beta1/types/geometry.py @@ -13,6 +13,8 @@ # See the License for the specific language governing permissions and # limitations under the License. # +from __future__ import annotations + from typing import MutableMapping, MutableSequence import proto # type: ignore diff --git a/google/cloud/vision_v1p3beta1/types/image_annotator.py b/google/cloud/vision_v1p3beta1/types/image_annotator.py index 7bf9ec32..7e1f4b56 100644 --- a/google/cloud/vision_v1p3beta1/types/image_annotator.py +++ b/google/cloud/vision_v1p3beta1/types/image_annotator.py @@ -13,6 +13,8 @@ # See the License for the specific language governing permissions and # limitations under the License. # +from __future__ import annotations + from typing import MutableMapping, MutableSequence import proto # type: ignore diff --git a/google/cloud/vision_v1p3beta1/types/product_search.py b/google/cloud/vision_v1p3beta1/types/product_search.py index 1a888cc8..3eb17536 100644 --- a/google/cloud/vision_v1p3beta1/types/product_search.py +++ b/google/cloud/vision_v1p3beta1/types/product_search.py @@ -13,6 +13,8 @@ # See the License for the specific language governing permissions and # limitations under the License. # +from __future__ import annotations + from typing import MutableMapping, MutableSequence import proto # type: ignore diff --git a/google/cloud/vision_v1p3beta1/types/product_search_service.py b/google/cloud/vision_v1p3beta1/types/product_search_service.py index 32635f61..e5fee18c 100644 --- a/google/cloud/vision_v1p3beta1/types/product_search_service.py +++ b/google/cloud/vision_v1p3beta1/types/product_search_service.py @@ -13,6 +13,8 @@ # See the License for the specific language governing permissions and # limitations under the License. # +from __future__ import annotations + from typing import MutableMapping, MutableSequence import proto # type: ignore diff --git a/google/cloud/vision_v1p3beta1/types/text_annotation.py b/google/cloud/vision_v1p3beta1/types/text_annotation.py index 689548dc..33f45266 100644 --- a/google/cloud/vision_v1p3beta1/types/text_annotation.py +++ b/google/cloud/vision_v1p3beta1/types/text_annotation.py @@ -13,6 +13,8 @@ # See the License for the specific language governing permissions and # limitations under the License. # +from __future__ import annotations + from typing import MutableMapping, MutableSequence import proto # type: ignore diff --git a/google/cloud/vision_v1p3beta1/types/web_detection.py b/google/cloud/vision_v1p3beta1/types/web_detection.py index 96713e4f..5d563e5c 100644 --- a/google/cloud/vision_v1p3beta1/types/web_detection.py +++ b/google/cloud/vision_v1p3beta1/types/web_detection.py @@ -13,6 +13,8 @@ # See the License for the specific language governing permissions and # limitations under the License. # +from __future__ import annotations + from typing import MutableMapping, MutableSequence import proto # type: ignore diff --git a/google/cloud/vision_v1p4beta1/__init__.py b/google/cloud/vision_v1p4beta1/__init__.py index 0d16eca7..4464df12 100644 --- a/google/cloud/vision_v1p4beta1/__init__.py +++ b/google/cloud/vision_v1p4beta1/__init__.py @@ -13,7 +13,7 @@ # See the License for the specific language governing permissions and # limitations under the License. # -from google.cloud.vision import gapic_version as package_version +from google.cloud.vision_v1p4beta1 import gapic_version as package_version __version__ = package_version.__version__ diff --git a/google/cloud/vision_v1p4beta1/gapic_metadata.json b/google/cloud/vision_v1p4beta1/gapic_metadata.json index bc41c344..9e0f3410 100644 --- a/google/cloud/vision_v1p4beta1/gapic_metadata.json +++ b/google/cloud/vision_v1p4beta1/gapic_metadata.json @@ -56,6 +56,31 @@ ] } } + }, + "rest": { + "libraryClient": "ImageAnnotatorClient", + "rpcs": { + "AsyncBatchAnnotateFiles": { + "methods": [ + "async_batch_annotate_files" + ] + }, + "AsyncBatchAnnotateImages": { + "methods": [ + "async_batch_annotate_images" + ] + }, + "BatchAnnotateFiles": { + "methods": [ + "batch_annotate_files" + ] + }, + "BatchAnnotateImages": { + "methods": [ + "batch_annotate_images" + ] + } + } } } }, @@ -260,6 +285,106 @@ ] } } + }, + "rest": { + "libraryClient": "ProductSearchClient", + "rpcs": { + "AddProductToProductSet": { + "methods": [ + "add_product_to_product_set" + ] + }, + "CreateProduct": { + "methods": [ + "create_product" + ] + }, + "CreateProductSet": { + "methods": [ + "create_product_set" + ] + }, + "CreateReferenceImage": { + "methods": [ + "create_reference_image" + ] + }, + "DeleteProduct": { + "methods": [ + "delete_product" + ] + }, + "DeleteProductSet": { + "methods": [ + "delete_product_set" + ] + }, + "DeleteReferenceImage": { + "methods": [ + "delete_reference_image" + ] + }, + "GetProduct": { + "methods": [ + "get_product" + ] + }, + "GetProductSet": { + "methods": [ + "get_product_set" + ] + }, + "GetReferenceImage": { + "methods": [ + "get_reference_image" + ] + }, + "ImportProductSets": { + "methods": [ + "import_product_sets" + ] + }, + "ListProductSets": { + "methods": [ + "list_product_sets" + ] + }, + "ListProducts": { + "methods": [ + "list_products" + ] + }, + "ListProductsInProductSet": { + "methods": [ + "list_products_in_product_set" + ] + }, + "ListReferenceImages": { + "methods": [ + "list_reference_images" + ] + }, + "PurgeProducts": { + "methods": [ + "purge_products" + ] + }, + "RemoveProductFromProductSet": { + "methods": [ + "remove_product_from_product_set" + ] + }, + "UpdateProduct": { + "methods": [ + "update_product" + ] + }, + "UpdateProductSet": { + "methods": [ + "update_product_set" + ] + } + } } } } diff --git a/google/cloud/vision_v1p4beta1/gapic_version.py b/google/cloud/vision_v1p4beta1/gapic_version.py index c443818a..431567aa 100644 --- a/google/cloud/vision_v1p4beta1/gapic_version.py +++ b/google/cloud/vision_v1p4beta1/gapic_version.py @@ -13,4 +13,4 @@ # See the License for the specific language governing permissions and # limitations under the License. # -__version__ = "3.3.1" # {x-release-please-version} +__version__ = "3.4.0" # {x-release-please-version} diff --git a/google/cloud/vision_v1p4beta1/services/image_annotator/client.py b/google/cloud/vision_v1p4beta1/services/image_annotator/client.py index abcc8a1d..436878f4 100644 --- a/google/cloud/vision_v1p4beta1/services/image_annotator/client.py +++ b/google/cloud/vision_v1p4beta1/services/image_annotator/client.py @@ -52,6 +52,7 @@ from .transports.base import ImageAnnotatorTransport, DEFAULT_CLIENT_INFO from .transports.grpc import ImageAnnotatorGrpcTransport from .transports.grpc_asyncio import ImageAnnotatorGrpcAsyncIOTransport +from .transports.rest import ImageAnnotatorRestTransport class ImageAnnotatorClientMeta(type): @@ -67,6 +68,7 @@ class ImageAnnotatorClientMeta(type): ) # type: Dict[str, Type[ImageAnnotatorTransport]] _transport_registry["grpc"] = ImageAnnotatorGrpcTransport _transport_registry["grpc_asyncio"] = ImageAnnotatorGrpcAsyncIOTransport + _transport_registry["rest"] = ImageAnnotatorRestTransport def get_transport_class( cls, diff --git a/google/cloud/vision_v1p4beta1/services/image_annotator/transports/__init__.py b/google/cloud/vision_v1p4beta1/services/image_annotator/transports/__init__.py index bb856540..e959448a 100644 --- a/google/cloud/vision_v1p4beta1/services/image_annotator/transports/__init__.py +++ b/google/cloud/vision_v1p4beta1/services/image_annotator/transports/__init__.py @@ -19,15 +19,20 @@ from .base import ImageAnnotatorTransport from .grpc import ImageAnnotatorGrpcTransport from .grpc_asyncio import ImageAnnotatorGrpcAsyncIOTransport +from .rest import ImageAnnotatorRestTransport +from .rest import ImageAnnotatorRestInterceptor # Compile a registry of transports. _transport_registry = OrderedDict() # type: Dict[str, Type[ImageAnnotatorTransport]] _transport_registry["grpc"] = ImageAnnotatorGrpcTransport _transport_registry["grpc_asyncio"] = ImageAnnotatorGrpcAsyncIOTransport +_transport_registry["rest"] = ImageAnnotatorRestTransport __all__ = ( "ImageAnnotatorTransport", "ImageAnnotatorGrpcTransport", "ImageAnnotatorGrpcAsyncIOTransport", + "ImageAnnotatorRestTransport", + "ImageAnnotatorRestInterceptor", ) diff --git a/google/cloud/vision_v1p4beta1/services/image_annotator/transports/rest.py b/google/cloud/vision_v1p4beta1/services/image_annotator/transports/rest.py new file mode 100644 index 00000000..80e1ada1 --- /dev/null +++ b/google/cloud/vision_v1p4beta1/services/image_annotator/transports/rest.py @@ -0,0 +1,789 @@ +# -*- coding: utf-8 -*- +# Copyright 2022 Google LLC +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. +# + +from google.auth.transport.requests import AuthorizedSession # type: ignore +import json # type: ignore +import grpc # type: ignore +from google.auth.transport.grpc import SslCredentials # type: ignore +from google.auth import credentials as ga_credentials # type: ignore +from google.api_core import exceptions as core_exceptions +from google.api_core import retry as retries +from google.api_core import rest_helpers +from google.api_core import rest_streaming +from google.api_core import path_template +from google.api_core import gapic_v1 + +from google.protobuf import json_format +from google.api_core import operations_v1 +from requests import __version__ as requests_version +import dataclasses +import re +from typing import Any, Callable, Dict, List, Optional, Sequence, Tuple, Union +import warnings + +try: + OptionalRetry = Union[retries.Retry, gapic_v1.method._MethodDefault] +except AttributeError: # pragma: NO COVER + OptionalRetry = Union[retries.Retry, object] # type: ignore + + +from google.cloud.vision_v1p4beta1.types import image_annotator +from google.longrunning import operations_pb2 # type: ignore + +from .base import ( + ImageAnnotatorTransport, + DEFAULT_CLIENT_INFO as BASE_DEFAULT_CLIENT_INFO, +) + + +DEFAULT_CLIENT_INFO = gapic_v1.client_info.ClientInfo( + gapic_version=BASE_DEFAULT_CLIENT_INFO.gapic_version, + grpc_version=None, + rest_version=requests_version, +) + + +class ImageAnnotatorRestInterceptor: + """Interceptor for ImageAnnotator. + + Interceptors are used to manipulate requests, request metadata, and responses + in arbitrary ways. + Example use cases include: + * Logging + * Verifying requests according to service or custom semantics + * Stripping extraneous information from responses + + These use cases and more can be enabled by injecting an + instance of a custom subclass when constructing the ImageAnnotatorRestTransport. + + .. code-block:: python + class MyCustomImageAnnotatorInterceptor(ImageAnnotatorRestInterceptor): + def pre_async_batch_annotate_files(self, request, metadata): + logging.log(f"Received request: {request}") + return request, metadata + + def post_async_batch_annotate_files(self, response): + logging.log(f"Received response: {response}") + return response + + def pre_async_batch_annotate_images(self, request, metadata): + logging.log(f"Received request: {request}") + return request, metadata + + def post_async_batch_annotate_images(self, response): + logging.log(f"Received response: {response}") + return response + + def pre_batch_annotate_files(self, request, metadata): + logging.log(f"Received request: {request}") + return request, metadata + + def post_batch_annotate_files(self, response): + logging.log(f"Received response: {response}") + return response + + def pre_batch_annotate_images(self, request, metadata): + logging.log(f"Received request: {request}") + return request, metadata + + def post_batch_annotate_images(self, response): + logging.log(f"Received response: {response}") + return response + + transport = ImageAnnotatorRestTransport(interceptor=MyCustomImageAnnotatorInterceptor()) + client = ImageAnnotatorClient(transport=transport) + + + """ + + def pre_async_batch_annotate_files( + self, + request: image_annotator.AsyncBatchAnnotateFilesRequest, + metadata: Sequence[Tuple[str, str]], + ) -> Tuple[ + image_annotator.AsyncBatchAnnotateFilesRequest, Sequence[Tuple[str, str]] + ]: + """Pre-rpc interceptor for async_batch_annotate_files + + Override in a subclass to manipulate the request or metadata + before they are sent to the ImageAnnotator server. + """ + return request, metadata + + def post_async_batch_annotate_files( + self, response: operations_pb2.Operation + ) -> operations_pb2.Operation: + """Post-rpc interceptor for async_batch_annotate_files + + Override in a subclass to manipulate the response + after it is returned by the ImageAnnotator server but before + it is returned to user code. + """ + return response + + def pre_async_batch_annotate_images( + self, + request: image_annotator.AsyncBatchAnnotateImagesRequest, + metadata: Sequence[Tuple[str, str]], + ) -> Tuple[ + image_annotator.AsyncBatchAnnotateImagesRequest, Sequence[Tuple[str, str]] + ]: + """Pre-rpc interceptor for async_batch_annotate_images + + Override in a subclass to manipulate the request or metadata + before they are sent to the ImageAnnotator server. + """ + return request, metadata + + def post_async_batch_annotate_images( + self, response: operations_pb2.Operation + ) -> operations_pb2.Operation: + """Post-rpc interceptor for async_batch_annotate_images + + Override in a subclass to manipulate the response + after it is returned by the ImageAnnotator server but before + it is returned to user code. + """ + return response + + def pre_batch_annotate_files( + self, + request: image_annotator.BatchAnnotateFilesRequest, + metadata: Sequence[Tuple[str, str]], + ) -> Tuple[image_annotator.BatchAnnotateFilesRequest, Sequence[Tuple[str, str]]]: + """Pre-rpc interceptor for batch_annotate_files + + Override in a subclass to manipulate the request or metadata + before they are sent to the ImageAnnotator server. + """ + return request, metadata + + def post_batch_annotate_files( + self, response: image_annotator.BatchAnnotateFilesResponse + ) -> image_annotator.BatchAnnotateFilesResponse: + """Post-rpc interceptor for batch_annotate_files + + Override in a subclass to manipulate the response + after it is returned by the ImageAnnotator server but before + it is returned to user code. + """ + return response + + def pre_batch_annotate_images( + self, + request: image_annotator.BatchAnnotateImagesRequest, + metadata: Sequence[Tuple[str, str]], + ) -> Tuple[image_annotator.BatchAnnotateImagesRequest, Sequence[Tuple[str, str]]]: + """Pre-rpc interceptor for batch_annotate_images + + Override in a subclass to manipulate the request or metadata + before they are sent to the ImageAnnotator server. + """ + return request, metadata + + def post_batch_annotate_images( + self, response: image_annotator.BatchAnnotateImagesResponse + ) -> image_annotator.BatchAnnotateImagesResponse: + """Post-rpc interceptor for batch_annotate_images + + Override in a subclass to manipulate the response + after it is returned by the ImageAnnotator server but before + it is returned to user code. + """ + return response + + +@dataclasses.dataclass +class ImageAnnotatorRestStub: + _session: AuthorizedSession + _host: str + _interceptor: ImageAnnotatorRestInterceptor + + +class ImageAnnotatorRestTransport(ImageAnnotatorTransport): + """REST backend transport for ImageAnnotator. + + Service that performs Google Cloud Vision API detection tasks + over client images, such as face, landmark, logo, label, and + text detection. The ImageAnnotator service returns detected + entities from the images. + + This class defines the same methods as the primary client, so the + primary client can load the underlying transport implementation + and call it. + + It sends JSON representations of protocol buffers over HTTP/1.1 + + """ + + def __init__( + self, + *, + host: str = "vision.googleapis.com", + credentials: Optional[ga_credentials.Credentials] = None, + credentials_file: Optional[str] = None, + scopes: Optional[Sequence[str]] = None, + client_cert_source_for_mtls: Optional[Callable[[], Tuple[bytes, bytes]]] = None, + quota_project_id: Optional[str] = None, + client_info: gapic_v1.client_info.ClientInfo = DEFAULT_CLIENT_INFO, + always_use_jwt_access: Optional[bool] = False, + url_scheme: str = "https", + interceptor: Optional[ImageAnnotatorRestInterceptor] = None, + api_audience: Optional[str] = None, + ) -> None: + """Instantiate the transport. + + Args: + host (Optional[str]): + The hostname to connect to. + credentials (Optional[google.auth.credentials.Credentials]): The + authorization credentials to attach to requests. These + credentials identify the application to the service; if none + are specified, the client will attempt to ascertain the + credentials from the environment. + + credentials_file (Optional[str]): A file with credentials that can + be loaded with :func:`google.auth.load_credentials_from_file`. + This argument is ignored if ``channel`` is provided. + scopes (Optional(Sequence[str])): A list of scopes. This argument is + ignored if ``channel`` is provided. + client_cert_source_for_mtls (Callable[[], Tuple[bytes, bytes]]): Client + certificate to configure mutual TLS HTTP channel. It is ignored + if ``channel`` is provided. + quota_project_id (Optional[str]): An optional project to use for billing + and quota. + client_info (google.api_core.gapic_v1.client_info.ClientInfo): + The client info used to send a user-agent string along with + API requests. If ``None``, then default info will be used. + Generally, you only need to set this if you are developing + your own client library. + always_use_jwt_access (Optional[bool]): Whether self signed JWT should + be used for service account credentials. + url_scheme: the protocol scheme for the API endpoint. Normally + "https", but for testing or local servers, + "http" can be specified. + """ + # Run the base constructor + # TODO(yon-mg): resolve other ctor params i.e. scopes, quota, etc. + # TODO: When custom host (api_endpoint) is set, `scopes` must *also* be set on the + # credentials object + maybe_url_match = re.match("^(?Phttp(?:s)?://)?(?P.*)$", host) + if maybe_url_match is None: + raise ValueError( + f"Unexpected hostname structure: {host}" + ) # pragma: NO COVER + + url_match_items = maybe_url_match.groupdict() + + host = f"{url_scheme}://{host}" if not url_match_items["scheme"] else host + + super().__init__( + host=host, + credentials=credentials, + client_info=client_info, + always_use_jwt_access=always_use_jwt_access, + api_audience=api_audience, + ) + self._session = AuthorizedSession( + self._credentials, default_host=self.DEFAULT_HOST + ) + self._operations_client: Optional[operations_v1.AbstractOperationsClient] = None + if client_cert_source_for_mtls: + self._session.configure_mtls_channel(client_cert_source_for_mtls) + self._interceptor = interceptor or ImageAnnotatorRestInterceptor() + self._prep_wrapped_messages(client_info) + + @property + def operations_client(self) -> operations_v1.AbstractOperationsClient: + """Create the client designed to process long-running operations. + + This property caches on the instance; repeated calls return the same + client. + """ + # Only create a new client if we do not already have one. + if self._operations_client is None: + http_options: Dict[str, List[Dict[str, str]]] = {} + + rest_transport = operations_v1.OperationsRestTransport( + host=self._host, + # use the credentials which are saved + credentials=self._credentials, + scopes=self._scopes, + http_options=http_options, + path_prefix="v1p4beta1", + ) + + self._operations_client = operations_v1.AbstractOperationsClient( + transport=rest_transport + ) + + # Return the client from cache. + return self._operations_client + + class _AsyncBatchAnnotateFiles(ImageAnnotatorRestStub): + def __hash__(self): + return hash("AsyncBatchAnnotateFiles") + + __REQUIRED_FIELDS_DEFAULT_VALUES: Dict[str, Any] = {} + + @classmethod + def _get_unset_required_fields(cls, message_dict): + return { + k: v + for k, v in cls.__REQUIRED_FIELDS_DEFAULT_VALUES.items() + if k not in message_dict + } + + def __call__( + self, + request: image_annotator.AsyncBatchAnnotateFilesRequest, + *, + retry: OptionalRetry = gapic_v1.method.DEFAULT, + timeout: Optional[float] = None, + metadata: Sequence[Tuple[str, str]] = (), + ) -> operations_pb2.Operation: + r"""Call the async batch annotate + files method over HTTP. + + Args: + request (~.image_annotator.AsyncBatchAnnotateFilesRequest): + The request object. Multiple async file annotation + requests are batched into a single + service call. + + retry (google.api_core.retry.Retry): Designation of what errors, if any, + should be retried. + timeout (float): The timeout for this request. + metadata (Sequence[Tuple[str, str]]): Strings which should be + sent along with the request as metadata. + + Returns: + ~.operations_pb2.Operation: + This resource represents a + long-running operation that is the + result of a network API call. + + """ + + http_options: List[Dict[str, str]] = [ + { + "method": "post", + "uri": "/v1p4beta1/files:asyncBatchAnnotate", + "body": "*", + }, + ] + request, metadata = self._interceptor.pre_async_batch_annotate_files( + request, metadata + ) + pb_request = image_annotator.AsyncBatchAnnotateFilesRequest.pb(request) + transcoded_request = path_template.transcode(http_options, pb_request) + + # Jsonify the request body + + body = json_format.MessageToJson( + transcoded_request["body"], + including_default_value_fields=False, + use_integers_for_enums=True, + ) + uri = transcoded_request["uri"] + method = transcoded_request["method"] + + # Jsonify the query params + query_params = json.loads( + json_format.MessageToJson( + transcoded_request["query_params"], + including_default_value_fields=False, + use_integers_for_enums=True, + ) + ) + query_params.update(self._get_unset_required_fields(query_params)) + + query_params["$alt"] = "json;enum-encoding=int" + + # Send the request + headers = dict(metadata) + headers["Content-Type"] = "application/json" + response = getattr(self._session, method)( + "{host}{uri}".format(host=self._host, uri=uri), + timeout=timeout, + headers=headers, + params=rest_helpers.flatten_query_params(query_params, strict=True), + data=body, + ) + + # In case of error, raise the appropriate core_exceptions.GoogleAPICallError exception + # subclass. + if response.status_code >= 400: + raise core_exceptions.from_http_response(response) + + # Return the response + resp = operations_pb2.Operation() + json_format.Parse(response.content, resp, ignore_unknown_fields=True) + resp = self._interceptor.post_async_batch_annotate_files(resp) + return resp + + class _AsyncBatchAnnotateImages(ImageAnnotatorRestStub): + def __hash__(self): + return hash("AsyncBatchAnnotateImages") + + __REQUIRED_FIELDS_DEFAULT_VALUES: Dict[str, Any] = {} + + @classmethod + def _get_unset_required_fields(cls, message_dict): + return { + k: v + for k, v in cls.__REQUIRED_FIELDS_DEFAULT_VALUES.items() + if k not in message_dict + } + + def __call__( + self, + request: image_annotator.AsyncBatchAnnotateImagesRequest, + *, + retry: OptionalRetry = gapic_v1.method.DEFAULT, + timeout: Optional[float] = None, + metadata: Sequence[Tuple[str, str]] = (), + ) -> operations_pb2.Operation: + r"""Call the async batch annotate + images method over HTTP. + + Args: + request (~.image_annotator.AsyncBatchAnnotateImagesRequest): + The request object. Request for async image annotation + for a list of images. + + retry (google.api_core.retry.Retry): Designation of what errors, if any, + should be retried. + timeout (float): The timeout for this request. + metadata (Sequence[Tuple[str, str]]): Strings which should be + sent along with the request as metadata. + + Returns: + ~.operations_pb2.Operation: + This resource represents a + long-running operation that is the + result of a network API call. + + """ + + http_options: List[Dict[str, str]] = [ + { + "method": "post", + "uri": "/v1p4beta1/images:asyncBatchAnnotate", + "body": "*", + }, + ] + request, metadata = self._interceptor.pre_async_batch_annotate_images( + request, metadata + ) + pb_request = image_annotator.AsyncBatchAnnotateImagesRequest.pb(request) + transcoded_request = path_template.transcode(http_options, pb_request) + + # Jsonify the request body + + body = json_format.MessageToJson( + transcoded_request["body"], + including_default_value_fields=False, + use_integers_for_enums=True, + ) + uri = transcoded_request["uri"] + method = transcoded_request["method"] + + # Jsonify the query params + query_params = json.loads( + json_format.MessageToJson( + transcoded_request["query_params"], + including_default_value_fields=False, + use_integers_for_enums=True, + ) + ) + query_params.update(self._get_unset_required_fields(query_params)) + + query_params["$alt"] = "json;enum-encoding=int" + + # Send the request + headers = dict(metadata) + headers["Content-Type"] = "application/json" + response = getattr(self._session, method)( + "{host}{uri}".format(host=self._host, uri=uri), + timeout=timeout, + headers=headers, + params=rest_helpers.flatten_query_params(query_params, strict=True), + data=body, + ) + + # In case of error, raise the appropriate core_exceptions.GoogleAPICallError exception + # subclass. + if response.status_code >= 400: + raise core_exceptions.from_http_response(response) + + # Return the response + resp = operations_pb2.Operation() + json_format.Parse(response.content, resp, ignore_unknown_fields=True) + resp = self._interceptor.post_async_batch_annotate_images(resp) + return resp + + class _BatchAnnotateFiles(ImageAnnotatorRestStub): + def __hash__(self): + return hash("BatchAnnotateFiles") + + __REQUIRED_FIELDS_DEFAULT_VALUES: Dict[str, Any] = {} + + @classmethod + def _get_unset_required_fields(cls, message_dict): + return { + k: v + for k, v in cls.__REQUIRED_FIELDS_DEFAULT_VALUES.items() + if k not in message_dict + } + + def __call__( + self, + request: image_annotator.BatchAnnotateFilesRequest, + *, + retry: OptionalRetry = gapic_v1.method.DEFAULT, + timeout: Optional[float] = None, + metadata: Sequence[Tuple[str, str]] = (), + ) -> image_annotator.BatchAnnotateFilesResponse: + r"""Call the batch annotate files method over HTTP. + + Args: + request (~.image_annotator.BatchAnnotateFilesRequest): + The request object. A list of requests to annotate files + using the BatchAnnotateFiles API. + + retry (google.api_core.retry.Retry): Designation of what errors, if any, + should be retried. + timeout (float): The timeout for this request. + metadata (Sequence[Tuple[str, str]]): Strings which should be + sent along with the request as metadata. + + Returns: + ~.image_annotator.BatchAnnotateFilesResponse: + A list of file annotation responses. + """ + + http_options: List[Dict[str, str]] = [ + { + "method": "post", + "uri": "/v1p4beta1/files:annotate", + "body": "*", + }, + ] + request, metadata = self._interceptor.pre_batch_annotate_files( + request, metadata + ) + pb_request = image_annotator.BatchAnnotateFilesRequest.pb(request) + transcoded_request = path_template.transcode(http_options, pb_request) + + # Jsonify the request body + + body = json_format.MessageToJson( + transcoded_request["body"], + including_default_value_fields=False, + use_integers_for_enums=True, + ) + uri = transcoded_request["uri"] + method = transcoded_request["method"] + + # Jsonify the query params + query_params = json.loads( + json_format.MessageToJson( + transcoded_request["query_params"], + including_default_value_fields=False, + use_integers_for_enums=True, + ) + ) + query_params.update(self._get_unset_required_fields(query_params)) + + query_params["$alt"] = "json;enum-encoding=int" + + # Send the request + headers = dict(metadata) + headers["Content-Type"] = "application/json" + response = getattr(self._session, method)( + "{host}{uri}".format(host=self._host, uri=uri), + timeout=timeout, + headers=headers, + params=rest_helpers.flatten_query_params(query_params, strict=True), + data=body, + ) + + # In case of error, raise the appropriate core_exceptions.GoogleAPICallError exception + # subclass. + if response.status_code >= 400: + raise core_exceptions.from_http_response(response) + + # Return the response + resp = image_annotator.BatchAnnotateFilesResponse() + pb_resp = image_annotator.BatchAnnotateFilesResponse.pb(resp) + + json_format.Parse(response.content, pb_resp, ignore_unknown_fields=True) + resp = self._interceptor.post_batch_annotate_files(resp) + return resp + + class _BatchAnnotateImages(ImageAnnotatorRestStub): + def __hash__(self): + return hash("BatchAnnotateImages") + + __REQUIRED_FIELDS_DEFAULT_VALUES: Dict[str, Any] = {} + + @classmethod + def _get_unset_required_fields(cls, message_dict): + return { + k: v + for k, v in cls.__REQUIRED_FIELDS_DEFAULT_VALUES.items() + if k not in message_dict + } + + def __call__( + self, + request: image_annotator.BatchAnnotateImagesRequest, + *, + retry: OptionalRetry = gapic_v1.method.DEFAULT, + timeout: Optional[float] = None, + metadata: Sequence[Tuple[str, str]] = (), + ) -> image_annotator.BatchAnnotateImagesResponse: + r"""Call the batch annotate images method over HTTP. + + Args: + request (~.image_annotator.BatchAnnotateImagesRequest): + The request object. Multiple image annotation requests + are batched into a single service call. + + retry (google.api_core.retry.Retry): Designation of what errors, if any, + should be retried. + timeout (float): The timeout for this request. + metadata (Sequence[Tuple[str, str]]): Strings which should be + sent along with the request as metadata. + + Returns: + ~.image_annotator.BatchAnnotateImagesResponse: + Response to a batch image annotation + request. + + """ + + http_options: List[Dict[str, str]] = [ + { + "method": "post", + "uri": "/v1p4beta1/images:annotate", + "body": "*", + }, + ] + request, metadata = self._interceptor.pre_batch_annotate_images( + request, metadata + ) + pb_request = image_annotator.BatchAnnotateImagesRequest.pb(request) + transcoded_request = path_template.transcode(http_options, pb_request) + + # Jsonify the request body + + body = json_format.MessageToJson( + transcoded_request["body"], + including_default_value_fields=False, + use_integers_for_enums=True, + ) + uri = transcoded_request["uri"] + method = transcoded_request["method"] + + # Jsonify the query params + query_params = json.loads( + json_format.MessageToJson( + transcoded_request["query_params"], + including_default_value_fields=False, + use_integers_for_enums=True, + ) + ) + query_params.update(self._get_unset_required_fields(query_params)) + + query_params["$alt"] = "json;enum-encoding=int" + + # Send the request + headers = dict(metadata) + headers["Content-Type"] = "application/json" + response = getattr(self._session, method)( + "{host}{uri}".format(host=self._host, uri=uri), + timeout=timeout, + headers=headers, + params=rest_helpers.flatten_query_params(query_params, strict=True), + data=body, + ) + + # In case of error, raise the appropriate core_exceptions.GoogleAPICallError exception + # subclass. + if response.status_code >= 400: + raise core_exceptions.from_http_response(response) + + # Return the response + resp = image_annotator.BatchAnnotateImagesResponse() + pb_resp = image_annotator.BatchAnnotateImagesResponse.pb(resp) + + json_format.Parse(response.content, pb_resp, ignore_unknown_fields=True) + resp = self._interceptor.post_batch_annotate_images(resp) + return resp + + @property + def async_batch_annotate_files( + self, + ) -> Callable[ + [image_annotator.AsyncBatchAnnotateFilesRequest], operations_pb2.Operation + ]: + # The return type is fine, but mypy isn't sophisticated enough to determine what's going on here. + # In C++ this would require a dynamic_cast + return self._AsyncBatchAnnotateFiles(self._session, self._host, self._interceptor) # type: ignore + + @property + def async_batch_annotate_images( + self, + ) -> Callable[ + [image_annotator.AsyncBatchAnnotateImagesRequest], operations_pb2.Operation + ]: + # The return type is fine, but mypy isn't sophisticated enough to determine what's going on here. + # In C++ this would require a dynamic_cast + return self._AsyncBatchAnnotateImages(self._session, self._host, self._interceptor) # type: ignore + + @property + def batch_annotate_files( + self, + ) -> Callable[ + [image_annotator.BatchAnnotateFilesRequest], + image_annotator.BatchAnnotateFilesResponse, + ]: + # The return type is fine, but mypy isn't sophisticated enough to determine what's going on here. + # In C++ this would require a dynamic_cast + return self._BatchAnnotateFiles(self._session, self._host, self._interceptor) # type: ignore + + @property + def batch_annotate_images( + self, + ) -> Callable[ + [image_annotator.BatchAnnotateImagesRequest], + image_annotator.BatchAnnotateImagesResponse, + ]: + # The return type is fine, but mypy isn't sophisticated enough to determine what's going on here. + # In C++ this would require a dynamic_cast + return self._BatchAnnotateImages(self._session, self._host, self._interceptor) # type: ignore + + @property + def kind(self) -> str: + return "rest" + + def close(self): + self._session.close() + + +__all__ = ("ImageAnnotatorRestTransport",) diff --git a/google/cloud/vision_v1p4beta1/services/product_search/client.py b/google/cloud/vision_v1p4beta1/services/product_search/client.py index e94709ae..eb3eaac0 100644 --- a/google/cloud/vision_v1p4beta1/services/product_search/client.py +++ b/google/cloud/vision_v1p4beta1/services/product_search/client.py @@ -58,6 +58,7 @@ from .transports.base import ProductSearchTransport, DEFAULT_CLIENT_INFO from .transports.grpc import ProductSearchGrpcTransport from .transports.grpc_asyncio import ProductSearchGrpcAsyncIOTransport +from .transports.rest import ProductSearchRestTransport class ProductSearchClientMeta(type): @@ -71,6 +72,7 @@ class ProductSearchClientMeta(type): _transport_registry = OrderedDict() # type: Dict[str, Type[ProductSearchTransport]] _transport_registry["grpc"] = ProductSearchGrpcTransport _transport_registry["grpc_asyncio"] = ProductSearchGrpcAsyncIOTransport + _transport_registry["rest"] = ProductSearchRestTransport def get_transport_class( cls, diff --git a/google/cloud/vision_v1p4beta1/services/product_search/transports/__init__.py b/google/cloud/vision_v1p4beta1/services/product_search/transports/__init__.py index 40a758f5..2878a076 100644 --- a/google/cloud/vision_v1p4beta1/services/product_search/transports/__init__.py +++ b/google/cloud/vision_v1p4beta1/services/product_search/transports/__init__.py @@ -19,15 +19,20 @@ from .base import ProductSearchTransport from .grpc import ProductSearchGrpcTransport from .grpc_asyncio import ProductSearchGrpcAsyncIOTransport +from .rest import ProductSearchRestTransport +from .rest import ProductSearchRestInterceptor # Compile a registry of transports. _transport_registry = OrderedDict() # type: Dict[str, Type[ProductSearchTransport]] _transport_registry["grpc"] = ProductSearchGrpcTransport _transport_registry["grpc_asyncio"] = ProductSearchGrpcAsyncIOTransport +_transport_registry["rest"] = ProductSearchRestTransport __all__ = ( "ProductSearchTransport", "ProductSearchGrpcTransport", "ProductSearchGrpcAsyncIOTransport", + "ProductSearchRestTransport", + "ProductSearchRestInterceptor", ) diff --git a/google/cloud/vision_v1p4beta1/services/product_search/transports/rest.py b/google/cloud/vision_v1p4beta1/services/product_search/transports/rest.py new file mode 100644 index 00000000..0360520d --- /dev/null +++ b/google/cloud/vision_v1p4beta1/services/product_search/transports/rest.py @@ -0,0 +1,2684 @@ +# -*- coding: utf-8 -*- +# Copyright 2022 Google LLC +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. +# + +from google.auth.transport.requests import AuthorizedSession # type: ignore +import json # type: ignore +import grpc # type: ignore +from google.auth.transport.grpc import SslCredentials # type: ignore +from google.auth import credentials as ga_credentials # type: ignore +from google.api_core import exceptions as core_exceptions +from google.api_core import retry as retries +from google.api_core import rest_helpers +from google.api_core import rest_streaming +from google.api_core import path_template +from google.api_core import gapic_v1 + +from google.protobuf import json_format +from google.api_core import operations_v1 +from requests import __version__ as requests_version +import dataclasses +import re +from typing import Any, Callable, Dict, List, Optional, Sequence, Tuple, Union +import warnings + +try: + OptionalRetry = Union[retries.Retry, gapic_v1.method._MethodDefault] +except AttributeError: # pragma: NO COVER + OptionalRetry = Union[retries.Retry, object] # type: ignore + + +from google.cloud.vision_v1p4beta1.types import product_search_service +from google.longrunning import operations_pb2 # type: ignore +from google.protobuf import empty_pb2 # type: ignore + +from .base import ( + ProductSearchTransport, + DEFAULT_CLIENT_INFO as BASE_DEFAULT_CLIENT_INFO, +) + + +DEFAULT_CLIENT_INFO = gapic_v1.client_info.ClientInfo( + gapic_version=BASE_DEFAULT_CLIENT_INFO.gapic_version, + grpc_version=None, + rest_version=requests_version, +) + + +class ProductSearchRestInterceptor: + """Interceptor for ProductSearch. + + Interceptors are used to manipulate requests, request metadata, and responses + in arbitrary ways. + Example use cases include: + * Logging + * Verifying requests according to service or custom semantics + * Stripping extraneous information from responses + + These use cases and more can be enabled by injecting an + instance of a custom subclass when constructing the ProductSearchRestTransport. + + .. code-block:: python + class MyCustomProductSearchInterceptor(ProductSearchRestInterceptor): + def pre_add_product_to_product_set(self, request, metadata): + logging.log(f"Received request: {request}") + return request, metadata + + def pre_create_product(self, request, metadata): + logging.log(f"Received request: {request}") + return request, metadata + + def post_create_product(self, response): + logging.log(f"Received response: {response}") + return response + + def pre_create_product_set(self, request, metadata): + logging.log(f"Received request: {request}") + return request, metadata + + def post_create_product_set(self, response): + logging.log(f"Received response: {response}") + return response + + def pre_create_reference_image(self, request, metadata): + logging.log(f"Received request: {request}") + return request, metadata + + def post_create_reference_image(self, response): + logging.log(f"Received response: {response}") + return response + + def pre_delete_product(self, request, metadata): + logging.log(f"Received request: {request}") + return request, metadata + + def pre_delete_product_set(self, request, metadata): + logging.log(f"Received request: {request}") + return request, metadata + + def pre_delete_reference_image(self, request, metadata): + logging.log(f"Received request: {request}") + return request, metadata + + def pre_get_product(self, request, metadata): + logging.log(f"Received request: {request}") + return request, metadata + + def post_get_product(self, response): + logging.log(f"Received response: {response}") + return response + + def pre_get_product_set(self, request, metadata): + logging.log(f"Received request: {request}") + return request, metadata + + def post_get_product_set(self, response): + logging.log(f"Received response: {response}") + return response + + def pre_get_reference_image(self, request, metadata): + logging.log(f"Received request: {request}") + return request, metadata + + def post_get_reference_image(self, response): + logging.log(f"Received response: {response}") + return response + + def pre_import_product_sets(self, request, metadata): + logging.log(f"Received request: {request}") + return request, metadata + + def post_import_product_sets(self, response): + logging.log(f"Received response: {response}") + return response + + def pre_list_products(self, request, metadata): + logging.log(f"Received request: {request}") + return request, metadata + + def post_list_products(self, response): + logging.log(f"Received response: {response}") + return response + + def pre_list_product_sets(self, request, metadata): + logging.log(f"Received request: {request}") + return request, metadata + + def post_list_product_sets(self, response): + logging.log(f"Received response: {response}") + return response + + def pre_list_products_in_product_set(self, request, metadata): + logging.log(f"Received request: {request}") + return request, metadata + + def post_list_products_in_product_set(self, response): + logging.log(f"Received response: {response}") + return response + + def pre_list_reference_images(self, request, metadata): + logging.log(f"Received request: {request}") + return request, metadata + + def post_list_reference_images(self, response): + logging.log(f"Received response: {response}") + return response + + def pre_purge_products(self, request, metadata): + logging.log(f"Received request: {request}") + return request, metadata + + def post_purge_products(self, response): + logging.log(f"Received response: {response}") + return response + + def pre_remove_product_from_product_set(self, request, metadata): + logging.log(f"Received request: {request}") + return request, metadata + + def pre_update_product(self, request, metadata): + logging.log(f"Received request: {request}") + return request, metadata + + def post_update_product(self, response): + logging.log(f"Received response: {response}") + return response + + def pre_update_product_set(self, request, metadata): + logging.log(f"Received request: {request}") + return request, metadata + + def post_update_product_set(self, response): + logging.log(f"Received response: {response}") + return response + + transport = ProductSearchRestTransport(interceptor=MyCustomProductSearchInterceptor()) + client = ProductSearchClient(transport=transport) + + + """ + + def pre_add_product_to_product_set( + self, + request: product_search_service.AddProductToProductSetRequest, + metadata: Sequence[Tuple[str, str]], + ) -> Tuple[ + product_search_service.AddProductToProductSetRequest, Sequence[Tuple[str, str]] + ]: + """Pre-rpc interceptor for add_product_to_product_set + + Override in a subclass to manipulate the request or metadata + before they are sent to the ProductSearch server. + """ + return request, metadata + + def pre_create_product( + self, + request: product_search_service.CreateProductRequest, + metadata: Sequence[Tuple[str, str]], + ) -> Tuple[product_search_service.CreateProductRequest, Sequence[Tuple[str, str]]]: + """Pre-rpc interceptor for create_product + + Override in a subclass to manipulate the request or metadata + before they are sent to the ProductSearch server. + """ + return request, metadata + + def post_create_product( + self, response: product_search_service.Product + ) -> product_search_service.Product: + """Post-rpc interceptor for create_product + + Override in a subclass to manipulate the response + after it is returned by the ProductSearch server but before + it is returned to user code. + """ + return response + + def pre_create_product_set( + self, + request: product_search_service.CreateProductSetRequest, + metadata: Sequence[Tuple[str, str]], + ) -> Tuple[ + product_search_service.CreateProductSetRequest, Sequence[Tuple[str, str]] + ]: + """Pre-rpc interceptor for create_product_set + + Override in a subclass to manipulate the request or metadata + before they are sent to the ProductSearch server. + """ + return request, metadata + + def post_create_product_set( + self, response: product_search_service.ProductSet + ) -> product_search_service.ProductSet: + """Post-rpc interceptor for create_product_set + + Override in a subclass to manipulate the response + after it is returned by the ProductSearch server but before + it is returned to user code. + """ + return response + + def pre_create_reference_image( + self, + request: product_search_service.CreateReferenceImageRequest, + metadata: Sequence[Tuple[str, str]], + ) -> Tuple[ + product_search_service.CreateReferenceImageRequest, Sequence[Tuple[str, str]] + ]: + """Pre-rpc interceptor for create_reference_image + + Override in a subclass to manipulate the request or metadata + before they are sent to the ProductSearch server. + """ + return request, metadata + + def post_create_reference_image( + self, response: product_search_service.ReferenceImage + ) -> product_search_service.ReferenceImage: + """Post-rpc interceptor for create_reference_image + + Override in a subclass to manipulate the response + after it is returned by the ProductSearch server but before + it is returned to user code. + """ + return response + + def pre_delete_product( + self, + request: product_search_service.DeleteProductRequest, + metadata: Sequence[Tuple[str, str]], + ) -> Tuple[product_search_service.DeleteProductRequest, Sequence[Tuple[str, str]]]: + """Pre-rpc interceptor for delete_product + + Override in a subclass to manipulate the request or metadata + before they are sent to the ProductSearch server. + """ + return request, metadata + + def pre_delete_product_set( + self, + request: product_search_service.DeleteProductSetRequest, + metadata: Sequence[Tuple[str, str]], + ) -> Tuple[ + product_search_service.DeleteProductSetRequest, Sequence[Tuple[str, str]] + ]: + """Pre-rpc interceptor for delete_product_set + + Override in a subclass to manipulate the request or metadata + before they are sent to the ProductSearch server. + """ + return request, metadata + + def pre_delete_reference_image( + self, + request: product_search_service.DeleteReferenceImageRequest, + metadata: Sequence[Tuple[str, str]], + ) -> Tuple[ + product_search_service.DeleteReferenceImageRequest, Sequence[Tuple[str, str]] + ]: + """Pre-rpc interceptor for delete_reference_image + + Override in a subclass to manipulate the request or metadata + before they are sent to the ProductSearch server. + """ + return request, metadata + + def pre_get_product( + self, + request: product_search_service.GetProductRequest, + metadata: Sequence[Tuple[str, str]], + ) -> Tuple[product_search_service.GetProductRequest, Sequence[Tuple[str, str]]]: + """Pre-rpc interceptor for get_product + + Override in a subclass to manipulate the request or metadata + before they are sent to the ProductSearch server. + """ + return request, metadata + + def post_get_product( + self, response: product_search_service.Product + ) -> product_search_service.Product: + """Post-rpc interceptor for get_product + + Override in a subclass to manipulate the response + after it is returned by the ProductSearch server but before + it is returned to user code. + """ + return response + + def pre_get_product_set( + self, + request: product_search_service.GetProductSetRequest, + metadata: Sequence[Tuple[str, str]], + ) -> Tuple[product_search_service.GetProductSetRequest, Sequence[Tuple[str, str]]]: + """Pre-rpc interceptor for get_product_set + + Override in a subclass to manipulate the request or metadata + before they are sent to the ProductSearch server. + """ + return request, metadata + + def post_get_product_set( + self, response: product_search_service.ProductSet + ) -> product_search_service.ProductSet: + """Post-rpc interceptor for get_product_set + + Override in a subclass to manipulate the response + after it is returned by the ProductSearch server but before + it is returned to user code. + """ + return response + + def pre_get_reference_image( + self, + request: product_search_service.GetReferenceImageRequest, + metadata: Sequence[Tuple[str, str]], + ) -> Tuple[ + product_search_service.GetReferenceImageRequest, Sequence[Tuple[str, str]] + ]: + """Pre-rpc interceptor for get_reference_image + + Override in a subclass to manipulate the request or metadata + before they are sent to the ProductSearch server. + """ + return request, metadata + + def post_get_reference_image( + self, response: product_search_service.ReferenceImage + ) -> product_search_service.ReferenceImage: + """Post-rpc interceptor for get_reference_image + + Override in a subclass to manipulate the response + after it is returned by the ProductSearch server but before + it is returned to user code. + """ + return response + + def pre_import_product_sets( + self, + request: product_search_service.ImportProductSetsRequest, + metadata: Sequence[Tuple[str, str]], + ) -> Tuple[ + product_search_service.ImportProductSetsRequest, Sequence[Tuple[str, str]] + ]: + """Pre-rpc interceptor for import_product_sets + + Override in a subclass to manipulate the request or metadata + before they are sent to the ProductSearch server. + """ + return request, metadata + + def post_import_product_sets( + self, response: operations_pb2.Operation + ) -> operations_pb2.Operation: + """Post-rpc interceptor for import_product_sets + + Override in a subclass to manipulate the response + after it is returned by the ProductSearch server but before + it is returned to user code. + """ + return response + + def pre_list_products( + self, + request: product_search_service.ListProductsRequest, + metadata: Sequence[Tuple[str, str]], + ) -> Tuple[product_search_service.ListProductsRequest, Sequence[Tuple[str, str]]]: + """Pre-rpc interceptor for list_products + + Override in a subclass to manipulate the request or metadata + before they are sent to the ProductSearch server. + """ + return request, metadata + + def post_list_products( + self, response: product_search_service.ListProductsResponse + ) -> product_search_service.ListProductsResponse: + """Post-rpc interceptor for list_products + + Override in a subclass to manipulate the response + after it is returned by the ProductSearch server but before + it is returned to user code. + """ + return response + + def pre_list_product_sets( + self, + request: product_search_service.ListProductSetsRequest, + metadata: Sequence[Tuple[str, str]], + ) -> Tuple[ + product_search_service.ListProductSetsRequest, Sequence[Tuple[str, str]] + ]: + """Pre-rpc interceptor for list_product_sets + + Override in a subclass to manipulate the request or metadata + before they are sent to the ProductSearch server. + """ + return request, metadata + + def post_list_product_sets( + self, response: product_search_service.ListProductSetsResponse + ) -> product_search_service.ListProductSetsResponse: + """Post-rpc interceptor for list_product_sets + + Override in a subclass to manipulate the response + after it is returned by the ProductSearch server but before + it is returned to user code. + """ + return response + + def pre_list_products_in_product_set( + self, + request: product_search_service.ListProductsInProductSetRequest, + metadata: Sequence[Tuple[str, str]], + ) -> Tuple[ + product_search_service.ListProductsInProductSetRequest, + Sequence[Tuple[str, str]], + ]: + """Pre-rpc interceptor for list_products_in_product_set + + Override in a subclass to manipulate the request or metadata + before they are sent to the ProductSearch server. + """ + return request, metadata + + def post_list_products_in_product_set( + self, response: product_search_service.ListProductsInProductSetResponse + ) -> product_search_service.ListProductsInProductSetResponse: + """Post-rpc interceptor for list_products_in_product_set + + Override in a subclass to manipulate the response + after it is returned by the ProductSearch server but before + it is returned to user code. + """ + return response + + def pre_list_reference_images( + self, + request: product_search_service.ListReferenceImagesRequest, + metadata: Sequence[Tuple[str, str]], + ) -> Tuple[ + product_search_service.ListReferenceImagesRequest, Sequence[Tuple[str, str]] + ]: + """Pre-rpc interceptor for list_reference_images + + Override in a subclass to manipulate the request or metadata + before they are sent to the ProductSearch server. + """ + return request, metadata + + def post_list_reference_images( + self, response: product_search_service.ListReferenceImagesResponse + ) -> product_search_service.ListReferenceImagesResponse: + """Post-rpc interceptor for list_reference_images + + Override in a subclass to manipulate the response + after it is returned by the ProductSearch server but before + it is returned to user code. + """ + return response + + def pre_purge_products( + self, + request: product_search_service.PurgeProductsRequest, + metadata: Sequence[Tuple[str, str]], + ) -> Tuple[product_search_service.PurgeProductsRequest, Sequence[Tuple[str, str]]]: + """Pre-rpc interceptor for purge_products + + Override in a subclass to manipulate the request or metadata + before they are sent to the ProductSearch server. + """ + return request, metadata + + def post_purge_products( + self, response: operations_pb2.Operation + ) -> operations_pb2.Operation: + """Post-rpc interceptor for purge_products + + Override in a subclass to manipulate the response + after it is returned by the ProductSearch server but before + it is returned to user code. + """ + return response + + def pre_remove_product_from_product_set( + self, + request: product_search_service.RemoveProductFromProductSetRequest, + metadata: Sequence[Tuple[str, str]], + ) -> Tuple[ + product_search_service.RemoveProductFromProductSetRequest, + Sequence[Tuple[str, str]], + ]: + """Pre-rpc interceptor for remove_product_from_product_set + + Override in a subclass to manipulate the request or metadata + before they are sent to the ProductSearch server. + """ + return request, metadata + + def pre_update_product( + self, + request: product_search_service.UpdateProductRequest, + metadata: Sequence[Tuple[str, str]], + ) -> Tuple[product_search_service.UpdateProductRequest, Sequence[Tuple[str, str]]]: + """Pre-rpc interceptor for update_product + + Override in a subclass to manipulate the request or metadata + before they are sent to the ProductSearch server. + """ + return request, metadata + + def post_update_product( + self, response: product_search_service.Product + ) -> product_search_service.Product: + """Post-rpc interceptor for update_product + + Override in a subclass to manipulate the response + after it is returned by the ProductSearch server but before + it is returned to user code. + """ + return response + + def pre_update_product_set( + self, + request: product_search_service.UpdateProductSetRequest, + metadata: Sequence[Tuple[str, str]], + ) -> Tuple[ + product_search_service.UpdateProductSetRequest, Sequence[Tuple[str, str]] + ]: + """Pre-rpc interceptor for update_product_set + + Override in a subclass to manipulate the request or metadata + before they are sent to the ProductSearch server. + """ + return request, metadata + + def post_update_product_set( + self, response: product_search_service.ProductSet + ) -> product_search_service.ProductSet: + """Post-rpc interceptor for update_product_set + + Override in a subclass to manipulate the response + after it is returned by the ProductSearch server but before + it is returned to user code. + """ + return response + + +@dataclasses.dataclass +class ProductSearchRestStub: + _session: AuthorizedSession + _host: str + _interceptor: ProductSearchRestInterceptor + + +class ProductSearchRestTransport(ProductSearchTransport): + """REST backend transport for ProductSearch. + + Manages Products and ProductSets of reference images for use in + product search. It uses the following resource model: + + - The API has a collection of + [ProductSet][google.cloud.vision.v1p4beta1.ProductSet] resources, + named ``projects/*/locations/*/productSets/*``, which acts as a + way to put different products into groups to limit + identification. + + In parallel, + + - The API has a collection of + [Product][google.cloud.vision.v1p4beta1.Product] resources, named + ``projects/*/locations/*/products/*`` + + - Each [Product][google.cloud.vision.v1p4beta1.Product] has a + collection of + [ReferenceImage][google.cloud.vision.v1p4beta1.ReferenceImage] + resources, named + ``projects/*/locations/*/products/*/referenceImages/*`` + + This class defines the same methods as the primary client, so the + primary client can load the underlying transport implementation + and call it. + + It sends JSON representations of protocol buffers over HTTP/1.1 + + """ + + def __init__( + self, + *, + host: str = "vision.googleapis.com", + credentials: Optional[ga_credentials.Credentials] = None, + credentials_file: Optional[str] = None, + scopes: Optional[Sequence[str]] = None, + client_cert_source_for_mtls: Optional[Callable[[], Tuple[bytes, bytes]]] = None, + quota_project_id: Optional[str] = None, + client_info: gapic_v1.client_info.ClientInfo = DEFAULT_CLIENT_INFO, + always_use_jwt_access: Optional[bool] = False, + url_scheme: str = "https", + interceptor: Optional[ProductSearchRestInterceptor] = None, + api_audience: Optional[str] = None, + ) -> None: + """Instantiate the transport. + + Args: + host (Optional[str]): + The hostname to connect to. + credentials (Optional[google.auth.credentials.Credentials]): The + authorization credentials to attach to requests. These + credentials identify the application to the service; if none + are specified, the client will attempt to ascertain the + credentials from the environment. + + credentials_file (Optional[str]): A file with credentials that can + be loaded with :func:`google.auth.load_credentials_from_file`. + This argument is ignored if ``channel`` is provided. + scopes (Optional(Sequence[str])): A list of scopes. This argument is + ignored if ``channel`` is provided. + client_cert_source_for_mtls (Callable[[], Tuple[bytes, bytes]]): Client + certificate to configure mutual TLS HTTP channel. It is ignored + if ``channel`` is provided. + quota_project_id (Optional[str]): An optional project to use for billing + and quota. + client_info (google.api_core.gapic_v1.client_info.ClientInfo): + The client info used to send a user-agent string along with + API requests. If ``None``, then default info will be used. + Generally, you only need to set this if you are developing + your own client library. + always_use_jwt_access (Optional[bool]): Whether self signed JWT should + be used for service account credentials. + url_scheme: the protocol scheme for the API endpoint. Normally + "https", but for testing or local servers, + "http" can be specified. + """ + # Run the base constructor + # TODO(yon-mg): resolve other ctor params i.e. scopes, quota, etc. + # TODO: When custom host (api_endpoint) is set, `scopes` must *also* be set on the + # credentials object + maybe_url_match = re.match("^(?Phttp(?:s)?://)?(?P.*)$", host) + if maybe_url_match is None: + raise ValueError( + f"Unexpected hostname structure: {host}" + ) # pragma: NO COVER + + url_match_items = maybe_url_match.groupdict() + + host = f"{url_scheme}://{host}" if not url_match_items["scheme"] else host + + super().__init__( + host=host, + credentials=credentials, + client_info=client_info, + always_use_jwt_access=always_use_jwt_access, + api_audience=api_audience, + ) + self._session = AuthorizedSession( + self._credentials, default_host=self.DEFAULT_HOST + ) + self._operations_client: Optional[operations_v1.AbstractOperationsClient] = None + if client_cert_source_for_mtls: + self._session.configure_mtls_channel(client_cert_source_for_mtls) + self._interceptor = interceptor or ProductSearchRestInterceptor() + self._prep_wrapped_messages(client_info) + + @property + def operations_client(self) -> operations_v1.AbstractOperationsClient: + """Create the client designed to process long-running operations. + + This property caches on the instance; repeated calls return the same + client. + """ + # Only create a new client if we do not already have one. + if self._operations_client is None: + http_options: Dict[str, List[Dict[str, str]]] = {} + + rest_transport = operations_v1.OperationsRestTransport( + host=self._host, + # use the credentials which are saved + credentials=self._credentials, + scopes=self._scopes, + http_options=http_options, + path_prefix="v1p4beta1", + ) + + self._operations_client = operations_v1.AbstractOperationsClient( + transport=rest_transport + ) + + # Return the client from cache. + return self._operations_client + + class _AddProductToProductSet(ProductSearchRestStub): + def __hash__(self): + return hash("AddProductToProductSet") + + __REQUIRED_FIELDS_DEFAULT_VALUES: Dict[str, Any] = {} + + @classmethod + def _get_unset_required_fields(cls, message_dict): + return { + k: v + for k, v in cls.__REQUIRED_FIELDS_DEFAULT_VALUES.items() + if k not in message_dict + } + + def __call__( + self, + request: product_search_service.AddProductToProductSetRequest, + *, + retry: OptionalRetry = gapic_v1.method.DEFAULT, + timeout: Optional[float] = None, + metadata: Sequence[Tuple[str, str]] = (), + ): + r"""Call the add product to product + set method over HTTP. + + Args: + request (~.product_search_service.AddProductToProductSetRequest): + The request object. Request message for the ``AddProductToProductSet`` + method. + + retry (google.api_core.retry.Retry): Designation of what errors, if any, + should be retried. + timeout (float): The timeout for this request. + metadata (Sequence[Tuple[str, str]]): Strings which should be + sent along with the request as metadata. + """ + + http_options: List[Dict[str, str]] = [ + { + "method": "post", + "uri": "/v1p4beta1/{name=projects/*/locations/*/productSets/*}:addProduct", + "body": "*", + }, + ] + request, metadata = self._interceptor.pre_add_product_to_product_set( + request, metadata + ) + pb_request = product_search_service.AddProductToProductSetRequest.pb( + request + ) + transcoded_request = path_template.transcode(http_options, pb_request) + + # Jsonify the request body + + body = json_format.MessageToJson( + transcoded_request["body"], + including_default_value_fields=False, + use_integers_for_enums=True, + ) + uri = transcoded_request["uri"] + method = transcoded_request["method"] + + # Jsonify the query params + query_params = json.loads( + json_format.MessageToJson( + transcoded_request["query_params"], + including_default_value_fields=False, + use_integers_for_enums=True, + ) + ) + query_params.update(self._get_unset_required_fields(query_params)) + + query_params["$alt"] = "json;enum-encoding=int" + + # Send the request + headers = dict(metadata) + headers["Content-Type"] = "application/json" + response = getattr(self._session, method)( + "{host}{uri}".format(host=self._host, uri=uri), + timeout=timeout, + headers=headers, + params=rest_helpers.flatten_query_params(query_params, strict=True), + data=body, + ) + + # In case of error, raise the appropriate core_exceptions.GoogleAPICallError exception + # subclass. + if response.status_code >= 400: + raise core_exceptions.from_http_response(response) + + class _CreateProduct(ProductSearchRestStub): + def __hash__(self): + return hash("CreateProduct") + + __REQUIRED_FIELDS_DEFAULT_VALUES: Dict[str, Any] = {} + + @classmethod + def _get_unset_required_fields(cls, message_dict): + return { + k: v + for k, v in cls.__REQUIRED_FIELDS_DEFAULT_VALUES.items() + if k not in message_dict + } + + def __call__( + self, + request: product_search_service.CreateProductRequest, + *, + retry: OptionalRetry = gapic_v1.method.DEFAULT, + timeout: Optional[float] = None, + metadata: Sequence[Tuple[str, str]] = (), + ) -> product_search_service.Product: + r"""Call the create product method over HTTP. + + Args: + request (~.product_search_service.CreateProductRequest): + The request object. Request message for the ``CreateProduct`` method. + retry (google.api_core.retry.Retry): Designation of what errors, if any, + should be retried. + timeout (float): The timeout for this request. + metadata (Sequence[Tuple[str, str]]): Strings which should be + sent along with the request as metadata. + + Returns: + ~.product_search_service.Product: + A Product contains ReferenceImages. + """ + + http_options: List[Dict[str, str]] = [ + { + "method": "post", + "uri": "/v1p4beta1/{parent=projects/*/locations/*}/products", + "body": "product", + }, + ] + request, metadata = self._interceptor.pre_create_product(request, metadata) + pb_request = product_search_service.CreateProductRequest.pb(request) + transcoded_request = path_template.transcode(http_options, pb_request) + + # Jsonify the request body + + body = json_format.MessageToJson( + transcoded_request["body"], + including_default_value_fields=False, + use_integers_for_enums=True, + ) + uri = transcoded_request["uri"] + method = transcoded_request["method"] + + # Jsonify the query params + query_params = json.loads( + json_format.MessageToJson( + transcoded_request["query_params"], + including_default_value_fields=False, + use_integers_for_enums=True, + ) + ) + query_params.update(self._get_unset_required_fields(query_params)) + + query_params["$alt"] = "json;enum-encoding=int" + + # Send the request + headers = dict(metadata) + headers["Content-Type"] = "application/json" + response = getattr(self._session, method)( + "{host}{uri}".format(host=self._host, uri=uri), + timeout=timeout, + headers=headers, + params=rest_helpers.flatten_query_params(query_params, strict=True), + data=body, + ) + + # In case of error, raise the appropriate core_exceptions.GoogleAPICallError exception + # subclass. + if response.status_code >= 400: + raise core_exceptions.from_http_response(response) + + # Return the response + resp = product_search_service.Product() + pb_resp = product_search_service.Product.pb(resp) + + json_format.Parse(response.content, pb_resp, ignore_unknown_fields=True) + resp = self._interceptor.post_create_product(resp) + return resp + + class _CreateProductSet(ProductSearchRestStub): + def __hash__(self): + return hash("CreateProductSet") + + __REQUIRED_FIELDS_DEFAULT_VALUES: Dict[str, Any] = {} + + @classmethod + def _get_unset_required_fields(cls, message_dict): + return { + k: v + for k, v in cls.__REQUIRED_FIELDS_DEFAULT_VALUES.items() + if k not in message_dict + } + + def __call__( + self, + request: product_search_service.CreateProductSetRequest, + *, + retry: OptionalRetry = gapic_v1.method.DEFAULT, + timeout: Optional[float] = None, + metadata: Sequence[Tuple[str, str]] = (), + ) -> product_search_service.ProductSet: + r"""Call the create product set method over HTTP. + + Args: + request (~.product_search_service.CreateProductSetRequest): + The request object. Request message for the ``CreateProductSet`` method. + retry (google.api_core.retry.Retry): Designation of what errors, if any, + should be retried. + timeout (float): The timeout for this request. + metadata (Sequence[Tuple[str, str]]): Strings which should be + sent along with the request as metadata. + + Returns: + ~.product_search_service.ProductSet: + A ProductSet contains Products. A + ProductSet can contain a maximum of 1 + million reference images. If the limit + is exceeded, periodic indexing will + fail. + + """ + + http_options: List[Dict[str, str]] = [ + { + "method": "post", + "uri": "/v1p4beta1/{parent=projects/*/locations/*}/productSets", + "body": "product_set", + }, + ] + request, metadata = self._interceptor.pre_create_product_set( + request, metadata + ) + pb_request = product_search_service.CreateProductSetRequest.pb(request) + transcoded_request = path_template.transcode(http_options, pb_request) + + # Jsonify the request body + + body = json_format.MessageToJson( + transcoded_request["body"], + including_default_value_fields=False, + use_integers_for_enums=True, + ) + uri = transcoded_request["uri"] + method = transcoded_request["method"] + + # Jsonify the query params + query_params = json.loads( + json_format.MessageToJson( + transcoded_request["query_params"], + including_default_value_fields=False, + use_integers_for_enums=True, + ) + ) + query_params.update(self._get_unset_required_fields(query_params)) + + query_params["$alt"] = "json;enum-encoding=int" + + # Send the request + headers = dict(metadata) + headers["Content-Type"] = "application/json" + response = getattr(self._session, method)( + "{host}{uri}".format(host=self._host, uri=uri), + timeout=timeout, + headers=headers, + params=rest_helpers.flatten_query_params(query_params, strict=True), + data=body, + ) + + # In case of error, raise the appropriate core_exceptions.GoogleAPICallError exception + # subclass. + if response.status_code >= 400: + raise core_exceptions.from_http_response(response) + + # Return the response + resp = product_search_service.ProductSet() + pb_resp = product_search_service.ProductSet.pb(resp) + + json_format.Parse(response.content, pb_resp, ignore_unknown_fields=True) + resp = self._interceptor.post_create_product_set(resp) + return resp + + class _CreateReferenceImage(ProductSearchRestStub): + def __hash__(self): + return hash("CreateReferenceImage") + + __REQUIRED_FIELDS_DEFAULT_VALUES: Dict[str, Any] = {} + + @classmethod + def _get_unset_required_fields(cls, message_dict): + return { + k: v + for k, v in cls.__REQUIRED_FIELDS_DEFAULT_VALUES.items() + if k not in message_dict + } + + def __call__( + self, + request: product_search_service.CreateReferenceImageRequest, + *, + retry: OptionalRetry = gapic_v1.method.DEFAULT, + timeout: Optional[float] = None, + metadata: Sequence[Tuple[str, str]] = (), + ) -> product_search_service.ReferenceImage: + r"""Call the create reference image method over HTTP. + + Args: + request (~.product_search_service.CreateReferenceImageRequest): + The request object. Request message for the ``CreateReferenceImage`` method. + retry (google.api_core.retry.Retry): Designation of what errors, if any, + should be retried. + timeout (float): The timeout for this request. + metadata (Sequence[Tuple[str, str]]): Strings which should be + sent along with the request as metadata. + + Returns: + ~.product_search_service.ReferenceImage: + A ``ReferenceImage`` represents a product image and its + associated metadata, such as bounding boxes. + + """ + + http_options: List[Dict[str, str]] = [ + { + "method": "post", + "uri": "/v1p4beta1/{parent=projects/*/locations/*/products/*}/referenceImages", + "body": "reference_image", + }, + ] + request, metadata = self._interceptor.pre_create_reference_image( + request, metadata + ) + pb_request = product_search_service.CreateReferenceImageRequest.pb(request) + transcoded_request = path_template.transcode(http_options, pb_request) + + # Jsonify the request body + + body = json_format.MessageToJson( + transcoded_request["body"], + including_default_value_fields=False, + use_integers_for_enums=True, + ) + uri = transcoded_request["uri"] + method = transcoded_request["method"] + + # Jsonify the query params + query_params = json.loads( + json_format.MessageToJson( + transcoded_request["query_params"], + including_default_value_fields=False, + use_integers_for_enums=True, + ) + ) + query_params.update(self._get_unset_required_fields(query_params)) + + query_params["$alt"] = "json;enum-encoding=int" + + # Send the request + headers = dict(metadata) + headers["Content-Type"] = "application/json" + response = getattr(self._session, method)( + "{host}{uri}".format(host=self._host, uri=uri), + timeout=timeout, + headers=headers, + params=rest_helpers.flatten_query_params(query_params, strict=True), + data=body, + ) + + # In case of error, raise the appropriate core_exceptions.GoogleAPICallError exception + # subclass. + if response.status_code >= 400: + raise core_exceptions.from_http_response(response) + + # Return the response + resp = product_search_service.ReferenceImage() + pb_resp = product_search_service.ReferenceImage.pb(resp) + + json_format.Parse(response.content, pb_resp, ignore_unknown_fields=True) + resp = self._interceptor.post_create_reference_image(resp) + return resp + + class _DeleteProduct(ProductSearchRestStub): + def __hash__(self): + return hash("DeleteProduct") + + __REQUIRED_FIELDS_DEFAULT_VALUES: Dict[str, Any] = {} + + @classmethod + def _get_unset_required_fields(cls, message_dict): + return { + k: v + for k, v in cls.__REQUIRED_FIELDS_DEFAULT_VALUES.items() + if k not in message_dict + } + + def __call__( + self, + request: product_search_service.DeleteProductRequest, + *, + retry: OptionalRetry = gapic_v1.method.DEFAULT, + timeout: Optional[float] = None, + metadata: Sequence[Tuple[str, str]] = (), + ): + r"""Call the delete product method over HTTP. + + Args: + request (~.product_search_service.DeleteProductRequest): + The request object. Request message for the ``DeleteProduct`` method. + retry (google.api_core.retry.Retry): Designation of what errors, if any, + should be retried. + timeout (float): The timeout for this request. + metadata (Sequence[Tuple[str, str]]): Strings which should be + sent along with the request as metadata. + """ + + http_options: List[Dict[str, str]] = [ + { + "method": "delete", + "uri": "/v1p4beta1/{name=projects/*/locations/*/products/*}", + }, + ] + request, metadata = self._interceptor.pre_delete_product(request, metadata) + pb_request = product_search_service.DeleteProductRequest.pb(request) + transcoded_request = path_template.transcode(http_options, pb_request) + + uri = transcoded_request["uri"] + method = transcoded_request["method"] + + # Jsonify the query params + query_params = json.loads( + json_format.MessageToJson( + transcoded_request["query_params"], + including_default_value_fields=False, + use_integers_for_enums=True, + ) + ) + query_params.update(self._get_unset_required_fields(query_params)) + + query_params["$alt"] = "json;enum-encoding=int" + + # Send the request + headers = dict(metadata) + headers["Content-Type"] = "application/json" + response = getattr(self._session, method)( + "{host}{uri}".format(host=self._host, uri=uri), + timeout=timeout, + headers=headers, + params=rest_helpers.flatten_query_params(query_params, strict=True), + ) + + # In case of error, raise the appropriate core_exceptions.GoogleAPICallError exception + # subclass. + if response.status_code >= 400: + raise core_exceptions.from_http_response(response) + + class _DeleteProductSet(ProductSearchRestStub): + def __hash__(self): + return hash("DeleteProductSet") + + __REQUIRED_FIELDS_DEFAULT_VALUES: Dict[str, Any] = {} + + @classmethod + def _get_unset_required_fields(cls, message_dict): + return { + k: v + for k, v in cls.__REQUIRED_FIELDS_DEFAULT_VALUES.items() + if k not in message_dict + } + + def __call__( + self, + request: product_search_service.DeleteProductSetRequest, + *, + retry: OptionalRetry = gapic_v1.method.DEFAULT, + timeout: Optional[float] = None, + metadata: Sequence[Tuple[str, str]] = (), + ): + r"""Call the delete product set method over HTTP. + + Args: + request (~.product_search_service.DeleteProductSetRequest): + The request object. Request message for the ``DeleteProductSet`` method. + retry (google.api_core.retry.Retry): Designation of what errors, if any, + should be retried. + timeout (float): The timeout for this request. + metadata (Sequence[Tuple[str, str]]): Strings which should be + sent along with the request as metadata. + """ + + http_options: List[Dict[str, str]] = [ + { + "method": "delete", + "uri": "/v1p4beta1/{name=projects/*/locations/*/productSets/*}", + }, + ] + request, metadata = self._interceptor.pre_delete_product_set( + request, metadata + ) + pb_request = product_search_service.DeleteProductSetRequest.pb(request) + transcoded_request = path_template.transcode(http_options, pb_request) + + uri = transcoded_request["uri"] + method = transcoded_request["method"] + + # Jsonify the query params + query_params = json.loads( + json_format.MessageToJson( + transcoded_request["query_params"], + including_default_value_fields=False, + use_integers_for_enums=True, + ) + ) + query_params.update(self._get_unset_required_fields(query_params)) + + query_params["$alt"] = "json;enum-encoding=int" + + # Send the request + headers = dict(metadata) + headers["Content-Type"] = "application/json" + response = getattr(self._session, method)( + "{host}{uri}".format(host=self._host, uri=uri), + timeout=timeout, + headers=headers, + params=rest_helpers.flatten_query_params(query_params, strict=True), + ) + + # In case of error, raise the appropriate core_exceptions.GoogleAPICallError exception + # subclass. + if response.status_code >= 400: + raise core_exceptions.from_http_response(response) + + class _DeleteReferenceImage(ProductSearchRestStub): + def __hash__(self): + return hash("DeleteReferenceImage") + + __REQUIRED_FIELDS_DEFAULT_VALUES: Dict[str, Any] = {} + + @classmethod + def _get_unset_required_fields(cls, message_dict): + return { + k: v + for k, v in cls.__REQUIRED_FIELDS_DEFAULT_VALUES.items() + if k not in message_dict + } + + def __call__( + self, + request: product_search_service.DeleteReferenceImageRequest, + *, + retry: OptionalRetry = gapic_v1.method.DEFAULT, + timeout: Optional[float] = None, + metadata: Sequence[Tuple[str, str]] = (), + ): + r"""Call the delete reference image method over HTTP. + + Args: + request (~.product_search_service.DeleteReferenceImageRequest): + The request object. Request message for the ``DeleteReferenceImage`` method. + retry (google.api_core.retry.Retry): Designation of what errors, if any, + should be retried. + timeout (float): The timeout for this request. + metadata (Sequence[Tuple[str, str]]): Strings which should be + sent along with the request as metadata. + """ + + http_options: List[Dict[str, str]] = [ + { + "method": "delete", + "uri": "/v1p4beta1/{name=projects/*/locations/*/products/*/referenceImages/*}", + }, + ] + request, metadata = self._interceptor.pre_delete_reference_image( + request, metadata + ) + pb_request = product_search_service.DeleteReferenceImageRequest.pb(request) + transcoded_request = path_template.transcode(http_options, pb_request) + + uri = transcoded_request["uri"] + method = transcoded_request["method"] + + # Jsonify the query params + query_params = json.loads( + json_format.MessageToJson( + transcoded_request["query_params"], + including_default_value_fields=False, + use_integers_for_enums=True, + ) + ) + query_params.update(self._get_unset_required_fields(query_params)) + + query_params["$alt"] = "json;enum-encoding=int" + + # Send the request + headers = dict(metadata) + headers["Content-Type"] = "application/json" + response = getattr(self._session, method)( + "{host}{uri}".format(host=self._host, uri=uri), + timeout=timeout, + headers=headers, + params=rest_helpers.flatten_query_params(query_params, strict=True), + ) + + # In case of error, raise the appropriate core_exceptions.GoogleAPICallError exception + # subclass. + if response.status_code >= 400: + raise core_exceptions.from_http_response(response) + + class _GetProduct(ProductSearchRestStub): + def __hash__(self): + return hash("GetProduct") + + __REQUIRED_FIELDS_DEFAULT_VALUES: Dict[str, Any] = {} + + @classmethod + def _get_unset_required_fields(cls, message_dict): + return { + k: v + for k, v in cls.__REQUIRED_FIELDS_DEFAULT_VALUES.items() + if k not in message_dict + } + + def __call__( + self, + request: product_search_service.GetProductRequest, + *, + retry: OptionalRetry = gapic_v1.method.DEFAULT, + timeout: Optional[float] = None, + metadata: Sequence[Tuple[str, str]] = (), + ) -> product_search_service.Product: + r"""Call the get product method over HTTP. + + Args: + request (~.product_search_service.GetProductRequest): + The request object. Request message for the ``GetProduct`` method. + retry (google.api_core.retry.Retry): Designation of what errors, if any, + should be retried. + timeout (float): The timeout for this request. + metadata (Sequence[Tuple[str, str]]): Strings which should be + sent along with the request as metadata. + + Returns: + ~.product_search_service.Product: + A Product contains ReferenceImages. + """ + + http_options: List[Dict[str, str]] = [ + { + "method": "get", + "uri": "/v1p4beta1/{name=projects/*/locations/*/products/*}", + }, + ] + request, metadata = self._interceptor.pre_get_product(request, metadata) + pb_request = product_search_service.GetProductRequest.pb(request) + transcoded_request = path_template.transcode(http_options, pb_request) + + uri = transcoded_request["uri"] + method = transcoded_request["method"] + + # Jsonify the query params + query_params = json.loads( + json_format.MessageToJson( + transcoded_request["query_params"], + including_default_value_fields=False, + use_integers_for_enums=True, + ) + ) + query_params.update(self._get_unset_required_fields(query_params)) + + query_params["$alt"] = "json;enum-encoding=int" + + # Send the request + headers = dict(metadata) + headers["Content-Type"] = "application/json" + response = getattr(self._session, method)( + "{host}{uri}".format(host=self._host, uri=uri), + timeout=timeout, + headers=headers, + params=rest_helpers.flatten_query_params(query_params, strict=True), + ) + + # In case of error, raise the appropriate core_exceptions.GoogleAPICallError exception + # subclass. + if response.status_code >= 400: + raise core_exceptions.from_http_response(response) + + # Return the response + resp = product_search_service.Product() + pb_resp = product_search_service.Product.pb(resp) + + json_format.Parse(response.content, pb_resp, ignore_unknown_fields=True) + resp = self._interceptor.post_get_product(resp) + return resp + + class _GetProductSet(ProductSearchRestStub): + def __hash__(self): + return hash("GetProductSet") + + __REQUIRED_FIELDS_DEFAULT_VALUES: Dict[str, Any] = {} + + @classmethod + def _get_unset_required_fields(cls, message_dict): + return { + k: v + for k, v in cls.__REQUIRED_FIELDS_DEFAULT_VALUES.items() + if k not in message_dict + } + + def __call__( + self, + request: product_search_service.GetProductSetRequest, + *, + retry: OptionalRetry = gapic_v1.method.DEFAULT, + timeout: Optional[float] = None, + metadata: Sequence[Tuple[str, str]] = (), + ) -> product_search_service.ProductSet: + r"""Call the get product set method over HTTP. + + Args: + request (~.product_search_service.GetProductSetRequest): + The request object. Request message for the ``GetProductSet`` method. + retry (google.api_core.retry.Retry): Designation of what errors, if any, + should be retried. + timeout (float): The timeout for this request. + metadata (Sequence[Tuple[str, str]]): Strings which should be + sent along with the request as metadata. + + Returns: + ~.product_search_service.ProductSet: + A ProductSet contains Products. A + ProductSet can contain a maximum of 1 + million reference images. If the limit + is exceeded, periodic indexing will + fail. + + """ + + http_options: List[Dict[str, str]] = [ + { + "method": "get", + "uri": "/v1p4beta1/{name=projects/*/locations/*/productSets/*}", + }, + ] + request, metadata = self._interceptor.pre_get_product_set(request, metadata) + pb_request = product_search_service.GetProductSetRequest.pb(request) + transcoded_request = path_template.transcode(http_options, pb_request) + + uri = transcoded_request["uri"] + method = transcoded_request["method"] + + # Jsonify the query params + query_params = json.loads( + json_format.MessageToJson( + transcoded_request["query_params"], + including_default_value_fields=False, + use_integers_for_enums=True, + ) + ) + query_params.update(self._get_unset_required_fields(query_params)) + + query_params["$alt"] = "json;enum-encoding=int" + + # Send the request + headers = dict(metadata) + headers["Content-Type"] = "application/json" + response = getattr(self._session, method)( + "{host}{uri}".format(host=self._host, uri=uri), + timeout=timeout, + headers=headers, + params=rest_helpers.flatten_query_params(query_params, strict=True), + ) + + # In case of error, raise the appropriate core_exceptions.GoogleAPICallError exception + # subclass. + if response.status_code >= 400: + raise core_exceptions.from_http_response(response) + + # Return the response + resp = product_search_service.ProductSet() + pb_resp = product_search_service.ProductSet.pb(resp) + + json_format.Parse(response.content, pb_resp, ignore_unknown_fields=True) + resp = self._interceptor.post_get_product_set(resp) + return resp + + class _GetReferenceImage(ProductSearchRestStub): + def __hash__(self): + return hash("GetReferenceImage") + + __REQUIRED_FIELDS_DEFAULT_VALUES: Dict[str, Any] = {} + + @classmethod + def _get_unset_required_fields(cls, message_dict): + return { + k: v + for k, v in cls.__REQUIRED_FIELDS_DEFAULT_VALUES.items() + if k not in message_dict + } + + def __call__( + self, + request: product_search_service.GetReferenceImageRequest, + *, + retry: OptionalRetry = gapic_v1.method.DEFAULT, + timeout: Optional[float] = None, + metadata: Sequence[Tuple[str, str]] = (), + ) -> product_search_service.ReferenceImage: + r"""Call the get reference image method over HTTP. + + Args: + request (~.product_search_service.GetReferenceImageRequest): + The request object. Request message for the ``GetReferenceImage`` method. + retry (google.api_core.retry.Retry): Designation of what errors, if any, + should be retried. + timeout (float): The timeout for this request. + metadata (Sequence[Tuple[str, str]]): Strings which should be + sent along with the request as metadata. + + Returns: + ~.product_search_service.ReferenceImage: + A ``ReferenceImage`` represents a product image and its + associated metadata, such as bounding boxes. + + """ + + http_options: List[Dict[str, str]] = [ + { + "method": "get", + "uri": "/v1p4beta1/{name=projects/*/locations/*/products/*/referenceImages/*}", + }, + ] + request, metadata = self._interceptor.pre_get_reference_image( + request, metadata + ) + pb_request = product_search_service.GetReferenceImageRequest.pb(request) + transcoded_request = path_template.transcode(http_options, pb_request) + + uri = transcoded_request["uri"] + method = transcoded_request["method"] + + # Jsonify the query params + query_params = json.loads( + json_format.MessageToJson( + transcoded_request["query_params"], + including_default_value_fields=False, + use_integers_for_enums=True, + ) + ) + query_params.update(self._get_unset_required_fields(query_params)) + + query_params["$alt"] = "json;enum-encoding=int" + + # Send the request + headers = dict(metadata) + headers["Content-Type"] = "application/json" + response = getattr(self._session, method)( + "{host}{uri}".format(host=self._host, uri=uri), + timeout=timeout, + headers=headers, + params=rest_helpers.flatten_query_params(query_params, strict=True), + ) + + # In case of error, raise the appropriate core_exceptions.GoogleAPICallError exception + # subclass. + if response.status_code >= 400: + raise core_exceptions.from_http_response(response) + + # Return the response + resp = product_search_service.ReferenceImage() + pb_resp = product_search_service.ReferenceImage.pb(resp) + + json_format.Parse(response.content, pb_resp, ignore_unknown_fields=True) + resp = self._interceptor.post_get_reference_image(resp) + return resp + + class _ImportProductSets(ProductSearchRestStub): + def __hash__(self): + return hash("ImportProductSets") + + __REQUIRED_FIELDS_DEFAULT_VALUES: Dict[str, Any] = {} + + @classmethod + def _get_unset_required_fields(cls, message_dict): + return { + k: v + for k, v in cls.__REQUIRED_FIELDS_DEFAULT_VALUES.items() + if k not in message_dict + } + + def __call__( + self, + request: product_search_service.ImportProductSetsRequest, + *, + retry: OptionalRetry = gapic_v1.method.DEFAULT, + timeout: Optional[float] = None, + metadata: Sequence[Tuple[str, str]] = (), + ) -> operations_pb2.Operation: + r"""Call the import product sets method over HTTP. + + Args: + request (~.product_search_service.ImportProductSetsRequest): + The request object. Request message for the ``ImportProductSets`` method. + retry (google.api_core.retry.Retry): Designation of what errors, if any, + should be retried. + timeout (float): The timeout for this request. + metadata (Sequence[Tuple[str, str]]): Strings which should be + sent along with the request as metadata. + + Returns: + ~.operations_pb2.Operation: + This resource represents a + long-running operation that is the + result of a network API call. + + """ + + http_options: List[Dict[str, str]] = [ + { + "method": "post", + "uri": "/v1p4beta1/{parent=projects/*/locations/*}/productSets:import", + "body": "*", + }, + ] + request, metadata = self._interceptor.pre_import_product_sets( + request, metadata + ) + pb_request = product_search_service.ImportProductSetsRequest.pb(request) + transcoded_request = path_template.transcode(http_options, pb_request) + + # Jsonify the request body + + body = json_format.MessageToJson( + transcoded_request["body"], + including_default_value_fields=False, + use_integers_for_enums=True, + ) + uri = transcoded_request["uri"] + method = transcoded_request["method"] + + # Jsonify the query params + query_params = json.loads( + json_format.MessageToJson( + transcoded_request["query_params"], + including_default_value_fields=False, + use_integers_for_enums=True, + ) + ) + query_params.update(self._get_unset_required_fields(query_params)) + + query_params["$alt"] = "json;enum-encoding=int" + + # Send the request + headers = dict(metadata) + headers["Content-Type"] = "application/json" + response = getattr(self._session, method)( + "{host}{uri}".format(host=self._host, uri=uri), + timeout=timeout, + headers=headers, + params=rest_helpers.flatten_query_params(query_params, strict=True), + data=body, + ) + + # In case of error, raise the appropriate core_exceptions.GoogleAPICallError exception + # subclass. + if response.status_code >= 400: + raise core_exceptions.from_http_response(response) + + # Return the response + resp = operations_pb2.Operation() + json_format.Parse(response.content, resp, ignore_unknown_fields=True) + resp = self._interceptor.post_import_product_sets(resp) + return resp + + class _ListProducts(ProductSearchRestStub): + def __hash__(self): + return hash("ListProducts") + + __REQUIRED_FIELDS_DEFAULT_VALUES: Dict[str, Any] = {} + + @classmethod + def _get_unset_required_fields(cls, message_dict): + return { + k: v + for k, v in cls.__REQUIRED_FIELDS_DEFAULT_VALUES.items() + if k not in message_dict + } + + def __call__( + self, + request: product_search_service.ListProductsRequest, + *, + retry: OptionalRetry = gapic_v1.method.DEFAULT, + timeout: Optional[float] = None, + metadata: Sequence[Tuple[str, str]] = (), + ) -> product_search_service.ListProductsResponse: + r"""Call the list products method over HTTP. + + Args: + request (~.product_search_service.ListProductsRequest): + The request object. Request message for the ``ListProducts`` method. + retry (google.api_core.retry.Retry): Designation of what errors, if any, + should be retried. + timeout (float): The timeout for this request. + metadata (Sequence[Tuple[str, str]]): Strings which should be + sent along with the request as metadata. + + Returns: + ~.product_search_service.ListProductsResponse: + Response message for the ``ListProducts`` method. + """ + + http_options: List[Dict[str, str]] = [ + { + "method": "get", + "uri": "/v1p4beta1/{parent=projects/*/locations/*}/products", + }, + ] + request, metadata = self._interceptor.pre_list_products(request, metadata) + pb_request = product_search_service.ListProductsRequest.pb(request) + transcoded_request = path_template.transcode(http_options, pb_request) + + uri = transcoded_request["uri"] + method = transcoded_request["method"] + + # Jsonify the query params + query_params = json.loads( + json_format.MessageToJson( + transcoded_request["query_params"], + including_default_value_fields=False, + use_integers_for_enums=True, + ) + ) + query_params.update(self._get_unset_required_fields(query_params)) + + query_params["$alt"] = "json;enum-encoding=int" + + # Send the request + headers = dict(metadata) + headers["Content-Type"] = "application/json" + response = getattr(self._session, method)( + "{host}{uri}".format(host=self._host, uri=uri), + timeout=timeout, + headers=headers, + params=rest_helpers.flatten_query_params(query_params, strict=True), + ) + + # In case of error, raise the appropriate core_exceptions.GoogleAPICallError exception + # subclass. + if response.status_code >= 400: + raise core_exceptions.from_http_response(response) + + # Return the response + resp = product_search_service.ListProductsResponse() + pb_resp = product_search_service.ListProductsResponse.pb(resp) + + json_format.Parse(response.content, pb_resp, ignore_unknown_fields=True) + resp = self._interceptor.post_list_products(resp) + return resp + + class _ListProductSets(ProductSearchRestStub): + def __hash__(self): + return hash("ListProductSets") + + __REQUIRED_FIELDS_DEFAULT_VALUES: Dict[str, Any] = {} + + @classmethod + def _get_unset_required_fields(cls, message_dict): + return { + k: v + for k, v in cls.__REQUIRED_FIELDS_DEFAULT_VALUES.items() + if k not in message_dict + } + + def __call__( + self, + request: product_search_service.ListProductSetsRequest, + *, + retry: OptionalRetry = gapic_v1.method.DEFAULT, + timeout: Optional[float] = None, + metadata: Sequence[Tuple[str, str]] = (), + ) -> product_search_service.ListProductSetsResponse: + r"""Call the list product sets method over HTTP. + + Args: + request (~.product_search_service.ListProductSetsRequest): + The request object. Request message for the ``ListProductSets`` method. + retry (google.api_core.retry.Retry): Designation of what errors, if any, + should be retried. + timeout (float): The timeout for this request. + metadata (Sequence[Tuple[str, str]]): Strings which should be + sent along with the request as metadata. + + Returns: + ~.product_search_service.ListProductSetsResponse: + Response message for the ``ListProductSets`` method. + """ + + http_options: List[Dict[str, str]] = [ + { + "method": "get", + "uri": "/v1p4beta1/{parent=projects/*/locations/*}/productSets", + }, + ] + request, metadata = self._interceptor.pre_list_product_sets( + request, metadata + ) + pb_request = product_search_service.ListProductSetsRequest.pb(request) + transcoded_request = path_template.transcode(http_options, pb_request) + + uri = transcoded_request["uri"] + method = transcoded_request["method"] + + # Jsonify the query params + query_params = json.loads( + json_format.MessageToJson( + transcoded_request["query_params"], + including_default_value_fields=False, + use_integers_for_enums=True, + ) + ) + query_params.update(self._get_unset_required_fields(query_params)) + + query_params["$alt"] = "json;enum-encoding=int" + + # Send the request + headers = dict(metadata) + headers["Content-Type"] = "application/json" + response = getattr(self._session, method)( + "{host}{uri}".format(host=self._host, uri=uri), + timeout=timeout, + headers=headers, + params=rest_helpers.flatten_query_params(query_params, strict=True), + ) + + # In case of error, raise the appropriate core_exceptions.GoogleAPICallError exception + # subclass. + if response.status_code >= 400: + raise core_exceptions.from_http_response(response) + + # Return the response + resp = product_search_service.ListProductSetsResponse() + pb_resp = product_search_service.ListProductSetsResponse.pb(resp) + + json_format.Parse(response.content, pb_resp, ignore_unknown_fields=True) + resp = self._interceptor.post_list_product_sets(resp) + return resp + + class _ListProductsInProductSet(ProductSearchRestStub): + def __hash__(self): + return hash("ListProductsInProductSet") + + __REQUIRED_FIELDS_DEFAULT_VALUES: Dict[str, Any] = {} + + @classmethod + def _get_unset_required_fields(cls, message_dict): + return { + k: v + for k, v in cls.__REQUIRED_FIELDS_DEFAULT_VALUES.items() + if k not in message_dict + } + + def __call__( + self, + request: product_search_service.ListProductsInProductSetRequest, + *, + retry: OptionalRetry = gapic_v1.method.DEFAULT, + timeout: Optional[float] = None, + metadata: Sequence[Tuple[str, str]] = (), + ) -> product_search_service.ListProductsInProductSetResponse: + r"""Call the list products in product + set method over HTTP. + + Args: + request (~.product_search_service.ListProductsInProductSetRequest): + The request object. Request message for the ``ListProductsInProductSet`` + method. + + retry (google.api_core.retry.Retry): Designation of what errors, if any, + should be retried. + timeout (float): The timeout for this request. + metadata (Sequence[Tuple[str, str]]): Strings which should be + sent along with the request as metadata. + + Returns: + ~.product_search_service.ListProductsInProductSetResponse: + Response message for the ``ListProductsInProductSet`` + method. + + """ + + http_options: List[Dict[str, str]] = [ + { + "method": "get", + "uri": "/v1p4beta1/{name=projects/*/locations/*/productSets/*}/products", + }, + ] + request, metadata = self._interceptor.pre_list_products_in_product_set( + request, metadata + ) + pb_request = product_search_service.ListProductsInProductSetRequest.pb( + request + ) + transcoded_request = path_template.transcode(http_options, pb_request) + + uri = transcoded_request["uri"] + method = transcoded_request["method"] + + # Jsonify the query params + query_params = json.loads( + json_format.MessageToJson( + transcoded_request["query_params"], + including_default_value_fields=False, + use_integers_for_enums=True, + ) + ) + query_params.update(self._get_unset_required_fields(query_params)) + + query_params["$alt"] = "json;enum-encoding=int" + + # Send the request + headers = dict(metadata) + headers["Content-Type"] = "application/json" + response = getattr(self._session, method)( + "{host}{uri}".format(host=self._host, uri=uri), + timeout=timeout, + headers=headers, + params=rest_helpers.flatten_query_params(query_params, strict=True), + ) + + # In case of error, raise the appropriate core_exceptions.GoogleAPICallError exception + # subclass. + if response.status_code >= 400: + raise core_exceptions.from_http_response(response) + + # Return the response + resp = product_search_service.ListProductsInProductSetResponse() + pb_resp = product_search_service.ListProductsInProductSetResponse.pb(resp) + + json_format.Parse(response.content, pb_resp, ignore_unknown_fields=True) + resp = self._interceptor.post_list_products_in_product_set(resp) + return resp + + class _ListReferenceImages(ProductSearchRestStub): + def __hash__(self): + return hash("ListReferenceImages") + + __REQUIRED_FIELDS_DEFAULT_VALUES: Dict[str, Any] = {} + + @classmethod + def _get_unset_required_fields(cls, message_dict): + return { + k: v + for k, v in cls.__REQUIRED_FIELDS_DEFAULT_VALUES.items() + if k not in message_dict + } + + def __call__( + self, + request: product_search_service.ListReferenceImagesRequest, + *, + retry: OptionalRetry = gapic_v1.method.DEFAULT, + timeout: Optional[float] = None, + metadata: Sequence[Tuple[str, str]] = (), + ) -> product_search_service.ListReferenceImagesResponse: + r"""Call the list reference images method over HTTP. + + Args: + request (~.product_search_service.ListReferenceImagesRequest): + The request object. Request message for the ``ListReferenceImages`` method. + retry (google.api_core.retry.Retry): Designation of what errors, if any, + should be retried. + timeout (float): The timeout for this request. + metadata (Sequence[Tuple[str, str]]): Strings which should be + sent along with the request as metadata. + + Returns: + ~.product_search_service.ListReferenceImagesResponse: + Response message for the ``ListReferenceImages`` method. + """ + + http_options: List[Dict[str, str]] = [ + { + "method": "get", + "uri": "/v1p4beta1/{parent=projects/*/locations/*/products/*}/referenceImages", + }, + ] + request, metadata = self._interceptor.pre_list_reference_images( + request, metadata + ) + pb_request = product_search_service.ListReferenceImagesRequest.pb(request) + transcoded_request = path_template.transcode(http_options, pb_request) + + uri = transcoded_request["uri"] + method = transcoded_request["method"] + + # Jsonify the query params + query_params = json.loads( + json_format.MessageToJson( + transcoded_request["query_params"], + including_default_value_fields=False, + use_integers_for_enums=True, + ) + ) + query_params.update(self._get_unset_required_fields(query_params)) + + query_params["$alt"] = "json;enum-encoding=int" + + # Send the request + headers = dict(metadata) + headers["Content-Type"] = "application/json" + response = getattr(self._session, method)( + "{host}{uri}".format(host=self._host, uri=uri), + timeout=timeout, + headers=headers, + params=rest_helpers.flatten_query_params(query_params, strict=True), + ) + + # In case of error, raise the appropriate core_exceptions.GoogleAPICallError exception + # subclass. + if response.status_code >= 400: + raise core_exceptions.from_http_response(response) + + # Return the response + resp = product_search_service.ListReferenceImagesResponse() + pb_resp = product_search_service.ListReferenceImagesResponse.pb(resp) + + json_format.Parse(response.content, pb_resp, ignore_unknown_fields=True) + resp = self._interceptor.post_list_reference_images(resp) + return resp + + class _PurgeProducts(ProductSearchRestStub): + def __hash__(self): + return hash("PurgeProducts") + + __REQUIRED_FIELDS_DEFAULT_VALUES: Dict[str, Any] = {} + + @classmethod + def _get_unset_required_fields(cls, message_dict): + return { + k: v + for k, v in cls.__REQUIRED_FIELDS_DEFAULT_VALUES.items() + if k not in message_dict + } + + def __call__( + self, + request: product_search_service.PurgeProductsRequest, + *, + retry: OptionalRetry = gapic_v1.method.DEFAULT, + timeout: Optional[float] = None, + metadata: Sequence[Tuple[str, str]] = (), + ) -> operations_pb2.Operation: + r"""Call the purge products method over HTTP. + + Args: + request (~.product_search_service.PurgeProductsRequest): + The request object. Request message for the ``PurgeProducts`` method. + retry (google.api_core.retry.Retry): Designation of what errors, if any, + should be retried. + timeout (float): The timeout for this request. + metadata (Sequence[Tuple[str, str]]): Strings which should be + sent along with the request as metadata. + + Returns: + ~.operations_pb2.Operation: + This resource represents a + long-running operation that is the + result of a network API call. + + """ + + http_options: List[Dict[str, str]] = [ + { + "method": "post", + "uri": "/v1p4beta1/{parent=projects/*/locations/*}/products:purge", + "body": "*", + }, + ] + request, metadata = self._interceptor.pre_purge_products(request, metadata) + pb_request = product_search_service.PurgeProductsRequest.pb(request) + transcoded_request = path_template.transcode(http_options, pb_request) + + # Jsonify the request body + + body = json_format.MessageToJson( + transcoded_request["body"], + including_default_value_fields=False, + use_integers_for_enums=True, + ) + uri = transcoded_request["uri"] + method = transcoded_request["method"] + + # Jsonify the query params + query_params = json.loads( + json_format.MessageToJson( + transcoded_request["query_params"], + including_default_value_fields=False, + use_integers_for_enums=True, + ) + ) + query_params.update(self._get_unset_required_fields(query_params)) + + query_params["$alt"] = "json;enum-encoding=int" + + # Send the request + headers = dict(metadata) + headers["Content-Type"] = "application/json" + response = getattr(self._session, method)( + "{host}{uri}".format(host=self._host, uri=uri), + timeout=timeout, + headers=headers, + params=rest_helpers.flatten_query_params(query_params, strict=True), + data=body, + ) + + # In case of error, raise the appropriate core_exceptions.GoogleAPICallError exception + # subclass. + if response.status_code >= 400: + raise core_exceptions.from_http_response(response) + + # Return the response + resp = operations_pb2.Operation() + json_format.Parse(response.content, resp, ignore_unknown_fields=True) + resp = self._interceptor.post_purge_products(resp) + return resp + + class _RemoveProductFromProductSet(ProductSearchRestStub): + def __hash__(self): + return hash("RemoveProductFromProductSet") + + __REQUIRED_FIELDS_DEFAULT_VALUES: Dict[str, Any] = {} + + @classmethod + def _get_unset_required_fields(cls, message_dict): + return { + k: v + for k, v in cls.__REQUIRED_FIELDS_DEFAULT_VALUES.items() + if k not in message_dict + } + + def __call__( + self, + request: product_search_service.RemoveProductFromProductSetRequest, + *, + retry: OptionalRetry = gapic_v1.method.DEFAULT, + timeout: Optional[float] = None, + metadata: Sequence[Tuple[str, str]] = (), + ): + r"""Call the remove product from + product set method over HTTP. + + Args: + request (~.product_search_service.RemoveProductFromProductSetRequest): + The request object. Request message for the ``RemoveProductFromProductSet`` + method. + + retry (google.api_core.retry.Retry): Designation of what errors, if any, + should be retried. + timeout (float): The timeout for this request. + metadata (Sequence[Tuple[str, str]]): Strings which should be + sent along with the request as metadata. + """ + + http_options: List[Dict[str, str]] = [ + { + "method": "post", + "uri": "/v1p4beta1/{name=projects/*/locations/*/productSets/*}:removeProduct", + "body": "*", + }, + ] + request, metadata = self._interceptor.pre_remove_product_from_product_set( + request, metadata + ) + pb_request = product_search_service.RemoveProductFromProductSetRequest.pb( + request + ) + transcoded_request = path_template.transcode(http_options, pb_request) + + # Jsonify the request body + + body = json_format.MessageToJson( + transcoded_request["body"], + including_default_value_fields=False, + use_integers_for_enums=True, + ) + uri = transcoded_request["uri"] + method = transcoded_request["method"] + + # Jsonify the query params + query_params = json.loads( + json_format.MessageToJson( + transcoded_request["query_params"], + including_default_value_fields=False, + use_integers_for_enums=True, + ) + ) + query_params.update(self._get_unset_required_fields(query_params)) + + query_params["$alt"] = "json;enum-encoding=int" + + # Send the request + headers = dict(metadata) + headers["Content-Type"] = "application/json" + response = getattr(self._session, method)( + "{host}{uri}".format(host=self._host, uri=uri), + timeout=timeout, + headers=headers, + params=rest_helpers.flatten_query_params(query_params, strict=True), + data=body, + ) + + # In case of error, raise the appropriate core_exceptions.GoogleAPICallError exception + # subclass. + if response.status_code >= 400: + raise core_exceptions.from_http_response(response) + + class _UpdateProduct(ProductSearchRestStub): + def __hash__(self): + return hash("UpdateProduct") + + __REQUIRED_FIELDS_DEFAULT_VALUES: Dict[str, Any] = {} + + @classmethod + def _get_unset_required_fields(cls, message_dict): + return { + k: v + for k, v in cls.__REQUIRED_FIELDS_DEFAULT_VALUES.items() + if k not in message_dict + } + + def __call__( + self, + request: product_search_service.UpdateProductRequest, + *, + retry: OptionalRetry = gapic_v1.method.DEFAULT, + timeout: Optional[float] = None, + metadata: Sequence[Tuple[str, str]] = (), + ) -> product_search_service.Product: + r"""Call the update product method over HTTP. + + Args: + request (~.product_search_service.UpdateProductRequest): + The request object. Request message for the ``UpdateProduct`` method. + retry (google.api_core.retry.Retry): Designation of what errors, if any, + should be retried. + timeout (float): The timeout for this request. + metadata (Sequence[Tuple[str, str]]): Strings which should be + sent along with the request as metadata. + + Returns: + ~.product_search_service.Product: + A Product contains ReferenceImages. + """ + + http_options: List[Dict[str, str]] = [ + { + "method": "patch", + "uri": "/v1p4beta1/{product.name=projects/*/locations/*/products/*}", + "body": "product", + }, + ] + request, metadata = self._interceptor.pre_update_product(request, metadata) + pb_request = product_search_service.UpdateProductRequest.pb(request) + transcoded_request = path_template.transcode(http_options, pb_request) + + # Jsonify the request body + + body = json_format.MessageToJson( + transcoded_request["body"], + including_default_value_fields=False, + use_integers_for_enums=True, + ) + uri = transcoded_request["uri"] + method = transcoded_request["method"] + + # Jsonify the query params + query_params = json.loads( + json_format.MessageToJson( + transcoded_request["query_params"], + including_default_value_fields=False, + use_integers_for_enums=True, + ) + ) + query_params.update(self._get_unset_required_fields(query_params)) + + query_params["$alt"] = "json;enum-encoding=int" + + # Send the request + headers = dict(metadata) + headers["Content-Type"] = "application/json" + response = getattr(self._session, method)( + "{host}{uri}".format(host=self._host, uri=uri), + timeout=timeout, + headers=headers, + params=rest_helpers.flatten_query_params(query_params, strict=True), + data=body, + ) + + # In case of error, raise the appropriate core_exceptions.GoogleAPICallError exception + # subclass. + if response.status_code >= 400: + raise core_exceptions.from_http_response(response) + + # Return the response + resp = product_search_service.Product() + pb_resp = product_search_service.Product.pb(resp) + + json_format.Parse(response.content, pb_resp, ignore_unknown_fields=True) + resp = self._interceptor.post_update_product(resp) + return resp + + class _UpdateProductSet(ProductSearchRestStub): + def __hash__(self): + return hash("UpdateProductSet") + + __REQUIRED_FIELDS_DEFAULT_VALUES: Dict[str, Any] = {} + + @classmethod + def _get_unset_required_fields(cls, message_dict): + return { + k: v + for k, v in cls.__REQUIRED_FIELDS_DEFAULT_VALUES.items() + if k not in message_dict + } + + def __call__( + self, + request: product_search_service.UpdateProductSetRequest, + *, + retry: OptionalRetry = gapic_v1.method.DEFAULT, + timeout: Optional[float] = None, + metadata: Sequence[Tuple[str, str]] = (), + ) -> product_search_service.ProductSet: + r"""Call the update product set method over HTTP. + + Args: + request (~.product_search_service.UpdateProductSetRequest): + The request object. Request message for the ``UpdateProductSet`` method. + retry (google.api_core.retry.Retry): Designation of what errors, if any, + should be retried. + timeout (float): The timeout for this request. + metadata (Sequence[Tuple[str, str]]): Strings which should be + sent along with the request as metadata. + + Returns: + ~.product_search_service.ProductSet: + A ProductSet contains Products. A + ProductSet can contain a maximum of 1 + million reference images. If the limit + is exceeded, periodic indexing will + fail. + + """ + + http_options: List[Dict[str, str]] = [ + { + "method": "patch", + "uri": "/v1p4beta1/{product_set.name=projects/*/locations/*/productSets/*}", + "body": "product_set", + }, + ] + request, metadata = self._interceptor.pre_update_product_set( + request, metadata + ) + pb_request = product_search_service.UpdateProductSetRequest.pb(request) + transcoded_request = path_template.transcode(http_options, pb_request) + + # Jsonify the request body + + body = json_format.MessageToJson( + transcoded_request["body"], + including_default_value_fields=False, + use_integers_for_enums=True, + ) + uri = transcoded_request["uri"] + method = transcoded_request["method"] + + # Jsonify the query params + query_params = json.loads( + json_format.MessageToJson( + transcoded_request["query_params"], + including_default_value_fields=False, + use_integers_for_enums=True, + ) + ) + query_params.update(self._get_unset_required_fields(query_params)) + + query_params["$alt"] = "json;enum-encoding=int" + + # Send the request + headers = dict(metadata) + headers["Content-Type"] = "application/json" + response = getattr(self._session, method)( + "{host}{uri}".format(host=self._host, uri=uri), + timeout=timeout, + headers=headers, + params=rest_helpers.flatten_query_params(query_params, strict=True), + data=body, + ) + + # In case of error, raise the appropriate core_exceptions.GoogleAPICallError exception + # subclass. + if response.status_code >= 400: + raise core_exceptions.from_http_response(response) + + # Return the response + resp = product_search_service.ProductSet() + pb_resp = product_search_service.ProductSet.pb(resp) + + json_format.Parse(response.content, pb_resp, ignore_unknown_fields=True) + resp = self._interceptor.post_update_product_set(resp) + return resp + + @property + def add_product_to_product_set( + self, + ) -> Callable[ + [product_search_service.AddProductToProductSetRequest], empty_pb2.Empty + ]: + # The return type is fine, but mypy isn't sophisticated enough to determine what's going on here. + # In C++ this would require a dynamic_cast + return self._AddProductToProductSet(self._session, self._host, self._interceptor) # type: ignore + + @property + def create_product( + self, + ) -> Callable[ + [product_search_service.CreateProductRequest], product_search_service.Product + ]: + # The return type is fine, but mypy isn't sophisticated enough to determine what's going on here. + # In C++ this would require a dynamic_cast + return self._CreateProduct(self._session, self._host, self._interceptor) # type: ignore + + @property + def create_product_set( + self, + ) -> Callable[ + [product_search_service.CreateProductSetRequest], + product_search_service.ProductSet, + ]: + # The return type is fine, but mypy isn't sophisticated enough to determine what's going on here. + # In C++ this would require a dynamic_cast + return self._CreateProductSet(self._session, self._host, self._interceptor) # type: ignore + + @property + def create_reference_image( + self, + ) -> Callable[ + [product_search_service.CreateReferenceImageRequest], + product_search_service.ReferenceImage, + ]: + # The return type is fine, but mypy isn't sophisticated enough to determine what's going on here. + # In C++ this would require a dynamic_cast + return self._CreateReferenceImage(self._session, self._host, self._interceptor) # type: ignore + + @property + def delete_product( + self, + ) -> Callable[[product_search_service.DeleteProductRequest], empty_pb2.Empty]: + # The return type is fine, but mypy isn't sophisticated enough to determine what's going on here. + # In C++ this would require a dynamic_cast + return self._DeleteProduct(self._session, self._host, self._interceptor) # type: ignore + + @property + def delete_product_set( + self, + ) -> Callable[[product_search_service.DeleteProductSetRequest], empty_pb2.Empty]: + # The return type is fine, but mypy isn't sophisticated enough to determine what's going on here. + # In C++ this would require a dynamic_cast + return self._DeleteProductSet(self._session, self._host, self._interceptor) # type: ignore + + @property + def delete_reference_image( + self, + ) -> Callable[ + [product_search_service.DeleteReferenceImageRequest], empty_pb2.Empty + ]: + # The return type is fine, but mypy isn't sophisticated enough to determine what's going on here. + # In C++ this would require a dynamic_cast + return self._DeleteReferenceImage(self._session, self._host, self._interceptor) # type: ignore + + @property + def get_product( + self, + ) -> Callable[ + [product_search_service.GetProductRequest], product_search_service.Product + ]: + # The return type is fine, but mypy isn't sophisticated enough to determine what's going on here. + # In C++ this would require a dynamic_cast + return self._GetProduct(self._session, self._host, self._interceptor) # type: ignore + + @property + def get_product_set( + self, + ) -> Callable[ + [product_search_service.GetProductSetRequest], product_search_service.ProductSet + ]: + # The return type is fine, but mypy isn't sophisticated enough to determine what's going on here. + # In C++ this would require a dynamic_cast + return self._GetProductSet(self._session, self._host, self._interceptor) # type: ignore + + @property + def get_reference_image( + self, + ) -> Callable[ + [product_search_service.GetReferenceImageRequest], + product_search_service.ReferenceImage, + ]: + # The return type is fine, but mypy isn't sophisticated enough to determine what's going on here. + # In C++ this would require a dynamic_cast + return self._GetReferenceImage(self._session, self._host, self._interceptor) # type: ignore + + @property + def import_product_sets( + self, + ) -> Callable[ + [product_search_service.ImportProductSetsRequest], operations_pb2.Operation + ]: + # The return type is fine, but mypy isn't sophisticated enough to determine what's going on here. + # In C++ this would require a dynamic_cast + return self._ImportProductSets(self._session, self._host, self._interceptor) # type: ignore + + @property + def list_products( + self, + ) -> Callable[ + [product_search_service.ListProductsRequest], + product_search_service.ListProductsResponse, + ]: + # The return type is fine, but mypy isn't sophisticated enough to determine what's going on here. + # In C++ this would require a dynamic_cast + return self._ListProducts(self._session, self._host, self._interceptor) # type: ignore + + @property + def list_product_sets( + self, + ) -> Callable[ + [product_search_service.ListProductSetsRequest], + product_search_service.ListProductSetsResponse, + ]: + # The return type is fine, but mypy isn't sophisticated enough to determine what's going on here. + # In C++ this would require a dynamic_cast + return self._ListProductSets(self._session, self._host, self._interceptor) # type: ignore + + @property + def list_products_in_product_set( + self, + ) -> Callable[ + [product_search_service.ListProductsInProductSetRequest], + product_search_service.ListProductsInProductSetResponse, + ]: + # The return type is fine, but mypy isn't sophisticated enough to determine what's going on here. + # In C++ this would require a dynamic_cast + return self._ListProductsInProductSet(self._session, self._host, self._interceptor) # type: ignore + + @property + def list_reference_images( + self, + ) -> Callable[ + [product_search_service.ListReferenceImagesRequest], + product_search_service.ListReferenceImagesResponse, + ]: + # The return type is fine, but mypy isn't sophisticated enough to determine what's going on here. + # In C++ this would require a dynamic_cast + return self._ListReferenceImages(self._session, self._host, self._interceptor) # type: ignore + + @property + def purge_products( + self, + ) -> Callable[ + [product_search_service.PurgeProductsRequest], operations_pb2.Operation + ]: + # The return type is fine, but mypy isn't sophisticated enough to determine what's going on here. + # In C++ this would require a dynamic_cast + return self._PurgeProducts(self._session, self._host, self._interceptor) # type: ignore + + @property + def remove_product_from_product_set( + self, + ) -> Callable[ + [product_search_service.RemoveProductFromProductSetRequest], empty_pb2.Empty + ]: + # The return type is fine, but mypy isn't sophisticated enough to determine what's going on here. + # In C++ this would require a dynamic_cast + return self._RemoveProductFromProductSet(self._session, self._host, self._interceptor) # type: ignore + + @property + def update_product( + self, + ) -> Callable[ + [product_search_service.UpdateProductRequest], product_search_service.Product + ]: + # The return type is fine, but mypy isn't sophisticated enough to determine what's going on here. + # In C++ this would require a dynamic_cast + return self._UpdateProduct(self._session, self._host, self._interceptor) # type: ignore + + @property + def update_product_set( + self, + ) -> Callable[ + [product_search_service.UpdateProductSetRequest], + product_search_service.ProductSet, + ]: + # The return type is fine, but mypy isn't sophisticated enough to determine what's going on here. + # In C++ this would require a dynamic_cast + return self._UpdateProductSet(self._session, self._host, self._interceptor) # type: ignore + + @property + def kind(self) -> str: + return "rest" + + def close(self): + self._session.close() + + +__all__ = ("ProductSearchRestTransport",) diff --git a/google/cloud/vision_v1p4beta1/types/face.py b/google/cloud/vision_v1p4beta1/types/face.py index 76d58cf5..d8db1edc 100644 --- a/google/cloud/vision_v1p4beta1/types/face.py +++ b/google/cloud/vision_v1p4beta1/types/face.py @@ -13,6 +13,8 @@ # See the License for the specific language governing permissions and # limitations under the License. # +from __future__ import annotations + from typing import MutableMapping, MutableSequence import proto # type: ignore diff --git a/google/cloud/vision_v1p4beta1/types/geometry.py b/google/cloud/vision_v1p4beta1/types/geometry.py index 5d72b28e..2166004c 100644 --- a/google/cloud/vision_v1p4beta1/types/geometry.py +++ b/google/cloud/vision_v1p4beta1/types/geometry.py @@ -13,6 +13,8 @@ # See the License for the specific language governing permissions and # limitations under the License. # +from __future__ import annotations + from typing import MutableMapping, MutableSequence import proto # type: ignore diff --git a/google/cloud/vision_v1p4beta1/types/image_annotator.py b/google/cloud/vision_v1p4beta1/types/image_annotator.py index fb61a846..235a7da9 100644 --- a/google/cloud/vision_v1p4beta1/types/image_annotator.py +++ b/google/cloud/vision_v1p4beta1/types/image_annotator.py @@ -13,6 +13,8 @@ # See the License for the specific language governing permissions and # limitations under the License. # +from __future__ import annotations + from typing import MutableMapping, MutableSequence import proto # type: ignore diff --git a/google/cloud/vision_v1p4beta1/types/product_search.py b/google/cloud/vision_v1p4beta1/types/product_search.py index 12d1a37c..6c71a276 100644 --- a/google/cloud/vision_v1p4beta1/types/product_search.py +++ b/google/cloud/vision_v1p4beta1/types/product_search.py @@ -13,6 +13,8 @@ # See the License for the specific language governing permissions and # limitations under the License. # +from __future__ import annotations + from typing import MutableMapping, MutableSequence import proto # type: ignore diff --git a/google/cloud/vision_v1p4beta1/types/product_search_service.py b/google/cloud/vision_v1p4beta1/types/product_search_service.py index 90f87814..a42bedcb 100644 --- a/google/cloud/vision_v1p4beta1/types/product_search_service.py +++ b/google/cloud/vision_v1p4beta1/types/product_search_service.py @@ -13,6 +13,8 @@ # See the License for the specific language governing permissions and # limitations under the License. # +from __future__ import annotations + from typing import MutableMapping, MutableSequence import proto # type: ignore diff --git a/google/cloud/vision_v1p4beta1/types/text_annotation.py b/google/cloud/vision_v1p4beta1/types/text_annotation.py index ccf90ea8..64578622 100644 --- a/google/cloud/vision_v1p4beta1/types/text_annotation.py +++ b/google/cloud/vision_v1p4beta1/types/text_annotation.py @@ -13,6 +13,8 @@ # See the License for the specific language governing permissions and # limitations under the License. # +from __future__ import annotations + from typing import MutableMapping, MutableSequence import proto # type: ignore diff --git a/google/cloud/vision_v1p4beta1/types/web_detection.py b/google/cloud/vision_v1p4beta1/types/web_detection.py index 47b6dd5a..8ef959ef 100644 --- a/google/cloud/vision_v1p4beta1/types/web_detection.py +++ b/google/cloud/vision_v1p4beta1/types/web_detection.py @@ -13,6 +13,8 @@ # See the License for the specific language governing permissions and # limitations under the License. # +from __future__ import annotations + from typing import MutableMapping, MutableSequence import proto # type: ignore diff --git a/noxfile.py b/noxfile.py index dcf84a1b..53dc6f74 100644 --- a/noxfile.py +++ b/noxfile.py @@ -190,9 +190,9 @@ def unit(session): def install_systemtest_dependencies(session, *constraints): # Use pre-release gRPC for system tests. - # Exclude version 1.49.0rc1 which has a known issue. - # See https://github.com/grpc/grpc/pull/30642 - session.install("--pre", "grpcio!=1.49.0rc1") + # Exclude version 1.52.0rc1 which has a known issue. + # See https://github.com/grpc/grpc/issues/32163 + session.install("--pre", "grpcio!=1.52.0rc1") session.install(*SYSTEM_TEST_STANDARD_DEPENDENCIES, *constraints) @@ -347,9 +347,7 @@ def prerelease_deps(session): unit_deps_all = UNIT_TEST_STANDARD_DEPENDENCIES + UNIT_TEST_EXTERNAL_DEPENDENCIES session.install(*unit_deps_all) system_deps_all = ( - SYSTEM_TEST_STANDARD_DEPENDENCIES - + SYSTEM_TEST_EXTERNAL_DEPENDENCIES - + SYSTEM_TEST_EXTRAS + SYSTEM_TEST_STANDARD_DEPENDENCIES + SYSTEM_TEST_EXTERNAL_DEPENDENCIES ) session.install(*system_deps_all) @@ -379,8 +377,8 @@ def prerelease_deps(session): # dependency of grpc "six", "googleapis-common-protos", - # Exclude version 1.49.0rc1 which has a known issue. See https://github.com/grpc/grpc/pull/30642 - "grpcio!=1.49.0rc1", + # Exclude version 1.52.0rc1 which has a known issue. See https://github.com/grpc/grpc/issues/32163 + "grpcio!=1.52.0rc1", "grpcio-status", "google-api-core", "proto-plus", diff --git a/samples/generated_samples/snippet_metadata_google.cloud.vision.v1.json b/samples/generated_samples/snippet_metadata_google.cloud.vision.v1.json index 051caa58..abd6811f 100644 --- a/samples/generated_samples/snippet_metadata_google.cloud.vision.v1.json +++ b/samples/generated_samples/snippet_metadata_google.cloud.vision.v1.json @@ -8,7 +8,7 @@ ], "language": "PYTHON", "name": "google-cloud-vision", - "version": "3.3.1" + "version": "3.4.0" }, "snippets": [ { diff --git a/samples/generated_samples/snippet_metadata_google.cloud.vision.v1p1beta1.json b/samples/generated_samples/snippet_metadata_google.cloud.vision.v1p1beta1.json index c435168f..c915e113 100644 --- a/samples/generated_samples/snippet_metadata_google.cloud.vision.v1p1beta1.json +++ b/samples/generated_samples/snippet_metadata_google.cloud.vision.v1p1beta1.json @@ -8,7 +8,7 @@ ], "language": "PYTHON", "name": "google-cloud-vision", - "version": "3.3.1" + "version": "3.4.0" }, "snippets": [ { diff --git a/samples/generated_samples/snippet_metadata_google.cloud.vision.v1p2beta1.json b/samples/generated_samples/snippet_metadata_google.cloud.vision.v1p2beta1.json index c1f19518..a9a17189 100644 --- a/samples/generated_samples/snippet_metadata_google.cloud.vision.v1p2beta1.json +++ b/samples/generated_samples/snippet_metadata_google.cloud.vision.v1p2beta1.json @@ -8,7 +8,7 @@ ], "language": "PYTHON", "name": "google-cloud-vision", - "version": "3.3.1" + "version": "3.4.0" }, "snippets": [ { diff --git a/samples/generated_samples/snippet_metadata_google.cloud.vision.v1p3beta1.json b/samples/generated_samples/snippet_metadata_google.cloud.vision.v1p3beta1.json index b046ce7b..1b237fca 100644 --- a/samples/generated_samples/snippet_metadata_google.cloud.vision.v1p3beta1.json +++ b/samples/generated_samples/snippet_metadata_google.cloud.vision.v1p3beta1.json @@ -8,7 +8,7 @@ ], "language": "PYTHON", "name": "google-cloud-vision", - "version": "3.3.1" + "version": "3.4.0" }, "snippets": [ { diff --git a/samples/generated_samples/snippet_metadata_google.cloud.vision.v1p4beta1.json b/samples/generated_samples/snippet_metadata_google.cloud.vision.v1p4beta1.json index ff7df131..846af972 100644 --- a/samples/generated_samples/snippet_metadata_google.cloud.vision.v1p4beta1.json +++ b/samples/generated_samples/snippet_metadata_google.cloud.vision.v1p4beta1.json @@ -8,7 +8,7 @@ ], "language": "PYTHON", "name": "google-cloud-vision", - "version": "3.3.1" + "version": "3.4.0" }, "snippets": [ { diff --git a/setup.py b/setup.py index 28edbc23..705f331e 100644 --- a/setup.py +++ b/setup.py @@ -55,9 +55,7 @@ if package.startswith("google") ] -namespaces = ["google"] -if "google.cloud" in packages: - namespaces.append("google.cloud") +namespaces = ["google", "google.cloud"] setuptools.setup( name=name, diff --git a/tests/unit/gapic/vision_v1/test_image_annotator.py b/tests/unit/gapic/vision_v1/test_image_annotator.py index fa54ff9f..e383a652 100644 --- a/tests/unit/gapic/vision_v1/test_image_annotator.py +++ b/tests/unit/gapic/vision_v1/test_image_annotator.py @@ -24,10 +24,17 @@ import grpc from grpc.experimental import aio +from collections.abc import Iterable +from google.protobuf import json_format +import json import math import pytest from proto.marshal.rules.dates import DurationRule, TimestampRule from proto.marshal.rules import wrappers +from requests import Response +from requests import Request, PreparedRequest +from requests.sessions import Session +from google.protobuf import json_format from google.api_core import client_options from google.api_core import exceptions as core_exceptions @@ -102,6 +109,7 @@ def test__get_default_mtls_endpoint(): [ (ImageAnnotatorClient, "grpc"), (ImageAnnotatorAsyncClient, "grpc_asyncio"), + (ImageAnnotatorClient, "rest"), ], ) def test_image_annotator_client_from_service_account_info(client_class, transport_name): @@ -115,7 +123,11 @@ def test_image_annotator_client_from_service_account_info(client_class, transpor assert client.transport._credentials == creds assert isinstance(client, client_class) - assert client.transport._host == ("vision.googleapis.com:443") + assert client.transport._host == ( + "vision.googleapis.com:443" + if transport_name in ["grpc", "grpc_asyncio"] + else "https://vision.googleapis.com/" + ) @pytest.mark.parametrize( @@ -123,6 +135,7 @@ def test_image_annotator_client_from_service_account_info(client_class, transpor [ (transports.ImageAnnotatorGrpcTransport, "grpc"), (transports.ImageAnnotatorGrpcAsyncIOTransport, "grpc_asyncio"), + (transports.ImageAnnotatorRestTransport, "rest"), ], ) def test_image_annotator_client_service_account_always_use_jwt( @@ -148,6 +161,7 @@ def test_image_annotator_client_service_account_always_use_jwt( [ (ImageAnnotatorClient, "grpc"), (ImageAnnotatorAsyncClient, "grpc_asyncio"), + (ImageAnnotatorClient, "rest"), ], ) def test_image_annotator_client_from_service_account_file(client_class, transport_name): @@ -168,13 +182,18 @@ def test_image_annotator_client_from_service_account_file(client_class, transpor assert client.transport._credentials == creds assert isinstance(client, client_class) - assert client.transport._host == ("vision.googleapis.com:443") + assert client.transport._host == ( + "vision.googleapis.com:443" + if transport_name in ["grpc", "grpc_asyncio"] + else "https://vision.googleapis.com/" + ) def test_image_annotator_client_get_transport_class(): transport = ImageAnnotatorClient.get_transport_class() available_transports = [ transports.ImageAnnotatorGrpcTransport, + transports.ImageAnnotatorRestTransport, ] assert transport in available_transports @@ -191,6 +210,7 @@ def test_image_annotator_client_get_transport_class(): transports.ImageAnnotatorGrpcAsyncIOTransport, "grpc_asyncio", ), + (ImageAnnotatorClient, transports.ImageAnnotatorRestTransport, "rest"), ], ) @mock.patch.object( @@ -336,6 +356,8 @@ def test_image_annotator_client_client_options( "grpc_asyncio", "false", ), + (ImageAnnotatorClient, transports.ImageAnnotatorRestTransport, "rest", "true"), + (ImageAnnotatorClient, transports.ImageAnnotatorRestTransport, "rest", "false"), ], ) @mock.patch.object( @@ -535,6 +557,7 @@ def test_image_annotator_client_get_mtls_endpoint_and_cert_source(client_class): transports.ImageAnnotatorGrpcAsyncIOTransport, "grpc_asyncio", ), + (ImageAnnotatorClient, transports.ImageAnnotatorRestTransport, "rest"), ], ) def test_image_annotator_client_client_options_scopes( @@ -575,6 +598,7 @@ def test_image_annotator_client_client_options_scopes( "grpc_asyncio", grpc_helpers_async, ), + (ImageAnnotatorClient, transports.ImageAnnotatorRestTransport, "rest", None), ], ) def test_image_annotator_client_client_options_credentials_file( @@ -1536,6 +1560,1097 @@ async def test_async_batch_annotate_files_flattened_error_async(): ) +@pytest.mark.parametrize( + "request_type", + [ + image_annotator.BatchAnnotateImagesRequest, + dict, + ], +) +def test_batch_annotate_images_rest(request_type): + client = ImageAnnotatorClient( + credentials=ga_credentials.AnonymousCredentials(), + transport="rest", + ) + + # send a request that will satisfy transcoding + request_init = {} + request = request_type(**request_init) + + # Mock the http request call within the method and fake a response. + with mock.patch.object(type(client.transport._session), "request") as req: + # Designate an appropriate value for the returned response. + return_value = image_annotator.BatchAnnotateImagesResponse() + + # Wrap the value into a proper Response obj + response_value = Response() + response_value.status_code = 200 + pb_return_value = image_annotator.BatchAnnotateImagesResponse.pb(return_value) + json_return_value = json_format.MessageToJson(pb_return_value) + + response_value._content = json_return_value.encode("UTF-8") + req.return_value = response_value + response = client.batch_annotate_images(request) + + # Establish that the response is the type that we expect. + assert isinstance(response, image_annotator.BatchAnnotateImagesResponse) + + +def test_batch_annotate_images_rest_required_fields( + request_type=image_annotator.BatchAnnotateImagesRequest, +): + transport_class = transports.ImageAnnotatorRestTransport + + request_init = {} + request = request_type(**request_init) + pb_request = request_type.pb(request) + jsonified_request = json.loads( + json_format.MessageToJson( + pb_request, + including_default_value_fields=False, + use_integers_for_enums=False, + ) + ) + + # verify fields with default values are dropped + + unset_fields = transport_class( + credentials=ga_credentials.AnonymousCredentials() + ).batch_annotate_images._get_unset_required_fields(jsonified_request) + jsonified_request.update(unset_fields) + + # verify required fields with default values are now present + + unset_fields = transport_class( + credentials=ga_credentials.AnonymousCredentials() + ).batch_annotate_images._get_unset_required_fields(jsonified_request) + jsonified_request.update(unset_fields) + + # verify required fields with non-default values are left alone + + client = ImageAnnotatorClient( + credentials=ga_credentials.AnonymousCredentials(), + transport="rest", + ) + request = request_type(**request_init) + + # Designate an appropriate value for the returned response. + return_value = image_annotator.BatchAnnotateImagesResponse() + # Mock the http request call within the method and fake a response. + with mock.patch.object(Session, "request") as req: + # We need to mock transcode() because providing default values + # for required fields will fail the real version if the http_options + # expect actual values for those fields. + with mock.patch.object(path_template, "transcode") as transcode: + # A uri without fields and an empty body will force all the + # request fields to show up in the query_params. + pb_request = request_type.pb(request) + transcode_result = { + "uri": "v1/sample_method", + "method": "post", + "query_params": pb_request, + } + transcode_result["body"] = pb_request + transcode.return_value = transcode_result + + response_value = Response() + response_value.status_code = 200 + + pb_return_value = image_annotator.BatchAnnotateImagesResponse.pb( + return_value + ) + json_return_value = json_format.MessageToJson(pb_return_value) + + response_value._content = json_return_value.encode("UTF-8") + req.return_value = response_value + + response = client.batch_annotate_images(request) + + expected_params = [("$alt", "json;enum-encoding=int")] + actual_params = req.call_args.kwargs["params"] + assert expected_params == actual_params + + +def test_batch_annotate_images_rest_unset_required_fields(): + transport = transports.ImageAnnotatorRestTransport( + credentials=ga_credentials.AnonymousCredentials + ) + + unset_fields = transport.batch_annotate_images._get_unset_required_fields({}) + assert set(unset_fields) == (set(()) & set(("requests",))) + + +@pytest.mark.parametrize("null_interceptor", [True, False]) +def test_batch_annotate_images_rest_interceptors(null_interceptor): + transport = transports.ImageAnnotatorRestTransport( + credentials=ga_credentials.AnonymousCredentials(), + interceptor=None + if null_interceptor + else transports.ImageAnnotatorRestInterceptor(), + ) + client = ImageAnnotatorClient(transport=transport) + with mock.patch.object( + type(client.transport._session), "request" + ) as req, mock.patch.object( + path_template, "transcode" + ) as transcode, mock.patch.object( + transports.ImageAnnotatorRestInterceptor, "post_batch_annotate_images" + ) as post, mock.patch.object( + transports.ImageAnnotatorRestInterceptor, "pre_batch_annotate_images" + ) as pre: + pre.assert_not_called() + post.assert_not_called() + pb_message = image_annotator.BatchAnnotateImagesRequest.pb( + image_annotator.BatchAnnotateImagesRequest() + ) + transcode.return_value = { + "method": "post", + "uri": "my_uri", + "body": pb_message, + "query_params": pb_message, + } + + req.return_value = Response() + req.return_value.status_code = 200 + req.return_value.request = PreparedRequest() + req.return_value._content = image_annotator.BatchAnnotateImagesResponse.to_json( + image_annotator.BatchAnnotateImagesResponse() + ) + + request = image_annotator.BatchAnnotateImagesRequest() + metadata = [ + ("key", "val"), + ("cephalopod", "squid"), + ] + pre.return_value = request, metadata + post.return_value = image_annotator.BatchAnnotateImagesResponse() + + client.batch_annotate_images( + request, + metadata=[ + ("key", "val"), + ("cephalopod", "squid"), + ], + ) + + pre.assert_called_once() + post.assert_called_once() + + +def test_batch_annotate_images_rest_bad_request( + transport: str = "rest", request_type=image_annotator.BatchAnnotateImagesRequest +): + client = ImageAnnotatorClient( + credentials=ga_credentials.AnonymousCredentials(), + transport=transport, + ) + + # send a request that will satisfy transcoding + request_init = {} + request = request_type(**request_init) + + # Mock the http request call within the method and fake a BadRequest error. + with mock.patch.object(Session, "request") as req, pytest.raises( + core_exceptions.BadRequest + ): + # Wrap the value into a proper Response obj + response_value = Response() + response_value.status_code = 400 + response_value.request = Request() + req.return_value = response_value + client.batch_annotate_images(request) + + +def test_batch_annotate_images_rest_flattened(): + client = ImageAnnotatorClient( + credentials=ga_credentials.AnonymousCredentials(), + transport="rest", + ) + + # Mock the http request call within the method and fake a response. + with mock.patch.object(type(client.transport._session), "request") as req: + # Designate an appropriate value for the returned response. + return_value = image_annotator.BatchAnnotateImagesResponse() + + # get arguments that satisfy an http rule for this method + sample_request = {} + + # get truthy value for each flattened field + mock_args = dict( + requests=[ + image_annotator.AnnotateImageRequest( + image=image_annotator.Image(content=b"content_blob") + ) + ], + ) + mock_args.update(sample_request) + + # Wrap the value into a proper Response obj + response_value = Response() + response_value.status_code = 200 + pb_return_value = image_annotator.BatchAnnotateImagesResponse.pb(return_value) + json_return_value = json_format.MessageToJson(pb_return_value) + response_value._content = json_return_value.encode("UTF-8") + req.return_value = response_value + + client.batch_annotate_images(**mock_args) + + # Establish that the underlying call was made with the expected + # request object values. + assert len(req.mock_calls) == 1 + _, args, _ = req.mock_calls[0] + assert path_template.validate( + "%s/v1/images:annotate" % client.transport._host, args[1] + ) + + +def test_batch_annotate_images_rest_flattened_error(transport: str = "rest"): + client = ImageAnnotatorClient( + credentials=ga_credentials.AnonymousCredentials(), + transport=transport, + ) + + # Attempting to call a method with both a request object and flattened + # fields is an error. + with pytest.raises(ValueError): + client.batch_annotate_images( + image_annotator.BatchAnnotateImagesRequest(), + requests=[ + image_annotator.AnnotateImageRequest( + image=image_annotator.Image(content=b"content_blob") + ) + ], + ) + + +def test_batch_annotate_images_rest_error(): + client = ImageAnnotatorClient( + credentials=ga_credentials.AnonymousCredentials(), transport="rest" + ) + + +@pytest.mark.parametrize( + "request_type", + [ + image_annotator.BatchAnnotateFilesRequest, + dict, + ], +) +def test_batch_annotate_files_rest(request_type): + client = ImageAnnotatorClient( + credentials=ga_credentials.AnonymousCredentials(), + transport="rest", + ) + + # send a request that will satisfy transcoding + request_init = {} + request = request_type(**request_init) + + # Mock the http request call within the method and fake a response. + with mock.patch.object(type(client.transport._session), "request") as req: + # Designate an appropriate value for the returned response. + return_value = image_annotator.BatchAnnotateFilesResponse() + + # Wrap the value into a proper Response obj + response_value = Response() + response_value.status_code = 200 + pb_return_value = image_annotator.BatchAnnotateFilesResponse.pb(return_value) + json_return_value = json_format.MessageToJson(pb_return_value) + + response_value._content = json_return_value.encode("UTF-8") + req.return_value = response_value + response = client.batch_annotate_files(request) + + # Establish that the response is the type that we expect. + assert isinstance(response, image_annotator.BatchAnnotateFilesResponse) + + +def test_batch_annotate_files_rest_required_fields( + request_type=image_annotator.BatchAnnotateFilesRequest, +): + transport_class = transports.ImageAnnotatorRestTransport + + request_init = {} + request = request_type(**request_init) + pb_request = request_type.pb(request) + jsonified_request = json.loads( + json_format.MessageToJson( + pb_request, + including_default_value_fields=False, + use_integers_for_enums=False, + ) + ) + + # verify fields with default values are dropped + + unset_fields = transport_class( + credentials=ga_credentials.AnonymousCredentials() + ).batch_annotate_files._get_unset_required_fields(jsonified_request) + jsonified_request.update(unset_fields) + + # verify required fields with default values are now present + + unset_fields = transport_class( + credentials=ga_credentials.AnonymousCredentials() + ).batch_annotate_files._get_unset_required_fields(jsonified_request) + jsonified_request.update(unset_fields) + + # verify required fields with non-default values are left alone + + client = ImageAnnotatorClient( + credentials=ga_credentials.AnonymousCredentials(), + transport="rest", + ) + request = request_type(**request_init) + + # Designate an appropriate value for the returned response. + return_value = image_annotator.BatchAnnotateFilesResponse() + # Mock the http request call within the method and fake a response. + with mock.patch.object(Session, "request") as req: + # We need to mock transcode() because providing default values + # for required fields will fail the real version if the http_options + # expect actual values for those fields. + with mock.patch.object(path_template, "transcode") as transcode: + # A uri without fields and an empty body will force all the + # request fields to show up in the query_params. + pb_request = request_type.pb(request) + transcode_result = { + "uri": "v1/sample_method", + "method": "post", + "query_params": pb_request, + } + transcode_result["body"] = pb_request + transcode.return_value = transcode_result + + response_value = Response() + response_value.status_code = 200 + + pb_return_value = image_annotator.BatchAnnotateFilesResponse.pb( + return_value + ) + json_return_value = json_format.MessageToJson(pb_return_value) + + response_value._content = json_return_value.encode("UTF-8") + req.return_value = response_value + + response = client.batch_annotate_files(request) + + expected_params = [("$alt", "json;enum-encoding=int")] + actual_params = req.call_args.kwargs["params"] + assert expected_params == actual_params + + +def test_batch_annotate_files_rest_unset_required_fields(): + transport = transports.ImageAnnotatorRestTransport( + credentials=ga_credentials.AnonymousCredentials + ) + + unset_fields = transport.batch_annotate_files._get_unset_required_fields({}) + assert set(unset_fields) == (set(()) & set(("requests",))) + + +@pytest.mark.parametrize("null_interceptor", [True, False]) +def test_batch_annotate_files_rest_interceptors(null_interceptor): + transport = transports.ImageAnnotatorRestTransport( + credentials=ga_credentials.AnonymousCredentials(), + interceptor=None + if null_interceptor + else transports.ImageAnnotatorRestInterceptor(), + ) + client = ImageAnnotatorClient(transport=transport) + with mock.patch.object( + type(client.transport._session), "request" + ) as req, mock.patch.object( + path_template, "transcode" + ) as transcode, mock.patch.object( + transports.ImageAnnotatorRestInterceptor, "post_batch_annotate_files" + ) as post, mock.patch.object( + transports.ImageAnnotatorRestInterceptor, "pre_batch_annotate_files" + ) as pre: + pre.assert_not_called() + post.assert_not_called() + pb_message = image_annotator.BatchAnnotateFilesRequest.pb( + image_annotator.BatchAnnotateFilesRequest() + ) + transcode.return_value = { + "method": "post", + "uri": "my_uri", + "body": pb_message, + "query_params": pb_message, + } + + req.return_value = Response() + req.return_value.status_code = 200 + req.return_value.request = PreparedRequest() + req.return_value._content = image_annotator.BatchAnnotateFilesResponse.to_json( + image_annotator.BatchAnnotateFilesResponse() + ) + + request = image_annotator.BatchAnnotateFilesRequest() + metadata = [ + ("key", "val"), + ("cephalopod", "squid"), + ] + pre.return_value = request, metadata + post.return_value = image_annotator.BatchAnnotateFilesResponse() + + client.batch_annotate_files( + request, + metadata=[ + ("key", "val"), + ("cephalopod", "squid"), + ], + ) + + pre.assert_called_once() + post.assert_called_once() + + +def test_batch_annotate_files_rest_bad_request( + transport: str = "rest", request_type=image_annotator.BatchAnnotateFilesRequest +): + client = ImageAnnotatorClient( + credentials=ga_credentials.AnonymousCredentials(), + transport=transport, + ) + + # send a request that will satisfy transcoding + request_init = {} + request = request_type(**request_init) + + # Mock the http request call within the method and fake a BadRequest error. + with mock.patch.object(Session, "request") as req, pytest.raises( + core_exceptions.BadRequest + ): + # Wrap the value into a proper Response obj + response_value = Response() + response_value.status_code = 400 + response_value.request = Request() + req.return_value = response_value + client.batch_annotate_files(request) + + +def test_batch_annotate_files_rest_flattened(): + client = ImageAnnotatorClient( + credentials=ga_credentials.AnonymousCredentials(), + transport="rest", + ) + + # Mock the http request call within the method and fake a response. + with mock.patch.object(type(client.transport._session), "request") as req: + # Designate an appropriate value for the returned response. + return_value = image_annotator.BatchAnnotateFilesResponse() + + # get arguments that satisfy an http rule for this method + sample_request = {} + + # get truthy value for each flattened field + mock_args = dict( + requests=[ + image_annotator.AnnotateFileRequest( + input_config=image_annotator.InputConfig( + gcs_source=image_annotator.GcsSource(uri="uri_value") + ) + ) + ], + ) + mock_args.update(sample_request) + + # Wrap the value into a proper Response obj + response_value = Response() + response_value.status_code = 200 + pb_return_value = image_annotator.BatchAnnotateFilesResponse.pb(return_value) + json_return_value = json_format.MessageToJson(pb_return_value) + response_value._content = json_return_value.encode("UTF-8") + req.return_value = response_value + + client.batch_annotate_files(**mock_args) + + # Establish that the underlying call was made with the expected + # request object values. + assert len(req.mock_calls) == 1 + _, args, _ = req.mock_calls[0] + assert path_template.validate( + "%s/v1/files:annotate" % client.transport._host, args[1] + ) + + +def test_batch_annotate_files_rest_flattened_error(transport: str = "rest"): + client = ImageAnnotatorClient( + credentials=ga_credentials.AnonymousCredentials(), + transport=transport, + ) + + # Attempting to call a method with both a request object and flattened + # fields is an error. + with pytest.raises(ValueError): + client.batch_annotate_files( + image_annotator.BatchAnnotateFilesRequest(), + requests=[ + image_annotator.AnnotateFileRequest( + input_config=image_annotator.InputConfig( + gcs_source=image_annotator.GcsSource(uri="uri_value") + ) + ) + ], + ) + + +def test_batch_annotate_files_rest_error(): + client = ImageAnnotatorClient( + credentials=ga_credentials.AnonymousCredentials(), transport="rest" + ) + + +@pytest.mark.parametrize( + "request_type", + [ + image_annotator.AsyncBatchAnnotateImagesRequest, + dict, + ], +) +def test_async_batch_annotate_images_rest(request_type): + client = ImageAnnotatorClient( + credentials=ga_credentials.AnonymousCredentials(), + transport="rest", + ) + + # send a request that will satisfy transcoding + request_init = {} + request = request_type(**request_init) + + # Mock the http request call within the method and fake a response. + with mock.patch.object(type(client.transport._session), "request") as req: + # Designate an appropriate value for the returned response. + return_value = operations_pb2.Operation(name="operations/spam") + + # Wrap the value into a proper Response obj + response_value = Response() + response_value.status_code = 200 + json_return_value = json_format.MessageToJson(return_value) + + response_value._content = json_return_value.encode("UTF-8") + req.return_value = response_value + response = client.async_batch_annotate_images(request) + + # Establish that the response is the type that we expect. + assert response.operation.name == "operations/spam" + + +def test_async_batch_annotate_images_rest_required_fields( + request_type=image_annotator.AsyncBatchAnnotateImagesRequest, +): + transport_class = transports.ImageAnnotatorRestTransport + + request_init = {} + request = request_type(**request_init) + pb_request = request_type.pb(request) + jsonified_request = json.loads( + json_format.MessageToJson( + pb_request, + including_default_value_fields=False, + use_integers_for_enums=False, + ) + ) + + # verify fields with default values are dropped + + unset_fields = transport_class( + credentials=ga_credentials.AnonymousCredentials() + ).async_batch_annotate_images._get_unset_required_fields(jsonified_request) + jsonified_request.update(unset_fields) + + # verify required fields with default values are now present + + unset_fields = transport_class( + credentials=ga_credentials.AnonymousCredentials() + ).async_batch_annotate_images._get_unset_required_fields(jsonified_request) + jsonified_request.update(unset_fields) + + # verify required fields with non-default values are left alone + + client = ImageAnnotatorClient( + credentials=ga_credentials.AnonymousCredentials(), + transport="rest", + ) + request = request_type(**request_init) + + # Designate an appropriate value for the returned response. + return_value = operations_pb2.Operation(name="operations/spam") + # Mock the http request call within the method and fake a response. + with mock.patch.object(Session, "request") as req: + # We need to mock transcode() because providing default values + # for required fields will fail the real version if the http_options + # expect actual values for those fields. + with mock.patch.object(path_template, "transcode") as transcode: + # A uri without fields and an empty body will force all the + # request fields to show up in the query_params. + pb_request = request_type.pb(request) + transcode_result = { + "uri": "v1/sample_method", + "method": "post", + "query_params": pb_request, + } + transcode_result["body"] = pb_request + transcode.return_value = transcode_result + + response_value = Response() + response_value.status_code = 200 + json_return_value = json_format.MessageToJson(return_value) + + response_value._content = json_return_value.encode("UTF-8") + req.return_value = response_value + + response = client.async_batch_annotate_images(request) + + expected_params = [("$alt", "json;enum-encoding=int")] + actual_params = req.call_args.kwargs["params"] + assert expected_params == actual_params + + +def test_async_batch_annotate_images_rest_unset_required_fields(): + transport = transports.ImageAnnotatorRestTransport( + credentials=ga_credentials.AnonymousCredentials + ) + + unset_fields = transport.async_batch_annotate_images._get_unset_required_fields({}) + assert set(unset_fields) == ( + set(()) + & set( + ( + "requests", + "outputConfig", + ) + ) + ) + + +@pytest.mark.parametrize("null_interceptor", [True, False]) +def test_async_batch_annotate_images_rest_interceptors(null_interceptor): + transport = transports.ImageAnnotatorRestTransport( + credentials=ga_credentials.AnonymousCredentials(), + interceptor=None + if null_interceptor + else transports.ImageAnnotatorRestInterceptor(), + ) + client = ImageAnnotatorClient(transport=transport) + with mock.patch.object( + type(client.transport._session), "request" + ) as req, mock.patch.object( + path_template, "transcode" + ) as transcode, mock.patch.object( + operation.Operation, "_set_result_from_operation" + ), mock.patch.object( + transports.ImageAnnotatorRestInterceptor, "post_async_batch_annotate_images" + ) as post, mock.patch.object( + transports.ImageAnnotatorRestInterceptor, "pre_async_batch_annotate_images" + ) as pre: + pre.assert_not_called() + post.assert_not_called() + pb_message = image_annotator.AsyncBatchAnnotateImagesRequest.pb( + image_annotator.AsyncBatchAnnotateImagesRequest() + ) + transcode.return_value = { + "method": "post", + "uri": "my_uri", + "body": pb_message, + "query_params": pb_message, + } + + req.return_value = Response() + req.return_value.status_code = 200 + req.return_value.request = PreparedRequest() + req.return_value._content = json_format.MessageToJson( + operations_pb2.Operation() + ) + + request = image_annotator.AsyncBatchAnnotateImagesRequest() + metadata = [ + ("key", "val"), + ("cephalopod", "squid"), + ] + pre.return_value = request, metadata + post.return_value = operations_pb2.Operation() + + client.async_batch_annotate_images( + request, + metadata=[ + ("key", "val"), + ("cephalopod", "squid"), + ], + ) + + pre.assert_called_once() + post.assert_called_once() + + +def test_async_batch_annotate_images_rest_bad_request( + transport: str = "rest", + request_type=image_annotator.AsyncBatchAnnotateImagesRequest, +): + client = ImageAnnotatorClient( + credentials=ga_credentials.AnonymousCredentials(), + transport=transport, + ) + + # send a request that will satisfy transcoding + request_init = {} + request = request_type(**request_init) + + # Mock the http request call within the method and fake a BadRequest error. + with mock.patch.object(Session, "request") as req, pytest.raises( + core_exceptions.BadRequest + ): + # Wrap the value into a proper Response obj + response_value = Response() + response_value.status_code = 400 + response_value.request = Request() + req.return_value = response_value + client.async_batch_annotate_images(request) + + +def test_async_batch_annotate_images_rest_flattened(): + client = ImageAnnotatorClient( + credentials=ga_credentials.AnonymousCredentials(), + transport="rest", + ) + + # Mock the http request call within the method and fake a response. + with mock.patch.object(type(client.transport._session), "request") as req: + # Designate an appropriate value for the returned response. + return_value = operations_pb2.Operation(name="operations/spam") + + # get arguments that satisfy an http rule for this method + sample_request = {} + + # get truthy value for each flattened field + mock_args = dict( + requests=[ + image_annotator.AnnotateImageRequest( + image=image_annotator.Image(content=b"content_blob") + ) + ], + output_config=image_annotator.OutputConfig( + gcs_destination=image_annotator.GcsDestination(uri="uri_value") + ), + ) + mock_args.update(sample_request) + + # Wrap the value into a proper Response obj + response_value = Response() + response_value.status_code = 200 + json_return_value = json_format.MessageToJson(return_value) + response_value._content = json_return_value.encode("UTF-8") + req.return_value = response_value + + client.async_batch_annotate_images(**mock_args) + + # Establish that the underlying call was made with the expected + # request object values. + assert len(req.mock_calls) == 1 + _, args, _ = req.mock_calls[0] + assert path_template.validate( + "%s/v1/images:asyncBatchAnnotate" % client.transport._host, args[1] + ) + + +def test_async_batch_annotate_images_rest_flattened_error(transport: str = "rest"): + client = ImageAnnotatorClient( + credentials=ga_credentials.AnonymousCredentials(), + transport=transport, + ) + + # Attempting to call a method with both a request object and flattened + # fields is an error. + with pytest.raises(ValueError): + client.async_batch_annotate_images( + image_annotator.AsyncBatchAnnotateImagesRequest(), + requests=[ + image_annotator.AnnotateImageRequest( + image=image_annotator.Image(content=b"content_blob") + ) + ], + output_config=image_annotator.OutputConfig( + gcs_destination=image_annotator.GcsDestination(uri="uri_value") + ), + ) + + +def test_async_batch_annotate_images_rest_error(): + client = ImageAnnotatorClient( + credentials=ga_credentials.AnonymousCredentials(), transport="rest" + ) + + +@pytest.mark.parametrize( + "request_type", + [ + image_annotator.AsyncBatchAnnotateFilesRequest, + dict, + ], +) +def test_async_batch_annotate_files_rest(request_type): + client = ImageAnnotatorClient( + credentials=ga_credentials.AnonymousCredentials(), + transport="rest", + ) + + # send a request that will satisfy transcoding + request_init = {} + request = request_type(**request_init) + + # Mock the http request call within the method and fake a response. + with mock.patch.object(type(client.transport._session), "request") as req: + # Designate an appropriate value for the returned response. + return_value = operations_pb2.Operation(name="operations/spam") + + # Wrap the value into a proper Response obj + response_value = Response() + response_value.status_code = 200 + json_return_value = json_format.MessageToJson(return_value) + + response_value._content = json_return_value.encode("UTF-8") + req.return_value = response_value + response = client.async_batch_annotate_files(request) + + # Establish that the response is the type that we expect. + assert response.operation.name == "operations/spam" + + +def test_async_batch_annotate_files_rest_required_fields( + request_type=image_annotator.AsyncBatchAnnotateFilesRequest, +): + transport_class = transports.ImageAnnotatorRestTransport + + request_init = {} + request = request_type(**request_init) + pb_request = request_type.pb(request) + jsonified_request = json.loads( + json_format.MessageToJson( + pb_request, + including_default_value_fields=False, + use_integers_for_enums=False, + ) + ) + + # verify fields with default values are dropped + + unset_fields = transport_class( + credentials=ga_credentials.AnonymousCredentials() + ).async_batch_annotate_files._get_unset_required_fields(jsonified_request) + jsonified_request.update(unset_fields) + + # verify required fields with default values are now present + + unset_fields = transport_class( + credentials=ga_credentials.AnonymousCredentials() + ).async_batch_annotate_files._get_unset_required_fields(jsonified_request) + jsonified_request.update(unset_fields) + + # verify required fields with non-default values are left alone + + client = ImageAnnotatorClient( + credentials=ga_credentials.AnonymousCredentials(), + transport="rest", + ) + request = request_type(**request_init) + + # Designate an appropriate value for the returned response. + return_value = operations_pb2.Operation(name="operations/spam") + # Mock the http request call within the method and fake a response. + with mock.patch.object(Session, "request") as req: + # We need to mock transcode() because providing default values + # for required fields will fail the real version if the http_options + # expect actual values for those fields. + with mock.patch.object(path_template, "transcode") as transcode: + # A uri without fields and an empty body will force all the + # request fields to show up in the query_params. + pb_request = request_type.pb(request) + transcode_result = { + "uri": "v1/sample_method", + "method": "post", + "query_params": pb_request, + } + transcode_result["body"] = pb_request + transcode.return_value = transcode_result + + response_value = Response() + response_value.status_code = 200 + json_return_value = json_format.MessageToJson(return_value) + + response_value._content = json_return_value.encode("UTF-8") + req.return_value = response_value + + response = client.async_batch_annotate_files(request) + + expected_params = [("$alt", "json;enum-encoding=int")] + actual_params = req.call_args.kwargs["params"] + assert expected_params == actual_params + + +def test_async_batch_annotate_files_rest_unset_required_fields(): + transport = transports.ImageAnnotatorRestTransport( + credentials=ga_credentials.AnonymousCredentials + ) + + unset_fields = transport.async_batch_annotate_files._get_unset_required_fields({}) + assert set(unset_fields) == (set(()) & set(("requests",))) + + +@pytest.mark.parametrize("null_interceptor", [True, False]) +def test_async_batch_annotate_files_rest_interceptors(null_interceptor): + transport = transports.ImageAnnotatorRestTransport( + credentials=ga_credentials.AnonymousCredentials(), + interceptor=None + if null_interceptor + else transports.ImageAnnotatorRestInterceptor(), + ) + client = ImageAnnotatorClient(transport=transport) + with mock.patch.object( + type(client.transport._session), "request" + ) as req, mock.patch.object( + path_template, "transcode" + ) as transcode, mock.patch.object( + operation.Operation, "_set_result_from_operation" + ), mock.patch.object( + transports.ImageAnnotatorRestInterceptor, "post_async_batch_annotate_files" + ) as post, mock.patch.object( + transports.ImageAnnotatorRestInterceptor, "pre_async_batch_annotate_files" + ) as pre: + pre.assert_not_called() + post.assert_not_called() + pb_message = image_annotator.AsyncBatchAnnotateFilesRequest.pb( + image_annotator.AsyncBatchAnnotateFilesRequest() + ) + transcode.return_value = { + "method": "post", + "uri": "my_uri", + "body": pb_message, + "query_params": pb_message, + } + + req.return_value = Response() + req.return_value.status_code = 200 + req.return_value.request = PreparedRequest() + req.return_value._content = json_format.MessageToJson( + operations_pb2.Operation() + ) + + request = image_annotator.AsyncBatchAnnotateFilesRequest() + metadata = [ + ("key", "val"), + ("cephalopod", "squid"), + ] + pre.return_value = request, metadata + post.return_value = operations_pb2.Operation() + + client.async_batch_annotate_files( + request, + metadata=[ + ("key", "val"), + ("cephalopod", "squid"), + ], + ) + + pre.assert_called_once() + post.assert_called_once() + + +def test_async_batch_annotate_files_rest_bad_request( + transport: str = "rest", request_type=image_annotator.AsyncBatchAnnotateFilesRequest +): + client = ImageAnnotatorClient( + credentials=ga_credentials.AnonymousCredentials(), + transport=transport, + ) + + # send a request that will satisfy transcoding + request_init = {} + request = request_type(**request_init) + + # Mock the http request call within the method and fake a BadRequest error. + with mock.patch.object(Session, "request") as req, pytest.raises( + core_exceptions.BadRequest + ): + # Wrap the value into a proper Response obj + response_value = Response() + response_value.status_code = 400 + response_value.request = Request() + req.return_value = response_value + client.async_batch_annotate_files(request) + + +def test_async_batch_annotate_files_rest_flattened(): + client = ImageAnnotatorClient( + credentials=ga_credentials.AnonymousCredentials(), + transport="rest", + ) + + # Mock the http request call within the method and fake a response. + with mock.patch.object(type(client.transport._session), "request") as req: + # Designate an appropriate value for the returned response. + return_value = operations_pb2.Operation(name="operations/spam") + + # get arguments that satisfy an http rule for this method + sample_request = {} + + # get truthy value for each flattened field + mock_args = dict( + requests=[ + image_annotator.AsyncAnnotateFileRequest( + input_config=image_annotator.InputConfig( + gcs_source=image_annotator.GcsSource(uri="uri_value") + ) + ) + ], + ) + mock_args.update(sample_request) + + # Wrap the value into a proper Response obj + response_value = Response() + response_value.status_code = 200 + json_return_value = json_format.MessageToJson(return_value) + response_value._content = json_return_value.encode("UTF-8") + req.return_value = response_value + + client.async_batch_annotate_files(**mock_args) + + # Establish that the underlying call was made with the expected + # request object values. + assert len(req.mock_calls) == 1 + _, args, _ = req.mock_calls[0] + assert path_template.validate( + "%s/v1/files:asyncBatchAnnotate" % client.transport._host, args[1] + ) + + +def test_async_batch_annotate_files_rest_flattened_error(transport: str = "rest"): + client = ImageAnnotatorClient( + credentials=ga_credentials.AnonymousCredentials(), + transport=transport, + ) + + # Attempting to call a method with both a request object and flattened + # fields is an error. + with pytest.raises(ValueError): + client.async_batch_annotate_files( + image_annotator.AsyncBatchAnnotateFilesRequest(), + requests=[ + image_annotator.AsyncAnnotateFileRequest( + input_config=image_annotator.InputConfig( + gcs_source=image_annotator.GcsSource(uri="uri_value") + ) + ) + ], + ) + + +def test_async_batch_annotate_files_rest_error(): + client = ImageAnnotatorClient( + credentials=ga_credentials.AnonymousCredentials(), transport="rest" + ) + + def test_credentials_transport_error(): # It is an error to provide credentials and a transport instance. transport = transports.ImageAnnotatorGrpcTransport( @@ -1617,6 +2732,7 @@ def test_transport_get_channel(): [ transports.ImageAnnotatorGrpcTransport, transports.ImageAnnotatorGrpcAsyncIOTransport, + transports.ImageAnnotatorRestTransport, ], ) def test_transport_adc(transport_class): @@ -1631,6 +2747,7 @@ def test_transport_adc(transport_class): "transport_name", [ "grpc", + "rest", ], ) def test_transport_kind(transport_name): @@ -1777,6 +2894,7 @@ def test_image_annotator_transport_auth_adc(transport_class): [ transports.ImageAnnotatorGrpcTransport, transports.ImageAnnotatorGrpcAsyncIOTransport, + transports.ImageAnnotatorRestTransport, ], ) def test_image_annotator_transport_auth_gdch_credentials(transport_class): @@ -1877,11 +2995,40 @@ def test_image_annotator_grpc_transport_client_cert_source_for_mtls(transport_cl ) +def test_image_annotator_http_transport_client_cert_source_for_mtls(): + cred = ga_credentials.AnonymousCredentials() + with mock.patch( + "google.auth.transport.requests.AuthorizedSession.configure_mtls_channel" + ) as mock_configure_mtls_channel: + transports.ImageAnnotatorRestTransport( + credentials=cred, client_cert_source_for_mtls=client_cert_source_callback + ) + mock_configure_mtls_channel.assert_called_once_with(client_cert_source_callback) + + +def test_image_annotator_rest_lro_client(): + client = ImageAnnotatorClient( + credentials=ga_credentials.AnonymousCredentials(), + transport="rest", + ) + transport = client.transport + + # Ensure that we have a api-core operations client. + assert isinstance( + transport.operations_client, + operations_v1.AbstractOperationsClient, + ) + + # Ensure that subsequent calls to the property send the exact same object. + assert transport.operations_client is transport.operations_client + + @pytest.mark.parametrize( "transport_name", [ "grpc", "grpc_asyncio", + "rest", ], ) def test_image_annotator_host_no_port(transport_name): @@ -1892,7 +3039,11 @@ def test_image_annotator_host_no_port(transport_name): ), transport=transport_name, ) - assert client.transport._host == ("vision.googleapis.com:443") + assert client.transport._host == ( + "vision.googleapis.com:443" + if transport_name in ["grpc", "grpc_asyncio"] + else "https://vision.googleapis.com/" + ) @pytest.mark.parametrize( @@ -1900,6 +3051,7 @@ def test_image_annotator_host_no_port(transport_name): [ "grpc", "grpc_asyncio", + "rest", ], ) def test_image_annotator_host_with_port(transport_name): @@ -1910,7 +3062,42 @@ def test_image_annotator_host_with_port(transport_name): ), transport=transport_name, ) - assert client.transport._host == ("vision.googleapis.com:8000") + assert client.transport._host == ( + "vision.googleapis.com:8000" + if transport_name in ["grpc", "grpc_asyncio"] + else "https://vision.googleapis.com:8000/" + ) + + +@pytest.mark.parametrize( + "transport_name", + [ + "rest", + ], +) +def test_image_annotator_client_transport_session_collision(transport_name): + creds1 = ga_credentials.AnonymousCredentials() + creds2 = ga_credentials.AnonymousCredentials() + client1 = ImageAnnotatorClient( + credentials=creds1, + transport=transport_name, + ) + client2 = ImageAnnotatorClient( + credentials=creds2, + transport=transport_name, + ) + session1 = client1.transport.batch_annotate_images._session + session2 = client2.transport.batch_annotate_images._session + assert session1 != session2 + session1 = client1.transport.batch_annotate_files._session + session2 = client2.transport.batch_annotate_files._session + assert session1 != session2 + session1 = client1.transport.async_batch_annotate_images._session + session2 = client2.transport.async_batch_annotate_images._session + assert session1 != session2 + session1 = client1.transport.async_batch_annotate_files._session + session2 = client2.transport.async_batch_annotate_files._session + assert session1 != session2 def test_image_annotator_grpc_transport_channel(): @@ -2269,6 +3456,7 @@ async def test_transport_close_async(): def test_transport_close(): transports = { + "rest": "_session", "grpc": "_grpc_channel", } @@ -2286,6 +3474,7 @@ def test_transport_close(): def test_client_ctx(): transports = [ + "rest", "grpc", ] for transport in transports: diff --git a/tests/unit/gapic/vision_v1/test_product_search.py b/tests/unit/gapic/vision_v1/test_product_search.py index f8731d52..d254dd45 100644 --- a/tests/unit/gapic/vision_v1/test_product_search.py +++ b/tests/unit/gapic/vision_v1/test_product_search.py @@ -24,10 +24,17 @@ import grpc from grpc.experimental import aio +from collections.abc import Iterable +from google.protobuf import json_format +import json import math import pytest from proto.marshal.rules.dates import DurationRule, TimestampRule from proto.marshal.rules import wrappers +from requests import Response +from requests import Request, PreparedRequest +from requests.sessions import Session +from google.protobuf import json_format from google.api_core import client_options from google.api_core import exceptions as core_exceptions @@ -106,6 +113,7 @@ def test__get_default_mtls_endpoint(): [ (ProductSearchClient, "grpc"), (ProductSearchAsyncClient, "grpc_asyncio"), + (ProductSearchClient, "rest"), ], ) def test_product_search_client_from_service_account_info(client_class, transport_name): @@ -119,7 +127,11 @@ def test_product_search_client_from_service_account_info(client_class, transport assert client.transport._credentials == creds assert isinstance(client, client_class) - assert client.transport._host == ("vision.googleapis.com:443") + assert client.transport._host == ( + "vision.googleapis.com:443" + if transport_name in ["grpc", "grpc_asyncio"] + else "https://vision.googleapis.com/" + ) @pytest.mark.parametrize( @@ -127,6 +139,7 @@ def test_product_search_client_from_service_account_info(client_class, transport [ (transports.ProductSearchGrpcTransport, "grpc"), (transports.ProductSearchGrpcAsyncIOTransport, "grpc_asyncio"), + (transports.ProductSearchRestTransport, "rest"), ], ) def test_product_search_client_service_account_always_use_jwt( @@ -152,6 +165,7 @@ def test_product_search_client_service_account_always_use_jwt( [ (ProductSearchClient, "grpc"), (ProductSearchAsyncClient, "grpc_asyncio"), + (ProductSearchClient, "rest"), ], ) def test_product_search_client_from_service_account_file(client_class, transport_name): @@ -172,13 +186,18 @@ def test_product_search_client_from_service_account_file(client_class, transport assert client.transport._credentials == creds assert isinstance(client, client_class) - assert client.transport._host == ("vision.googleapis.com:443") + assert client.transport._host == ( + "vision.googleapis.com:443" + if transport_name in ["grpc", "grpc_asyncio"] + else "https://vision.googleapis.com/" + ) def test_product_search_client_get_transport_class(): transport = ProductSearchClient.get_transport_class() available_transports = [ transports.ProductSearchGrpcTransport, + transports.ProductSearchRestTransport, ] assert transport in available_transports @@ -195,6 +214,7 @@ def test_product_search_client_get_transport_class(): transports.ProductSearchGrpcAsyncIOTransport, "grpc_asyncio", ), + (ProductSearchClient, transports.ProductSearchRestTransport, "rest"), ], ) @mock.patch.object( @@ -340,6 +360,8 @@ def test_product_search_client_client_options( "grpc_asyncio", "false", ), + (ProductSearchClient, transports.ProductSearchRestTransport, "rest", "true"), + (ProductSearchClient, transports.ProductSearchRestTransport, "rest", "false"), ], ) @mock.patch.object( @@ -539,6 +561,7 @@ def test_product_search_client_get_mtls_endpoint_and_cert_source(client_class): transports.ProductSearchGrpcAsyncIOTransport, "grpc_asyncio", ), + (ProductSearchClient, transports.ProductSearchRestTransport, "rest"), ], ) def test_product_search_client_client_options_scopes( @@ -579,6 +602,7 @@ def test_product_search_client_client_options_scopes( "grpc_asyncio", grpc_helpers_async, ), + (ProductSearchClient, transports.ProductSearchRestTransport, "rest", None), ], ) def test_product_search_client_client_options_credentials_file( @@ -6191,210 +6215,5824 @@ async def test_purge_products_flattened_error_async(): ) -def test_credentials_transport_error(): - # It is an error to provide credentials and a transport instance. - transport = transports.ProductSearchGrpcTransport( +@pytest.mark.parametrize( + "request_type", + [ + product_search_service.CreateProductSetRequest, + dict, + ], +) +def test_create_product_set_rest(request_type): + client = ProductSearchClient( credentials=ga_credentials.AnonymousCredentials(), - ) - with pytest.raises(ValueError): - client = ProductSearchClient( - credentials=ga_credentials.AnonymousCredentials(), - transport=transport, + transport="rest", + ) + + # send a request that will satisfy transcoding + request_init = {"parent": "projects/sample1/locations/sample2"} + request_init["product_set"] = { + "name": "name_value", + "display_name": "display_name_value", + "index_time": {"seconds": 751, "nanos": 543}, + "index_error": { + "code": 411, + "message": "message_value", + "details": [ + { + "type_url": "type.googleapis.com/google.protobuf.Duration", + "value": b"\x08\x0c\x10\xdb\x07", + } + ], + }, + } + request = request_type(**request_init) + + # Mock the http request call within the method and fake a response. + with mock.patch.object(type(client.transport._session), "request") as req: + # Designate an appropriate value for the returned response. + return_value = product_search_service.ProductSet( + name="name_value", + display_name="display_name_value", ) - # It is an error to provide a credentials file and a transport instance. - transport = transports.ProductSearchGrpcTransport( - credentials=ga_credentials.AnonymousCredentials(), - ) - with pytest.raises(ValueError): - client = ProductSearchClient( - client_options={"credentials_file": "credentials.json"}, - transport=transport, + # Wrap the value into a proper Response obj + response_value = Response() + response_value.status_code = 200 + pb_return_value = product_search_service.ProductSet.pb(return_value) + json_return_value = json_format.MessageToJson(pb_return_value) + + response_value._content = json_return_value.encode("UTF-8") + req.return_value = response_value + response = client.create_product_set(request) + + # Establish that the response is the type that we expect. + assert isinstance(response, product_search_service.ProductSet) + assert response.name == "name_value" + assert response.display_name == "display_name_value" + + +def test_create_product_set_rest_required_fields( + request_type=product_search_service.CreateProductSetRequest, +): + transport_class = transports.ProductSearchRestTransport + + request_init = {} + request_init["parent"] = "" + request = request_type(**request_init) + pb_request = request_type.pb(request) + jsonified_request = json.loads( + json_format.MessageToJson( + pb_request, + including_default_value_fields=False, + use_integers_for_enums=False, ) + ) - # It is an error to provide an api_key and a transport instance. - transport = transports.ProductSearchGrpcTransport( + # verify fields with default values are dropped + + unset_fields = transport_class( + credentials=ga_credentials.AnonymousCredentials() + ).create_product_set._get_unset_required_fields(jsonified_request) + jsonified_request.update(unset_fields) + + # verify required fields with default values are now present + + jsonified_request["parent"] = "parent_value" + + unset_fields = transport_class( + credentials=ga_credentials.AnonymousCredentials() + ).create_product_set._get_unset_required_fields(jsonified_request) + # Check that path parameters and body parameters are not mixing in. + assert not set(unset_fields) - set(("product_set_id",)) + jsonified_request.update(unset_fields) + + # verify required fields with non-default values are left alone + assert "parent" in jsonified_request + assert jsonified_request["parent"] == "parent_value" + + client = ProductSearchClient( credentials=ga_credentials.AnonymousCredentials(), - ) - options = client_options.ClientOptions() - options.api_key = "api_key" - with pytest.raises(ValueError): - client = ProductSearchClient( - client_options=options, - transport=transport, + transport="rest", + ) + request = request_type(**request_init) + + # Designate an appropriate value for the returned response. + return_value = product_search_service.ProductSet() + # Mock the http request call within the method and fake a response. + with mock.patch.object(Session, "request") as req: + # We need to mock transcode() because providing default values + # for required fields will fail the real version if the http_options + # expect actual values for those fields. + with mock.patch.object(path_template, "transcode") as transcode: + # A uri without fields and an empty body will force all the + # request fields to show up in the query_params. + pb_request = request_type.pb(request) + transcode_result = { + "uri": "v1/sample_method", + "method": "post", + "query_params": pb_request, + } + transcode_result["body"] = pb_request + transcode.return_value = transcode_result + + response_value = Response() + response_value.status_code = 200 + + pb_return_value = product_search_service.ProductSet.pb(return_value) + json_return_value = json_format.MessageToJson(pb_return_value) + + response_value._content = json_return_value.encode("UTF-8") + req.return_value = response_value + + response = client.create_product_set(request) + + expected_params = [("$alt", "json;enum-encoding=int")] + actual_params = req.call_args.kwargs["params"] + assert expected_params == actual_params + + +def test_create_product_set_rest_unset_required_fields(): + transport = transports.ProductSearchRestTransport( + credentials=ga_credentials.AnonymousCredentials + ) + + unset_fields = transport.create_product_set._get_unset_required_fields({}) + assert set(unset_fields) == ( + set(("productSetId",)) + & set( + ( + "parent", + "productSet", + ) ) + ) - # It is an error to provide an api_key and a credential. - options = mock.Mock() - options.api_key = "api_key" - with pytest.raises(ValueError): - client = ProductSearchClient( - client_options=options, credentials=ga_credentials.AnonymousCredentials() - ) - # It is an error to provide scopes and a transport instance. - transport = transports.ProductSearchGrpcTransport( +@pytest.mark.parametrize("null_interceptor", [True, False]) +def test_create_product_set_rest_interceptors(null_interceptor): + transport = transports.ProductSearchRestTransport( credentials=ga_credentials.AnonymousCredentials(), + interceptor=None + if null_interceptor + else transports.ProductSearchRestInterceptor(), ) - with pytest.raises(ValueError): - client = ProductSearchClient( - client_options={"scopes": ["1", "2"]}, - transport=transport, + client = ProductSearchClient(transport=transport) + with mock.patch.object( + type(client.transport._session), "request" + ) as req, mock.patch.object( + path_template, "transcode" + ) as transcode, mock.patch.object( + transports.ProductSearchRestInterceptor, "post_create_product_set" + ) as post, mock.patch.object( + transports.ProductSearchRestInterceptor, "pre_create_product_set" + ) as pre: + pre.assert_not_called() + post.assert_not_called() + pb_message = product_search_service.CreateProductSetRequest.pb( + product_search_service.CreateProductSetRequest() + ) + transcode.return_value = { + "method": "post", + "uri": "my_uri", + "body": pb_message, + "query_params": pb_message, + } + + req.return_value = Response() + req.return_value.status_code = 200 + req.return_value.request = PreparedRequest() + req.return_value._content = product_search_service.ProductSet.to_json( + product_search_service.ProductSet() ) + request = product_search_service.CreateProductSetRequest() + metadata = [ + ("key", "val"), + ("cephalopod", "squid"), + ] + pre.return_value = request, metadata + post.return_value = product_search_service.ProductSet() -def test_transport_instance(): - # A client may be instantiated with a custom transport instance. - transport = transports.ProductSearchGrpcTransport( + client.create_product_set( + request, + metadata=[ + ("key", "val"), + ("cephalopod", "squid"), + ], + ) + + pre.assert_called_once() + post.assert_called_once() + + +def test_create_product_set_rest_bad_request( + transport: str = "rest", request_type=product_search_service.CreateProductSetRequest +): + client = ProductSearchClient( credentials=ga_credentials.AnonymousCredentials(), + transport=transport, ) - client = ProductSearchClient(transport=transport) - assert client.transport is transport + # send a request that will satisfy transcoding + request_init = {"parent": "projects/sample1/locations/sample2"} + request_init["product_set"] = { + "name": "name_value", + "display_name": "display_name_value", + "index_time": {"seconds": 751, "nanos": 543}, + "index_error": { + "code": 411, + "message": "message_value", + "details": [ + { + "type_url": "type.googleapis.com/google.protobuf.Duration", + "value": b"\x08\x0c\x10\xdb\x07", + } + ], + }, + } + request = request_type(**request_init) -def test_transport_get_channel(): - # A client may be instantiated with a custom transport instance. - transport = transports.ProductSearchGrpcTransport( + # Mock the http request call within the method and fake a BadRequest error. + with mock.patch.object(Session, "request") as req, pytest.raises( + core_exceptions.BadRequest + ): + # Wrap the value into a proper Response obj + response_value = Response() + response_value.status_code = 400 + response_value.request = Request() + req.return_value = response_value + client.create_product_set(request) + + +def test_create_product_set_rest_flattened(): + client = ProductSearchClient( credentials=ga_credentials.AnonymousCredentials(), + transport="rest", ) - channel = transport.grpc_channel - assert channel - transport = transports.ProductSearchGrpcAsyncIOTransport( + # Mock the http request call within the method and fake a response. + with mock.patch.object(type(client.transport._session), "request") as req: + # Designate an appropriate value for the returned response. + return_value = product_search_service.ProductSet() + + # get arguments that satisfy an http rule for this method + sample_request = {"parent": "projects/sample1/locations/sample2"} + + # get truthy value for each flattened field + mock_args = dict( + parent="parent_value", + product_set=product_search_service.ProductSet(name="name_value"), + product_set_id="product_set_id_value", + ) + mock_args.update(sample_request) + + # Wrap the value into a proper Response obj + response_value = Response() + response_value.status_code = 200 + pb_return_value = product_search_service.ProductSet.pb(return_value) + json_return_value = json_format.MessageToJson(pb_return_value) + response_value._content = json_return_value.encode("UTF-8") + req.return_value = response_value + + client.create_product_set(**mock_args) + + # Establish that the underlying call was made with the expected + # request object values. + assert len(req.mock_calls) == 1 + _, args, _ = req.mock_calls[0] + assert path_template.validate( + "%s/v1/{parent=projects/*/locations/*}/productSets" + % client.transport._host, + args[1], + ) + + +def test_create_product_set_rest_flattened_error(transport: str = "rest"): + client = ProductSearchClient( credentials=ga_credentials.AnonymousCredentials(), + transport=transport, ) - channel = transport.grpc_channel - assert channel + + # Attempting to call a method with both a request object and flattened + # fields is an error. + with pytest.raises(ValueError): + client.create_product_set( + product_search_service.CreateProductSetRequest(), + parent="parent_value", + product_set=product_search_service.ProductSet(name="name_value"), + product_set_id="product_set_id_value", + ) -@pytest.mark.parametrize( - "transport_class", - [ - transports.ProductSearchGrpcTransport, - transports.ProductSearchGrpcAsyncIOTransport, - ], -) -def test_transport_adc(transport_class): - # Test default credentials are used if not provided. - with mock.patch.object(google.auth, "default") as adc: - adc.return_value = (ga_credentials.AnonymousCredentials(), None) - transport_class() - adc.assert_called_once() +def test_create_product_set_rest_error(): + client = ProductSearchClient( + credentials=ga_credentials.AnonymousCredentials(), transport="rest" + ) @pytest.mark.parametrize( - "transport_name", + "request_type", [ - "grpc", + product_search_service.ListProductSetsRequest, + dict, ], ) -def test_transport_kind(transport_name): - transport = ProductSearchClient.get_transport_class(transport_name)( - credentials=ga_credentials.AnonymousCredentials(), - ) - assert transport.kind == transport_name - - -def test_transport_grpc_default(): - # A client should use the gRPC transport by default. +def test_list_product_sets_rest(request_type): client = ProductSearchClient( credentials=ga_credentials.AnonymousCredentials(), - ) - assert isinstance( - client.transport, - transports.ProductSearchGrpcTransport, + transport="rest", ) + # send a request that will satisfy transcoding + request_init = {"parent": "projects/sample1/locations/sample2"} + request = request_type(**request_init) -def test_product_search_base_transport_error(): - # Passing both a credentials object and credentials_file should raise an error - with pytest.raises(core_exceptions.DuplicateCredentialArgs): - transport = transports.ProductSearchTransport( - credentials=ga_credentials.AnonymousCredentials(), - credentials_file="credentials.json", + # Mock the http request call within the method and fake a response. + with mock.patch.object(type(client.transport._session), "request") as req: + # Designate an appropriate value for the returned response. + return_value = product_search_service.ListProductSetsResponse( + next_page_token="next_page_token_value", ) - -def test_product_search_base_transport(): - # Instantiate the base transport. - with mock.patch( - "google.cloud.vision_v1.services.product_search.transports.ProductSearchTransport.__init__" - ) as Transport: - Transport.return_value = None - transport = transports.ProductSearchTransport( - credentials=ga_credentials.AnonymousCredentials(), + # Wrap the value into a proper Response obj + response_value = Response() + response_value.status_code = 200 + pb_return_value = product_search_service.ListProductSetsResponse.pb( + return_value ) + json_return_value = json_format.MessageToJson(pb_return_value) - # Every method on the transport should just blindly - # raise NotImplementedError. - methods = ( - "create_product_set", - "list_product_sets", - "get_product_set", - "update_product_set", - "delete_product_set", - "create_product", - "list_products", - "get_product", - "update_product", - "delete_product", - "create_reference_image", - "delete_reference_image", - "list_reference_images", - "get_reference_image", - "add_product_to_product_set", - "remove_product_from_product_set", - "list_products_in_product_set", - "import_product_sets", - "purge_products", + response_value._content = json_return_value.encode("UTF-8") + req.return_value = response_value + response = client.list_product_sets(request) + + # Establish that the response is the type that we expect. + assert isinstance(response, pagers.ListProductSetsPager) + assert response.next_page_token == "next_page_token_value" + + +def test_list_product_sets_rest_required_fields( + request_type=product_search_service.ListProductSetsRequest, +): + transport_class = transports.ProductSearchRestTransport + + request_init = {} + request_init["parent"] = "" + request = request_type(**request_init) + pb_request = request_type.pb(request) + jsonified_request = json.loads( + json_format.MessageToJson( + pb_request, + including_default_value_fields=False, + use_integers_for_enums=False, + ) ) - for method in methods: - with pytest.raises(NotImplementedError): - getattr(transport, method)(request=object()) - with pytest.raises(NotImplementedError): - transport.close() + # verify fields with default values are dropped - # Additionally, the LRO client (a property) should - # also raise NotImplementedError - with pytest.raises(NotImplementedError): - transport.operations_client + unset_fields = transport_class( + credentials=ga_credentials.AnonymousCredentials() + ).list_product_sets._get_unset_required_fields(jsonified_request) + jsonified_request.update(unset_fields) - # Catch all for all remaining methods and properties - remainder = [ - "kind", - ] - for r in remainder: - with pytest.raises(NotImplementedError): - getattr(transport, r)() + # verify required fields with default values are now present + jsonified_request["parent"] = "parent_value" -def test_product_search_base_transport_with_credentials_file(): - # 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.vision_v1.services.product_search.transports.ProductSearchTransport._prep_wrapped_messages" - ) as Transport: - Transport.return_value = None - load_creds.return_value = (ga_credentials.AnonymousCredentials(), None) - transport = transports.ProductSearchTransport( - credentials_file="credentials.json", - quota_project_id="octopus", - ) - load_creds.assert_called_once_with( - "credentials.json", - scopes=None, - default_scopes=( - "https://www.googleapis.com/auth/cloud-platform", - "https://www.googleapis.com/auth/cloud-vision", - ), - quota_project_id="octopus", + unset_fields = transport_class( + credentials=ga_credentials.AnonymousCredentials() + ).list_product_sets._get_unset_required_fields(jsonified_request) + # Check that path parameters and body parameters are not mixing in. + assert not set(unset_fields) - set( + ( + "page_size", + "page_token", ) + ) + jsonified_request.update(unset_fields) + # verify required fields with non-default values are left alone + assert "parent" in jsonified_request + assert jsonified_request["parent"] == "parent_value" -def test_product_search_base_transport_with_adc(): - # Test the default credentials are used if credentials and credentials_file are None. + client = ProductSearchClient( + credentials=ga_credentials.AnonymousCredentials(), + transport="rest", + ) + request = request_type(**request_init) + + # Designate an appropriate value for the returned response. + return_value = product_search_service.ListProductSetsResponse() + # Mock the http request call within the method and fake a response. + with mock.patch.object(Session, "request") as req: + # We need to mock transcode() because providing default values + # for required fields will fail the real version if the http_options + # expect actual values for those fields. + with mock.patch.object(path_template, "transcode") as transcode: + # A uri without fields and an empty body will force all the + # request fields to show up in the query_params. + pb_request = request_type.pb(request) + transcode_result = { + "uri": "v1/sample_method", + "method": "get", + "query_params": pb_request, + } + transcode.return_value = transcode_result + + response_value = Response() + response_value.status_code = 200 + + pb_return_value = product_search_service.ListProductSetsResponse.pb( + return_value + ) + json_return_value = json_format.MessageToJson(pb_return_value) + + response_value._content = json_return_value.encode("UTF-8") + req.return_value = response_value + + response = client.list_product_sets(request) + + expected_params = [("$alt", "json;enum-encoding=int")] + actual_params = req.call_args.kwargs["params"] + assert expected_params == actual_params + + +def test_list_product_sets_rest_unset_required_fields(): + transport = transports.ProductSearchRestTransport( + credentials=ga_credentials.AnonymousCredentials + ) + + unset_fields = transport.list_product_sets._get_unset_required_fields({}) + assert set(unset_fields) == ( + set( + ( + "pageSize", + "pageToken", + ) + ) + & set(("parent",)) + ) + + +@pytest.mark.parametrize("null_interceptor", [True, False]) +def test_list_product_sets_rest_interceptors(null_interceptor): + transport = transports.ProductSearchRestTransport( + credentials=ga_credentials.AnonymousCredentials(), + interceptor=None + if null_interceptor + else transports.ProductSearchRestInterceptor(), + ) + client = ProductSearchClient(transport=transport) + with mock.patch.object( + type(client.transport._session), "request" + ) as req, mock.patch.object( + path_template, "transcode" + ) as transcode, mock.patch.object( + transports.ProductSearchRestInterceptor, "post_list_product_sets" + ) as post, mock.patch.object( + transports.ProductSearchRestInterceptor, "pre_list_product_sets" + ) as pre: + pre.assert_not_called() + post.assert_not_called() + pb_message = product_search_service.ListProductSetsRequest.pb( + product_search_service.ListProductSetsRequest() + ) + transcode.return_value = { + "method": "post", + "uri": "my_uri", + "body": pb_message, + "query_params": pb_message, + } + + req.return_value = Response() + req.return_value.status_code = 200 + req.return_value.request = PreparedRequest() + req.return_value._content = ( + product_search_service.ListProductSetsResponse.to_json( + product_search_service.ListProductSetsResponse() + ) + ) + + request = product_search_service.ListProductSetsRequest() + metadata = [ + ("key", "val"), + ("cephalopod", "squid"), + ] + pre.return_value = request, metadata + post.return_value = product_search_service.ListProductSetsResponse() + + client.list_product_sets( + request, + metadata=[ + ("key", "val"), + ("cephalopod", "squid"), + ], + ) + + pre.assert_called_once() + post.assert_called_once() + + +def test_list_product_sets_rest_bad_request( + transport: str = "rest", request_type=product_search_service.ListProductSetsRequest +): + client = ProductSearchClient( + credentials=ga_credentials.AnonymousCredentials(), + transport=transport, + ) + + # send a request that will satisfy transcoding + request_init = {"parent": "projects/sample1/locations/sample2"} + request = request_type(**request_init) + + # Mock the http request call within the method and fake a BadRequest error. + with mock.patch.object(Session, "request") as req, pytest.raises( + core_exceptions.BadRequest + ): + # Wrap the value into a proper Response obj + response_value = Response() + response_value.status_code = 400 + response_value.request = Request() + req.return_value = response_value + client.list_product_sets(request) + + +def test_list_product_sets_rest_flattened(): + client = ProductSearchClient( + credentials=ga_credentials.AnonymousCredentials(), + transport="rest", + ) + + # Mock the http request call within the method and fake a response. + with mock.patch.object(type(client.transport._session), "request") as req: + # Designate an appropriate value for the returned response. + return_value = product_search_service.ListProductSetsResponse() + + # get arguments that satisfy an http rule for this method + sample_request = {"parent": "projects/sample1/locations/sample2"} + + # get truthy value for each flattened field + mock_args = dict( + parent="parent_value", + ) + mock_args.update(sample_request) + + # Wrap the value into a proper Response obj + response_value = Response() + response_value.status_code = 200 + pb_return_value = product_search_service.ListProductSetsResponse.pb( + return_value + ) + json_return_value = json_format.MessageToJson(pb_return_value) + response_value._content = json_return_value.encode("UTF-8") + req.return_value = response_value + + client.list_product_sets(**mock_args) + + # Establish that the underlying call was made with the expected + # request object values. + assert len(req.mock_calls) == 1 + _, args, _ = req.mock_calls[0] + assert path_template.validate( + "%s/v1/{parent=projects/*/locations/*}/productSets" + % client.transport._host, + args[1], + ) + + +def test_list_product_sets_rest_flattened_error(transport: str = "rest"): + client = ProductSearchClient( + credentials=ga_credentials.AnonymousCredentials(), + transport=transport, + ) + + # Attempting to call a method with both a request object and flattened + # fields is an error. + with pytest.raises(ValueError): + client.list_product_sets( + product_search_service.ListProductSetsRequest(), + parent="parent_value", + ) + + +def test_list_product_sets_rest_pager(transport: str = "rest"): + client = ProductSearchClient( + credentials=ga_credentials.AnonymousCredentials(), + transport=transport, + ) + + # Mock the http request call within the method and fake a response. + with mock.patch.object(Session, "request") as req: + # TODO(kbandes): remove this mock unless there's a good reason for it. + # with mock.patch.object(path_template, 'transcode') as transcode: + # Set the response as a series of pages + response = ( + product_search_service.ListProductSetsResponse( + product_sets=[ + product_search_service.ProductSet(), + product_search_service.ProductSet(), + product_search_service.ProductSet(), + ], + next_page_token="abc", + ), + product_search_service.ListProductSetsResponse( + product_sets=[], + next_page_token="def", + ), + product_search_service.ListProductSetsResponse( + product_sets=[ + product_search_service.ProductSet(), + ], + next_page_token="ghi", + ), + product_search_service.ListProductSetsResponse( + product_sets=[ + product_search_service.ProductSet(), + product_search_service.ProductSet(), + ], + ), + ) + # Two responses for two calls + response = response + response + + # Wrap the values into proper Response objs + response = tuple( + product_search_service.ListProductSetsResponse.to_json(x) for x in response + ) + return_values = tuple(Response() for i in response) + for return_val, response_val in zip(return_values, response): + return_val._content = response_val.encode("UTF-8") + return_val.status_code = 200 + req.side_effect = return_values + + sample_request = {"parent": "projects/sample1/locations/sample2"} + + pager = client.list_product_sets(request=sample_request) + + results = list(pager) + assert len(results) == 6 + assert all(isinstance(i, product_search_service.ProductSet) for i in results) + + pages = list(client.list_product_sets(request=sample_request).pages) + for page_, token in zip(pages, ["abc", "def", "ghi", ""]): + assert page_.raw_page.next_page_token == token + + +@pytest.mark.parametrize( + "request_type", + [ + product_search_service.GetProductSetRequest, + dict, + ], +) +def test_get_product_set_rest(request_type): + client = ProductSearchClient( + credentials=ga_credentials.AnonymousCredentials(), + transport="rest", + ) + + # send a request that will satisfy transcoding + request_init = {"name": "projects/sample1/locations/sample2/productSets/sample3"} + request = request_type(**request_init) + + # Mock the http request call within the method and fake a response. + with mock.patch.object(type(client.transport._session), "request") as req: + # Designate an appropriate value for the returned response. + return_value = product_search_service.ProductSet( + name="name_value", + display_name="display_name_value", + ) + + # Wrap the value into a proper Response obj + response_value = Response() + response_value.status_code = 200 + pb_return_value = product_search_service.ProductSet.pb(return_value) + json_return_value = json_format.MessageToJson(pb_return_value) + + response_value._content = json_return_value.encode("UTF-8") + req.return_value = response_value + response = client.get_product_set(request) + + # Establish that the response is the type that we expect. + assert isinstance(response, product_search_service.ProductSet) + assert response.name == "name_value" + assert response.display_name == "display_name_value" + + +def test_get_product_set_rest_required_fields( + request_type=product_search_service.GetProductSetRequest, +): + transport_class = transports.ProductSearchRestTransport + + request_init = {} + request_init["name"] = "" + request = request_type(**request_init) + pb_request = request_type.pb(request) + jsonified_request = json.loads( + json_format.MessageToJson( + pb_request, + including_default_value_fields=False, + use_integers_for_enums=False, + ) + ) + + # verify fields with default values are dropped + + unset_fields = transport_class( + credentials=ga_credentials.AnonymousCredentials() + ).get_product_set._get_unset_required_fields(jsonified_request) + jsonified_request.update(unset_fields) + + # verify required fields with default values are now present + + jsonified_request["name"] = "name_value" + + unset_fields = transport_class( + credentials=ga_credentials.AnonymousCredentials() + ).get_product_set._get_unset_required_fields(jsonified_request) + jsonified_request.update(unset_fields) + + # verify required fields with non-default values are left alone + assert "name" in jsonified_request + assert jsonified_request["name"] == "name_value" + + client = ProductSearchClient( + credentials=ga_credentials.AnonymousCredentials(), + transport="rest", + ) + request = request_type(**request_init) + + # Designate an appropriate value for the returned response. + return_value = product_search_service.ProductSet() + # Mock the http request call within the method and fake a response. + with mock.patch.object(Session, "request") as req: + # We need to mock transcode() because providing default values + # for required fields will fail the real version if the http_options + # expect actual values for those fields. + with mock.patch.object(path_template, "transcode") as transcode: + # A uri without fields and an empty body will force all the + # request fields to show up in the query_params. + pb_request = request_type.pb(request) + transcode_result = { + "uri": "v1/sample_method", + "method": "get", + "query_params": pb_request, + } + transcode.return_value = transcode_result + + response_value = Response() + response_value.status_code = 200 + + pb_return_value = product_search_service.ProductSet.pb(return_value) + json_return_value = json_format.MessageToJson(pb_return_value) + + response_value._content = json_return_value.encode("UTF-8") + req.return_value = response_value + + response = client.get_product_set(request) + + expected_params = [("$alt", "json;enum-encoding=int")] + actual_params = req.call_args.kwargs["params"] + assert expected_params == actual_params + + +def test_get_product_set_rest_unset_required_fields(): + transport = transports.ProductSearchRestTransport( + credentials=ga_credentials.AnonymousCredentials + ) + + unset_fields = transport.get_product_set._get_unset_required_fields({}) + assert set(unset_fields) == (set(()) & set(("name",))) + + +@pytest.mark.parametrize("null_interceptor", [True, False]) +def test_get_product_set_rest_interceptors(null_interceptor): + transport = transports.ProductSearchRestTransport( + credentials=ga_credentials.AnonymousCredentials(), + interceptor=None + if null_interceptor + else transports.ProductSearchRestInterceptor(), + ) + client = ProductSearchClient(transport=transport) + with mock.patch.object( + type(client.transport._session), "request" + ) as req, mock.patch.object( + path_template, "transcode" + ) as transcode, mock.patch.object( + transports.ProductSearchRestInterceptor, "post_get_product_set" + ) as post, mock.patch.object( + transports.ProductSearchRestInterceptor, "pre_get_product_set" + ) as pre: + pre.assert_not_called() + post.assert_not_called() + pb_message = product_search_service.GetProductSetRequest.pb( + product_search_service.GetProductSetRequest() + ) + transcode.return_value = { + "method": "post", + "uri": "my_uri", + "body": pb_message, + "query_params": pb_message, + } + + req.return_value = Response() + req.return_value.status_code = 200 + req.return_value.request = PreparedRequest() + req.return_value._content = product_search_service.ProductSet.to_json( + product_search_service.ProductSet() + ) + + request = product_search_service.GetProductSetRequest() + metadata = [ + ("key", "val"), + ("cephalopod", "squid"), + ] + pre.return_value = request, metadata + post.return_value = product_search_service.ProductSet() + + client.get_product_set( + request, + metadata=[ + ("key", "val"), + ("cephalopod", "squid"), + ], + ) + + pre.assert_called_once() + post.assert_called_once() + + +def test_get_product_set_rest_bad_request( + transport: str = "rest", request_type=product_search_service.GetProductSetRequest +): + client = ProductSearchClient( + credentials=ga_credentials.AnonymousCredentials(), + transport=transport, + ) + + # send a request that will satisfy transcoding + request_init = {"name": "projects/sample1/locations/sample2/productSets/sample3"} + request = request_type(**request_init) + + # Mock the http request call within the method and fake a BadRequest error. + with mock.patch.object(Session, "request") as req, pytest.raises( + core_exceptions.BadRequest + ): + # Wrap the value into a proper Response obj + response_value = Response() + response_value.status_code = 400 + response_value.request = Request() + req.return_value = response_value + client.get_product_set(request) + + +def test_get_product_set_rest_flattened(): + client = ProductSearchClient( + credentials=ga_credentials.AnonymousCredentials(), + transport="rest", + ) + + # Mock the http request call within the method and fake a response. + with mock.patch.object(type(client.transport._session), "request") as req: + # Designate an appropriate value for the returned response. + return_value = product_search_service.ProductSet() + + # get arguments that satisfy an http rule for this method + sample_request = { + "name": "projects/sample1/locations/sample2/productSets/sample3" + } + + # get truthy value for each flattened field + mock_args = dict( + name="name_value", + ) + mock_args.update(sample_request) + + # Wrap the value into a proper Response obj + response_value = Response() + response_value.status_code = 200 + pb_return_value = product_search_service.ProductSet.pb(return_value) + json_return_value = json_format.MessageToJson(pb_return_value) + response_value._content = json_return_value.encode("UTF-8") + req.return_value = response_value + + client.get_product_set(**mock_args) + + # Establish that the underlying call was made with the expected + # request object values. + assert len(req.mock_calls) == 1 + _, args, _ = req.mock_calls[0] + assert path_template.validate( + "%s/v1/{name=projects/*/locations/*/productSets/*}" + % client.transport._host, + args[1], + ) + + +def test_get_product_set_rest_flattened_error(transport: str = "rest"): + client = ProductSearchClient( + credentials=ga_credentials.AnonymousCredentials(), + transport=transport, + ) + + # Attempting to call a method with both a request object and flattened + # fields is an error. + with pytest.raises(ValueError): + client.get_product_set( + product_search_service.GetProductSetRequest(), + name="name_value", + ) + + +def test_get_product_set_rest_error(): + client = ProductSearchClient( + credentials=ga_credentials.AnonymousCredentials(), transport="rest" + ) + + +@pytest.mark.parametrize( + "request_type", + [ + product_search_service.UpdateProductSetRequest, + dict, + ], +) +def test_update_product_set_rest(request_type): + client = ProductSearchClient( + credentials=ga_credentials.AnonymousCredentials(), + transport="rest", + ) + + # send a request that will satisfy transcoding + request_init = { + "product_set": { + "name": "projects/sample1/locations/sample2/productSets/sample3" + } + } + request_init["product_set"] = { + "name": "projects/sample1/locations/sample2/productSets/sample3", + "display_name": "display_name_value", + "index_time": {"seconds": 751, "nanos": 543}, + "index_error": { + "code": 411, + "message": "message_value", + "details": [ + { + "type_url": "type.googleapis.com/google.protobuf.Duration", + "value": b"\x08\x0c\x10\xdb\x07", + } + ], + }, + } + request = request_type(**request_init) + + # Mock the http request call within the method and fake a response. + with mock.patch.object(type(client.transport._session), "request") as req: + # Designate an appropriate value for the returned response. + return_value = product_search_service.ProductSet( + name="name_value", + display_name="display_name_value", + ) + + # Wrap the value into a proper Response obj + response_value = Response() + response_value.status_code = 200 + pb_return_value = product_search_service.ProductSet.pb(return_value) + json_return_value = json_format.MessageToJson(pb_return_value) + + response_value._content = json_return_value.encode("UTF-8") + req.return_value = response_value + response = client.update_product_set(request) + + # Establish that the response is the type that we expect. + assert isinstance(response, product_search_service.ProductSet) + assert response.name == "name_value" + assert response.display_name == "display_name_value" + + +def test_update_product_set_rest_required_fields( + request_type=product_search_service.UpdateProductSetRequest, +): + transport_class = transports.ProductSearchRestTransport + + request_init = {} + request = request_type(**request_init) + pb_request = request_type.pb(request) + jsonified_request = json.loads( + json_format.MessageToJson( + pb_request, + including_default_value_fields=False, + use_integers_for_enums=False, + ) + ) + + # verify fields with default values are dropped + + unset_fields = transport_class( + credentials=ga_credentials.AnonymousCredentials() + ).update_product_set._get_unset_required_fields(jsonified_request) + jsonified_request.update(unset_fields) + + # verify required fields with default values are now present + + unset_fields = transport_class( + credentials=ga_credentials.AnonymousCredentials() + ).update_product_set._get_unset_required_fields(jsonified_request) + # Check that path parameters and body parameters are not mixing in. + assert not set(unset_fields) - set(("update_mask",)) + jsonified_request.update(unset_fields) + + # verify required fields with non-default values are left alone + + client = ProductSearchClient( + credentials=ga_credentials.AnonymousCredentials(), + transport="rest", + ) + request = request_type(**request_init) + + # Designate an appropriate value for the returned response. + return_value = product_search_service.ProductSet() + # Mock the http request call within the method and fake a response. + with mock.patch.object(Session, "request") as req: + # We need to mock transcode() because providing default values + # for required fields will fail the real version if the http_options + # expect actual values for those fields. + with mock.patch.object(path_template, "transcode") as transcode: + # A uri without fields and an empty body will force all the + # request fields to show up in the query_params. + pb_request = request_type.pb(request) + transcode_result = { + "uri": "v1/sample_method", + "method": "patch", + "query_params": pb_request, + } + transcode_result["body"] = pb_request + transcode.return_value = transcode_result + + response_value = Response() + response_value.status_code = 200 + + pb_return_value = product_search_service.ProductSet.pb(return_value) + json_return_value = json_format.MessageToJson(pb_return_value) + + response_value._content = json_return_value.encode("UTF-8") + req.return_value = response_value + + response = client.update_product_set(request) + + expected_params = [("$alt", "json;enum-encoding=int")] + actual_params = req.call_args.kwargs["params"] + assert expected_params == actual_params + + +def test_update_product_set_rest_unset_required_fields(): + transport = transports.ProductSearchRestTransport( + credentials=ga_credentials.AnonymousCredentials + ) + + unset_fields = transport.update_product_set._get_unset_required_fields({}) + assert set(unset_fields) == (set(("updateMask",)) & set(("productSet",))) + + +@pytest.mark.parametrize("null_interceptor", [True, False]) +def test_update_product_set_rest_interceptors(null_interceptor): + transport = transports.ProductSearchRestTransport( + credentials=ga_credentials.AnonymousCredentials(), + interceptor=None + if null_interceptor + else transports.ProductSearchRestInterceptor(), + ) + client = ProductSearchClient(transport=transport) + with mock.patch.object( + type(client.transport._session), "request" + ) as req, mock.patch.object( + path_template, "transcode" + ) as transcode, mock.patch.object( + transports.ProductSearchRestInterceptor, "post_update_product_set" + ) as post, mock.patch.object( + transports.ProductSearchRestInterceptor, "pre_update_product_set" + ) as pre: + pre.assert_not_called() + post.assert_not_called() + pb_message = product_search_service.UpdateProductSetRequest.pb( + product_search_service.UpdateProductSetRequest() + ) + transcode.return_value = { + "method": "post", + "uri": "my_uri", + "body": pb_message, + "query_params": pb_message, + } + + req.return_value = Response() + req.return_value.status_code = 200 + req.return_value.request = PreparedRequest() + req.return_value._content = product_search_service.ProductSet.to_json( + product_search_service.ProductSet() + ) + + request = product_search_service.UpdateProductSetRequest() + metadata = [ + ("key", "val"), + ("cephalopod", "squid"), + ] + pre.return_value = request, metadata + post.return_value = product_search_service.ProductSet() + + client.update_product_set( + request, + metadata=[ + ("key", "val"), + ("cephalopod", "squid"), + ], + ) + + pre.assert_called_once() + post.assert_called_once() + + +def test_update_product_set_rest_bad_request( + transport: str = "rest", request_type=product_search_service.UpdateProductSetRequest +): + client = ProductSearchClient( + credentials=ga_credentials.AnonymousCredentials(), + transport=transport, + ) + + # send a request that will satisfy transcoding + request_init = { + "product_set": { + "name": "projects/sample1/locations/sample2/productSets/sample3" + } + } + request_init["product_set"] = { + "name": "projects/sample1/locations/sample2/productSets/sample3", + "display_name": "display_name_value", + "index_time": {"seconds": 751, "nanos": 543}, + "index_error": { + "code": 411, + "message": "message_value", + "details": [ + { + "type_url": "type.googleapis.com/google.protobuf.Duration", + "value": b"\x08\x0c\x10\xdb\x07", + } + ], + }, + } + request = request_type(**request_init) + + # Mock the http request call within the method and fake a BadRequest error. + with mock.patch.object(Session, "request") as req, pytest.raises( + core_exceptions.BadRequest + ): + # Wrap the value into a proper Response obj + response_value = Response() + response_value.status_code = 400 + response_value.request = Request() + req.return_value = response_value + client.update_product_set(request) + + +def test_update_product_set_rest_flattened(): + client = ProductSearchClient( + credentials=ga_credentials.AnonymousCredentials(), + transport="rest", + ) + + # Mock the http request call within the method and fake a response. + with mock.patch.object(type(client.transport._session), "request") as req: + # Designate an appropriate value for the returned response. + return_value = product_search_service.ProductSet() + + # get arguments that satisfy an http rule for this method + sample_request = { + "product_set": { + "name": "projects/sample1/locations/sample2/productSets/sample3" + } + } + + # get truthy value for each flattened field + mock_args = dict( + product_set=product_search_service.ProductSet(name="name_value"), + update_mask=field_mask_pb2.FieldMask(paths=["paths_value"]), + ) + mock_args.update(sample_request) + + # Wrap the value into a proper Response obj + response_value = Response() + response_value.status_code = 200 + pb_return_value = product_search_service.ProductSet.pb(return_value) + json_return_value = json_format.MessageToJson(pb_return_value) + response_value._content = json_return_value.encode("UTF-8") + req.return_value = response_value + + client.update_product_set(**mock_args) + + # Establish that the underlying call was made with the expected + # request object values. + assert len(req.mock_calls) == 1 + _, args, _ = req.mock_calls[0] + assert path_template.validate( + "%s/v1/{product_set.name=projects/*/locations/*/productSets/*}" + % client.transport._host, + args[1], + ) + + +def test_update_product_set_rest_flattened_error(transport: str = "rest"): + client = ProductSearchClient( + credentials=ga_credentials.AnonymousCredentials(), + transport=transport, + ) + + # Attempting to call a method with both a request object and flattened + # fields is an error. + with pytest.raises(ValueError): + client.update_product_set( + product_search_service.UpdateProductSetRequest(), + product_set=product_search_service.ProductSet(name="name_value"), + update_mask=field_mask_pb2.FieldMask(paths=["paths_value"]), + ) + + +def test_update_product_set_rest_error(): + client = ProductSearchClient( + credentials=ga_credentials.AnonymousCredentials(), transport="rest" + ) + + +@pytest.mark.parametrize( + "request_type", + [ + product_search_service.DeleteProductSetRequest, + dict, + ], +) +def test_delete_product_set_rest(request_type): + client = ProductSearchClient( + credentials=ga_credentials.AnonymousCredentials(), + transport="rest", + ) + + # send a request that will satisfy transcoding + request_init = {"name": "projects/sample1/locations/sample2/productSets/sample3"} + request = request_type(**request_init) + + # Mock the http request call within the method and fake a response. + with mock.patch.object(type(client.transport._session), "request") as req: + # Designate an appropriate value for the returned response. + return_value = None + + # Wrap the value into a proper Response obj + response_value = Response() + response_value.status_code = 200 + json_return_value = "" + + response_value._content = json_return_value.encode("UTF-8") + req.return_value = response_value + response = client.delete_product_set(request) + + # Establish that the response is the type that we expect. + assert response is None + + +def test_delete_product_set_rest_required_fields( + request_type=product_search_service.DeleteProductSetRequest, +): + transport_class = transports.ProductSearchRestTransport + + request_init = {} + request_init["name"] = "" + request = request_type(**request_init) + pb_request = request_type.pb(request) + jsonified_request = json.loads( + json_format.MessageToJson( + pb_request, + including_default_value_fields=False, + use_integers_for_enums=False, + ) + ) + + # verify fields with default values are dropped + + unset_fields = transport_class( + credentials=ga_credentials.AnonymousCredentials() + ).delete_product_set._get_unset_required_fields(jsonified_request) + jsonified_request.update(unset_fields) + + # verify required fields with default values are now present + + jsonified_request["name"] = "name_value" + + unset_fields = transport_class( + credentials=ga_credentials.AnonymousCredentials() + ).delete_product_set._get_unset_required_fields(jsonified_request) + jsonified_request.update(unset_fields) + + # verify required fields with non-default values are left alone + assert "name" in jsonified_request + assert jsonified_request["name"] == "name_value" + + client = ProductSearchClient( + credentials=ga_credentials.AnonymousCredentials(), + transport="rest", + ) + request = request_type(**request_init) + + # Designate an appropriate value for the returned response. + return_value = None + # Mock the http request call within the method and fake a response. + with mock.patch.object(Session, "request") as req: + # We need to mock transcode() because providing default values + # for required fields will fail the real version if the http_options + # expect actual values for those fields. + with mock.patch.object(path_template, "transcode") as transcode: + # A uri without fields and an empty body will force all the + # request fields to show up in the query_params. + pb_request = request_type.pb(request) + transcode_result = { + "uri": "v1/sample_method", + "method": "delete", + "query_params": pb_request, + } + transcode.return_value = transcode_result + + response_value = Response() + response_value.status_code = 200 + json_return_value = "" + + response_value._content = json_return_value.encode("UTF-8") + req.return_value = response_value + + response = client.delete_product_set(request) + + expected_params = [("$alt", "json;enum-encoding=int")] + actual_params = req.call_args.kwargs["params"] + assert expected_params == actual_params + + +def test_delete_product_set_rest_unset_required_fields(): + transport = transports.ProductSearchRestTransport( + credentials=ga_credentials.AnonymousCredentials + ) + + unset_fields = transport.delete_product_set._get_unset_required_fields({}) + assert set(unset_fields) == (set(()) & set(("name",))) + + +@pytest.mark.parametrize("null_interceptor", [True, False]) +def test_delete_product_set_rest_interceptors(null_interceptor): + transport = transports.ProductSearchRestTransport( + credentials=ga_credentials.AnonymousCredentials(), + interceptor=None + if null_interceptor + else transports.ProductSearchRestInterceptor(), + ) + client = ProductSearchClient(transport=transport) + with mock.patch.object( + type(client.transport._session), "request" + ) as req, mock.patch.object( + path_template, "transcode" + ) as transcode, mock.patch.object( + transports.ProductSearchRestInterceptor, "pre_delete_product_set" + ) as pre: + pre.assert_not_called() + pb_message = product_search_service.DeleteProductSetRequest.pb( + product_search_service.DeleteProductSetRequest() + ) + transcode.return_value = { + "method": "post", + "uri": "my_uri", + "body": pb_message, + "query_params": pb_message, + } + + req.return_value = Response() + req.return_value.status_code = 200 + req.return_value.request = PreparedRequest() + + request = product_search_service.DeleteProductSetRequest() + metadata = [ + ("key", "val"), + ("cephalopod", "squid"), + ] + pre.return_value = request, metadata + + client.delete_product_set( + request, + metadata=[ + ("key", "val"), + ("cephalopod", "squid"), + ], + ) + + pre.assert_called_once() + + +def test_delete_product_set_rest_bad_request( + transport: str = "rest", request_type=product_search_service.DeleteProductSetRequest +): + client = ProductSearchClient( + credentials=ga_credentials.AnonymousCredentials(), + transport=transport, + ) + + # send a request that will satisfy transcoding + request_init = {"name": "projects/sample1/locations/sample2/productSets/sample3"} + request = request_type(**request_init) + + # Mock the http request call within the method and fake a BadRequest error. + with mock.patch.object(Session, "request") as req, pytest.raises( + core_exceptions.BadRequest + ): + # Wrap the value into a proper Response obj + response_value = Response() + response_value.status_code = 400 + response_value.request = Request() + req.return_value = response_value + client.delete_product_set(request) + + +def test_delete_product_set_rest_flattened(): + client = ProductSearchClient( + credentials=ga_credentials.AnonymousCredentials(), + transport="rest", + ) + + # Mock the http request call within the method and fake a response. + with mock.patch.object(type(client.transport._session), "request") as req: + # Designate an appropriate value for the returned response. + return_value = None + + # get arguments that satisfy an http rule for this method + sample_request = { + "name": "projects/sample1/locations/sample2/productSets/sample3" + } + + # get truthy value for each flattened field + mock_args = dict( + name="name_value", + ) + mock_args.update(sample_request) + + # Wrap the value into a proper Response obj + response_value = Response() + response_value.status_code = 200 + json_return_value = "" + response_value._content = json_return_value.encode("UTF-8") + req.return_value = response_value + + client.delete_product_set(**mock_args) + + # Establish that the underlying call was made with the expected + # request object values. + assert len(req.mock_calls) == 1 + _, args, _ = req.mock_calls[0] + assert path_template.validate( + "%s/v1/{name=projects/*/locations/*/productSets/*}" + % client.transport._host, + args[1], + ) + + +def test_delete_product_set_rest_flattened_error(transport: str = "rest"): + client = ProductSearchClient( + credentials=ga_credentials.AnonymousCredentials(), + transport=transport, + ) + + # Attempting to call a method with both a request object and flattened + # fields is an error. + with pytest.raises(ValueError): + client.delete_product_set( + product_search_service.DeleteProductSetRequest(), + name="name_value", + ) + + +def test_delete_product_set_rest_error(): + client = ProductSearchClient( + credentials=ga_credentials.AnonymousCredentials(), transport="rest" + ) + + +@pytest.mark.parametrize( + "request_type", + [ + product_search_service.CreateProductRequest, + dict, + ], +) +def test_create_product_rest(request_type): + client = ProductSearchClient( + credentials=ga_credentials.AnonymousCredentials(), + transport="rest", + ) + + # send a request that will satisfy transcoding + request_init = {"parent": "projects/sample1/locations/sample2"} + request_init["product"] = { + "name": "name_value", + "display_name": "display_name_value", + "description": "description_value", + "product_category": "product_category_value", + "product_labels": [{"key": "key_value", "value": "value_value"}], + } + request = request_type(**request_init) + + # Mock the http request call within the method and fake a response. + with mock.patch.object(type(client.transport._session), "request") as req: + # Designate an appropriate value for the returned response. + return_value = product_search_service.Product( + name="name_value", + display_name="display_name_value", + description="description_value", + product_category="product_category_value", + ) + + # Wrap the value into a proper Response obj + response_value = Response() + response_value.status_code = 200 + pb_return_value = product_search_service.Product.pb(return_value) + json_return_value = json_format.MessageToJson(pb_return_value) + + response_value._content = json_return_value.encode("UTF-8") + req.return_value = response_value + response = client.create_product(request) + + # Establish that the response is the type that we expect. + assert isinstance(response, product_search_service.Product) + assert response.name == "name_value" + assert response.display_name == "display_name_value" + assert response.description == "description_value" + assert response.product_category == "product_category_value" + + +def test_create_product_rest_required_fields( + request_type=product_search_service.CreateProductRequest, +): + transport_class = transports.ProductSearchRestTransport + + request_init = {} + request_init["parent"] = "" + request = request_type(**request_init) + pb_request = request_type.pb(request) + jsonified_request = json.loads( + json_format.MessageToJson( + pb_request, + including_default_value_fields=False, + use_integers_for_enums=False, + ) + ) + + # verify fields with default values are dropped + + unset_fields = transport_class( + credentials=ga_credentials.AnonymousCredentials() + ).create_product._get_unset_required_fields(jsonified_request) + jsonified_request.update(unset_fields) + + # verify required fields with default values are now present + + jsonified_request["parent"] = "parent_value" + + unset_fields = transport_class( + credentials=ga_credentials.AnonymousCredentials() + ).create_product._get_unset_required_fields(jsonified_request) + # Check that path parameters and body parameters are not mixing in. + assert not set(unset_fields) - set(("product_id",)) + jsonified_request.update(unset_fields) + + # verify required fields with non-default values are left alone + assert "parent" in jsonified_request + assert jsonified_request["parent"] == "parent_value" + + client = ProductSearchClient( + credentials=ga_credentials.AnonymousCredentials(), + transport="rest", + ) + request = request_type(**request_init) + + # Designate an appropriate value for the returned response. + return_value = product_search_service.Product() + # Mock the http request call within the method and fake a response. + with mock.patch.object(Session, "request") as req: + # We need to mock transcode() because providing default values + # for required fields will fail the real version if the http_options + # expect actual values for those fields. + with mock.patch.object(path_template, "transcode") as transcode: + # A uri without fields and an empty body will force all the + # request fields to show up in the query_params. + pb_request = request_type.pb(request) + transcode_result = { + "uri": "v1/sample_method", + "method": "post", + "query_params": pb_request, + } + transcode_result["body"] = pb_request + transcode.return_value = transcode_result + + response_value = Response() + response_value.status_code = 200 + + pb_return_value = product_search_service.Product.pb(return_value) + json_return_value = json_format.MessageToJson(pb_return_value) + + response_value._content = json_return_value.encode("UTF-8") + req.return_value = response_value + + response = client.create_product(request) + + expected_params = [("$alt", "json;enum-encoding=int")] + actual_params = req.call_args.kwargs["params"] + assert expected_params == actual_params + + +def test_create_product_rest_unset_required_fields(): + transport = transports.ProductSearchRestTransport( + credentials=ga_credentials.AnonymousCredentials + ) + + unset_fields = transport.create_product._get_unset_required_fields({}) + assert set(unset_fields) == ( + set(("productId",)) + & set( + ( + "parent", + "product", + ) + ) + ) + + +@pytest.mark.parametrize("null_interceptor", [True, False]) +def test_create_product_rest_interceptors(null_interceptor): + transport = transports.ProductSearchRestTransport( + credentials=ga_credentials.AnonymousCredentials(), + interceptor=None + if null_interceptor + else transports.ProductSearchRestInterceptor(), + ) + client = ProductSearchClient(transport=transport) + with mock.patch.object( + type(client.transport._session), "request" + ) as req, mock.patch.object( + path_template, "transcode" + ) as transcode, mock.patch.object( + transports.ProductSearchRestInterceptor, "post_create_product" + ) as post, mock.patch.object( + transports.ProductSearchRestInterceptor, "pre_create_product" + ) as pre: + pre.assert_not_called() + post.assert_not_called() + pb_message = product_search_service.CreateProductRequest.pb( + product_search_service.CreateProductRequest() + ) + transcode.return_value = { + "method": "post", + "uri": "my_uri", + "body": pb_message, + "query_params": pb_message, + } + + req.return_value = Response() + req.return_value.status_code = 200 + req.return_value.request = PreparedRequest() + req.return_value._content = product_search_service.Product.to_json( + product_search_service.Product() + ) + + request = product_search_service.CreateProductRequest() + metadata = [ + ("key", "val"), + ("cephalopod", "squid"), + ] + pre.return_value = request, metadata + post.return_value = product_search_service.Product() + + client.create_product( + request, + metadata=[ + ("key", "val"), + ("cephalopod", "squid"), + ], + ) + + pre.assert_called_once() + post.assert_called_once() + + +def test_create_product_rest_bad_request( + transport: str = "rest", request_type=product_search_service.CreateProductRequest +): + client = ProductSearchClient( + credentials=ga_credentials.AnonymousCredentials(), + transport=transport, + ) + + # send a request that will satisfy transcoding + request_init = {"parent": "projects/sample1/locations/sample2"} + request_init["product"] = { + "name": "name_value", + "display_name": "display_name_value", + "description": "description_value", + "product_category": "product_category_value", + "product_labels": [{"key": "key_value", "value": "value_value"}], + } + request = request_type(**request_init) + + # Mock the http request call within the method and fake a BadRequest error. + with mock.patch.object(Session, "request") as req, pytest.raises( + core_exceptions.BadRequest + ): + # Wrap the value into a proper Response obj + response_value = Response() + response_value.status_code = 400 + response_value.request = Request() + req.return_value = response_value + client.create_product(request) + + +def test_create_product_rest_flattened(): + client = ProductSearchClient( + credentials=ga_credentials.AnonymousCredentials(), + transport="rest", + ) + + # Mock the http request call within the method and fake a response. + with mock.patch.object(type(client.transport._session), "request") as req: + # Designate an appropriate value for the returned response. + return_value = product_search_service.Product() + + # get arguments that satisfy an http rule for this method + sample_request = {"parent": "projects/sample1/locations/sample2"} + + # get truthy value for each flattened field + mock_args = dict( + parent="parent_value", + product=product_search_service.Product(name="name_value"), + product_id="product_id_value", + ) + mock_args.update(sample_request) + + # Wrap the value into a proper Response obj + response_value = Response() + response_value.status_code = 200 + pb_return_value = product_search_service.Product.pb(return_value) + json_return_value = json_format.MessageToJson(pb_return_value) + response_value._content = json_return_value.encode("UTF-8") + req.return_value = response_value + + client.create_product(**mock_args) + + # Establish that the underlying call was made with the expected + # request object values. + assert len(req.mock_calls) == 1 + _, args, _ = req.mock_calls[0] + assert path_template.validate( + "%s/v1/{parent=projects/*/locations/*}/products" % client.transport._host, + args[1], + ) + + +def test_create_product_rest_flattened_error(transport: str = "rest"): + client = ProductSearchClient( + credentials=ga_credentials.AnonymousCredentials(), + transport=transport, + ) + + # Attempting to call a method with both a request object and flattened + # fields is an error. + with pytest.raises(ValueError): + client.create_product( + product_search_service.CreateProductRequest(), + parent="parent_value", + product=product_search_service.Product(name="name_value"), + product_id="product_id_value", + ) + + +def test_create_product_rest_error(): + client = ProductSearchClient( + credentials=ga_credentials.AnonymousCredentials(), transport="rest" + ) + + +@pytest.mark.parametrize( + "request_type", + [ + product_search_service.ListProductsRequest, + dict, + ], +) +def test_list_products_rest(request_type): + client = ProductSearchClient( + credentials=ga_credentials.AnonymousCredentials(), + transport="rest", + ) + + # send a request that will satisfy transcoding + request_init = {"parent": "projects/sample1/locations/sample2"} + request = request_type(**request_init) + + # Mock the http request call within the method and fake a response. + with mock.patch.object(type(client.transport._session), "request") as req: + # Designate an appropriate value for the returned response. + return_value = product_search_service.ListProductsResponse( + next_page_token="next_page_token_value", + ) + + # Wrap the value into a proper Response obj + response_value = Response() + response_value.status_code = 200 + pb_return_value = product_search_service.ListProductsResponse.pb(return_value) + json_return_value = json_format.MessageToJson(pb_return_value) + + response_value._content = json_return_value.encode("UTF-8") + req.return_value = response_value + response = client.list_products(request) + + # Establish that the response is the type that we expect. + assert isinstance(response, pagers.ListProductsPager) + assert response.next_page_token == "next_page_token_value" + + +def test_list_products_rest_required_fields( + request_type=product_search_service.ListProductsRequest, +): + transport_class = transports.ProductSearchRestTransport + + request_init = {} + request_init["parent"] = "" + request = request_type(**request_init) + pb_request = request_type.pb(request) + jsonified_request = json.loads( + json_format.MessageToJson( + pb_request, + including_default_value_fields=False, + use_integers_for_enums=False, + ) + ) + + # verify fields with default values are dropped + + unset_fields = transport_class( + credentials=ga_credentials.AnonymousCredentials() + ).list_products._get_unset_required_fields(jsonified_request) + jsonified_request.update(unset_fields) + + # verify required fields with default values are now present + + jsonified_request["parent"] = "parent_value" + + unset_fields = transport_class( + credentials=ga_credentials.AnonymousCredentials() + ).list_products._get_unset_required_fields(jsonified_request) + # Check that path parameters and body parameters are not mixing in. + assert not set(unset_fields) - set( + ( + "page_size", + "page_token", + ) + ) + jsonified_request.update(unset_fields) + + # verify required fields with non-default values are left alone + assert "parent" in jsonified_request + assert jsonified_request["parent"] == "parent_value" + + client = ProductSearchClient( + credentials=ga_credentials.AnonymousCredentials(), + transport="rest", + ) + request = request_type(**request_init) + + # Designate an appropriate value for the returned response. + return_value = product_search_service.ListProductsResponse() + # Mock the http request call within the method and fake a response. + with mock.patch.object(Session, "request") as req: + # We need to mock transcode() because providing default values + # for required fields will fail the real version if the http_options + # expect actual values for those fields. + with mock.patch.object(path_template, "transcode") as transcode: + # A uri without fields and an empty body will force all the + # request fields to show up in the query_params. + pb_request = request_type.pb(request) + transcode_result = { + "uri": "v1/sample_method", + "method": "get", + "query_params": pb_request, + } + transcode.return_value = transcode_result + + response_value = Response() + response_value.status_code = 200 + + pb_return_value = product_search_service.ListProductsResponse.pb( + return_value + ) + json_return_value = json_format.MessageToJson(pb_return_value) + + response_value._content = json_return_value.encode("UTF-8") + req.return_value = response_value + + response = client.list_products(request) + + expected_params = [("$alt", "json;enum-encoding=int")] + actual_params = req.call_args.kwargs["params"] + assert expected_params == actual_params + + +def test_list_products_rest_unset_required_fields(): + transport = transports.ProductSearchRestTransport( + credentials=ga_credentials.AnonymousCredentials + ) + + unset_fields = transport.list_products._get_unset_required_fields({}) + assert set(unset_fields) == ( + set( + ( + "pageSize", + "pageToken", + ) + ) + & set(("parent",)) + ) + + +@pytest.mark.parametrize("null_interceptor", [True, False]) +def test_list_products_rest_interceptors(null_interceptor): + transport = transports.ProductSearchRestTransport( + credentials=ga_credentials.AnonymousCredentials(), + interceptor=None + if null_interceptor + else transports.ProductSearchRestInterceptor(), + ) + client = ProductSearchClient(transport=transport) + with mock.patch.object( + type(client.transport._session), "request" + ) as req, mock.patch.object( + path_template, "transcode" + ) as transcode, mock.patch.object( + transports.ProductSearchRestInterceptor, "post_list_products" + ) as post, mock.patch.object( + transports.ProductSearchRestInterceptor, "pre_list_products" + ) as pre: + pre.assert_not_called() + post.assert_not_called() + pb_message = product_search_service.ListProductsRequest.pb( + product_search_service.ListProductsRequest() + ) + transcode.return_value = { + "method": "post", + "uri": "my_uri", + "body": pb_message, + "query_params": pb_message, + } + + req.return_value = Response() + req.return_value.status_code = 200 + req.return_value.request = PreparedRequest() + req.return_value._content = product_search_service.ListProductsResponse.to_json( + product_search_service.ListProductsResponse() + ) + + request = product_search_service.ListProductsRequest() + metadata = [ + ("key", "val"), + ("cephalopod", "squid"), + ] + pre.return_value = request, metadata + post.return_value = product_search_service.ListProductsResponse() + + client.list_products( + request, + metadata=[ + ("key", "val"), + ("cephalopod", "squid"), + ], + ) + + pre.assert_called_once() + post.assert_called_once() + + +def test_list_products_rest_bad_request( + transport: str = "rest", request_type=product_search_service.ListProductsRequest +): + client = ProductSearchClient( + credentials=ga_credentials.AnonymousCredentials(), + transport=transport, + ) + + # send a request that will satisfy transcoding + request_init = {"parent": "projects/sample1/locations/sample2"} + request = request_type(**request_init) + + # Mock the http request call within the method and fake a BadRequest error. + with mock.patch.object(Session, "request") as req, pytest.raises( + core_exceptions.BadRequest + ): + # Wrap the value into a proper Response obj + response_value = Response() + response_value.status_code = 400 + response_value.request = Request() + req.return_value = response_value + client.list_products(request) + + +def test_list_products_rest_flattened(): + client = ProductSearchClient( + credentials=ga_credentials.AnonymousCredentials(), + transport="rest", + ) + + # Mock the http request call within the method and fake a response. + with mock.patch.object(type(client.transport._session), "request") as req: + # Designate an appropriate value for the returned response. + return_value = product_search_service.ListProductsResponse() + + # get arguments that satisfy an http rule for this method + sample_request = {"parent": "projects/sample1/locations/sample2"} + + # get truthy value for each flattened field + mock_args = dict( + parent="parent_value", + ) + mock_args.update(sample_request) + + # Wrap the value into a proper Response obj + response_value = Response() + response_value.status_code = 200 + pb_return_value = product_search_service.ListProductsResponse.pb(return_value) + json_return_value = json_format.MessageToJson(pb_return_value) + response_value._content = json_return_value.encode("UTF-8") + req.return_value = response_value + + client.list_products(**mock_args) + + # Establish that the underlying call was made with the expected + # request object values. + assert len(req.mock_calls) == 1 + _, args, _ = req.mock_calls[0] + assert path_template.validate( + "%s/v1/{parent=projects/*/locations/*}/products" % client.transport._host, + args[1], + ) + + +def test_list_products_rest_flattened_error(transport: str = "rest"): + client = ProductSearchClient( + credentials=ga_credentials.AnonymousCredentials(), + transport=transport, + ) + + # Attempting to call a method with both a request object and flattened + # fields is an error. + with pytest.raises(ValueError): + client.list_products( + product_search_service.ListProductsRequest(), + parent="parent_value", + ) + + +def test_list_products_rest_pager(transport: str = "rest"): + client = ProductSearchClient( + credentials=ga_credentials.AnonymousCredentials(), + transport=transport, + ) + + # Mock the http request call within the method and fake a response. + with mock.patch.object(Session, "request") as req: + # TODO(kbandes): remove this mock unless there's a good reason for it. + # with mock.patch.object(path_template, 'transcode') as transcode: + # Set the response as a series of pages + response = ( + product_search_service.ListProductsResponse( + products=[ + product_search_service.Product(), + product_search_service.Product(), + product_search_service.Product(), + ], + next_page_token="abc", + ), + product_search_service.ListProductsResponse( + products=[], + next_page_token="def", + ), + product_search_service.ListProductsResponse( + products=[ + product_search_service.Product(), + ], + next_page_token="ghi", + ), + product_search_service.ListProductsResponse( + products=[ + product_search_service.Product(), + product_search_service.Product(), + ], + ), + ) + # Two responses for two calls + response = response + response + + # Wrap the values into proper Response objs + response = tuple( + product_search_service.ListProductsResponse.to_json(x) for x in response + ) + return_values = tuple(Response() for i in response) + for return_val, response_val in zip(return_values, response): + return_val._content = response_val.encode("UTF-8") + return_val.status_code = 200 + req.side_effect = return_values + + sample_request = {"parent": "projects/sample1/locations/sample2"} + + pager = client.list_products(request=sample_request) + + results = list(pager) + assert len(results) == 6 + assert all(isinstance(i, product_search_service.Product) for i in results) + + pages = list(client.list_products(request=sample_request).pages) + for page_, token in zip(pages, ["abc", "def", "ghi", ""]): + assert page_.raw_page.next_page_token == token + + +@pytest.mark.parametrize( + "request_type", + [ + product_search_service.GetProductRequest, + dict, + ], +) +def test_get_product_rest(request_type): + client = ProductSearchClient( + credentials=ga_credentials.AnonymousCredentials(), + transport="rest", + ) + + # send a request that will satisfy transcoding + request_init = {"name": "projects/sample1/locations/sample2/products/sample3"} + request = request_type(**request_init) + + # Mock the http request call within the method and fake a response. + with mock.patch.object(type(client.transport._session), "request") as req: + # Designate an appropriate value for the returned response. + return_value = product_search_service.Product( + name="name_value", + display_name="display_name_value", + description="description_value", + product_category="product_category_value", + ) + + # Wrap the value into a proper Response obj + response_value = Response() + response_value.status_code = 200 + pb_return_value = product_search_service.Product.pb(return_value) + json_return_value = json_format.MessageToJson(pb_return_value) + + response_value._content = json_return_value.encode("UTF-8") + req.return_value = response_value + response = client.get_product(request) + + # Establish that the response is the type that we expect. + assert isinstance(response, product_search_service.Product) + assert response.name == "name_value" + assert response.display_name == "display_name_value" + assert response.description == "description_value" + assert response.product_category == "product_category_value" + + +def test_get_product_rest_required_fields( + request_type=product_search_service.GetProductRequest, +): + transport_class = transports.ProductSearchRestTransport + + request_init = {} + request_init["name"] = "" + request = request_type(**request_init) + pb_request = request_type.pb(request) + jsonified_request = json.loads( + json_format.MessageToJson( + pb_request, + including_default_value_fields=False, + use_integers_for_enums=False, + ) + ) + + # verify fields with default values are dropped + + unset_fields = transport_class( + credentials=ga_credentials.AnonymousCredentials() + ).get_product._get_unset_required_fields(jsonified_request) + jsonified_request.update(unset_fields) + + # verify required fields with default values are now present + + jsonified_request["name"] = "name_value" + + unset_fields = transport_class( + credentials=ga_credentials.AnonymousCredentials() + ).get_product._get_unset_required_fields(jsonified_request) + jsonified_request.update(unset_fields) + + # verify required fields with non-default values are left alone + assert "name" in jsonified_request + assert jsonified_request["name"] == "name_value" + + client = ProductSearchClient( + credentials=ga_credentials.AnonymousCredentials(), + transport="rest", + ) + request = request_type(**request_init) + + # Designate an appropriate value for the returned response. + return_value = product_search_service.Product() + # Mock the http request call within the method and fake a response. + with mock.patch.object(Session, "request") as req: + # We need to mock transcode() because providing default values + # for required fields will fail the real version if the http_options + # expect actual values for those fields. + with mock.patch.object(path_template, "transcode") as transcode: + # A uri without fields and an empty body will force all the + # request fields to show up in the query_params. + pb_request = request_type.pb(request) + transcode_result = { + "uri": "v1/sample_method", + "method": "get", + "query_params": pb_request, + } + transcode.return_value = transcode_result + + response_value = Response() + response_value.status_code = 200 + + pb_return_value = product_search_service.Product.pb(return_value) + json_return_value = json_format.MessageToJson(pb_return_value) + + response_value._content = json_return_value.encode("UTF-8") + req.return_value = response_value + + response = client.get_product(request) + + expected_params = [("$alt", "json;enum-encoding=int")] + actual_params = req.call_args.kwargs["params"] + assert expected_params == actual_params + + +def test_get_product_rest_unset_required_fields(): + transport = transports.ProductSearchRestTransport( + credentials=ga_credentials.AnonymousCredentials + ) + + unset_fields = transport.get_product._get_unset_required_fields({}) + assert set(unset_fields) == (set(()) & set(("name",))) + + +@pytest.mark.parametrize("null_interceptor", [True, False]) +def test_get_product_rest_interceptors(null_interceptor): + transport = transports.ProductSearchRestTransport( + credentials=ga_credentials.AnonymousCredentials(), + interceptor=None + if null_interceptor + else transports.ProductSearchRestInterceptor(), + ) + client = ProductSearchClient(transport=transport) + with mock.patch.object( + type(client.transport._session), "request" + ) as req, mock.patch.object( + path_template, "transcode" + ) as transcode, mock.patch.object( + transports.ProductSearchRestInterceptor, "post_get_product" + ) as post, mock.patch.object( + transports.ProductSearchRestInterceptor, "pre_get_product" + ) as pre: + pre.assert_not_called() + post.assert_not_called() + pb_message = product_search_service.GetProductRequest.pb( + product_search_service.GetProductRequest() + ) + transcode.return_value = { + "method": "post", + "uri": "my_uri", + "body": pb_message, + "query_params": pb_message, + } + + req.return_value = Response() + req.return_value.status_code = 200 + req.return_value.request = PreparedRequest() + req.return_value._content = product_search_service.Product.to_json( + product_search_service.Product() + ) + + request = product_search_service.GetProductRequest() + metadata = [ + ("key", "val"), + ("cephalopod", "squid"), + ] + pre.return_value = request, metadata + post.return_value = product_search_service.Product() + + client.get_product( + request, + metadata=[ + ("key", "val"), + ("cephalopod", "squid"), + ], + ) + + pre.assert_called_once() + post.assert_called_once() + + +def test_get_product_rest_bad_request( + transport: str = "rest", request_type=product_search_service.GetProductRequest +): + client = ProductSearchClient( + credentials=ga_credentials.AnonymousCredentials(), + transport=transport, + ) + + # send a request that will satisfy transcoding + request_init = {"name": "projects/sample1/locations/sample2/products/sample3"} + request = request_type(**request_init) + + # Mock the http request call within the method and fake a BadRequest error. + with mock.patch.object(Session, "request") as req, pytest.raises( + core_exceptions.BadRequest + ): + # Wrap the value into a proper Response obj + response_value = Response() + response_value.status_code = 400 + response_value.request = Request() + req.return_value = response_value + client.get_product(request) + + +def test_get_product_rest_flattened(): + client = ProductSearchClient( + credentials=ga_credentials.AnonymousCredentials(), + transport="rest", + ) + + # Mock the http request call within the method and fake a response. + with mock.patch.object(type(client.transport._session), "request") as req: + # Designate an appropriate value for the returned response. + return_value = product_search_service.Product() + + # get arguments that satisfy an http rule for this method + sample_request = {"name": "projects/sample1/locations/sample2/products/sample3"} + + # get truthy value for each flattened field + mock_args = dict( + name="name_value", + ) + mock_args.update(sample_request) + + # Wrap the value into a proper Response obj + response_value = Response() + response_value.status_code = 200 + pb_return_value = product_search_service.Product.pb(return_value) + json_return_value = json_format.MessageToJson(pb_return_value) + response_value._content = json_return_value.encode("UTF-8") + req.return_value = response_value + + client.get_product(**mock_args) + + # Establish that the underlying call was made with the expected + # request object values. + assert len(req.mock_calls) == 1 + _, args, _ = req.mock_calls[0] + assert path_template.validate( + "%s/v1/{name=projects/*/locations/*/products/*}" % client.transport._host, + args[1], + ) + + +def test_get_product_rest_flattened_error(transport: str = "rest"): + client = ProductSearchClient( + credentials=ga_credentials.AnonymousCredentials(), + transport=transport, + ) + + # Attempting to call a method with both a request object and flattened + # fields is an error. + with pytest.raises(ValueError): + client.get_product( + product_search_service.GetProductRequest(), + name="name_value", + ) + + +def test_get_product_rest_error(): + client = ProductSearchClient( + credentials=ga_credentials.AnonymousCredentials(), transport="rest" + ) + + +@pytest.mark.parametrize( + "request_type", + [ + product_search_service.UpdateProductRequest, + dict, + ], +) +def test_update_product_rest(request_type): + client = ProductSearchClient( + credentials=ga_credentials.AnonymousCredentials(), + transport="rest", + ) + + # send a request that will satisfy transcoding + request_init = { + "product": {"name": "projects/sample1/locations/sample2/products/sample3"} + } + request_init["product"] = { + "name": "projects/sample1/locations/sample2/products/sample3", + "display_name": "display_name_value", + "description": "description_value", + "product_category": "product_category_value", + "product_labels": [{"key": "key_value", "value": "value_value"}], + } + request = request_type(**request_init) + + # Mock the http request call within the method and fake a response. + with mock.patch.object(type(client.transport._session), "request") as req: + # Designate an appropriate value for the returned response. + return_value = product_search_service.Product( + name="name_value", + display_name="display_name_value", + description="description_value", + product_category="product_category_value", + ) + + # Wrap the value into a proper Response obj + response_value = Response() + response_value.status_code = 200 + pb_return_value = product_search_service.Product.pb(return_value) + json_return_value = json_format.MessageToJson(pb_return_value) + + response_value._content = json_return_value.encode("UTF-8") + req.return_value = response_value + response = client.update_product(request) + + # Establish that the response is the type that we expect. + assert isinstance(response, product_search_service.Product) + assert response.name == "name_value" + assert response.display_name == "display_name_value" + assert response.description == "description_value" + assert response.product_category == "product_category_value" + + +def test_update_product_rest_required_fields( + request_type=product_search_service.UpdateProductRequest, +): + transport_class = transports.ProductSearchRestTransport + + request_init = {} + request = request_type(**request_init) + pb_request = request_type.pb(request) + jsonified_request = json.loads( + json_format.MessageToJson( + pb_request, + including_default_value_fields=False, + use_integers_for_enums=False, + ) + ) + + # verify fields with default values are dropped + + unset_fields = transport_class( + credentials=ga_credentials.AnonymousCredentials() + ).update_product._get_unset_required_fields(jsonified_request) + jsonified_request.update(unset_fields) + + # verify required fields with default values are now present + + unset_fields = transport_class( + credentials=ga_credentials.AnonymousCredentials() + ).update_product._get_unset_required_fields(jsonified_request) + # Check that path parameters and body parameters are not mixing in. + assert not set(unset_fields) - set(("update_mask",)) + jsonified_request.update(unset_fields) + + # verify required fields with non-default values are left alone + + client = ProductSearchClient( + credentials=ga_credentials.AnonymousCredentials(), + transport="rest", + ) + request = request_type(**request_init) + + # Designate an appropriate value for the returned response. + return_value = product_search_service.Product() + # Mock the http request call within the method and fake a response. + with mock.patch.object(Session, "request") as req: + # We need to mock transcode() because providing default values + # for required fields will fail the real version if the http_options + # expect actual values for those fields. + with mock.patch.object(path_template, "transcode") as transcode: + # A uri without fields and an empty body will force all the + # request fields to show up in the query_params. + pb_request = request_type.pb(request) + transcode_result = { + "uri": "v1/sample_method", + "method": "patch", + "query_params": pb_request, + } + transcode_result["body"] = pb_request + transcode.return_value = transcode_result + + response_value = Response() + response_value.status_code = 200 + + pb_return_value = product_search_service.Product.pb(return_value) + json_return_value = json_format.MessageToJson(pb_return_value) + + response_value._content = json_return_value.encode("UTF-8") + req.return_value = response_value + + response = client.update_product(request) + + expected_params = [("$alt", "json;enum-encoding=int")] + actual_params = req.call_args.kwargs["params"] + assert expected_params == actual_params + + +def test_update_product_rest_unset_required_fields(): + transport = transports.ProductSearchRestTransport( + credentials=ga_credentials.AnonymousCredentials + ) + + unset_fields = transport.update_product._get_unset_required_fields({}) + assert set(unset_fields) == (set(("updateMask",)) & set(("product",))) + + +@pytest.mark.parametrize("null_interceptor", [True, False]) +def test_update_product_rest_interceptors(null_interceptor): + transport = transports.ProductSearchRestTransport( + credentials=ga_credentials.AnonymousCredentials(), + interceptor=None + if null_interceptor + else transports.ProductSearchRestInterceptor(), + ) + client = ProductSearchClient(transport=transport) + with mock.patch.object( + type(client.transport._session), "request" + ) as req, mock.patch.object( + path_template, "transcode" + ) as transcode, mock.patch.object( + transports.ProductSearchRestInterceptor, "post_update_product" + ) as post, mock.patch.object( + transports.ProductSearchRestInterceptor, "pre_update_product" + ) as pre: + pre.assert_not_called() + post.assert_not_called() + pb_message = product_search_service.UpdateProductRequest.pb( + product_search_service.UpdateProductRequest() + ) + transcode.return_value = { + "method": "post", + "uri": "my_uri", + "body": pb_message, + "query_params": pb_message, + } + + req.return_value = Response() + req.return_value.status_code = 200 + req.return_value.request = PreparedRequest() + req.return_value._content = product_search_service.Product.to_json( + product_search_service.Product() + ) + + request = product_search_service.UpdateProductRequest() + metadata = [ + ("key", "val"), + ("cephalopod", "squid"), + ] + pre.return_value = request, metadata + post.return_value = product_search_service.Product() + + client.update_product( + request, + metadata=[ + ("key", "val"), + ("cephalopod", "squid"), + ], + ) + + pre.assert_called_once() + post.assert_called_once() + + +def test_update_product_rest_bad_request( + transport: str = "rest", request_type=product_search_service.UpdateProductRequest +): + client = ProductSearchClient( + credentials=ga_credentials.AnonymousCredentials(), + transport=transport, + ) + + # send a request that will satisfy transcoding + request_init = { + "product": {"name": "projects/sample1/locations/sample2/products/sample3"} + } + request_init["product"] = { + "name": "projects/sample1/locations/sample2/products/sample3", + "display_name": "display_name_value", + "description": "description_value", + "product_category": "product_category_value", + "product_labels": [{"key": "key_value", "value": "value_value"}], + } + request = request_type(**request_init) + + # Mock the http request call within the method and fake a BadRequest error. + with mock.patch.object(Session, "request") as req, pytest.raises( + core_exceptions.BadRequest + ): + # Wrap the value into a proper Response obj + response_value = Response() + response_value.status_code = 400 + response_value.request = Request() + req.return_value = response_value + client.update_product(request) + + +def test_update_product_rest_flattened(): + client = ProductSearchClient( + credentials=ga_credentials.AnonymousCredentials(), + transport="rest", + ) + + # Mock the http request call within the method and fake a response. + with mock.patch.object(type(client.transport._session), "request") as req: + # Designate an appropriate value for the returned response. + return_value = product_search_service.Product() + + # get arguments that satisfy an http rule for this method + sample_request = { + "product": {"name": "projects/sample1/locations/sample2/products/sample3"} + } + + # get truthy value for each flattened field + mock_args = dict( + product=product_search_service.Product(name="name_value"), + update_mask=field_mask_pb2.FieldMask(paths=["paths_value"]), + ) + mock_args.update(sample_request) + + # Wrap the value into a proper Response obj + response_value = Response() + response_value.status_code = 200 + pb_return_value = product_search_service.Product.pb(return_value) + json_return_value = json_format.MessageToJson(pb_return_value) + response_value._content = json_return_value.encode("UTF-8") + req.return_value = response_value + + client.update_product(**mock_args) + + # Establish that the underlying call was made with the expected + # request object values. + assert len(req.mock_calls) == 1 + _, args, _ = req.mock_calls[0] + assert path_template.validate( + "%s/v1/{product.name=projects/*/locations/*/products/*}" + % client.transport._host, + args[1], + ) + + +def test_update_product_rest_flattened_error(transport: str = "rest"): + client = ProductSearchClient( + credentials=ga_credentials.AnonymousCredentials(), + transport=transport, + ) + + # Attempting to call a method with both a request object and flattened + # fields is an error. + with pytest.raises(ValueError): + client.update_product( + product_search_service.UpdateProductRequest(), + product=product_search_service.Product(name="name_value"), + update_mask=field_mask_pb2.FieldMask(paths=["paths_value"]), + ) + + +def test_update_product_rest_error(): + client = ProductSearchClient( + credentials=ga_credentials.AnonymousCredentials(), transport="rest" + ) + + +@pytest.mark.parametrize( + "request_type", + [ + product_search_service.DeleteProductRequest, + dict, + ], +) +def test_delete_product_rest(request_type): + client = ProductSearchClient( + credentials=ga_credentials.AnonymousCredentials(), + transport="rest", + ) + + # send a request that will satisfy transcoding + request_init = {"name": "projects/sample1/locations/sample2/products/sample3"} + request = request_type(**request_init) + + # Mock the http request call within the method and fake a response. + with mock.patch.object(type(client.transport._session), "request") as req: + # Designate an appropriate value for the returned response. + return_value = None + + # Wrap the value into a proper Response obj + response_value = Response() + response_value.status_code = 200 + json_return_value = "" + + response_value._content = json_return_value.encode("UTF-8") + req.return_value = response_value + response = client.delete_product(request) + + # Establish that the response is the type that we expect. + assert response is None + + +def test_delete_product_rest_required_fields( + request_type=product_search_service.DeleteProductRequest, +): + transport_class = transports.ProductSearchRestTransport + + request_init = {} + request_init["name"] = "" + request = request_type(**request_init) + pb_request = request_type.pb(request) + jsonified_request = json.loads( + json_format.MessageToJson( + pb_request, + including_default_value_fields=False, + use_integers_for_enums=False, + ) + ) + + # verify fields with default values are dropped + + unset_fields = transport_class( + credentials=ga_credentials.AnonymousCredentials() + ).delete_product._get_unset_required_fields(jsonified_request) + jsonified_request.update(unset_fields) + + # verify required fields with default values are now present + + jsonified_request["name"] = "name_value" + + unset_fields = transport_class( + credentials=ga_credentials.AnonymousCredentials() + ).delete_product._get_unset_required_fields(jsonified_request) + jsonified_request.update(unset_fields) + + # verify required fields with non-default values are left alone + assert "name" in jsonified_request + assert jsonified_request["name"] == "name_value" + + client = ProductSearchClient( + credentials=ga_credentials.AnonymousCredentials(), + transport="rest", + ) + request = request_type(**request_init) + + # Designate an appropriate value for the returned response. + return_value = None + # Mock the http request call within the method and fake a response. + with mock.patch.object(Session, "request") as req: + # We need to mock transcode() because providing default values + # for required fields will fail the real version if the http_options + # expect actual values for those fields. + with mock.patch.object(path_template, "transcode") as transcode: + # A uri without fields and an empty body will force all the + # request fields to show up in the query_params. + pb_request = request_type.pb(request) + transcode_result = { + "uri": "v1/sample_method", + "method": "delete", + "query_params": pb_request, + } + transcode.return_value = transcode_result + + response_value = Response() + response_value.status_code = 200 + json_return_value = "" + + response_value._content = json_return_value.encode("UTF-8") + req.return_value = response_value + + response = client.delete_product(request) + + expected_params = [("$alt", "json;enum-encoding=int")] + actual_params = req.call_args.kwargs["params"] + assert expected_params == actual_params + + +def test_delete_product_rest_unset_required_fields(): + transport = transports.ProductSearchRestTransport( + credentials=ga_credentials.AnonymousCredentials + ) + + unset_fields = transport.delete_product._get_unset_required_fields({}) + assert set(unset_fields) == (set(()) & set(("name",))) + + +@pytest.mark.parametrize("null_interceptor", [True, False]) +def test_delete_product_rest_interceptors(null_interceptor): + transport = transports.ProductSearchRestTransport( + credentials=ga_credentials.AnonymousCredentials(), + interceptor=None + if null_interceptor + else transports.ProductSearchRestInterceptor(), + ) + client = ProductSearchClient(transport=transport) + with mock.patch.object( + type(client.transport._session), "request" + ) as req, mock.patch.object( + path_template, "transcode" + ) as transcode, mock.patch.object( + transports.ProductSearchRestInterceptor, "pre_delete_product" + ) as pre: + pre.assert_not_called() + pb_message = product_search_service.DeleteProductRequest.pb( + product_search_service.DeleteProductRequest() + ) + transcode.return_value = { + "method": "post", + "uri": "my_uri", + "body": pb_message, + "query_params": pb_message, + } + + req.return_value = Response() + req.return_value.status_code = 200 + req.return_value.request = PreparedRequest() + + request = product_search_service.DeleteProductRequest() + metadata = [ + ("key", "val"), + ("cephalopod", "squid"), + ] + pre.return_value = request, metadata + + client.delete_product( + request, + metadata=[ + ("key", "val"), + ("cephalopod", "squid"), + ], + ) + + pre.assert_called_once() + + +def test_delete_product_rest_bad_request( + transport: str = "rest", request_type=product_search_service.DeleteProductRequest +): + client = ProductSearchClient( + credentials=ga_credentials.AnonymousCredentials(), + transport=transport, + ) + + # send a request that will satisfy transcoding + request_init = {"name": "projects/sample1/locations/sample2/products/sample3"} + request = request_type(**request_init) + + # Mock the http request call within the method and fake a BadRequest error. + with mock.patch.object(Session, "request") as req, pytest.raises( + core_exceptions.BadRequest + ): + # Wrap the value into a proper Response obj + response_value = Response() + response_value.status_code = 400 + response_value.request = Request() + req.return_value = response_value + client.delete_product(request) + + +def test_delete_product_rest_flattened(): + client = ProductSearchClient( + credentials=ga_credentials.AnonymousCredentials(), + transport="rest", + ) + + # Mock the http request call within the method and fake a response. + with mock.patch.object(type(client.transport._session), "request") as req: + # Designate an appropriate value for the returned response. + return_value = None + + # get arguments that satisfy an http rule for this method + sample_request = {"name": "projects/sample1/locations/sample2/products/sample3"} + + # get truthy value for each flattened field + mock_args = dict( + name="name_value", + ) + mock_args.update(sample_request) + + # Wrap the value into a proper Response obj + response_value = Response() + response_value.status_code = 200 + json_return_value = "" + response_value._content = json_return_value.encode("UTF-8") + req.return_value = response_value + + client.delete_product(**mock_args) + + # Establish that the underlying call was made with the expected + # request object values. + assert len(req.mock_calls) == 1 + _, args, _ = req.mock_calls[0] + assert path_template.validate( + "%s/v1/{name=projects/*/locations/*/products/*}" % client.transport._host, + args[1], + ) + + +def test_delete_product_rest_flattened_error(transport: str = "rest"): + client = ProductSearchClient( + credentials=ga_credentials.AnonymousCredentials(), + transport=transport, + ) + + # Attempting to call a method with both a request object and flattened + # fields is an error. + with pytest.raises(ValueError): + client.delete_product( + product_search_service.DeleteProductRequest(), + name="name_value", + ) + + +def test_delete_product_rest_error(): + client = ProductSearchClient( + credentials=ga_credentials.AnonymousCredentials(), transport="rest" + ) + + +@pytest.mark.parametrize( + "request_type", + [ + product_search_service.CreateReferenceImageRequest, + dict, + ], +) +def test_create_reference_image_rest(request_type): + client = ProductSearchClient( + credentials=ga_credentials.AnonymousCredentials(), + transport="rest", + ) + + # send a request that will satisfy transcoding + request_init = {"parent": "projects/sample1/locations/sample2/products/sample3"} + request_init["reference_image"] = { + "name": "name_value", + "uri": "uri_value", + "bounding_polys": [ + { + "vertices": [{"x": 120, "y": 121}], + "normalized_vertices": [{"x": 0.12, "y": 0.121}], + } + ], + } + request = request_type(**request_init) + + # Mock the http request call within the method and fake a response. + with mock.patch.object(type(client.transport._session), "request") as req: + # Designate an appropriate value for the returned response. + return_value = product_search_service.ReferenceImage( + name="name_value", + uri="uri_value", + ) + + # Wrap the value into a proper Response obj + response_value = Response() + response_value.status_code = 200 + pb_return_value = product_search_service.ReferenceImage.pb(return_value) + json_return_value = json_format.MessageToJson(pb_return_value) + + response_value._content = json_return_value.encode("UTF-8") + req.return_value = response_value + response = client.create_reference_image(request) + + # Establish that the response is the type that we expect. + assert isinstance(response, product_search_service.ReferenceImage) + assert response.name == "name_value" + assert response.uri == "uri_value" + + +def test_create_reference_image_rest_required_fields( + request_type=product_search_service.CreateReferenceImageRequest, +): + transport_class = transports.ProductSearchRestTransport + + request_init = {} + request_init["parent"] = "" + request = request_type(**request_init) + pb_request = request_type.pb(request) + jsonified_request = json.loads( + json_format.MessageToJson( + pb_request, + including_default_value_fields=False, + use_integers_for_enums=False, + ) + ) + + # verify fields with default values are dropped + + unset_fields = transport_class( + credentials=ga_credentials.AnonymousCredentials() + ).create_reference_image._get_unset_required_fields(jsonified_request) + jsonified_request.update(unset_fields) + + # verify required fields with default values are now present + + jsonified_request["parent"] = "parent_value" + + unset_fields = transport_class( + credentials=ga_credentials.AnonymousCredentials() + ).create_reference_image._get_unset_required_fields(jsonified_request) + # Check that path parameters and body parameters are not mixing in. + assert not set(unset_fields) - set(("reference_image_id",)) + jsonified_request.update(unset_fields) + + # verify required fields with non-default values are left alone + assert "parent" in jsonified_request + assert jsonified_request["parent"] == "parent_value" + + client = ProductSearchClient( + credentials=ga_credentials.AnonymousCredentials(), + transport="rest", + ) + request = request_type(**request_init) + + # Designate an appropriate value for the returned response. + return_value = product_search_service.ReferenceImage() + # Mock the http request call within the method and fake a response. + with mock.patch.object(Session, "request") as req: + # We need to mock transcode() because providing default values + # for required fields will fail the real version if the http_options + # expect actual values for those fields. + with mock.patch.object(path_template, "transcode") as transcode: + # A uri without fields and an empty body will force all the + # request fields to show up in the query_params. + pb_request = request_type.pb(request) + transcode_result = { + "uri": "v1/sample_method", + "method": "post", + "query_params": pb_request, + } + transcode_result["body"] = pb_request + transcode.return_value = transcode_result + + response_value = Response() + response_value.status_code = 200 + + pb_return_value = product_search_service.ReferenceImage.pb(return_value) + json_return_value = json_format.MessageToJson(pb_return_value) + + response_value._content = json_return_value.encode("UTF-8") + req.return_value = response_value + + response = client.create_reference_image(request) + + expected_params = [("$alt", "json;enum-encoding=int")] + actual_params = req.call_args.kwargs["params"] + assert expected_params == actual_params + + +def test_create_reference_image_rest_unset_required_fields(): + transport = transports.ProductSearchRestTransport( + credentials=ga_credentials.AnonymousCredentials + ) + + unset_fields = transport.create_reference_image._get_unset_required_fields({}) + assert set(unset_fields) == ( + set(("referenceImageId",)) + & set( + ( + "parent", + "referenceImage", + ) + ) + ) + + +@pytest.mark.parametrize("null_interceptor", [True, False]) +def test_create_reference_image_rest_interceptors(null_interceptor): + transport = transports.ProductSearchRestTransport( + credentials=ga_credentials.AnonymousCredentials(), + interceptor=None + if null_interceptor + else transports.ProductSearchRestInterceptor(), + ) + client = ProductSearchClient(transport=transport) + with mock.patch.object( + type(client.transport._session), "request" + ) as req, mock.patch.object( + path_template, "transcode" + ) as transcode, mock.patch.object( + transports.ProductSearchRestInterceptor, "post_create_reference_image" + ) as post, mock.patch.object( + transports.ProductSearchRestInterceptor, "pre_create_reference_image" + ) as pre: + pre.assert_not_called() + post.assert_not_called() + pb_message = product_search_service.CreateReferenceImageRequest.pb( + product_search_service.CreateReferenceImageRequest() + ) + transcode.return_value = { + "method": "post", + "uri": "my_uri", + "body": pb_message, + "query_params": pb_message, + } + + req.return_value = Response() + req.return_value.status_code = 200 + req.return_value.request = PreparedRequest() + req.return_value._content = product_search_service.ReferenceImage.to_json( + product_search_service.ReferenceImage() + ) + + request = product_search_service.CreateReferenceImageRequest() + metadata = [ + ("key", "val"), + ("cephalopod", "squid"), + ] + pre.return_value = request, metadata + post.return_value = product_search_service.ReferenceImage() + + client.create_reference_image( + request, + metadata=[ + ("key", "val"), + ("cephalopod", "squid"), + ], + ) + + pre.assert_called_once() + post.assert_called_once() + + +def test_create_reference_image_rest_bad_request( + transport: str = "rest", + request_type=product_search_service.CreateReferenceImageRequest, +): + client = ProductSearchClient( + credentials=ga_credentials.AnonymousCredentials(), + transport=transport, + ) + + # send a request that will satisfy transcoding + request_init = {"parent": "projects/sample1/locations/sample2/products/sample3"} + request_init["reference_image"] = { + "name": "name_value", + "uri": "uri_value", + "bounding_polys": [ + { + "vertices": [{"x": 120, "y": 121}], + "normalized_vertices": [{"x": 0.12, "y": 0.121}], + } + ], + } + request = request_type(**request_init) + + # Mock the http request call within the method and fake a BadRequest error. + with mock.patch.object(Session, "request") as req, pytest.raises( + core_exceptions.BadRequest + ): + # Wrap the value into a proper Response obj + response_value = Response() + response_value.status_code = 400 + response_value.request = Request() + req.return_value = response_value + client.create_reference_image(request) + + +def test_create_reference_image_rest_flattened(): + client = ProductSearchClient( + credentials=ga_credentials.AnonymousCredentials(), + transport="rest", + ) + + # Mock the http request call within the method and fake a response. + with mock.patch.object(type(client.transport._session), "request") as req: + # Designate an appropriate value for the returned response. + return_value = product_search_service.ReferenceImage() + + # get arguments that satisfy an http rule for this method + sample_request = { + "parent": "projects/sample1/locations/sample2/products/sample3" + } + + # get truthy value for each flattened field + mock_args = dict( + parent="parent_value", + reference_image=product_search_service.ReferenceImage(name="name_value"), + reference_image_id="reference_image_id_value", + ) + mock_args.update(sample_request) + + # Wrap the value into a proper Response obj + response_value = Response() + response_value.status_code = 200 + pb_return_value = product_search_service.ReferenceImage.pb(return_value) + json_return_value = json_format.MessageToJson(pb_return_value) + response_value._content = json_return_value.encode("UTF-8") + req.return_value = response_value + + client.create_reference_image(**mock_args) + + # Establish that the underlying call was made with the expected + # request object values. + assert len(req.mock_calls) == 1 + _, args, _ = req.mock_calls[0] + assert path_template.validate( + "%s/v1/{parent=projects/*/locations/*/products/*}/referenceImages" + % client.transport._host, + args[1], + ) + + +def test_create_reference_image_rest_flattened_error(transport: str = "rest"): + client = ProductSearchClient( + credentials=ga_credentials.AnonymousCredentials(), + transport=transport, + ) + + # Attempting to call a method with both a request object and flattened + # fields is an error. + with pytest.raises(ValueError): + client.create_reference_image( + product_search_service.CreateReferenceImageRequest(), + parent="parent_value", + reference_image=product_search_service.ReferenceImage(name="name_value"), + reference_image_id="reference_image_id_value", + ) + + +def test_create_reference_image_rest_error(): + client = ProductSearchClient( + credentials=ga_credentials.AnonymousCredentials(), transport="rest" + ) + + +@pytest.mark.parametrize( + "request_type", + [ + product_search_service.DeleteReferenceImageRequest, + dict, + ], +) +def test_delete_reference_image_rest(request_type): + client = ProductSearchClient( + credentials=ga_credentials.AnonymousCredentials(), + transport="rest", + ) + + # send a request that will satisfy transcoding + request_init = { + "name": "projects/sample1/locations/sample2/products/sample3/referenceImages/sample4" + } + request = request_type(**request_init) + + # Mock the http request call within the method and fake a response. + with mock.patch.object(type(client.transport._session), "request") as req: + # Designate an appropriate value for the returned response. + return_value = None + + # Wrap the value into a proper Response obj + response_value = Response() + response_value.status_code = 200 + json_return_value = "" + + response_value._content = json_return_value.encode("UTF-8") + req.return_value = response_value + response = client.delete_reference_image(request) + + # Establish that the response is the type that we expect. + assert response is None + + +def test_delete_reference_image_rest_required_fields( + request_type=product_search_service.DeleteReferenceImageRequest, +): + transport_class = transports.ProductSearchRestTransport + + request_init = {} + request_init["name"] = "" + request = request_type(**request_init) + pb_request = request_type.pb(request) + jsonified_request = json.loads( + json_format.MessageToJson( + pb_request, + including_default_value_fields=False, + use_integers_for_enums=False, + ) + ) + + # verify fields with default values are dropped + + unset_fields = transport_class( + credentials=ga_credentials.AnonymousCredentials() + ).delete_reference_image._get_unset_required_fields(jsonified_request) + jsonified_request.update(unset_fields) + + # verify required fields with default values are now present + + jsonified_request["name"] = "name_value" + + unset_fields = transport_class( + credentials=ga_credentials.AnonymousCredentials() + ).delete_reference_image._get_unset_required_fields(jsonified_request) + jsonified_request.update(unset_fields) + + # verify required fields with non-default values are left alone + assert "name" in jsonified_request + assert jsonified_request["name"] == "name_value" + + client = ProductSearchClient( + credentials=ga_credentials.AnonymousCredentials(), + transport="rest", + ) + request = request_type(**request_init) + + # Designate an appropriate value for the returned response. + return_value = None + # Mock the http request call within the method and fake a response. + with mock.patch.object(Session, "request") as req: + # We need to mock transcode() because providing default values + # for required fields will fail the real version if the http_options + # expect actual values for those fields. + with mock.patch.object(path_template, "transcode") as transcode: + # A uri without fields and an empty body will force all the + # request fields to show up in the query_params. + pb_request = request_type.pb(request) + transcode_result = { + "uri": "v1/sample_method", + "method": "delete", + "query_params": pb_request, + } + transcode.return_value = transcode_result + + response_value = Response() + response_value.status_code = 200 + json_return_value = "" + + response_value._content = json_return_value.encode("UTF-8") + req.return_value = response_value + + response = client.delete_reference_image(request) + + expected_params = [("$alt", "json;enum-encoding=int")] + actual_params = req.call_args.kwargs["params"] + assert expected_params == actual_params + + +def test_delete_reference_image_rest_unset_required_fields(): + transport = transports.ProductSearchRestTransport( + credentials=ga_credentials.AnonymousCredentials + ) + + unset_fields = transport.delete_reference_image._get_unset_required_fields({}) + assert set(unset_fields) == (set(()) & set(("name",))) + + +@pytest.mark.parametrize("null_interceptor", [True, False]) +def test_delete_reference_image_rest_interceptors(null_interceptor): + transport = transports.ProductSearchRestTransport( + credentials=ga_credentials.AnonymousCredentials(), + interceptor=None + if null_interceptor + else transports.ProductSearchRestInterceptor(), + ) + client = ProductSearchClient(transport=transport) + with mock.patch.object( + type(client.transport._session), "request" + ) as req, mock.patch.object( + path_template, "transcode" + ) as transcode, mock.patch.object( + transports.ProductSearchRestInterceptor, "pre_delete_reference_image" + ) as pre: + pre.assert_not_called() + pb_message = product_search_service.DeleteReferenceImageRequest.pb( + product_search_service.DeleteReferenceImageRequest() + ) + transcode.return_value = { + "method": "post", + "uri": "my_uri", + "body": pb_message, + "query_params": pb_message, + } + + req.return_value = Response() + req.return_value.status_code = 200 + req.return_value.request = PreparedRequest() + + request = product_search_service.DeleteReferenceImageRequest() + metadata = [ + ("key", "val"), + ("cephalopod", "squid"), + ] + pre.return_value = request, metadata + + client.delete_reference_image( + request, + metadata=[ + ("key", "val"), + ("cephalopod", "squid"), + ], + ) + + pre.assert_called_once() + + +def test_delete_reference_image_rest_bad_request( + transport: str = "rest", + request_type=product_search_service.DeleteReferenceImageRequest, +): + client = ProductSearchClient( + credentials=ga_credentials.AnonymousCredentials(), + transport=transport, + ) + + # send a request that will satisfy transcoding + request_init = { + "name": "projects/sample1/locations/sample2/products/sample3/referenceImages/sample4" + } + request = request_type(**request_init) + + # Mock the http request call within the method and fake a BadRequest error. + with mock.patch.object(Session, "request") as req, pytest.raises( + core_exceptions.BadRequest + ): + # Wrap the value into a proper Response obj + response_value = Response() + response_value.status_code = 400 + response_value.request = Request() + req.return_value = response_value + client.delete_reference_image(request) + + +def test_delete_reference_image_rest_flattened(): + client = ProductSearchClient( + credentials=ga_credentials.AnonymousCredentials(), + transport="rest", + ) + + # Mock the http request call within the method and fake a response. + with mock.patch.object(type(client.transport._session), "request") as req: + # Designate an appropriate value for the returned response. + return_value = None + + # get arguments that satisfy an http rule for this method + sample_request = { + "name": "projects/sample1/locations/sample2/products/sample3/referenceImages/sample4" + } + + # get truthy value for each flattened field + mock_args = dict( + name="name_value", + ) + mock_args.update(sample_request) + + # Wrap the value into a proper Response obj + response_value = Response() + response_value.status_code = 200 + json_return_value = "" + response_value._content = json_return_value.encode("UTF-8") + req.return_value = response_value + + client.delete_reference_image(**mock_args) + + # Establish that the underlying call was made with the expected + # request object values. + assert len(req.mock_calls) == 1 + _, args, _ = req.mock_calls[0] + assert path_template.validate( + "%s/v1/{name=projects/*/locations/*/products/*/referenceImages/*}" + % client.transport._host, + args[1], + ) + + +def test_delete_reference_image_rest_flattened_error(transport: str = "rest"): + client = ProductSearchClient( + credentials=ga_credentials.AnonymousCredentials(), + transport=transport, + ) + + # Attempting to call a method with both a request object and flattened + # fields is an error. + with pytest.raises(ValueError): + client.delete_reference_image( + product_search_service.DeleteReferenceImageRequest(), + name="name_value", + ) + + +def test_delete_reference_image_rest_error(): + client = ProductSearchClient( + credentials=ga_credentials.AnonymousCredentials(), transport="rest" + ) + + +@pytest.mark.parametrize( + "request_type", + [ + product_search_service.ListReferenceImagesRequest, + dict, + ], +) +def test_list_reference_images_rest(request_type): + client = ProductSearchClient( + credentials=ga_credentials.AnonymousCredentials(), + transport="rest", + ) + + # send a request that will satisfy transcoding + request_init = {"parent": "projects/sample1/locations/sample2/products/sample3"} + request = request_type(**request_init) + + # Mock the http request call within the method and fake a response. + with mock.patch.object(type(client.transport._session), "request") as req: + # Designate an appropriate value for the returned response. + return_value = product_search_service.ListReferenceImagesResponse( + page_size=951, + next_page_token="next_page_token_value", + ) + + # Wrap the value into a proper Response obj + response_value = Response() + response_value.status_code = 200 + pb_return_value = product_search_service.ListReferenceImagesResponse.pb( + return_value + ) + json_return_value = json_format.MessageToJson(pb_return_value) + + response_value._content = json_return_value.encode("UTF-8") + req.return_value = response_value + response = client.list_reference_images(request) + + # Establish that the response is the type that we expect. + assert isinstance(response, pagers.ListReferenceImagesPager) + assert response.page_size == 951 + assert response.next_page_token == "next_page_token_value" + + +def test_list_reference_images_rest_required_fields( + request_type=product_search_service.ListReferenceImagesRequest, +): + transport_class = transports.ProductSearchRestTransport + + request_init = {} + request_init["parent"] = "" + request = request_type(**request_init) + pb_request = request_type.pb(request) + jsonified_request = json.loads( + json_format.MessageToJson( + pb_request, + including_default_value_fields=False, + use_integers_for_enums=False, + ) + ) + + # verify fields with default values are dropped + + unset_fields = transport_class( + credentials=ga_credentials.AnonymousCredentials() + ).list_reference_images._get_unset_required_fields(jsonified_request) + jsonified_request.update(unset_fields) + + # verify required fields with default values are now present + + jsonified_request["parent"] = "parent_value" + + unset_fields = transport_class( + credentials=ga_credentials.AnonymousCredentials() + ).list_reference_images._get_unset_required_fields(jsonified_request) + # Check that path parameters and body parameters are not mixing in. + assert not set(unset_fields) - set( + ( + "page_size", + "page_token", + ) + ) + jsonified_request.update(unset_fields) + + # verify required fields with non-default values are left alone + assert "parent" in jsonified_request + assert jsonified_request["parent"] == "parent_value" + + client = ProductSearchClient( + credentials=ga_credentials.AnonymousCredentials(), + transport="rest", + ) + request = request_type(**request_init) + + # Designate an appropriate value for the returned response. + return_value = product_search_service.ListReferenceImagesResponse() + # Mock the http request call within the method and fake a response. + with mock.patch.object(Session, "request") as req: + # We need to mock transcode() because providing default values + # for required fields will fail the real version if the http_options + # expect actual values for those fields. + with mock.patch.object(path_template, "transcode") as transcode: + # A uri without fields and an empty body will force all the + # request fields to show up in the query_params. + pb_request = request_type.pb(request) + transcode_result = { + "uri": "v1/sample_method", + "method": "get", + "query_params": pb_request, + } + transcode.return_value = transcode_result + + response_value = Response() + response_value.status_code = 200 + + pb_return_value = product_search_service.ListReferenceImagesResponse.pb( + return_value + ) + json_return_value = json_format.MessageToJson(pb_return_value) + + response_value._content = json_return_value.encode("UTF-8") + req.return_value = response_value + + response = client.list_reference_images(request) + + expected_params = [("$alt", "json;enum-encoding=int")] + actual_params = req.call_args.kwargs["params"] + assert expected_params == actual_params + + +def test_list_reference_images_rest_unset_required_fields(): + transport = transports.ProductSearchRestTransport( + credentials=ga_credentials.AnonymousCredentials + ) + + unset_fields = transport.list_reference_images._get_unset_required_fields({}) + assert set(unset_fields) == ( + set( + ( + "pageSize", + "pageToken", + ) + ) + & set(("parent",)) + ) + + +@pytest.mark.parametrize("null_interceptor", [True, False]) +def test_list_reference_images_rest_interceptors(null_interceptor): + transport = transports.ProductSearchRestTransport( + credentials=ga_credentials.AnonymousCredentials(), + interceptor=None + if null_interceptor + else transports.ProductSearchRestInterceptor(), + ) + client = ProductSearchClient(transport=transport) + with mock.patch.object( + type(client.transport._session), "request" + ) as req, mock.patch.object( + path_template, "transcode" + ) as transcode, mock.patch.object( + transports.ProductSearchRestInterceptor, "post_list_reference_images" + ) as post, mock.patch.object( + transports.ProductSearchRestInterceptor, "pre_list_reference_images" + ) as pre: + pre.assert_not_called() + post.assert_not_called() + pb_message = product_search_service.ListReferenceImagesRequest.pb( + product_search_service.ListReferenceImagesRequest() + ) + transcode.return_value = { + "method": "post", + "uri": "my_uri", + "body": pb_message, + "query_params": pb_message, + } + + req.return_value = Response() + req.return_value.status_code = 200 + req.return_value.request = PreparedRequest() + req.return_value._content = ( + product_search_service.ListReferenceImagesResponse.to_json( + product_search_service.ListReferenceImagesResponse() + ) + ) + + request = product_search_service.ListReferenceImagesRequest() + metadata = [ + ("key", "val"), + ("cephalopod", "squid"), + ] + pre.return_value = request, metadata + post.return_value = product_search_service.ListReferenceImagesResponse() + + client.list_reference_images( + request, + metadata=[ + ("key", "val"), + ("cephalopod", "squid"), + ], + ) + + pre.assert_called_once() + post.assert_called_once() + + +def test_list_reference_images_rest_bad_request( + transport: str = "rest", + request_type=product_search_service.ListReferenceImagesRequest, +): + client = ProductSearchClient( + credentials=ga_credentials.AnonymousCredentials(), + transport=transport, + ) + + # send a request that will satisfy transcoding + request_init = {"parent": "projects/sample1/locations/sample2/products/sample3"} + request = request_type(**request_init) + + # Mock the http request call within the method and fake a BadRequest error. + with mock.patch.object(Session, "request") as req, pytest.raises( + core_exceptions.BadRequest + ): + # Wrap the value into a proper Response obj + response_value = Response() + response_value.status_code = 400 + response_value.request = Request() + req.return_value = response_value + client.list_reference_images(request) + + +def test_list_reference_images_rest_flattened(): + client = ProductSearchClient( + credentials=ga_credentials.AnonymousCredentials(), + transport="rest", + ) + + # Mock the http request call within the method and fake a response. + with mock.patch.object(type(client.transport._session), "request") as req: + # Designate an appropriate value for the returned response. + return_value = product_search_service.ListReferenceImagesResponse() + + # get arguments that satisfy an http rule for this method + sample_request = { + "parent": "projects/sample1/locations/sample2/products/sample3" + } + + # get truthy value for each flattened field + mock_args = dict( + parent="parent_value", + ) + mock_args.update(sample_request) + + # Wrap the value into a proper Response obj + response_value = Response() + response_value.status_code = 200 + pb_return_value = product_search_service.ListReferenceImagesResponse.pb( + return_value + ) + json_return_value = json_format.MessageToJson(pb_return_value) + response_value._content = json_return_value.encode("UTF-8") + req.return_value = response_value + + client.list_reference_images(**mock_args) + + # Establish that the underlying call was made with the expected + # request object values. + assert len(req.mock_calls) == 1 + _, args, _ = req.mock_calls[0] + assert path_template.validate( + "%s/v1/{parent=projects/*/locations/*/products/*}/referenceImages" + % client.transport._host, + args[1], + ) + + +def test_list_reference_images_rest_flattened_error(transport: str = "rest"): + client = ProductSearchClient( + credentials=ga_credentials.AnonymousCredentials(), + transport=transport, + ) + + # Attempting to call a method with both a request object and flattened + # fields is an error. + with pytest.raises(ValueError): + client.list_reference_images( + product_search_service.ListReferenceImagesRequest(), + parent="parent_value", + ) + + +def test_list_reference_images_rest_pager(transport: str = "rest"): + client = ProductSearchClient( + credentials=ga_credentials.AnonymousCredentials(), + transport=transport, + ) + + # Mock the http request call within the method and fake a response. + with mock.patch.object(Session, "request") as req: + # TODO(kbandes): remove this mock unless there's a good reason for it. + # with mock.patch.object(path_template, 'transcode') as transcode: + # Set the response as a series of pages + response = ( + product_search_service.ListReferenceImagesResponse( + reference_images=[ + product_search_service.ReferenceImage(), + product_search_service.ReferenceImage(), + product_search_service.ReferenceImage(), + ], + next_page_token="abc", + ), + product_search_service.ListReferenceImagesResponse( + reference_images=[], + next_page_token="def", + ), + product_search_service.ListReferenceImagesResponse( + reference_images=[ + product_search_service.ReferenceImage(), + ], + next_page_token="ghi", + ), + product_search_service.ListReferenceImagesResponse( + reference_images=[ + product_search_service.ReferenceImage(), + product_search_service.ReferenceImage(), + ], + ), + ) + # Two responses for two calls + response = response + response + + # Wrap the values into proper Response objs + response = tuple( + product_search_service.ListReferenceImagesResponse.to_json(x) + for x in response + ) + return_values = tuple(Response() for i in response) + for return_val, response_val in zip(return_values, response): + return_val._content = response_val.encode("UTF-8") + return_val.status_code = 200 + req.side_effect = return_values + + sample_request = { + "parent": "projects/sample1/locations/sample2/products/sample3" + } + + pager = client.list_reference_images(request=sample_request) + + results = list(pager) + assert len(results) == 6 + assert all( + isinstance(i, product_search_service.ReferenceImage) for i in results + ) + + pages = list(client.list_reference_images(request=sample_request).pages) + for page_, token in zip(pages, ["abc", "def", "ghi", ""]): + assert page_.raw_page.next_page_token == token + + +@pytest.mark.parametrize( + "request_type", + [ + product_search_service.GetReferenceImageRequest, + dict, + ], +) +def test_get_reference_image_rest(request_type): + client = ProductSearchClient( + credentials=ga_credentials.AnonymousCredentials(), + transport="rest", + ) + + # send a request that will satisfy transcoding + request_init = { + "name": "projects/sample1/locations/sample2/products/sample3/referenceImages/sample4" + } + request = request_type(**request_init) + + # Mock the http request call within the method and fake a response. + with mock.patch.object(type(client.transport._session), "request") as req: + # Designate an appropriate value for the returned response. + return_value = product_search_service.ReferenceImage( + name="name_value", + uri="uri_value", + ) + + # Wrap the value into a proper Response obj + response_value = Response() + response_value.status_code = 200 + pb_return_value = product_search_service.ReferenceImage.pb(return_value) + json_return_value = json_format.MessageToJson(pb_return_value) + + response_value._content = json_return_value.encode("UTF-8") + req.return_value = response_value + response = client.get_reference_image(request) + + # Establish that the response is the type that we expect. + assert isinstance(response, product_search_service.ReferenceImage) + assert response.name == "name_value" + assert response.uri == "uri_value" + + +def test_get_reference_image_rest_required_fields( + request_type=product_search_service.GetReferenceImageRequest, +): + transport_class = transports.ProductSearchRestTransport + + request_init = {} + request_init["name"] = "" + request = request_type(**request_init) + pb_request = request_type.pb(request) + jsonified_request = json.loads( + json_format.MessageToJson( + pb_request, + including_default_value_fields=False, + use_integers_for_enums=False, + ) + ) + + # verify fields with default values are dropped + + unset_fields = transport_class( + credentials=ga_credentials.AnonymousCredentials() + ).get_reference_image._get_unset_required_fields(jsonified_request) + jsonified_request.update(unset_fields) + + # verify required fields with default values are now present + + jsonified_request["name"] = "name_value" + + unset_fields = transport_class( + credentials=ga_credentials.AnonymousCredentials() + ).get_reference_image._get_unset_required_fields(jsonified_request) + jsonified_request.update(unset_fields) + + # verify required fields with non-default values are left alone + assert "name" in jsonified_request + assert jsonified_request["name"] == "name_value" + + client = ProductSearchClient( + credentials=ga_credentials.AnonymousCredentials(), + transport="rest", + ) + request = request_type(**request_init) + + # Designate an appropriate value for the returned response. + return_value = product_search_service.ReferenceImage() + # Mock the http request call within the method and fake a response. + with mock.patch.object(Session, "request") as req: + # We need to mock transcode() because providing default values + # for required fields will fail the real version if the http_options + # expect actual values for those fields. + with mock.patch.object(path_template, "transcode") as transcode: + # A uri without fields and an empty body will force all the + # request fields to show up in the query_params. + pb_request = request_type.pb(request) + transcode_result = { + "uri": "v1/sample_method", + "method": "get", + "query_params": pb_request, + } + transcode.return_value = transcode_result + + response_value = Response() + response_value.status_code = 200 + + pb_return_value = product_search_service.ReferenceImage.pb(return_value) + json_return_value = json_format.MessageToJson(pb_return_value) + + response_value._content = json_return_value.encode("UTF-8") + req.return_value = response_value + + response = client.get_reference_image(request) + + expected_params = [("$alt", "json;enum-encoding=int")] + actual_params = req.call_args.kwargs["params"] + assert expected_params == actual_params + + +def test_get_reference_image_rest_unset_required_fields(): + transport = transports.ProductSearchRestTransport( + credentials=ga_credentials.AnonymousCredentials + ) + + unset_fields = transport.get_reference_image._get_unset_required_fields({}) + assert set(unset_fields) == (set(()) & set(("name",))) + + +@pytest.mark.parametrize("null_interceptor", [True, False]) +def test_get_reference_image_rest_interceptors(null_interceptor): + transport = transports.ProductSearchRestTransport( + credentials=ga_credentials.AnonymousCredentials(), + interceptor=None + if null_interceptor + else transports.ProductSearchRestInterceptor(), + ) + client = ProductSearchClient(transport=transport) + with mock.patch.object( + type(client.transport._session), "request" + ) as req, mock.patch.object( + path_template, "transcode" + ) as transcode, mock.patch.object( + transports.ProductSearchRestInterceptor, "post_get_reference_image" + ) as post, mock.patch.object( + transports.ProductSearchRestInterceptor, "pre_get_reference_image" + ) as pre: + pre.assert_not_called() + post.assert_not_called() + pb_message = product_search_service.GetReferenceImageRequest.pb( + product_search_service.GetReferenceImageRequest() + ) + transcode.return_value = { + "method": "post", + "uri": "my_uri", + "body": pb_message, + "query_params": pb_message, + } + + req.return_value = Response() + req.return_value.status_code = 200 + req.return_value.request = PreparedRequest() + req.return_value._content = product_search_service.ReferenceImage.to_json( + product_search_service.ReferenceImage() + ) + + request = product_search_service.GetReferenceImageRequest() + metadata = [ + ("key", "val"), + ("cephalopod", "squid"), + ] + pre.return_value = request, metadata + post.return_value = product_search_service.ReferenceImage() + + client.get_reference_image( + request, + metadata=[ + ("key", "val"), + ("cephalopod", "squid"), + ], + ) + + pre.assert_called_once() + post.assert_called_once() + + +def test_get_reference_image_rest_bad_request( + transport: str = "rest", + request_type=product_search_service.GetReferenceImageRequest, +): + client = ProductSearchClient( + credentials=ga_credentials.AnonymousCredentials(), + transport=transport, + ) + + # send a request that will satisfy transcoding + request_init = { + "name": "projects/sample1/locations/sample2/products/sample3/referenceImages/sample4" + } + request = request_type(**request_init) + + # Mock the http request call within the method and fake a BadRequest error. + with mock.patch.object(Session, "request") as req, pytest.raises( + core_exceptions.BadRequest + ): + # Wrap the value into a proper Response obj + response_value = Response() + response_value.status_code = 400 + response_value.request = Request() + req.return_value = response_value + client.get_reference_image(request) + + +def test_get_reference_image_rest_flattened(): + client = ProductSearchClient( + credentials=ga_credentials.AnonymousCredentials(), + transport="rest", + ) + + # Mock the http request call within the method and fake a response. + with mock.patch.object(type(client.transport._session), "request") as req: + # Designate an appropriate value for the returned response. + return_value = product_search_service.ReferenceImage() + + # get arguments that satisfy an http rule for this method + sample_request = { + "name": "projects/sample1/locations/sample2/products/sample3/referenceImages/sample4" + } + + # get truthy value for each flattened field + mock_args = dict( + name="name_value", + ) + mock_args.update(sample_request) + + # Wrap the value into a proper Response obj + response_value = Response() + response_value.status_code = 200 + pb_return_value = product_search_service.ReferenceImage.pb(return_value) + json_return_value = json_format.MessageToJson(pb_return_value) + response_value._content = json_return_value.encode("UTF-8") + req.return_value = response_value + + client.get_reference_image(**mock_args) + + # Establish that the underlying call was made with the expected + # request object values. + assert len(req.mock_calls) == 1 + _, args, _ = req.mock_calls[0] + assert path_template.validate( + "%s/v1/{name=projects/*/locations/*/products/*/referenceImages/*}" + % client.transport._host, + args[1], + ) + + +def test_get_reference_image_rest_flattened_error(transport: str = "rest"): + client = ProductSearchClient( + credentials=ga_credentials.AnonymousCredentials(), + transport=transport, + ) + + # Attempting to call a method with both a request object and flattened + # fields is an error. + with pytest.raises(ValueError): + client.get_reference_image( + product_search_service.GetReferenceImageRequest(), + name="name_value", + ) + + +def test_get_reference_image_rest_error(): + client = ProductSearchClient( + credentials=ga_credentials.AnonymousCredentials(), transport="rest" + ) + + +@pytest.mark.parametrize( + "request_type", + [ + product_search_service.AddProductToProductSetRequest, + dict, + ], +) +def test_add_product_to_product_set_rest(request_type): + client = ProductSearchClient( + credentials=ga_credentials.AnonymousCredentials(), + transport="rest", + ) + + # send a request that will satisfy transcoding + request_init = {"name": "projects/sample1/locations/sample2/productSets/sample3"} + request = request_type(**request_init) + + # Mock the http request call within the method and fake a response. + with mock.patch.object(type(client.transport._session), "request") as req: + # Designate an appropriate value for the returned response. + return_value = None + + # Wrap the value into a proper Response obj + response_value = Response() + response_value.status_code = 200 + json_return_value = "" + + response_value._content = json_return_value.encode("UTF-8") + req.return_value = response_value + response = client.add_product_to_product_set(request) + + # Establish that the response is the type that we expect. + assert response is None + + +def test_add_product_to_product_set_rest_required_fields( + request_type=product_search_service.AddProductToProductSetRequest, +): + transport_class = transports.ProductSearchRestTransport + + request_init = {} + request_init["name"] = "" + request_init["product"] = "" + request = request_type(**request_init) + pb_request = request_type.pb(request) + jsonified_request = json.loads( + json_format.MessageToJson( + pb_request, + including_default_value_fields=False, + use_integers_for_enums=False, + ) + ) + + # verify fields with default values are dropped + + unset_fields = transport_class( + credentials=ga_credentials.AnonymousCredentials() + ).add_product_to_product_set._get_unset_required_fields(jsonified_request) + jsonified_request.update(unset_fields) + + # verify required fields with default values are now present + + jsonified_request["name"] = "name_value" + jsonified_request["product"] = "product_value" + + unset_fields = transport_class( + credentials=ga_credentials.AnonymousCredentials() + ).add_product_to_product_set._get_unset_required_fields(jsonified_request) + jsonified_request.update(unset_fields) + + # verify required fields with non-default values are left alone + assert "name" in jsonified_request + assert jsonified_request["name"] == "name_value" + assert "product" in jsonified_request + assert jsonified_request["product"] == "product_value" + + client = ProductSearchClient( + credentials=ga_credentials.AnonymousCredentials(), + transport="rest", + ) + request = request_type(**request_init) + + # Designate an appropriate value for the returned response. + return_value = None + # Mock the http request call within the method and fake a response. + with mock.patch.object(Session, "request") as req: + # We need to mock transcode() because providing default values + # for required fields will fail the real version if the http_options + # expect actual values for those fields. + with mock.patch.object(path_template, "transcode") as transcode: + # A uri without fields and an empty body will force all the + # request fields to show up in the query_params. + pb_request = request_type.pb(request) + transcode_result = { + "uri": "v1/sample_method", + "method": "post", + "query_params": pb_request, + } + transcode_result["body"] = pb_request + transcode.return_value = transcode_result + + response_value = Response() + response_value.status_code = 200 + json_return_value = "" + + response_value._content = json_return_value.encode("UTF-8") + req.return_value = response_value + + response = client.add_product_to_product_set(request) + + expected_params = [("$alt", "json;enum-encoding=int")] + actual_params = req.call_args.kwargs["params"] + assert expected_params == actual_params + + +def test_add_product_to_product_set_rest_unset_required_fields(): + transport = transports.ProductSearchRestTransport( + credentials=ga_credentials.AnonymousCredentials + ) + + unset_fields = transport.add_product_to_product_set._get_unset_required_fields({}) + assert set(unset_fields) == ( + set(()) + & set( + ( + "name", + "product", + ) + ) + ) + + +@pytest.mark.parametrize("null_interceptor", [True, False]) +def test_add_product_to_product_set_rest_interceptors(null_interceptor): + transport = transports.ProductSearchRestTransport( + credentials=ga_credentials.AnonymousCredentials(), + interceptor=None + if null_interceptor + else transports.ProductSearchRestInterceptor(), + ) + client = ProductSearchClient(transport=transport) + with mock.patch.object( + type(client.transport._session), "request" + ) as req, mock.patch.object( + path_template, "transcode" + ) as transcode, mock.patch.object( + transports.ProductSearchRestInterceptor, "pre_add_product_to_product_set" + ) as pre: + pre.assert_not_called() + pb_message = product_search_service.AddProductToProductSetRequest.pb( + product_search_service.AddProductToProductSetRequest() + ) + transcode.return_value = { + "method": "post", + "uri": "my_uri", + "body": pb_message, + "query_params": pb_message, + } + + req.return_value = Response() + req.return_value.status_code = 200 + req.return_value.request = PreparedRequest() + + request = product_search_service.AddProductToProductSetRequest() + metadata = [ + ("key", "val"), + ("cephalopod", "squid"), + ] + pre.return_value = request, metadata + + client.add_product_to_product_set( + request, + metadata=[ + ("key", "val"), + ("cephalopod", "squid"), + ], + ) + + pre.assert_called_once() + + +def test_add_product_to_product_set_rest_bad_request( + transport: str = "rest", + request_type=product_search_service.AddProductToProductSetRequest, +): + client = ProductSearchClient( + credentials=ga_credentials.AnonymousCredentials(), + transport=transport, + ) + + # send a request that will satisfy transcoding + request_init = {"name": "projects/sample1/locations/sample2/productSets/sample3"} + request = request_type(**request_init) + + # Mock the http request call within the method and fake a BadRequest error. + with mock.patch.object(Session, "request") as req, pytest.raises( + core_exceptions.BadRequest + ): + # Wrap the value into a proper Response obj + response_value = Response() + response_value.status_code = 400 + response_value.request = Request() + req.return_value = response_value + client.add_product_to_product_set(request) + + +def test_add_product_to_product_set_rest_flattened(): + client = ProductSearchClient( + credentials=ga_credentials.AnonymousCredentials(), + transport="rest", + ) + + # Mock the http request call within the method and fake a response. + with mock.patch.object(type(client.transport._session), "request") as req: + # Designate an appropriate value for the returned response. + return_value = None + + # get arguments that satisfy an http rule for this method + sample_request = { + "name": "projects/sample1/locations/sample2/productSets/sample3" + } + + # get truthy value for each flattened field + mock_args = dict( + name="name_value", + product="product_value", + ) + mock_args.update(sample_request) + + # Wrap the value into a proper Response obj + response_value = Response() + response_value.status_code = 200 + json_return_value = "" + response_value._content = json_return_value.encode("UTF-8") + req.return_value = response_value + + client.add_product_to_product_set(**mock_args) + + # Establish that the underlying call was made with the expected + # request object values. + assert len(req.mock_calls) == 1 + _, args, _ = req.mock_calls[0] + assert path_template.validate( + "%s/v1/{name=projects/*/locations/*/productSets/*}:addProduct" + % client.transport._host, + args[1], + ) + + +def test_add_product_to_product_set_rest_flattened_error(transport: str = "rest"): + client = ProductSearchClient( + credentials=ga_credentials.AnonymousCredentials(), + transport=transport, + ) + + # Attempting to call a method with both a request object and flattened + # fields is an error. + with pytest.raises(ValueError): + client.add_product_to_product_set( + product_search_service.AddProductToProductSetRequest(), + name="name_value", + product="product_value", + ) + + +def test_add_product_to_product_set_rest_error(): + client = ProductSearchClient( + credentials=ga_credentials.AnonymousCredentials(), transport="rest" + ) + + +@pytest.mark.parametrize( + "request_type", + [ + product_search_service.RemoveProductFromProductSetRequest, + dict, + ], +) +def test_remove_product_from_product_set_rest(request_type): + client = ProductSearchClient( + credentials=ga_credentials.AnonymousCredentials(), + transport="rest", + ) + + # send a request that will satisfy transcoding + request_init = {"name": "projects/sample1/locations/sample2/productSets/sample3"} + request = request_type(**request_init) + + # Mock the http request call within the method and fake a response. + with mock.patch.object(type(client.transport._session), "request") as req: + # Designate an appropriate value for the returned response. + return_value = None + + # Wrap the value into a proper Response obj + response_value = Response() + response_value.status_code = 200 + json_return_value = "" + + response_value._content = json_return_value.encode("UTF-8") + req.return_value = response_value + response = client.remove_product_from_product_set(request) + + # Establish that the response is the type that we expect. + assert response is None + + +def test_remove_product_from_product_set_rest_required_fields( + request_type=product_search_service.RemoveProductFromProductSetRequest, +): + transport_class = transports.ProductSearchRestTransport + + request_init = {} + request_init["name"] = "" + request_init["product"] = "" + request = request_type(**request_init) + pb_request = request_type.pb(request) + jsonified_request = json.loads( + json_format.MessageToJson( + pb_request, + including_default_value_fields=False, + use_integers_for_enums=False, + ) + ) + + # verify fields with default values are dropped + + unset_fields = transport_class( + credentials=ga_credentials.AnonymousCredentials() + ).remove_product_from_product_set._get_unset_required_fields(jsonified_request) + jsonified_request.update(unset_fields) + + # verify required fields with default values are now present + + jsonified_request["name"] = "name_value" + jsonified_request["product"] = "product_value" + + unset_fields = transport_class( + credentials=ga_credentials.AnonymousCredentials() + ).remove_product_from_product_set._get_unset_required_fields(jsonified_request) + jsonified_request.update(unset_fields) + + # verify required fields with non-default values are left alone + assert "name" in jsonified_request + assert jsonified_request["name"] == "name_value" + assert "product" in jsonified_request + assert jsonified_request["product"] == "product_value" + + client = ProductSearchClient( + credentials=ga_credentials.AnonymousCredentials(), + transport="rest", + ) + request = request_type(**request_init) + + # Designate an appropriate value for the returned response. + return_value = None + # Mock the http request call within the method and fake a response. + with mock.patch.object(Session, "request") as req: + # We need to mock transcode() because providing default values + # for required fields will fail the real version if the http_options + # expect actual values for those fields. + with mock.patch.object(path_template, "transcode") as transcode: + # A uri without fields and an empty body will force all the + # request fields to show up in the query_params. + pb_request = request_type.pb(request) + transcode_result = { + "uri": "v1/sample_method", + "method": "post", + "query_params": pb_request, + } + transcode_result["body"] = pb_request + transcode.return_value = transcode_result + + response_value = Response() + response_value.status_code = 200 + json_return_value = "" + + response_value._content = json_return_value.encode("UTF-8") + req.return_value = response_value + + response = client.remove_product_from_product_set(request) + + expected_params = [("$alt", "json;enum-encoding=int")] + actual_params = req.call_args.kwargs["params"] + assert expected_params == actual_params + + +def test_remove_product_from_product_set_rest_unset_required_fields(): + transport = transports.ProductSearchRestTransport( + credentials=ga_credentials.AnonymousCredentials + ) + + unset_fields = transport.remove_product_from_product_set._get_unset_required_fields( + {} + ) + assert set(unset_fields) == ( + set(()) + & set( + ( + "name", + "product", + ) + ) + ) + + +@pytest.mark.parametrize("null_interceptor", [True, False]) +def test_remove_product_from_product_set_rest_interceptors(null_interceptor): + transport = transports.ProductSearchRestTransport( + credentials=ga_credentials.AnonymousCredentials(), + interceptor=None + if null_interceptor + else transports.ProductSearchRestInterceptor(), + ) + client = ProductSearchClient(transport=transport) + with mock.patch.object( + type(client.transport._session), "request" + ) as req, mock.patch.object( + path_template, "transcode" + ) as transcode, mock.patch.object( + transports.ProductSearchRestInterceptor, "pre_remove_product_from_product_set" + ) as pre: + pre.assert_not_called() + pb_message = product_search_service.RemoveProductFromProductSetRequest.pb( + product_search_service.RemoveProductFromProductSetRequest() + ) + transcode.return_value = { + "method": "post", + "uri": "my_uri", + "body": pb_message, + "query_params": pb_message, + } + + req.return_value = Response() + req.return_value.status_code = 200 + req.return_value.request = PreparedRequest() + + request = product_search_service.RemoveProductFromProductSetRequest() + metadata = [ + ("key", "val"), + ("cephalopod", "squid"), + ] + pre.return_value = request, metadata + + client.remove_product_from_product_set( + request, + metadata=[ + ("key", "val"), + ("cephalopod", "squid"), + ], + ) + + pre.assert_called_once() + + +def test_remove_product_from_product_set_rest_bad_request( + transport: str = "rest", + request_type=product_search_service.RemoveProductFromProductSetRequest, +): + client = ProductSearchClient( + credentials=ga_credentials.AnonymousCredentials(), + transport=transport, + ) + + # send a request that will satisfy transcoding + request_init = {"name": "projects/sample1/locations/sample2/productSets/sample3"} + request = request_type(**request_init) + + # Mock the http request call within the method and fake a BadRequest error. + with mock.patch.object(Session, "request") as req, pytest.raises( + core_exceptions.BadRequest + ): + # Wrap the value into a proper Response obj + response_value = Response() + response_value.status_code = 400 + response_value.request = Request() + req.return_value = response_value + client.remove_product_from_product_set(request) + + +def test_remove_product_from_product_set_rest_flattened(): + client = ProductSearchClient( + credentials=ga_credentials.AnonymousCredentials(), + transport="rest", + ) + + # Mock the http request call within the method and fake a response. + with mock.patch.object(type(client.transport._session), "request") as req: + # Designate an appropriate value for the returned response. + return_value = None + + # get arguments that satisfy an http rule for this method + sample_request = { + "name": "projects/sample1/locations/sample2/productSets/sample3" + } + + # get truthy value for each flattened field + mock_args = dict( + name="name_value", + product="product_value", + ) + mock_args.update(sample_request) + + # Wrap the value into a proper Response obj + response_value = Response() + response_value.status_code = 200 + json_return_value = "" + response_value._content = json_return_value.encode("UTF-8") + req.return_value = response_value + + client.remove_product_from_product_set(**mock_args) + + # Establish that the underlying call was made with the expected + # request object values. + assert len(req.mock_calls) == 1 + _, args, _ = req.mock_calls[0] + assert path_template.validate( + "%s/v1/{name=projects/*/locations/*/productSets/*}:removeProduct" + % client.transport._host, + args[1], + ) + + +def test_remove_product_from_product_set_rest_flattened_error(transport: str = "rest"): + client = ProductSearchClient( + credentials=ga_credentials.AnonymousCredentials(), + transport=transport, + ) + + # Attempting to call a method with both a request object and flattened + # fields is an error. + with pytest.raises(ValueError): + client.remove_product_from_product_set( + product_search_service.RemoveProductFromProductSetRequest(), + name="name_value", + product="product_value", + ) + + +def test_remove_product_from_product_set_rest_error(): + client = ProductSearchClient( + credentials=ga_credentials.AnonymousCredentials(), transport="rest" + ) + + +@pytest.mark.parametrize( + "request_type", + [ + product_search_service.ListProductsInProductSetRequest, + dict, + ], +) +def test_list_products_in_product_set_rest(request_type): + client = ProductSearchClient( + credentials=ga_credentials.AnonymousCredentials(), + transport="rest", + ) + + # send a request that will satisfy transcoding + request_init = {"name": "projects/sample1/locations/sample2/productSets/sample3"} + request = request_type(**request_init) + + # Mock the http request call within the method and fake a response. + with mock.patch.object(type(client.transport._session), "request") as req: + # Designate an appropriate value for the returned response. + return_value = product_search_service.ListProductsInProductSetResponse( + next_page_token="next_page_token_value", + ) + + # Wrap the value into a proper Response obj + response_value = Response() + response_value.status_code = 200 + pb_return_value = product_search_service.ListProductsInProductSetResponse.pb( + return_value + ) + json_return_value = json_format.MessageToJson(pb_return_value) + + response_value._content = json_return_value.encode("UTF-8") + req.return_value = response_value + response = client.list_products_in_product_set(request) + + # Establish that the response is the type that we expect. + assert isinstance(response, pagers.ListProductsInProductSetPager) + assert response.next_page_token == "next_page_token_value" + + +def test_list_products_in_product_set_rest_required_fields( + request_type=product_search_service.ListProductsInProductSetRequest, +): + transport_class = transports.ProductSearchRestTransport + + request_init = {} + request_init["name"] = "" + request = request_type(**request_init) + pb_request = request_type.pb(request) + jsonified_request = json.loads( + json_format.MessageToJson( + pb_request, + including_default_value_fields=False, + use_integers_for_enums=False, + ) + ) + + # verify fields with default values are dropped + + unset_fields = transport_class( + credentials=ga_credentials.AnonymousCredentials() + ).list_products_in_product_set._get_unset_required_fields(jsonified_request) + jsonified_request.update(unset_fields) + + # verify required fields with default values are now present + + jsonified_request["name"] = "name_value" + + unset_fields = transport_class( + credentials=ga_credentials.AnonymousCredentials() + ).list_products_in_product_set._get_unset_required_fields(jsonified_request) + # Check that path parameters and body parameters are not mixing in. + assert not set(unset_fields) - set( + ( + "page_size", + "page_token", + ) + ) + jsonified_request.update(unset_fields) + + # verify required fields with non-default values are left alone + assert "name" in jsonified_request + assert jsonified_request["name"] == "name_value" + + client = ProductSearchClient( + credentials=ga_credentials.AnonymousCredentials(), + transport="rest", + ) + request = request_type(**request_init) + + # Designate an appropriate value for the returned response. + return_value = product_search_service.ListProductsInProductSetResponse() + # Mock the http request call within the method and fake a response. + with mock.patch.object(Session, "request") as req: + # We need to mock transcode() because providing default values + # for required fields will fail the real version if the http_options + # expect actual values for those fields. + with mock.patch.object(path_template, "transcode") as transcode: + # A uri without fields and an empty body will force all the + # request fields to show up in the query_params. + pb_request = request_type.pb(request) + transcode_result = { + "uri": "v1/sample_method", + "method": "get", + "query_params": pb_request, + } + transcode.return_value = transcode_result + + response_value = Response() + response_value.status_code = 200 + + pb_return_value = ( + product_search_service.ListProductsInProductSetResponse.pb(return_value) + ) + json_return_value = json_format.MessageToJson(pb_return_value) + + response_value._content = json_return_value.encode("UTF-8") + req.return_value = response_value + + response = client.list_products_in_product_set(request) + + expected_params = [("$alt", "json;enum-encoding=int")] + actual_params = req.call_args.kwargs["params"] + assert expected_params == actual_params + + +def test_list_products_in_product_set_rest_unset_required_fields(): + transport = transports.ProductSearchRestTransport( + credentials=ga_credentials.AnonymousCredentials + ) + + unset_fields = transport.list_products_in_product_set._get_unset_required_fields({}) + assert set(unset_fields) == ( + set( + ( + "pageSize", + "pageToken", + ) + ) + & set(("name",)) + ) + + +@pytest.mark.parametrize("null_interceptor", [True, False]) +def test_list_products_in_product_set_rest_interceptors(null_interceptor): + transport = transports.ProductSearchRestTransport( + credentials=ga_credentials.AnonymousCredentials(), + interceptor=None + if null_interceptor + else transports.ProductSearchRestInterceptor(), + ) + client = ProductSearchClient(transport=transport) + with mock.patch.object( + type(client.transport._session), "request" + ) as req, mock.patch.object( + path_template, "transcode" + ) as transcode, mock.patch.object( + transports.ProductSearchRestInterceptor, "post_list_products_in_product_set" + ) as post, mock.patch.object( + transports.ProductSearchRestInterceptor, "pre_list_products_in_product_set" + ) as pre: + pre.assert_not_called() + post.assert_not_called() + pb_message = product_search_service.ListProductsInProductSetRequest.pb( + product_search_service.ListProductsInProductSetRequest() + ) + transcode.return_value = { + "method": "post", + "uri": "my_uri", + "body": pb_message, + "query_params": pb_message, + } + + req.return_value = Response() + req.return_value.status_code = 200 + req.return_value.request = PreparedRequest() + req.return_value._content = ( + product_search_service.ListProductsInProductSetResponse.to_json( + product_search_service.ListProductsInProductSetResponse() + ) + ) + + request = product_search_service.ListProductsInProductSetRequest() + metadata = [ + ("key", "val"), + ("cephalopod", "squid"), + ] + pre.return_value = request, metadata + post.return_value = product_search_service.ListProductsInProductSetResponse() + + client.list_products_in_product_set( + request, + metadata=[ + ("key", "val"), + ("cephalopod", "squid"), + ], + ) + + pre.assert_called_once() + post.assert_called_once() + + +def test_list_products_in_product_set_rest_bad_request( + transport: str = "rest", + request_type=product_search_service.ListProductsInProductSetRequest, +): + client = ProductSearchClient( + credentials=ga_credentials.AnonymousCredentials(), + transport=transport, + ) + + # send a request that will satisfy transcoding + request_init = {"name": "projects/sample1/locations/sample2/productSets/sample3"} + request = request_type(**request_init) + + # Mock the http request call within the method and fake a BadRequest error. + with mock.patch.object(Session, "request") as req, pytest.raises( + core_exceptions.BadRequest + ): + # Wrap the value into a proper Response obj + response_value = Response() + response_value.status_code = 400 + response_value.request = Request() + req.return_value = response_value + client.list_products_in_product_set(request) + + +def test_list_products_in_product_set_rest_flattened(): + client = ProductSearchClient( + credentials=ga_credentials.AnonymousCredentials(), + transport="rest", + ) + + # Mock the http request call within the method and fake a response. + with mock.patch.object(type(client.transport._session), "request") as req: + # Designate an appropriate value for the returned response. + return_value = product_search_service.ListProductsInProductSetResponse() + + # get arguments that satisfy an http rule for this method + sample_request = { + "name": "projects/sample1/locations/sample2/productSets/sample3" + } + + # get truthy value for each flattened field + mock_args = dict( + name="name_value", + ) + mock_args.update(sample_request) + + # Wrap the value into a proper Response obj + response_value = Response() + response_value.status_code = 200 + pb_return_value = product_search_service.ListProductsInProductSetResponse.pb( + return_value + ) + json_return_value = json_format.MessageToJson(pb_return_value) + response_value._content = json_return_value.encode("UTF-8") + req.return_value = response_value + + client.list_products_in_product_set(**mock_args) + + # Establish that the underlying call was made with the expected + # request object values. + assert len(req.mock_calls) == 1 + _, args, _ = req.mock_calls[0] + assert path_template.validate( + "%s/v1/{name=projects/*/locations/*/productSets/*}/products" + % client.transport._host, + args[1], + ) + + +def test_list_products_in_product_set_rest_flattened_error(transport: str = "rest"): + client = ProductSearchClient( + credentials=ga_credentials.AnonymousCredentials(), + transport=transport, + ) + + # Attempting to call a method with both a request object and flattened + # fields is an error. + with pytest.raises(ValueError): + client.list_products_in_product_set( + product_search_service.ListProductsInProductSetRequest(), + name="name_value", + ) + + +def test_list_products_in_product_set_rest_pager(transport: str = "rest"): + client = ProductSearchClient( + credentials=ga_credentials.AnonymousCredentials(), + transport=transport, + ) + + # Mock the http request call within the method and fake a response. + with mock.patch.object(Session, "request") as req: + # TODO(kbandes): remove this mock unless there's a good reason for it. + # with mock.patch.object(path_template, 'transcode') as transcode: + # Set the response as a series of pages + response = ( + product_search_service.ListProductsInProductSetResponse( + products=[ + product_search_service.Product(), + product_search_service.Product(), + product_search_service.Product(), + ], + next_page_token="abc", + ), + product_search_service.ListProductsInProductSetResponse( + products=[], + next_page_token="def", + ), + product_search_service.ListProductsInProductSetResponse( + products=[ + product_search_service.Product(), + ], + next_page_token="ghi", + ), + product_search_service.ListProductsInProductSetResponse( + products=[ + product_search_service.Product(), + product_search_service.Product(), + ], + ), + ) + # Two responses for two calls + response = response + response + + # Wrap the values into proper Response objs + response = tuple( + product_search_service.ListProductsInProductSetResponse.to_json(x) + for x in response + ) + return_values = tuple(Response() for i in response) + for return_val, response_val in zip(return_values, response): + return_val._content = response_val.encode("UTF-8") + return_val.status_code = 200 + req.side_effect = return_values + + sample_request = { + "name": "projects/sample1/locations/sample2/productSets/sample3" + } + + pager = client.list_products_in_product_set(request=sample_request) + + results = list(pager) + assert len(results) == 6 + assert all(isinstance(i, product_search_service.Product) for i in results) + + pages = list(client.list_products_in_product_set(request=sample_request).pages) + for page_, token in zip(pages, ["abc", "def", "ghi", ""]): + assert page_.raw_page.next_page_token == token + + +@pytest.mark.parametrize( + "request_type", + [ + product_search_service.ImportProductSetsRequest, + dict, + ], +) +def test_import_product_sets_rest(request_type): + client = ProductSearchClient( + credentials=ga_credentials.AnonymousCredentials(), + transport="rest", + ) + + # send a request that will satisfy transcoding + request_init = {"parent": "projects/sample1/locations/sample2"} + request = request_type(**request_init) + + # Mock the http request call within the method and fake a response. + with mock.patch.object(type(client.transport._session), "request") as req: + # Designate an appropriate value for the returned response. + return_value = operations_pb2.Operation(name="operations/spam") + + # Wrap the value into a proper Response obj + response_value = Response() + response_value.status_code = 200 + json_return_value = json_format.MessageToJson(return_value) + + response_value._content = json_return_value.encode("UTF-8") + req.return_value = response_value + response = client.import_product_sets(request) + + # Establish that the response is the type that we expect. + assert response.operation.name == "operations/spam" + + +def test_import_product_sets_rest_required_fields( + request_type=product_search_service.ImportProductSetsRequest, +): + transport_class = transports.ProductSearchRestTransport + + request_init = {} + request_init["parent"] = "" + request = request_type(**request_init) + pb_request = request_type.pb(request) + jsonified_request = json.loads( + json_format.MessageToJson( + pb_request, + including_default_value_fields=False, + use_integers_for_enums=False, + ) + ) + + # verify fields with default values are dropped + + unset_fields = transport_class( + credentials=ga_credentials.AnonymousCredentials() + ).import_product_sets._get_unset_required_fields(jsonified_request) + jsonified_request.update(unset_fields) + + # verify required fields with default values are now present + + jsonified_request["parent"] = "parent_value" + + unset_fields = transport_class( + credentials=ga_credentials.AnonymousCredentials() + ).import_product_sets._get_unset_required_fields(jsonified_request) + jsonified_request.update(unset_fields) + + # verify required fields with non-default values are left alone + assert "parent" in jsonified_request + assert jsonified_request["parent"] == "parent_value" + + client = ProductSearchClient( + credentials=ga_credentials.AnonymousCredentials(), + transport="rest", + ) + request = request_type(**request_init) + + # Designate an appropriate value for the returned response. + return_value = operations_pb2.Operation(name="operations/spam") + # Mock the http request call within the method and fake a response. + with mock.patch.object(Session, "request") as req: + # We need to mock transcode() because providing default values + # for required fields will fail the real version if the http_options + # expect actual values for those fields. + with mock.patch.object(path_template, "transcode") as transcode: + # A uri without fields and an empty body will force all the + # request fields to show up in the query_params. + pb_request = request_type.pb(request) + transcode_result = { + "uri": "v1/sample_method", + "method": "post", + "query_params": pb_request, + } + transcode_result["body"] = pb_request + transcode.return_value = transcode_result + + response_value = Response() + response_value.status_code = 200 + json_return_value = json_format.MessageToJson(return_value) + + response_value._content = json_return_value.encode("UTF-8") + req.return_value = response_value + + response = client.import_product_sets(request) + + expected_params = [("$alt", "json;enum-encoding=int")] + actual_params = req.call_args.kwargs["params"] + assert expected_params == actual_params + + +def test_import_product_sets_rest_unset_required_fields(): + transport = transports.ProductSearchRestTransport( + credentials=ga_credentials.AnonymousCredentials + ) + + unset_fields = transport.import_product_sets._get_unset_required_fields({}) + assert set(unset_fields) == ( + set(()) + & set( + ( + "parent", + "inputConfig", + ) + ) + ) + + +@pytest.mark.parametrize("null_interceptor", [True, False]) +def test_import_product_sets_rest_interceptors(null_interceptor): + transport = transports.ProductSearchRestTransport( + credentials=ga_credentials.AnonymousCredentials(), + interceptor=None + if null_interceptor + else transports.ProductSearchRestInterceptor(), + ) + client = ProductSearchClient(transport=transport) + with mock.patch.object( + type(client.transport._session), "request" + ) as req, mock.patch.object( + path_template, "transcode" + ) as transcode, mock.patch.object( + operation.Operation, "_set_result_from_operation" + ), mock.patch.object( + transports.ProductSearchRestInterceptor, "post_import_product_sets" + ) as post, mock.patch.object( + transports.ProductSearchRestInterceptor, "pre_import_product_sets" + ) as pre: + pre.assert_not_called() + post.assert_not_called() + pb_message = product_search_service.ImportProductSetsRequest.pb( + product_search_service.ImportProductSetsRequest() + ) + transcode.return_value = { + "method": "post", + "uri": "my_uri", + "body": pb_message, + "query_params": pb_message, + } + + req.return_value = Response() + req.return_value.status_code = 200 + req.return_value.request = PreparedRequest() + req.return_value._content = json_format.MessageToJson( + operations_pb2.Operation() + ) + + request = product_search_service.ImportProductSetsRequest() + metadata = [ + ("key", "val"), + ("cephalopod", "squid"), + ] + pre.return_value = request, metadata + post.return_value = operations_pb2.Operation() + + client.import_product_sets( + request, + metadata=[ + ("key", "val"), + ("cephalopod", "squid"), + ], + ) + + pre.assert_called_once() + post.assert_called_once() + + +def test_import_product_sets_rest_bad_request( + transport: str = "rest", + request_type=product_search_service.ImportProductSetsRequest, +): + client = ProductSearchClient( + credentials=ga_credentials.AnonymousCredentials(), + transport=transport, + ) + + # send a request that will satisfy transcoding + request_init = {"parent": "projects/sample1/locations/sample2"} + request = request_type(**request_init) + + # Mock the http request call within the method and fake a BadRequest error. + with mock.patch.object(Session, "request") as req, pytest.raises( + core_exceptions.BadRequest + ): + # Wrap the value into a proper Response obj + response_value = Response() + response_value.status_code = 400 + response_value.request = Request() + req.return_value = response_value + client.import_product_sets(request) + + +def test_import_product_sets_rest_flattened(): + client = ProductSearchClient( + credentials=ga_credentials.AnonymousCredentials(), + transport="rest", + ) + + # Mock the http request call within the method and fake a response. + with mock.patch.object(type(client.transport._session), "request") as req: + # Designate an appropriate value for the returned response. + return_value = operations_pb2.Operation(name="operations/spam") + + # get arguments that satisfy an http rule for this method + sample_request = {"parent": "projects/sample1/locations/sample2"} + + # get truthy value for each flattened field + mock_args = dict( + parent="parent_value", + input_config=product_search_service.ImportProductSetsInputConfig( + gcs_source=product_search_service.ImportProductSetsGcsSource( + csv_file_uri="csv_file_uri_value" + ) + ), + ) + mock_args.update(sample_request) + + # Wrap the value into a proper Response obj + response_value = Response() + response_value.status_code = 200 + json_return_value = json_format.MessageToJson(return_value) + response_value._content = json_return_value.encode("UTF-8") + req.return_value = response_value + + client.import_product_sets(**mock_args) + + # Establish that the underlying call was made with the expected + # request object values. + assert len(req.mock_calls) == 1 + _, args, _ = req.mock_calls[0] + assert path_template.validate( + "%s/v1/{parent=projects/*/locations/*}/productSets:import" + % client.transport._host, + args[1], + ) + + +def test_import_product_sets_rest_flattened_error(transport: str = "rest"): + client = ProductSearchClient( + credentials=ga_credentials.AnonymousCredentials(), + transport=transport, + ) + + # Attempting to call a method with both a request object and flattened + # fields is an error. + with pytest.raises(ValueError): + client.import_product_sets( + product_search_service.ImportProductSetsRequest(), + parent="parent_value", + input_config=product_search_service.ImportProductSetsInputConfig( + gcs_source=product_search_service.ImportProductSetsGcsSource( + csv_file_uri="csv_file_uri_value" + ) + ), + ) + + +def test_import_product_sets_rest_error(): + client = ProductSearchClient( + credentials=ga_credentials.AnonymousCredentials(), transport="rest" + ) + + +@pytest.mark.parametrize( + "request_type", + [ + product_search_service.PurgeProductsRequest, + dict, + ], +) +def test_purge_products_rest(request_type): + client = ProductSearchClient( + credentials=ga_credentials.AnonymousCredentials(), + transport="rest", + ) + + # send a request that will satisfy transcoding + request_init = {"parent": "projects/sample1/locations/sample2"} + request = request_type(**request_init) + + # Mock the http request call within the method and fake a response. + with mock.patch.object(type(client.transport._session), "request") as req: + # Designate an appropriate value for the returned response. + return_value = operations_pb2.Operation(name="operations/spam") + + # Wrap the value into a proper Response obj + response_value = Response() + response_value.status_code = 200 + json_return_value = json_format.MessageToJson(return_value) + + response_value._content = json_return_value.encode("UTF-8") + req.return_value = response_value + response = client.purge_products(request) + + # Establish that the response is the type that we expect. + assert response.operation.name == "operations/spam" + + +def test_purge_products_rest_required_fields( + request_type=product_search_service.PurgeProductsRequest, +): + transport_class = transports.ProductSearchRestTransport + + request_init = {} + request_init["parent"] = "" + request = request_type(**request_init) + pb_request = request_type.pb(request) + jsonified_request = json.loads( + json_format.MessageToJson( + pb_request, + including_default_value_fields=False, + use_integers_for_enums=False, + ) + ) + + # verify fields with default values are dropped + + unset_fields = transport_class( + credentials=ga_credentials.AnonymousCredentials() + ).purge_products._get_unset_required_fields(jsonified_request) + jsonified_request.update(unset_fields) + + # verify required fields with default values are now present + + jsonified_request["parent"] = "parent_value" + + unset_fields = transport_class( + credentials=ga_credentials.AnonymousCredentials() + ).purge_products._get_unset_required_fields(jsonified_request) + jsonified_request.update(unset_fields) + + # verify required fields with non-default values are left alone + assert "parent" in jsonified_request + assert jsonified_request["parent"] == "parent_value" + + client = ProductSearchClient( + credentials=ga_credentials.AnonymousCredentials(), + transport="rest", + ) + request = request_type(**request_init) + + # Designate an appropriate value for the returned response. + return_value = operations_pb2.Operation(name="operations/spam") + # Mock the http request call within the method and fake a response. + with mock.patch.object(Session, "request") as req: + # We need to mock transcode() because providing default values + # for required fields will fail the real version if the http_options + # expect actual values for those fields. + with mock.patch.object(path_template, "transcode") as transcode: + # A uri without fields and an empty body will force all the + # request fields to show up in the query_params. + pb_request = request_type.pb(request) + transcode_result = { + "uri": "v1/sample_method", + "method": "post", + "query_params": pb_request, + } + transcode_result["body"] = pb_request + transcode.return_value = transcode_result + + response_value = Response() + response_value.status_code = 200 + json_return_value = json_format.MessageToJson(return_value) + + response_value._content = json_return_value.encode("UTF-8") + req.return_value = response_value + + response = client.purge_products(request) + + expected_params = [("$alt", "json;enum-encoding=int")] + actual_params = req.call_args.kwargs["params"] + assert expected_params == actual_params + + +def test_purge_products_rest_unset_required_fields(): + transport = transports.ProductSearchRestTransport( + credentials=ga_credentials.AnonymousCredentials + ) + + unset_fields = transport.purge_products._get_unset_required_fields({}) + assert set(unset_fields) == (set(()) & set(("parent",))) + + +@pytest.mark.parametrize("null_interceptor", [True, False]) +def test_purge_products_rest_interceptors(null_interceptor): + transport = transports.ProductSearchRestTransport( + credentials=ga_credentials.AnonymousCredentials(), + interceptor=None + if null_interceptor + else transports.ProductSearchRestInterceptor(), + ) + client = ProductSearchClient(transport=transport) + with mock.patch.object( + type(client.transport._session), "request" + ) as req, mock.patch.object( + path_template, "transcode" + ) as transcode, mock.patch.object( + operation.Operation, "_set_result_from_operation" + ), mock.patch.object( + transports.ProductSearchRestInterceptor, "post_purge_products" + ) as post, mock.patch.object( + transports.ProductSearchRestInterceptor, "pre_purge_products" + ) as pre: + pre.assert_not_called() + post.assert_not_called() + pb_message = product_search_service.PurgeProductsRequest.pb( + product_search_service.PurgeProductsRequest() + ) + transcode.return_value = { + "method": "post", + "uri": "my_uri", + "body": pb_message, + "query_params": pb_message, + } + + req.return_value = Response() + req.return_value.status_code = 200 + req.return_value.request = PreparedRequest() + req.return_value._content = json_format.MessageToJson( + operations_pb2.Operation() + ) + + request = product_search_service.PurgeProductsRequest() + metadata = [ + ("key", "val"), + ("cephalopod", "squid"), + ] + pre.return_value = request, metadata + post.return_value = operations_pb2.Operation() + + client.purge_products( + request, + metadata=[ + ("key", "val"), + ("cephalopod", "squid"), + ], + ) + + pre.assert_called_once() + post.assert_called_once() + + +def test_purge_products_rest_bad_request( + transport: str = "rest", request_type=product_search_service.PurgeProductsRequest +): + client = ProductSearchClient( + credentials=ga_credentials.AnonymousCredentials(), + transport=transport, + ) + + # send a request that will satisfy transcoding + request_init = {"parent": "projects/sample1/locations/sample2"} + request = request_type(**request_init) + + # Mock the http request call within the method and fake a BadRequest error. + with mock.patch.object(Session, "request") as req, pytest.raises( + core_exceptions.BadRequest + ): + # Wrap the value into a proper Response obj + response_value = Response() + response_value.status_code = 400 + response_value.request = Request() + req.return_value = response_value + client.purge_products(request) + + +def test_purge_products_rest_flattened(): + client = ProductSearchClient( + credentials=ga_credentials.AnonymousCredentials(), + transport="rest", + ) + + # Mock the http request call within the method and fake a response. + with mock.patch.object(type(client.transport._session), "request") as req: + # Designate an appropriate value for the returned response. + return_value = operations_pb2.Operation(name="operations/spam") + + # get arguments that satisfy an http rule for this method + sample_request = {"parent": "projects/sample1/locations/sample2"} + + # get truthy value for each flattened field + mock_args = dict( + parent="parent_value", + ) + mock_args.update(sample_request) + + # Wrap the value into a proper Response obj + response_value = Response() + response_value.status_code = 200 + json_return_value = json_format.MessageToJson(return_value) + response_value._content = json_return_value.encode("UTF-8") + req.return_value = response_value + + client.purge_products(**mock_args) + + # Establish that the underlying call was made with the expected + # request object values. + assert len(req.mock_calls) == 1 + _, args, _ = req.mock_calls[0] + assert path_template.validate( + "%s/v1/{parent=projects/*/locations/*}/products:purge" + % client.transport._host, + args[1], + ) + + +def test_purge_products_rest_flattened_error(transport: str = "rest"): + client = ProductSearchClient( + credentials=ga_credentials.AnonymousCredentials(), + transport=transport, + ) + + # Attempting to call a method with both a request object and flattened + # fields is an error. + with pytest.raises(ValueError): + client.purge_products( + product_search_service.PurgeProductsRequest(), + parent="parent_value", + ) + + +def test_purge_products_rest_error(): + client = ProductSearchClient( + credentials=ga_credentials.AnonymousCredentials(), transport="rest" + ) + + +def test_credentials_transport_error(): + # It is an error to provide credentials and a transport instance. + transport = transports.ProductSearchGrpcTransport( + credentials=ga_credentials.AnonymousCredentials(), + ) + with pytest.raises(ValueError): + client = ProductSearchClient( + credentials=ga_credentials.AnonymousCredentials(), + transport=transport, + ) + + # It is an error to provide a credentials file and a transport instance. + transport = transports.ProductSearchGrpcTransport( + credentials=ga_credentials.AnonymousCredentials(), + ) + with pytest.raises(ValueError): + client = ProductSearchClient( + client_options={"credentials_file": "credentials.json"}, + transport=transport, + ) + + # It is an error to provide an api_key and a transport instance. + transport = transports.ProductSearchGrpcTransport( + credentials=ga_credentials.AnonymousCredentials(), + ) + options = client_options.ClientOptions() + options.api_key = "api_key" + with pytest.raises(ValueError): + client = ProductSearchClient( + client_options=options, + transport=transport, + ) + + # It is an error to provide an api_key and a credential. + options = mock.Mock() + options.api_key = "api_key" + with pytest.raises(ValueError): + client = ProductSearchClient( + client_options=options, credentials=ga_credentials.AnonymousCredentials() + ) + + # It is an error to provide scopes and a transport instance. + transport = transports.ProductSearchGrpcTransport( + credentials=ga_credentials.AnonymousCredentials(), + ) + with pytest.raises(ValueError): + client = ProductSearchClient( + client_options={"scopes": ["1", "2"]}, + transport=transport, + ) + + +def test_transport_instance(): + # A client may be instantiated with a custom transport instance. + transport = transports.ProductSearchGrpcTransport( + credentials=ga_credentials.AnonymousCredentials(), + ) + client = ProductSearchClient(transport=transport) + assert client.transport is transport + + +def test_transport_get_channel(): + # A client may be instantiated with a custom transport instance. + transport = transports.ProductSearchGrpcTransport( + credentials=ga_credentials.AnonymousCredentials(), + ) + channel = transport.grpc_channel + assert channel + + transport = transports.ProductSearchGrpcAsyncIOTransport( + credentials=ga_credentials.AnonymousCredentials(), + ) + channel = transport.grpc_channel + assert channel + + +@pytest.mark.parametrize( + "transport_class", + [ + transports.ProductSearchGrpcTransport, + transports.ProductSearchGrpcAsyncIOTransport, + transports.ProductSearchRestTransport, + ], +) +def test_transport_adc(transport_class): + # Test default credentials are used if not provided. + with mock.patch.object(google.auth, "default") as adc: + adc.return_value = (ga_credentials.AnonymousCredentials(), None) + transport_class() + adc.assert_called_once() + + +@pytest.mark.parametrize( + "transport_name", + [ + "grpc", + "rest", + ], +) +def test_transport_kind(transport_name): + transport = ProductSearchClient.get_transport_class(transport_name)( + credentials=ga_credentials.AnonymousCredentials(), + ) + assert transport.kind == transport_name + + +def test_transport_grpc_default(): + # A client should use the gRPC transport by default. + client = ProductSearchClient( + credentials=ga_credentials.AnonymousCredentials(), + ) + assert isinstance( + client.transport, + transports.ProductSearchGrpcTransport, + ) + + +def test_product_search_base_transport_error(): + # Passing both a credentials object and credentials_file should raise an error + with pytest.raises(core_exceptions.DuplicateCredentialArgs): + transport = transports.ProductSearchTransport( + credentials=ga_credentials.AnonymousCredentials(), + credentials_file="credentials.json", + ) + + +def test_product_search_base_transport(): + # Instantiate the base transport. + with mock.patch( + "google.cloud.vision_v1.services.product_search.transports.ProductSearchTransport.__init__" + ) as Transport: + Transport.return_value = None + transport = transports.ProductSearchTransport( + credentials=ga_credentials.AnonymousCredentials(), + ) + + # Every method on the transport should just blindly + # raise NotImplementedError. + methods = ( + "create_product_set", + "list_product_sets", + "get_product_set", + "update_product_set", + "delete_product_set", + "create_product", + "list_products", + "get_product", + "update_product", + "delete_product", + "create_reference_image", + "delete_reference_image", + "list_reference_images", + "get_reference_image", + "add_product_to_product_set", + "remove_product_from_product_set", + "list_products_in_product_set", + "import_product_sets", + "purge_products", + ) + for method in methods: + 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): + transport.operations_client + + # Catch all for all remaining methods and properties + remainder = [ + "kind", + ] + for r in remainder: + with pytest.raises(NotImplementedError): + getattr(transport, r)() + + +def test_product_search_base_transport_with_credentials_file(): + # 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.vision_v1.services.product_search.transports.ProductSearchTransport._prep_wrapped_messages" + ) as Transport: + Transport.return_value = None + load_creds.return_value = (ga_credentials.AnonymousCredentials(), None) + transport = transports.ProductSearchTransport( + credentials_file="credentials.json", + quota_project_id="octopus", + ) + load_creds.assert_called_once_with( + "credentials.json", + scopes=None, + default_scopes=( + "https://www.googleapis.com/auth/cloud-platform", + "https://www.googleapis.com/auth/cloud-vision", + ), + quota_project_id="octopus", + ) + + +def test_product_search_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( "google.cloud.vision_v1.services.product_search.transports.ProductSearchTransport._prep_wrapped_messages" ) as Transport: @@ -6447,6 +12085,7 @@ def test_product_search_transport_auth_adc(transport_class): [ transports.ProductSearchGrpcTransport, transports.ProductSearchGrpcAsyncIOTransport, + transports.ProductSearchRestTransport, ], ) def test_product_search_transport_auth_gdch_credentials(transport_class): @@ -6547,11 +12186,40 @@ def test_product_search_grpc_transport_client_cert_source_for_mtls(transport_cla ) +def test_product_search_http_transport_client_cert_source_for_mtls(): + cred = ga_credentials.AnonymousCredentials() + with mock.patch( + "google.auth.transport.requests.AuthorizedSession.configure_mtls_channel" + ) as mock_configure_mtls_channel: + transports.ProductSearchRestTransport( + credentials=cred, client_cert_source_for_mtls=client_cert_source_callback + ) + mock_configure_mtls_channel.assert_called_once_with(client_cert_source_callback) + + +def test_product_search_rest_lro_client(): + client = ProductSearchClient( + credentials=ga_credentials.AnonymousCredentials(), + transport="rest", + ) + transport = client.transport + + # Ensure that we have a api-core operations client. + assert isinstance( + transport.operations_client, + operations_v1.AbstractOperationsClient, + ) + + # Ensure that subsequent calls to the property send the exact same object. + assert transport.operations_client is transport.operations_client + + @pytest.mark.parametrize( "transport_name", [ "grpc", "grpc_asyncio", + "rest", ], ) def test_product_search_host_no_port(transport_name): @@ -6562,7 +12230,11 @@ def test_product_search_host_no_port(transport_name): ), transport=transport_name, ) - assert client.transport._host == ("vision.googleapis.com:443") + assert client.transport._host == ( + "vision.googleapis.com:443" + if transport_name in ["grpc", "grpc_asyncio"] + else "https://vision.googleapis.com/" + ) @pytest.mark.parametrize( @@ -6570,6 +12242,7 @@ def test_product_search_host_no_port(transport_name): [ "grpc", "grpc_asyncio", + "rest", ], ) def test_product_search_host_with_port(transport_name): @@ -6580,7 +12253,87 @@ def test_product_search_host_with_port(transport_name): ), transport=transport_name, ) - assert client.transport._host == ("vision.googleapis.com:8000") + assert client.transport._host == ( + "vision.googleapis.com:8000" + if transport_name in ["grpc", "grpc_asyncio"] + else "https://vision.googleapis.com:8000/" + ) + + +@pytest.mark.parametrize( + "transport_name", + [ + "rest", + ], +) +def test_product_search_client_transport_session_collision(transport_name): + creds1 = ga_credentials.AnonymousCredentials() + creds2 = ga_credentials.AnonymousCredentials() + client1 = ProductSearchClient( + credentials=creds1, + transport=transport_name, + ) + client2 = ProductSearchClient( + credentials=creds2, + transport=transport_name, + ) + session1 = client1.transport.create_product_set._session + session2 = client2.transport.create_product_set._session + assert session1 != session2 + session1 = client1.transport.list_product_sets._session + session2 = client2.transport.list_product_sets._session + assert session1 != session2 + session1 = client1.transport.get_product_set._session + session2 = client2.transport.get_product_set._session + assert session1 != session2 + session1 = client1.transport.update_product_set._session + session2 = client2.transport.update_product_set._session + assert session1 != session2 + session1 = client1.transport.delete_product_set._session + session2 = client2.transport.delete_product_set._session + assert session1 != session2 + session1 = client1.transport.create_product._session + session2 = client2.transport.create_product._session + assert session1 != session2 + session1 = client1.transport.list_products._session + session2 = client2.transport.list_products._session + assert session1 != session2 + session1 = client1.transport.get_product._session + session2 = client2.transport.get_product._session + assert session1 != session2 + session1 = client1.transport.update_product._session + session2 = client2.transport.update_product._session + assert session1 != session2 + session1 = client1.transport.delete_product._session + session2 = client2.transport.delete_product._session + assert session1 != session2 + session1 = client1.transport.create_reference_image._session + session2 = client2.transport.create_reference_image._session + assert session1 != session2 + session1 = client1.transport.delete_reference_image._session + session2 = client2.transport.delete_reference_image._session + assert session1 != session2 + session1 = client1.transport.list_reference_images._session + session2 = client2.transport.list_reference_images._session + assert session1 != session2 + session1 = client1.transport.get_reference_image._session + session2 = client2.transport.get_reference_image._session + assert session1 != session2 + session1 = client1.transport.add_product_to_product_set._session + session2 = client2.transport.add_product_to_product_set._session + assert session1 != session2 + session1 = client1.transport.remove_product_from_product_set._session + session2 = client2.transport.remove_product_from_product_set._session + assert session1 != session2 + session1 = client1.transport.list_products_in_product_set._session + session2 = client2.transport.list_products_in_product_set._session + assert session1 != session2 + session1 = client1.transport.import_product_sets._session + session2 = client2.transport.import_product_sets._session + assert session1 != session2 + session1 = client1.transport.purge_products._session + session2 = client2.transport.purge_products._session + assert session1 != session2 def test_product_search_grpc_transport_channel(): @@ -6968,6 +12721,7 @@ async def test_transport_close_async(): def test_transport_close(): transports = { + "rest": "_session", "grpc": "_grpc_channel", } @@ -6985,6 +12739,7 @@ def test_transport_close(): def test_client_ctx(): transports = [ + "rest", "grpc", ] for transport in transports: diff --git a/tests/unit/gapic/vision_v1p1beta1/test_image_annotator.py b/tests/unit/gapic/vision_v1p1beta1/test_image_annotator.py index 306951f5..e88cfa76 100644 --- a/tests/unit/gapic/vision_v1p1beta1/test_image_annotator.py +++ b/tests/unit/gapic/vision_v1p1beta1/test_image_annotator.py @@ -24,10 +24,17 @@ import grpc from grpc.experimental import aio +from collections.abc import Iterable +from google.protobuf import json_format +import json import math import pytest from proto.marshal.rules.dates import DurationRule, TimestampRule from proto.marshal.rules import wrappers +from requests import Response +from requests import Request, PreparedRequest +from requests.sessions import Session +from google.protobuf import json_format from google.api_core import client_options from google.api_core import exceptions as core_exceptions @@ -97,6 +104,7 @@ def test__get_default_mtls_endpoint(): [ (ImageAnnotatorClient, "grpc"), (ImageAnnotatorAsyncClient, "grpc_asyncio"), + (ImageAnnotatorClient, "rest"), ], ) def test_image_annotator_client_from_service_account_info(client_class, transport_name): @@ -110,7 +118,11 @@ def test_image_annotator_client_from_service_account_info(client_class, transpor assert client.transport._credentials == creds assert isinstance(client, client_class) - assert client.transport._host == ("vision.googleapis.com:443") + assert client.transport._host == ( + "vision.googleapis.com:443" + if transport_name in ["grpc", "grpc_asyncio"] + else "https://vision.googleapis.com/" + ) @pytest.mark.parametrize( @@ -118,6 +130,7 @@ def test_image_annotator_client_from_service_account_info(client_class, transpor [ (transports.ImageAnnotatorGrpcTransport, "grpc"), (transports.ImageAnnotatorGrpcAsyncIOTransport, "grpc_asyncio"), + (transports.ImageAnnotatorRestTransport, "rest"), ], ) def test_image_annotator_client_service_account_always_use_jwt( @@ -143,6 +156,7 @@ def test_image_annotator_client_service_account_always_use_jwt( [ (ImageAnnotatorClient, "grpc"), (ImageAnnotatorAsyncClient, "grpc_asyncio"), + (ImageAnnotatorClient, "rest"), ], ) def test_image_annotator_client_from_service_account_file(client_class, transport_name): @@ -163,13 +177,18 @@ def test_image_annotator_client_from_service_account_file(client_class, transpor assert client.transport._credentials == creds assert isinstance(client, client_class) - assert client.transport._host == ("vision.googleapis.com:443") + assert client.transport._host == ( + "vision.googleapis.com:443" + if transport_name in ["grpc", "grpc_asyncio"] + else "https://vision.googleapis.com/" + ) def test_image_annotator_client_get_transport_class(): transport = ImageAnnotatorClient.get_transport_class() available_transports = [ transports.ImageAnnotatorGrpcTransport, + transports.ImageAnnotatorRestTransport, ] assert transport in available_transports @@ -186,6 +205,7 @@ def test_image_annotator_client_get_transport_class(): transports.ImageAnnotatorGrpcAsyncIOTransport, "grpc_asyncio", ), + (ImageAnnotatorClient, transports.ImageAnnotatorRestTransport, "rest"), ], ) @mock.patch.object( @@ -331,6 +351,8 @@ def test_image_annotator_client_client_options( "grpc_asyncio", "false", ), + (ImageAnnotatorClient, transports.ImageAnnotatorRestTransport, "rest", "true"), + (ImageAnnotatorClient, transports.ImageAnnotatorRestTransport, "rest", "false"), ], ) @mock.patch.object( @@ -530,6 +552,7 @@ def test_image_annotator_client_get_mtls_endpoint_and_cert_source(client_class): transports.ImageAnnotatorGrpcAsyncIOTransport, "grpc_asyncio", ), + (ImageAnnotatorClient, transports.ImageAnnotatorRestTransport, "rest"), ], ) def test_image_annotator_client_client_options_scopes( @@ -570,6 +593,7 @@ def test_image_annotator_client_client_options_scopes( "grpc_asyncio", grpc_helpers_async, ), + (ImageAnnotatorClient, transports.ImageAnnotatorRestTransport, "rest", None), ], ) def test_image_annotator_client_client_options_credentials_file( @@ -885,6 +909,275 @@ async def test_batch_annotate_images_flattened_error_async(): ) +@pytest.mark.parametrize( + "request_type", + [ + image_annotator.BatchAnnotateImagesRequest, + dict, + ], +) +def test_batch_annotate_images_rest(request_type): + client = ImageAnnotatorClient( + credentials=ga_credentials.AnonymousCredentials(), + transport="rest", + ) + + # send a request that will satisfy transcoding + request_init = {} + request = request_type(**request_init) + + # Mock the http request call within the method and fake a response. + with mock.patch.object(type(client.transport._session), "request") as req: + # Designate an appropriate value for the returned response. + return_value = image_annotator.BatchAnnotateImagesResponse() + + # Wrap the value into a proper Response obj + response_value = Response() + response_value.status_code = 200 + pb_return_value = image_annotator.BatchAnnotateImagesResponse.pb(return_value) + json_return_value = json_format.MessageToJson(pb_return_value) + + response_value._content = json_return_value.encode("UTF-8") + req.return_value = response_value + response = client.batch_annotate_images(request) + + # Establish that the response is the type that we expect. + assert isinstance(response, image_annotator.BatchAnnotateImagesResponse) + + +def test_batch_annotate_images_rest_required_fields( + request_type=image_annotator.BatchAnnotateImagesRequest, +): + transport_class = transports.ImageAnnotatorRestTransport + + request_init = {} + request = request_type(**request_init) + pb_request = request_type.pb(request) + jsonified_request = json.loads( + json_format.MessageToJson( + pb_request, + including_default_value_fields=False, + use_integers_for_enums=False, + ) + ) + + # verify fields with default values are dropped + + unset_fields = transport_class( + credentials=ga_credentials.AnonymousCredentials() + ).batch_annotate_images._get_unset_required_fields(jsonified_request) + jsonified_request.update(unset_fields) + + # verify required fields with default values are now present + + unset_fields = transport_class( + credentials=ga_credentials.AnonymousCredentials() + ).batch_annotate_images._get_unset_required_fields(jsonified_request) + jsonified_request.update(unset_fields) + + # verify required fields with non-default values are left alone + + client = ImageAnnotatorClient( + credentials=ga_credentials.AnonymousCredentials(), + transport="rest", + ) + request = request_type(**request_init) + + # Designate an appropriate value for the returned response. + return_value = image_annotator.BatchAnnotateImagesResponse() + # Mock the http request call within the method and fake a response. + with mock.patch.object(Session, "request") as req: + # We need to mock transcode() because providing default values + # for required fields will fail the real version if the http_options + # expect actual values for those fields. + with mock.patch.object(path_template, "transcode") as transcode: + # A uri without fields and an empty body will force all the + # request fields to show up in the query_params. + pb_request = request_type.pb(request) + transcode_result = { + "uri": "v1/sample_method", + "method": "post", + "query_params": pb_request, + } + transcode_result["body"] = pb_request + transcode.return_value = transcode_result + + response_value = Response() + response_value.status_code = 200 + + pb_return_value = image_annotator.BatchAnnotateImagesResponse.pb( + return_value + ) + json_return_value = json_format.MessageToJson(pb_return_value) + + response_value._content = json_return_value.encode("UTF-8") + req.return_value = response_value + + response = client.batch_annotate_images(request) + + expected_params = [("$alt", "json;enum-encoding=int")] + actual_params = req.call_args.kwargs["params"] + assert expected_params == actual_params + + +def test_batch_annotate_images_rest_unset_required_fields(): + transport = transports.ImageAnnotatorRestTransport( + credentials=ga_credentials.AnonymousCredentials + ) + + unset_fields = transport.batch_annotate_images._get_unset_required_fields({}) + assert set(unset_fields) == (set(()) & set(("requests",))) + + +@pytest.mark.parametrize("null_interceptor", [True, False]) +def test_batch_annotate_images_rest_interceptors(null_interceptor): + transport = transports.ImageAnnotatorRestTransport( + credentials=ga_credentials.AnonymousCredentials(), + interceptor=None + if null_interceptor + else transports.ImageAnnotatorRestInterceptor(), + ) + client = ImageAnnotatorClient(transport=transport) + with mock.patch.object( + type(client.transport._session), "request" + ) as req, mock.patch.object( + path_template, "transcode" + ) as transcode, mock.patch.object( + transports.ImageAnnotatorRestInterceptor, "post_batch_annotate_images" + ) as post, mock.patch.object( + transports.ImageAnnotatorRestInterceptor, "pre_batch_annotate_images" + ) as pre: + pre.assert_not_called() + post.assert_not_called() + pb_message = image_annotator.BatchAnnotateImagesRequest.pb( + image_annotator.BatchAnnotateImagesRequest() + ) + transcode.return_value = { + "method": "post", + "uri": "my_uri", + "body": pb_message, + "query_params": pb_message, + } + + req.return_value = Response() + req.return_value.status_code = 200 + req.return_value.request = PreparedRequest() + req.return_value._content = image_annotator.BatchAnnotateImagesResponse.to_json( + image_annotator.BatchAnnotateImagesResponse() + ) + + request = image_annotator.BatchAnnotateImagesRequest() + metadata = [ + ("key", "val"), + ("cephalopod", "squid"), + ] + pre.return_value = request, metadata + post.return_value = image_annotator.BatchAnnotateImagesResponse() + + client.batch_annotate_images( + request, + metadata=[ + ("key", "val"), + ("cephalopod", "squid"), + ], + ) + + pre.assert_called_once() + post.assert_called_once() + + +def test_batch_annotate_images_rest_bad_request( + transport: str = "rest", request_type=image_annotator.BatchAnnotateImagesRequest +): + client = ImageAnnotatorClient( + credentials=ga_credentials.AnonymousCredentials(), + transport=transport, + ) + + # send a request that will satisfy transcoding + request_init = {} + request = request_type(**request_init) + + # Mock the http request call within the method and fake a BadRequest error. + with mock.patch.object(Session, "request") as req, pytest.raises( + core_exceptions.BadRequest + ): + # Wrap the value into a proper Response obj + response_value = Response() + response_value.status_code = 400 + response_value.request = Request() + req.return_value = response_value + client.batch_annotate_images(request) + + +def test_batch_annotate_images_rest_flattened(): + client = ImageAnnotatorClient( + credentials=ga_credentials.AnonymousCredentials(), + transport="rest", + ) + + # Mock the http request call within the method and fake a response. + with mock.patch.object(type(client.transport._session), "request") as req: + # Designate an appropriate value for the returned response. + return_value = image_annotator.BatchAnnotateImagesResponse() + + # get arguments that satisfy an http rule for this method + sample_request = {} + + # get truthy value for each flattened field + mock_args = dict( + requests=[ + image_annotator.AnnotateImageRequest( + image=image_annotator.Image(content=b"content_blob") + ) + ], + ) + mock_args.update(sample_request) + + # Wrap the value into a proper Response obj + response_value = Response() + response_value.status_code = 200 + pb_return_value = image_annotator.BatchAnnotateImagesResponse.pb(return_value) + json_return_value = json_format.MessageToJson(pb_return_value) + response_value._content = json_return_value.encode("UTF-8") + req.return_value = response_value + + client.batch_annotate_images(**mock_args) + + # Establish that the underlying call was made with the expected + # request object values. + assert len(req.mock_calls) == 1 + _, args, _ = req.mock_calls[0] + assert path_template.validate( + "%s/v1p1beta1/images:annotate" % client.transport._host, args[1] + ) + + +def test_batch_annotate_images_rest_flattened_error(transport: str = "rest"): + client = ImageAnnotatorClient( + credentials=ga_credentials.AnonymousCredentials(), + transport=transport, + ) + + # Attempting to call a method with both a request object and flattened + # fields is an error. + with pytest.raises(ValueError): + client.batch_annotate_images( + image_annotator.BatchAnnotateImagesRequest(), + requests=[ + image_annotator.AnnotateImageRequest( + image=image_annotator.Image(content=b"content_blob") + ) + ], + ) + + +def test_batch_annotate_images_rest_error(): + client = ImageAnnotatorClient( + credentials=ga_credentials.AnonymousCredentials(), transport="rest" + ) + + def test_credentials_transport_error(): # It is an error to provide credentials and a transport instance. transport = transports.ImageAnnotatorGrpcTransport( @@ -966,6 +1259,7 @@ def test_transport_get_channel(): [ transports.ImageAnnotatorGrpcTransport, transports.ImageAnnotatorGrpcAsyncIOTransport, + transports.ImageAnnotatorRestTransport, ], ) def test_transport_adc(transport_class): @@ -980,6 +1274,7 @@ def test_transport_adc(transport_class): "transport_name", [ "grpc", + "rest", ], ) def test_transport_kind(transport_name): @@ -1116,6 +1411,7 @@ def test_image_annotator_transport_auth_adc(transport_class): [ transports.ImageAnnotatorGrpcTransport, transports.ImageAnnotatorGrpcAsyncIOTransport, + transports.ImageAnnotatorRestTransport, ], ) def test_image_annotator_transport_auth_gdch_credentials(transport_class): @@ -1216,11 +1512,23 @@ def test_image_annotator_grpc_transport_client_cert_source_for_mtls(transport_cl ) +def test_image_annotator_http_transport_client_cert_source_for_mtls(): + cred = ga_credentials.AnonymousCredentials() + with mock.patch( + "google.auth.transport.requests.AuthorizedSession.configure_mtls_channel" + ) as mock_configure_mtls_channel: + transports.ImageAnnotatorRestTransport( + credentials=cred, client_cert_source_for_mtls=client_cert_source_callback + ) + mock_configure_mtls_channel.assert_called_once_with(client_cert_source_callback) + + @pytest.mark.parametrize( "transport_name", [ "grpc", "grpc_asyncio", + "rest", ], ) def test_image_annotator_host_no_port(transport_name): @@ -1231,7 +1539,11 @@ def test_image_annotator_host_no_port(transport_name): ), transport=transport_name, ) - assert client.transport._host == ("vision.googleapis.com:443") + assert client.transport._host == ( + "vision.googleapis.com:443" + if transport_name in ["grpc", "grpc_asyncio"] + else "https://vision.googleapis.com/" + ) @pytest.mark.parametrize( @@ -1239,6 +1551,7 @@ def test_image_annotator_host_no_port(transport_name): [ "grpc", "grpc_asyncio", + "rest", ], ) def test_image_annotator_host_with_port(transport_name): @@ -1249,7 +1562,33 @@ def test_image_annotator_host_with_port(transport_name): ), transport=transport_name, ) - assert client.transport._host == ("vision.googleapis.com:8000") + assert client.transport._host == ( + "vision.googleapis.com:8000" + if transport_name in ["grpc", "grpc_asyncio"] + else "https://vision.googleapis.com:8000/" + ) + + +@pytest.mark.parametrize( + "transport_name", + [ + "rest", + ], +) +def test_image_annotator_client_transport_session_collision(transport_name): + creds1 = ga_credentials.AnonymousCredentials() + creds2 = ga_credentials.AnonymousCredentials() + client1 = ImageAnnotatorClient( + credentials=creds1, + transport=transport_name, + ) + client2 = ImageAnnotatorClient( + credentials=creds2, + transport=transport_name, + ) + session1 = client1.transport.batch_annotate_images._session + session2 = client2.transport.batch_annotate_images._session + assert session1 != session2 def test_image_annotator_grpc_transport_channel(): @@ -1520,6 +1859,7 @@ async def test_transport_close_async(): def test_transport_close(): transports = { + "rest": "_session", "grpc": "_grpc_channel", } @@ -1537,6 +1877,7 @@ def test_transport_close(): def test_client_ctx(): transports = [ + "rest", "grpc", ] for transport in transports: diff --git a/tests/unit/gapic/vision_v1p2beta1/test_image_annotator.py b/tests/unit/gapic/vision_v1p2beta1/test_image_annotator.py index 57dcd65f..a10ad978 100644 --- a/tests/unit/gapic/vision_v1p2beta1/test_image_annotator.py +++ b/tests/unit/gapic/vision_v1p2beta1/test_image_annotator.py @@ -24,10 +24,17 @@ import grpc from grpc.experimental import aio +from collections.abc import Iterable +from google.protobuf import json_format +import json import math import pytest from proto.marshal.rules.dates import DurationRule, TimestampRule from proto.marshal.rules import wrappers +from requests import Response +from requests import Request, PreparedRequest +from requests.sessions import Session +from google.protobuf import json_format from google.api_core import client_options from google.api_core import exceptions as core_exceptions @@ -102,6 +109,7 @@ def test__get_default_mtls_endpoint(): [ (ImageAnnotatorClient, "grpc"), (ImageAnnotatorAsyncClient, "grpc_asyncio"), + (ImageAnnotatorClient, "rest"), ], ) def test_image_annotator_client_from_service_account_info(client_class, transport_name): @@ -115,7 +123,11 @@ def test_image_annotator_client_from_service_account_info(client_class, transpor assert client.transport._credentials == creds assert isinstance(client, client_class) - assert client.transport._host == ("vision.googleapis.com:443") + assert client.transport._host == ( + "vision.googleapis.com:443" + if transport_name in ["grpc", "grpc_asyncio"] + else "https://vision.googleapis.com/" + ) @pytest.mark.parametrize( @@ -123,6 +135,7 @@ def test_image_annotator_client_from_service_account_info(client_class, transpor [ (transports.ImageAnnotatorGrpcTransport, "grpc"), (transports.ImageAnnotatorGrpcAsyncIOTransport, "grpc_asyncio"), + (transports.ImageAnnotatorRestTransport, "rest"), ], ) def test_image_annotator_client_service_account_always_use_jwt( @@ -148,6 +161,7 @@ def test_image_annotator_client_service_account_always_use_jwt( [ (ImageAnnotatorClient, "grpc"), (ImageAnnotatorAsyncClient, "grpc_asyncio"), + (ImageAnnotatorClient, "rest"), ], ) def test_image_annotator_client_from_service_account_file(client_class, transport_name): @@ -168,13 +182,18 @@ def test_image_annotator_client_from_service_account_file(client_class, transpor assert client.transport._credentials == creds assert isinstance(client, client_class) - assert client.transport._host == ("vision.googleapis.com:443") + assert client.transport._host == ( + "vision.googleapis.com:443" + if transport_name in ["grpc", "grpc_asyncio"] + else "https://vision.googleapis.com/" + ) def test_image_annotator_client_get_transport_class(): transport = ImageAnnotatorClient.get_transport_class() available_transports = [ transports.ImageAnnotatorGrpcTransport, + transports.ImageAnnotatorRestTransport, ] assert transport in available_transports @@ -191,6 +210,7 @@ def test_image_annotator_client_get_transport_class(): transports.ImageAnnotatorGrpcAsyncIOTransport, "grpc_asyncio", ), + (ImageAnnotatorClient, transports.ImageAnnotatorRestTransport, "rest"), ], ) @mock.patch.object( @@ -336,6 +356,8 @@ def test_image_annotator_client_client_options( "grpc_asyncio", "false", ), + (ImageAnnotatorClient, transports.ImageAnnotatorRestTransport, "rest", "true"), + (ImageAnnotatorClient, transports.ImageAnnotatorRestTransport, "rest", "false"), ], ) @mock.patch.object( @@ -535,6 +557,7 @@ def test_image_annotator_client_get_mtls_endpoint_and_cert_source(client_class): transports.ImageAnnotatorGrpcAsyncIOTransport, "grpc_asyncio", ), + (ImageAnnotatorClient, transports.ImageAnnotatorRestTransport, "rest"), ], ) def test_image_annotator_client_client_options_scopes( @@ -575,6 +598,7 @@ def test_image_annotator_client_client_options_scopes( "grpc_asyncio", grpc_helpers_async, ), + (ImageAnnotatorClient, transports.ImageAnnotatorRestTransport, "rest", None), ], ) def test_image_annotator_client_client_options_credentials_file( @@ -1102,6 +1126,544 @@ async def test_async_batch_annotate_files_flattened_error_async(): ) +@pytest.mark.parametrize( + "request_type", + [ + image_annotator.BatchAnnotateImagesRequest, + dict, + ], +) +def test_batch_annotate_images_rest(request_type): + client = ImageAnnotatorClient( + credentials=ga_credentials.AnonymousCredentials(), + transport="rest", + ) + + # send a request that will satisfy transcoding + request_init = {} + request = request_type(**request_init) + + # Mock the http request call within the method and fake a response. + with mock.patch.object(type(client.transport._session), "request") as req: + # Designate an appropriate value for the returned response. + return_value = image_annotator.BatchAnnotateImagesResponse() + + # Wrap the value into a proper Response obj + response_value = Response() + response_value.status_code = 200 + pb_return_value = image_annotator.BatchAnnotateImagesResponse.pb(return_value) + json_return_value = json_format.MessageToJson(pb_return_value) + + response_value._content = json_return_value.encode("UTF-8") + req.return_value = response_value + response = client.batch_annotate_images(request) + + # Establish that the response is the type that we expect. + assert isinstance(response, image_annotator.BatchAnnotateImagesResponse) + + +def test_batch_annotate_images_rest_required_fields( + request_type=image_annotator.BatchAnnotateImagesRequest, +): + transport_class = transports.ImageAnnotatorRestTransport + + request_init = {} + request = request_type(**request_init) + pb_request = request_type.pb(request) + jsonified_request = json.loads( + json_format.MessageToJson( + pb_request, + including_default_value_fields=False, + use_integers_for_enums=False, + ) + ) + + # verify fields with default values are dropped + + unset_fields = transport_class( + credentials=ga_credentials.AnonymousCredentials() + ).batch_annotate_images._get_unset_required_fields(jsonified_request) + jsonified_request.update(unset_fields) + + # verify required fields with default values are now present + + unset_fields = transport_class( + credentials=ga_credentials.AnonymousCredentials() + ).batch_annotate_images._get_unset_required_fields(jsonified_request) + jsonified_request.update(unset_fields) + + # verify required fields with non-default values are left alone + + client = ImageAnnotatorClient( + credentials=ga_credentials.AnonymousCredentials(), + transport="rest", + ) + request = request_type(**request_init) + + # Designate an appropriate value for the returned response. + return_value = image_annotator.BatchAnnotateImagesResponse() + # Mock the http request call within the method and fake a response. + with mock.patch.object(Session, "request") as req: + # We need to mock transcode() because providing default values + # for required fields will fail the real version if the http_options + # expect actual values for those fields. + with mock.patch.object(path_template, "transcode") as transcode: + # A uri without fields and an empty body will force all the + # request fields to show up in the query_params. + pb_request = request_type.pb(request) + transcode_result = { + "uri": "v1/sample_method", + "method": "post", + "query_params": pb_request, + } + transcode_result["body"] = pb_request + transcode.return_value = transcode_result + + response_value = Response() + response_value.status_code = 200 + + pb_return_value = image_annotator.BatchAnnotateImagesResponse.pb( + return_value + ) + json_return_value = json_format.MessageToJson(pb_return_value) + + response_value._content = json_return_value.encode("UTF-8") + req.return_value = response_value + + response = client.batch_annotate_images(request) + + expected_params = [("$alt", "json;enum-encoding=int")] + actual_params = req.call_args.kwargs["params"] + assert expected_params == actual_params + + +def test_batch_annotate_images_rest_unset_required_fields(): + transport = transports.ImageAnnotatorRestTransport( + credentials=ga_credentials.AnonymousCredentials + ) + + unset_fields = transport.batch_annotate_images._get_unset_required_fields({}) + assert set(unset_fields) == (set(()) & set(("requests",))) + + +@pytest.mark.parametrize("null_interceptor", [True, False]) +def test_batch_annotate_images_rest_interceptors(null_interceptor): + transport = transports.ImageAnnotatorRestTransport( + credentials=ga_credentials.AnonymousCredentials(), + interceptor=None + if null_interceptor + else transports.ImageAnnotatorRestInterceptor(), + ) + client = ImageAnnotatorClient(transport=transport) + with mock.patch.object( + type(client.transport._session), "request" + ) as req, mock.patch.object( + path_template, "transcode" + ) as transcode, mock.patch.object( + transports.ImageAnnotatorRestInterceptor, "post_batch_annotate_images" + ) as post, mock.patch.object( + transports.ImageAnnotatorRestInterceptor, "pre_batch_annotate_images" + ) as pre: + pre.assert_not_called() + post.assert_not_called() + pb_message = image_annotator.BatchAnnotateImagesRequest.pb( + image_annotator.BatchAnnotateImagesRequest() + ) + transcode.return_value = { + "method": "post", + "uri": "my_uri", + "body": pb_message, + "query_params": pb_message, + } + + req.return_value = Response() + req.return_value.status_code = 200 + req.return_value.request = PreparedRequest() + req.return_value._content = image_annotator.BatchAnnotateImagesResponse.to_json( + image_annotator.BatchAnnotateImagesResponse() + ) + + request = image_annotator.BatchAnnotateImagesRequest() + metadata = [ + ("key", "val"), + ("cephalopod", "squid"), + ] + pre.return_value = request, metadata + post.return_value = image_annotator.BatchAnnotateImagesResponse() + + client.batch_annotate_images( + request, + metadata=[ + ("key", "val"), + ("cephalopod", "squid"), + ], + ) + + pre.assert_called_once() + post.assert_called_once() + + +def test_batch_annotate_images_rest_bad_request( + transport: str = "rest", request_type=image_annotator.BatchAnnotateImagesRequest +): + client = ImageAnnotatorClient( + credentials=ga_credentials.AnonymousCredentials(), + transport=transport, + ) + + # send a request that will satisfy transcoding + request_init = {} + request = request_type(**request_init) + + # Mock the http request call within the method and fake a BadRequest error. + with mock.patch.object(Session, "request") as req, pytest.raises( + core_exceptions.BadRequest + ): + # Wrap the value into a proper Response obj + response_value = Response() + response_value.status_code = 400 + response_value.request = Request() + req.return_value = response_value + client.batch_annotate_images(request) + + +def test_batch_annotate_images_rest_flattened(): + client = ImageAnnotatorClient( + credentials=ga_credentials.AnonymousCredentials(), + transport="rest", + ) + + # Mock the http request call within the method and fake a response. + with mock.patch.object(type(client.transport._session), "request") as req: + # Designate an appropriate value for the returned response. + return_value = image_annotator.BatchAnnotateImagesResponse() + + # get arguments that satisfy an http rule for this method + sample_request = {} + + # get truthy value for each flattened field + mock_args = dict( + requests=[ + image_annotator.AnnotateImageRequest( + image=image_annotator.Image(content=b"content_blob") + ) + ], + ) + mock_args.update(sample_request) + + # Wrap the value into a proper Response obj + response_value = Response() + response_value.status_code = 200 + pb_return_value = image_annotator.BatchAnnotateImagesResponse.pb(return_value) + json_return_value = json_format.MessageToJson(pb_return_value) + response_value._content = json_return_value.encode("UTF-8") + req.return_value = response_value + + client.batch_annotate_images(**mock_args) + + # Establish that the underlying call was made with the expected + # request object values. + assert len(req.mock_calls) == 1 + _, args, _ = req.mock_calls[0] + assert path_template.validate( + "%s/v1p2beta1/images:annotate" % client.transport._host, args[1] + ) + + +def test_batch_annotate_images_rest_flattened_error(transport: str = "rest"): + client = ImageAnnotatorClient( + credentials=ga_credentials.AnonymousCredentials(), + transport=transport, + ) + + # Attempting to call a method with both a request object and flattened + # fields is an error. + with pytest.raises(ValueError): + client.batch_annotate_images( + image_annotator.BatchAnnotateImagesRequest(), + requests=[ + image_annotator.AnnotateImageRequest( + image=image_annotator.Image(content=b"content_blob") + ) + ], + ) + + +def test_batch_annotate_images_rest_error(): + client = ImageAnnotatorClient( + credentials=ga_credentials.AnonymousCredentials(), transport="rest" + ) + + +@pytest.mark.parametrize( + "request_type", + [ + image_annotator.AsyncBatchAnnotateFilesRequest, + dict, + ], +) +def test_async_batch_annotate_files_rest(request_type): + client = ImageAnnotatorClient( + credentials=ga_credentials.AnonymousCredentials(), + transport="rest", + ) + + # send a request that will satisfy transcoding + request_init = {} + request = request_type(**request_init) + + # Mock the http request call within the method and fake a response. + with mock.patch.object(type(client.transport._session), "request") as req: + # Designate an appropriate value for the returned response. + return_value = operations_pb2.Operation(name="operations/spam") + + # Wrap the value into a proper Response obj + response_value = Response() + response_value.status_code = 200 + json_return_value = json_format.MessageToJson(return_value) + + response_value._content = json_return_value.encode("UTF-8") + req.return_value = response_value + response = client.async_batch_annotate_files(request) + + # Establish that the response is the type that we expect. + assert response.operation.name == "operations/spam" + + +def test_async_batch_annotate_files_rest_required_fields( + request_type=image_annotator.AsyncBatchAnnotateFilesRequest, +): + transport_class = transports.ImageAnnotatorRestTransport + + request_init = {} + request = request_type(**request_init) + pb_request = request_type.pb(request) + jsonified_request = json.loads( + json_format.MessageToJson( + pb_request, + including_default_value_fields=False, + use_integers_for_enums=False, + ) + ) + + # verify fields with default values are dropped + + unset_fields = transport_class( + credentials=ga_credentials.AnonymousCredentials() + ).async_batch_annotate_files._get_unset_required_fields(jsonified_request) + jsonified_request.update(unset_fields) + + # verify required fields with default values are now present + + unset_fields = transport_class( + credentials=ga_credentials.AnonymousCredentials() + ).async_batch_annotate_files._get_unset_required_fields(jsonified_request) + jsonified_request.update(unset_fields) + + # verify required fields with non-default values are left alone + + client = ImageAnnotatorClient( + credentials=ga_credentials.AnonymousCredentials(), + transport="rest", + ) + request = request_type(**request_init) + + # Designate an appropriate value for the returned response. + return_value = operations_pb2.Operation(name="operations/spam") + # Mock the http request call within the method and fake a response. + with mock.patch.object(Session, "request") as req: + # We need to mock transcode() because providing default values + # for required fields will fail the real version if the http_options + # expect actual values for those fields. + with mock.patch.object(path_template, "transcode") as transcode: + # A uri without fields and an empty body will force all the + # request fields to show up in the query_params. + pb_request = request_type.pb(request) + transcode_result = { + "uri": "v1/sample_method", + "method": "post", + "query_params": pb_request, + } + transcode_result["body"] = pb_request + transcode.return_value = transcode_result + + response_value = Response() + response_value.status_code = 200 + json_return_value = json_format.MessageToJson(return_value) + + response_value._content = json_return_value.encode("UTF-8") + req.return_value = response_value + + response = client.async_batch_annotate_files(request) + + expected_params = [("$alt", "json;enum-encoding=int")] + actual_params = req.call_args.kwargs["params"] + assert expected_params == actual_params + + +def test_async_batch_annotate_files_rest_unset_required_fields(): + transport = transports.ImageAnnotatorRestTransport( + credentials=ga_credentials.AnonymousCredentials + ) + + unset_fields = transport.async_batch_annotate_files._get_unset_required_fields({}) + assert set(unset_fields) == (set(()) & set(("requests",))) + + +@pytest.mark.parametrize("null_interceptor", [True, False]) +def test_async_batch_annotate_files_rest_interceptors(null_interceptor): + transport = transports.ImageAnnotatorRestTransport( + credentials=ga_credentials.AnonymousCredentials(), + interceptor=None + if null_interceptor + else transports.ImageAnnotatorRestInterceptor(), + ) + client = ImageAnnotatorClient(transport=transport) + with mock.patch.object( + type(client.transport._session), "request" + ) as req, mock.patch.object( + path_template, "transcode" + ) as transcode, mock.patch.object( + operation.Operation, "_set_result_from_operation" + ), mock.patch.object( + transports.ImageAnnotatorRestInterceptor, "post_async_batch_annotate_files" + ) as post, mock.patch.object( + transports.ImageAnnotatorRestInterceptor, "pre_async_batch_annotate_files" + ) as pre: + pre.assert_not_called() + post.assert_not_called() + pb_message = image_annotator.AsyncBatchAnnotateFilesRequest.pb( + image_annotator.AsyncBatchAnnotateFilesRequest() + ) + transcode.return_value = { + "method": "post", + "uri": "my_uri", + "body": pb_message, + "query_params": pb_message, + } + + req.return_value = Response() + req.return_value.status_code = 200 + req.return_value.request = PreparedRequest() + req.return_value._content = json_format.MessageToJson( + operations_pb2.Operation() + ) + + request = image_annotator.AsyncBatchAnnotateFilesRequest() + metadata = [ + ("key", "val"), + ("cephalopod", "squid"), + ] + pre.return_value = request, metadata + post.return_value = operations_pb2.Operation() + + client.async_batch_annotate_files( + request, + metadata=[ + ("key", "val"), + ("cephalopod", "squid"), + ], + ) + + pre.assert_called_once() + post.assert_called_once() + + +def test_async_batch_annotate_files_rest_bad_request( + transport: str = "rest", request_type=image_annotator.AsyncBatchAnnotateFilesRequest +): + client = ImageAnnotatorClient( + credentials=ga_credentials.AnonymousCredentials(), + transport=transport, + ) + + # send a request that will satisfy transcoding + request_init = {} + request = request_type(**request_init) + + # Mock the http request call within the method and fake a BadRequest error. + with mock.patch.object(Session, "request") as req, pytest.raises( + core_exceptions.BadRequest + ): + # Wrap the value into a proper Response obj + response_value = Response() + response_value.status_code = 400 + response_value.request = Request() + req.return_value = response_value + client.async_batch_annotate_files(request) + + +def test_async_batch_annotate_files_rest_flattened(): + client = ImageAnnotatorClient( + credentials=ga_credentials.AnonymousCredentials(), + transport="rest", + ) + + # Mock the http request call within the method and fake a response. + with mock.patch.object(type(client.transport._session), "request") as req: + # Designate an appropriate value for the returned response. + return_value = operations_pb2.Operation(name="operations/spam") + + # get arguments that satisfy an http rule for this method + sample_request = {} + + # get truthy value for each flattened field + mock_args = dict( + requests=[ + image_annotator.AsyncAnnotateFileRequest( + input_config=image_annotator.InputConfig( + gcs_source=image_annotator.GcsSource(uri="uri_value") + ) + ) + ], + ) + mock_args.update(sample_request) + + # Wrap the value into a proper Response obj + response_value = Response() + response_value.status_code = 200 + json_return_value = json_format.MessageToJson(return_value) + response_value._content = json_return_value.encode("UTF-8") + req.return_value = response_value + + client.async_batch_annotate_files(**mock_args) + + # Establish that the underlying call was made with the expected + # request object values. + assert len(req.mock_calls) == 1 + _, args, _ = req.mock_calls[0] + assert path_template.validate( + "%s/v1p2beta1/files:asyncBatchAnnotate" % client.transport._host, args[1] + ) + + +def test_async_batch_annotate_files_rest_flattened_error(transport: str = "rest"): + client = ImageAnnotatorClient( + credentials=ga_credentials.AnonymousCredentials(), + transport=transport, + ) + + # Attempting to call a method with both a request object and flattened + # fields is an error. + with pytest.raises(ValueError): + client.async_batch_annotate_files( + image_annotator.AsyncBatchAnnotateFilesRequest(), + requests=[ + image_annotator.AsyncAnnotateFileRequest( + input_config=image_annotator.InputConfig( + gcs_source=image_annotator.GcsSource(uri="uri_value") + ) + ) + ], + ) + + +def test_async_batch_annotate_files_rest_error(): + client = ImageAnnotatorClient( + credentials=ga_credentials.AnonymousCredentials(), transport="rest" + ) + + def test_credentials_transport_error(): # It is an error to provide credentials and a transport instance. transport = transports.ImageAnnotatorGrpcTransport( @@ -1183,6 +1745,7 @@ def test_transport_get_channel(): [ transports.ImageAnnotatorGrpcTransport, transports.ImageAnnotatorGrpcAsyncIOTransport, + transports.ImageAnnotatorRestTransport, ], ) def test_transport_adc(transport_class): @@ -1197,6 +1760,7 @@ def test_transport_adc(transport_class): "transport_name", [ "grpc", + "rest", ], ) def test_transport_kind(transport_name): @@ -1341,6 +1905,7 @@ def test_image_annotator_transport_auth_adc(transport_class): [ transports.ImageAnnotatorGrpcTransport, transports.ImageAnnotatorGrpcAsyncIOTransport, + transports.ImageAnnotatorRestTransport, ], ) def test_image_annotator_transport_auth_gdch_credentials(transport_class): @@ -1441,11 +2006,40 @@ def test_image_annotator_grpc_transport_client_cert_source_for_mtls(transport_cl ) +def test_image_annotator_http_transport_client_cert_source_for_mtls(): + cred = ga_credentials.AnonymousCredentials() + with mock.patch( + "google.auth.transport.requests.AuthorizedSession.configure_mtls_channel" + ) as mock_configure_mtls_channel: + transports.ImageAnnotatorRestTransport( + credentials=cred, client_cert_source_for_mtls=client_cert_source_callback + ) + mock_configure_mtls_channel.assert_called_once_with(client_cert_source_callback) + + +def test_image_annotator_rest_lro_client(): + client = ImageAnnotatorClient( + credentials=ga_credentials.AnonymousCredentials(), + transport="rest", + ) + transport = client.transport + + # Ensure that we have a api-core operations client. + assert isinstance( + transport.operations_client, + operations_v1.AbstractOperationsClient, + ) + + # Ensure that subsequent calls to the property send the exact same object. + assert transport.operations_client is transport.operations_client + + @pytest.mark.parametrize( "transport_name", [ "grpc", "grpc_asyncio", + "rest", ], ) def test_image_annotator_host_no_port(transport_name): @@ -1456,7 +2050,11 @@ def test_image_annotator_host_no_port(transport_name): ), transport=transport_name, ) - assert client.transport._host == ("vision.googleapis.com:443") + assert client.transport._host == ( + "vision.googleapis.com:443" + if transport_name in ["grpc", "grpc_asyncio"] + else "https://vision.googleapis.com/" + ) @pytest.mark.parametrize( @@ -1464,6 +2062,7 @@ def test_image_annotator_host_no_port(transport_name): [ "grpc", "grpc_asyncio", + "rest", ], ) def test_image_annotator_host_with_port(transport_name): @@ -1474,7 +2073,36 @@ def test_image_annotator_host_with_port(transport_name): ), transport=transport_name, ) - assert client.transport._host == ("vision.googleapis.com:8000") + assert client.transport._host == ( + "vision.googleapis.com:8000" + if transport_name in ["grpc", "grpc_asyncio"] + else "https://vision.googleapis.com:8000/" + ) + + +@pytest.mark.parametrize( + "transport_name", + [ + "rest", + ], +) +def test_image_annotator_client_transport_session_collision(transport_name): + creds1 = ga_credentials.AnonymousCredentials() + creds2 = ga_credentials.AnonymousCredentials() + client1 = ImageAnnotatorClient( + credentials=creds1, + transport=transport_name, + ) + client2 = ImageAnnotatorClient( + credentials=creds2, + transport=transport_name, + ) + session1 = client1.transport.batch_annotate_images._session + session2 = client2.transport.batch_annotate_images._session + assert session1 != session2 + session1 = client1.transport.async_batch_annotate_files._session + session2 = client2.transport.async_batch_annotate_files._session + assert session1 != session2 def test_image_annotator_grpc_transport_channel(): @@ -1779,6 +2407,7 @@ async def test_transport_close_async(): def test_transport_close(): transports = { + "rest": "_session", "grpc": "_grpc_channel", } @@ -1796,6 +2425,7 @@ def test_transport_close(): def test_client_ctx(): transports = [ + "rest", "grpc", ] for transport in transports: diff --git a/tests/unit/gapic/vision_v1p3beta1/test_image_annotator.py b/tests/unit/gapic/vision_v1p3beta1/test_image_annotator.py index d6ba2703..99945cb2 100644 --- a/tests/unit/gapic/vision_v1p3beta1/test_image_annotator.py +++ b/tests/unit/gapic/vision_v1p3beta1/test_image_annotator.py @@ -24,10 +24,17 @@ import grpc from grpc.experimental import aio +from collections.abc import Iterable +from google.protobuf import json_format +import json import math import pytest from proto.marshal.rules.dates import DurationRule, TimestampRule from proto.marshal.rules import wrappers +from requests import Response +from requests import Request, PreparedRequest +from requests.sessions import Session +from google.protobuf import json_format from google.api_core import client_options from google.api_core import exceptions as core_exceptions @@ -104,6 +111,7 @@ def test__get_default_mtls_endpoint(): [ (ImageAnnotatorClient, "grpc"), (ImageAnnotatorAsyncClient, "grpc_asyncio"), + (ImageAnnotatorClient, "rest"), ], ) def test_image_annotator_client_from_service_account_info(client_class, transport_name): @@ -117,7 +125,11 @@ def test_image_annotator_client_from_service_account_info(client_class, transpor assert client.transport._credentials == creds assert isinstance(client, client_class) - assert client.transport._host == ("vision.googleapis.com:443") + assert client.transport._host == ( + "vision.googleapis.com:443" + if transport_name in ["grpc", "grpc_asyncio"] + else "https://vision.googleapis.com/" + ) @pytest.mark.parametrize( @@ -125,6 +137,7 @@ def test_image_annotator_client_from_service_account_info(client_class, transpor [ (transports.ImageAnnotatorGrpcTransport, "grpc"), (transports.ImageAnnotatorGrpcAsyncIOTransport, "grpc_asyncio"), + (transports.ImageAnnotatorRestTransport, "rest"), ], ) def test_image_annotator_client_service_account_always_use_jwt( @@ -150,6 +163,7 @@ def test_image_annotator_client_service_account_always_use_jwt( [ (ImageAnnotatorClient, "grpc"), (ImageAnnotatorAsyncClient, "grpc_asyncio"), + (ImageAnnotatorClient, "rest"), ], ) def test_image_annotator_client_from_service_account_file(client_class, transport_name): @@ -170,13 +184,18 @@ def test_image_annotator_client_from_service_account_file(client_class, transpor assert client.transport._credentials == creds assert isinstance(client, client_class) - assert client.transport._host == ("vision.googleapis.com:443") + assert client.transport._host == ( + "vision.googleapis.com:443" + if transport_name in ["grpc", "grpc_asyncio"] + else "https://vision.googleapis.com/" + ) def test_image_annotator_client_get_transport_class(): transport = ImageAnnotatorClient.get_transport_class() available_transports = [ transports.ImageAnnotatorGrpcTransport, + transports.ImageAnnotatorRestTransport, ] assert transport in available_transports @@ -193,6 +212,7 @@ def test_image_annotator_client_get_transport_class(): transports.ImageAnnotatorGrpcAsyncIOTransport, "grpc_asyncio", ), + (ImageAnnotatorClient, transports.ImageAnnotatorRestTransport, "rest"), ], ) @mock.patch.object( @@ -338,6 +358,8 @@ def test_image_annotator_client_client_options( "grpc_asyncio", "false", ), + (ImageAnnotatorClient, transports.ImageAnnotatorRestTransport, "rest", "true"), + (ImageAnnotatorClient, transports.ImageAnnotatorRestTransport, "rest", "false"), ], ) @mock.patch.object( @@ -537,6 +559,7 @@ def test_image_annotator_client_get_mtls_endpoint_and_cert_source(client_class): transports.ImageAnnotatorGrpcAsyncIOTransport, "grpc_asyncio", ), + (ImageAnnotatorClient, transports.ImageAnnotatorRestTransport, "rest"), ], ) def test_image_annotator_client_client_options_scopes( @@ -577,6 +600,7 @@ def test_image_annotator_client_client_options_scopes( "grpc_asyncio", grpc_helpers_async, ), + (ImageAnnotatorClient, transports.ImageAnnotatorRestTransport, "rest", None), ], ) def test_image_annotator_client_client_options_credentials_file( @@ -1104,6 +1128,544 @@ async def test_async_batch_annotate_files_flattened_error_async(): ) +@pytest.mark.parametrize( + "request_type", + [ + image_annotator.BatchAnnotateImagesRequest, + dict, + ], +) +def test_batch_annotate_images_rest(request_type): + client = ImageAnnotatorClient( + credentials=ga_credentials.AnonymousCredentials(), + transport="rest", + ) + + # send a request that will satisfy transcoding + request_init = {} + request = request_type(**request_init) + + # Mock the http request call within the method and fake a response. + with mock.patch.object(type(client.transport._session), "request") as req: + # Designate an appropriate value for the returned response. + return_value = image_annotator.BatchAnnotateImagesResponse() + + # Wrap the value into a proper Response obj + response_value = Response() + response_value.status_code = 200 + pb_return_value = image_annotator.BatchAnnotateImagesResponse.pb(return_value) + json_return_value = json_format.MessageToJson(pb_return_value) + + response_value._content = json_return_value.encode("UTF-8") + req.return_value = response_value + response = client.batch_annotate_images(request) + + # Establish that the response is the type that we expect. + assert isinstance(response, image_annotator.BatchAnnotateImagesResponse) + + +def test_batch_annotate_images_rest_required_fields( + request_type=image_annotator.BatchAnnotateImagesRequest, +): + transport_class = transports.ImageAnnotatorRestTransport + + request_init = {} + request = request_type(**request_init) + pb_request = request_type.pb(request) + jsonified_request = json.loads( + json_format.MessageToJson( + pb_request, + including_default_value_fields=False, + use_integers_for_enums=False, + ) + ) + + # verify fields with default values are dropped + + unset_fields = transport_class( + credentials=ga_credentials.AnonymousCredentials() + ).batch_annotate_images._get_unset_required_fields(jsonified_request) + jsonified_request.update(unset_fields) + + # verify required fields with default values are now present + + unset_fields = transport_class( + credentials=ga_credentials.AnonymousCredentials() + ).batch_annotate_images._get_unset_required_fields(jsonified_request) + jsonified_request.update(unset_fields) + + # verify required fields with non-default values are left alone + + client = ImageAnnotatorClient( + credentials=ga_credentials.AnonymousCredentials(), + transport="rest", + ) + request = request_type(**request_init) + + # Designate an appropriate value for the returned response. + return_value = image_annotator.BatchAnnotateImagesResponse() + # Mock the http request call within the method and fake a response. + with mock.patch.object(Session, "request") as req: + # We need to mock transcode() because providing default values + # for required fields will fail the real version if the http_options + # expect actual values for those fields. + with mock.patch.object(path_template, "transcode") as transcode: + # A uri without fields and an empty body will force all the + # request fields to show up in the query_params. + pb_request = request_type.pb(request) + transcode_result = { + "uri": "v1/sample_method", + "method": "post", + "query_params": pb_request, + } + transcode_result["body"] = pb_request + transcode.return_value = transcode_result + + response_value = Response() + response_value.status_code = 200 + + pb_return_value = image_annotator.BatchAnnotateImagesResponse.pb( + return_value + ) + json_return_value = json_format.MessageToJson(pb_return_value) + + response_value._content = json_return_value.encode("UTF-8") + req.return_value = response_value + + response = client.batch_annotate_images(request) + + expected_params = [("$alt", "json;enum-encoding=int")] + actual_params = req.call_args.kwargs["params"] + assert expected_params == actual_params + + +def test_batch_annotate_images_rest_unset_required_fields(): + transport = transports.ImageAnnotatorRestTransport( + credentials=ga_credentials.AnonymousCredentials + ) + + unset_fields = transport.batch_annotate_images._get_unset_required_fields({}) + assert set(unset_fields) == (set(()) & set(("requests",))) + + +@pytest.mark.parametrize("null_interceptor", [True, False]) +def test_batch_annotate_images_rest_interceptors(null_interceptor): + transport = transports.ImageAnnotatorRestTransport( + credentials=ga_credentials.AnonymousCredentials(), + interceptor=None + if null_interceptor + else transports.ImageAnnotatorRestInterceptor(), + ) + client = ImageAnnotatorClient(transport=transport) + with mock.patch.object( + type(client.transport._session), "request" + ) as req, mock.patch.object( + path_template, "transcode" + ) as transcode, mock.patch.object( + transports.ImageAnnotatorRestInterceptor, "post_batch_annotate_images" + ) as post, mock.patch.object( + transports.ImageAnnotatorRestInterceptor, "pre_batch_annotate_images" + ) as pre: + pre.assert_not_called() + post.assert_not_called() + pb_message = image_annotator.BatchAnnotateImagesRequest.pb( + image_annotator.BatchAnnotateImagesRequest() + ) + transcode.return_value = { + "method": "post", + "uri": "my_uri", + "body": pb_message, + "query_params": pb_message, + } + + req.return_value = Response() + req.return_value.status_code = 200 + req.return_value.request = PreparedRequest() + req.return_value._content = image_annotator.BatchAnnotateImagesResponse.to_json( + image_annotator.BatchAnnotateImagesResponse() + ) + + request = image_annotator.BatchAnnotateImagesRequest() + metadata = [ + ("key", "val"), + ("cephalopod", "squid"), + ] + pre.return_value = request, metadata + post.return_value = image_annotator.BatchAnnotateImagesResponse() + + client.batch_annotate_images( + request, + metadata=[ + ("key", "val"), + ("cephalopod", "squid"), + ], + ) + + pre.assert_called_once() + post.assert_called_once() + + +def test_batch_annotate_images_rest_bad_request( + transport: str = "rest", request_type=image_annotator.BatchAnnotateImagesRequest +): + client = ImageAnnotatorClient( + credentials=ga_credentials.AnonymousCredentials(), + transport=transport, + ) + + # send a request that will satisfy transcoding + request_init = {} + request = request_type(**request_init) + + # Mock the http request call within the method and fake a BadRequest error. + with mock.patch.object(Session, "request") as req, pytest.raises( + core_exceptions.BadRequest + ): + # Wrap the value into a proper Response obj + response_value = Response() + response_value.status_code = 400 + response_value.request = Request() + req.return_value = response_value + client.batch_annotate_images(request) + + +def test_batch_annotate_images_rest_flattened(): + client = ImageAnnotatorClient( + credentials=ga_credentials.AnonymousCredentials(), + transport="rest", + ) + + # Mock the http request call within the method and fake a response. + with mock.patch.object(type(client.transport._session), "request") as req: + # Designate an appropriate value for the returned response. + return_value = image_annotator.BatchAnnotateImagesResponse() + + # get arguments that satisfy an http rule for this method + sample_request = {} + + # get truthy value for each flattened field + mock_args = dict( + requests=[ + image_annotator.AnnotateImageRequest( + image=image_annotator.Image(content=b"content_blob") + ) + ], + ) + mock_args.update(sample_request) + + # Wrap the value into a proper Response obj + response_value = Response() + response_value.status_code = 200 + pb_return_value = image_annotator.BatchAnnotateImagesResponse.pb(return_value) + json_return_value = json_format.MessageToJson(pb_return_value) + response_value._content = json_return_value.encode("UTF-8") + req.return_value = response_value + + client.batch_annotate_images(**mock_args) + + # Establish that the underlying call was made with the expected + # request object values. + assert len(req.mock_calls) == 1 + _, args, _ = req.mock_calls[0] + assert path_template.validate( + "%s/v1p3beta1/images:annotate" % client.transport._host, args[1] + ) + + +def test_batch_annotate_images_rest_flattened_error(transport: str = "rest"): + client = ImageAnnotatorClient( + credentials=ga_credentials.AnonymousCredentials(), + transport=transport, + ) + + # Attempting to call a method with both a request object and flattened + # fields is an error. + with pytest.raises(ValueError): + client.batch_annotate_images( + image_annotator.BatchAnnotateImagesRequest(), + requests=[ + image_annotator.AnnotateImageRequest( + image=image_annotator.Image(content=b"content_blob") + ) + ], + ) + + +def test_batch_annotate_images_rest_error(): + client = ImageAnnotatorClient( + credentials=ga_credentials.AnonymousCredentials(), transport="rest" + ) + + +@pytest.mark.parametrize( + "request_type", + [ + image_annotator.AsyncBatchAnnotateFilesRequest, + dict, + ], +) +def test_async_batch_annotate_files_rest(request_type): + client = ImageAnnotatorClient( + credentials=ga_credentials.AnonymousCredentials(), + transport="rest", + ) + + # send a request that will satisfy transcoding + request_init = {} + request = request_type(**request_init) + + # Mock the http request call within the method and fake a response. + with mock.patch.object(type(client.transport._session), "request") as req: + # Designate an appropriate value for the returned response. + return_value = operations_pb2.Operation(name="operations/spam") + + # Wrap the value into a proper Response obj + response_value = Response() + response_value.status_code = 200 + json_return_value = json_format.MessageToJson(return_value) + + response_value._content = json_return_value.encode("UTF-8") + req.return_value = response_value + response = client.async_batch_annotate_files(request) + + # Establish that the response is the type that we expect. + assert response.operation.name == "operations/spam" + + +def test_async_batch_annotate_files_rest_required_fields( + request_type=image_annotator.AsyncBatchAnnotateFilesRequest, +): + transport_class = transports.ImageAnnotatorRestTransport + + request_init = {} + request = request_type(**request_init) + pb_request = request_type.pb(request) + jsonified_request = json.loads( + json_format.MessageToJson( + pb_request, + including_default_value_fields=False, + use_integers_for_enums=False, + ) + ) + + # verify fields with default values are dropped + + unset_fields = transport_class( + credentials=ga_credentials.AnonymousCredentials() + ).async_batch_annotate_files._get_unset_required_fields(jsonified_request) + jsonified_request.update(unset_fields) + + # verify required fields with default values are now present + + unset_fields = transport_class( + credentials=ga_credentials.AnonymousCredentials() + ).async_batch_annotate_files._get_unset_required_fields(jsonified_request) + jsonified_request.update(unset_fields) + + # verify required fields with non-default values are left alone + + client = ImageAnnotatorClient( + credentials=ga_credentials.AnonymousCredentials(), + transport="rest", + ) + request = request_type(**request_init) + + # Designate an appropriate value for the returned response. + return_value = operations_pb2.Operation(name="operations/spam") + # Mock the http request call within the method and fake a response. + with mock.patch.object(Session, "request") as req: + # We need to mock transcode() because providing default values + # for required fields will fail the real version if the http_options + # expect actual values for those fields. + with mock.patch.object(path_template, "transcode") as transcode: + # A uri without fields and an empty body will force all the + # request fields to show up in the query_params. + pb_request = request_type.pb(request) + transcode_result = { + "uri": "v1/sample_method", + "method": "post", + "query_params": pb_request, + } + transcode_result["body"] = pb_request + transcode.return_value = transcode_result + + response_value = Response() + response_value.status_code = 200 + json_return_value = json_format.MessageToJson(return_value) + + response_value._content = json_return_value.encode("UTF-8") + req.return_value = response_value + + response = client.async_batch_annotate_files(request) + + expected_params = [("$alt", "json;enum-encoding=int")] + actual_params = req.call_args.kwargs["params"] + assert expected_params == actual_params + + +def test_async_batch_annotate_files_rest_unset_required_fields(): + transport = transports.ImageAnnotatorRestTransport( + credentials=ga_credentials.AnonymousCredentials + ) + + unset_fields = transport.async_batch_annotate_files._get_unset_required_fields({}) + assert set(unset_fields) == (set(()) & set(("requests",))) + + +@pytest.mark.parametrize("null_interceptor", [True, False]) +def test_async_batch_annotate_files_rest_interceptors(null_interceptor): + transport = transports.ImageAnnotatorRestTransport( + credentials=ga_credentials.AnonymousCredentials(), + interceptor=None + if null_interceptor + else transports.ImageAnnotatorRestInterceptor(), + ) + client = ImageAnnotatorClient(transport=transport) + with mock.patch.object( + type(client.transport._session), "request" + ) as req, mock.patch.object( + path_template, "transcode" + ) as transcode, mock.patch.object( + operation.Operation, "_set_result_from_operation" + ), mock.patch.object( + transports.ImageAnnotatorRestInterceptor, "post_async_batch_annotate_files" + ) as post, mock.patch.object( + transports.ImageAnnotatorRestInterceptor, "pre_async_batch_annotate_files" + ) as pre: + pre.assert_not_called() + post.assert_not_called() + pb_message = image_annotator.AsyncBatchAnnotateFilesRequest.pb( + image_annotator.AsyncBatchAnnotateFilesRequest() + ) + transcode.return_value = { + "method": "post", + "uri": "my_uri", + "body": pb_message, + "query_params": pb_message, + } + + req.return_value = Response() + req.return_value.status_code = 200 + req.return_value.request = PreparedRequest() + req.return_value._content = json_format.MessageToJson( + operations_pb2.Operation() + ) + + request = image_annotator.AsyncBatchAnnotateFilesRequest() + metadata = [ + ("key", "val"), + ("cephalopod", "squid"), + ] + pre.return_value = request, metadata + post.return_value = operations_pb2.Operation() + + client.async_batch_annotate_files( + request, + metadata=[ + ("key", "val"), + ("cephalopod", "squid"), + ], + ) + + pre.assert_called_once() + post.assert_called_once() + + +def test_async_batch_annotate_files_rest_bad_request( + transport: str = "rest", request_type=image_annotator.AsyncBatchAnnotateFilesRequest +): + client = ImageAnnotatorClient( + credentials=ga_credentials.AnonymousCredentials(), + transport=transport, + ) + + # send a request that will satisfy transcoding + request_init = {} + request = request_type(**request_init) + + # Mock the http request call within the method and fake a BadRequest error. + with mock.patch.object(Session, "request") as req, pytest.raises( + core_exceptions.BadRequest + ): + # Wrap the value into a proper Response obj + response_value = Response() + response_value.status_code = 400 + response_value.request = Request() + req.return_value = response_value + client.async_batch_annotate_files(request) + + +def test_async_batch_annotate_files_rest_flattened(): + client = ImageAnnotatorClient( + credentials=ga_credentials.AnonymousCredentials(), + transport="rest", + ) + + # Mock the http request call within the method and fake a response. + with mock.patch.object(type(client.transport._session), "request") as req: + # Designate an appropriate value for the returned response. + return_value = operations_pb2.Operation(name="operations/spam") + + # get arguments that satisfy an http rule for this method + sample_request = {} + + # get truthy value for each flattened field + mock_args = dict( + requests=[ + image_annotator.AsyncAnnotateFileRequest( + input_config=image_annotator.InputConfig( + gcs_source=image_annotator.GcsSource(uri="uri_value") + ) + ) + ], + ) + mock_args.update(sample_request) + + # Wrap the value into a proper Response obj + response_value = Response() + response_value.status_code = 200 + json_return_value = json_format.MessageToJson(return_value) + response_value._content = json_return_value.encode("UTF-8") + req.return_value = response_value + + client.async_batch_annotate_files(**mock_args) + + # Establish that the underlying call was made with the expected + # request object values. + assert len(req.mock_calls) == 1 + _, args, _ = req.mock_calls[0] + assert path_template.validate( + "%s/v1p3beta1/files:asyncBatchAnnotate" % client.transport._host, args[1] + ) + + +def test_async_batch_annotate_files_rest_flattened_error(transport: str = "rest"): + client = ImageAnnotatorClient( + credentials=ga_credentials.AnonymousCredentials(), + transport=transport, + ) + + # Attempting to call a method with both a request object and flattened + # fields is an error. + with pytest.raises(ValueError): + client.async_batch_annotate_files( + image_annotator.AsyncBatchAnnotateFilesRequest(), + requests=[ + image_annotator.AsyncAnnotateFileRequest( + input_config=image_annotator.InputConfig( + gcs_source=image_annotator.GcsSource(uri="uri_value") + ) + ) + ], + ) + + +def test_async_batch_annotate_files_rest_error(): + client = ImageAnnotatorClient( + credentials=ga_credentials.AnonymousCredentials(), transport="rest" + ) + + def test_credentials_transport_error(): # It is an error to provide credentials and a transport instance. transport = transports.ImageAnnotatorGrpcTransport( @@ -1185,6 +1747,7 @@ def test_transport_get_channel(): [ transports.ImageAnnotatorGrpcTransport, transports.ImageAnnotatorGrpcAsyncIOTransport, + transports.ImageAnnotatorRestTransport, ], ) def test_transport_adc(transport_class): @@ -1199,6 +1762,7 @@ def test_transport_adc(transport_class): "transport_name", [ "grpc", + "rest", ], ) def test_transport_kind(transport_name): @@ -1343,6 +1907,7 @@ def test_image_annotator_transport_auth_adc(transport_class): [ transports.ImageAnnotatorGrpcTransport, transports.ImageAnnotatorGrpcAsyncIOTransport, + transports.ImageAnnotatorRestTransport, ], ) def test_image_annotator_transport_auth_gdch_credentials(transport_class): @@ -1443,11 +2008,40 @@ def test_image_annotator_grpc_transport_client_cert_source_for_mtls(transport_cl ) +def test_image_annotator_http_transport_client_cert_source_for_mtls(): + cred = ga_credentials.AnonymousCredentials() + with mock.patch( + "google.auth.transport.requests.AuthorizedSession.configure_mtls_channel" + ) as mock_configure_mtls_channel: + transports.ImageAnnotatorRestTransport( + credentials=cred, client_cert_source_for_mtls=client_cert_source_callback + ) + mock_configure_mtls_channel.assert_called_once_with(client_cert_source_callback) + + +def test_image_annotator_rest_lro_client(): + client = ImageAnnotatorClient( + credentials=ga_credentials.AnonymousCredentials(), + transport="rest", + ) + transport = client.transport + + # Ensure that we have a api-core operations client. + assert isinstance( + transport.operations_client, + operations_v1.AbstractOperationsClient, + ) + + # Ensure that subsequent calls to the property send the exact same object. + assert transport.operations_client is transport.operations_client + + @pytest.mark.parametrize( "transport_name", [ "grpc", "grpc_asyncio", + "rest", ], ) def test_image_annotator_host_no_port(transport_name): @@ -1458,7 +2052,11 @@ def test_image_annotator_host_no_port(transport_name): ), transport=transport_name, ) - assert client.transport._host == ("vision.googleapis.com:443") + assert client.transport._host == ( + "vision.googleapis.com:443" + if transport_name in ["grpc", "grpc_asyncio"] + else "https://vision.googleapis.com/" + ) @pytest.mark.parametrize( @@ -1466,6 +2064,7 @@ def test_image_annotator_host_no_port(transport_name): [ "grpc", "grpc_asyncio", + "rest", ], ) def test_image_annotator_host_with_port(transport_name): @@ -1476,7 +2075,36 @@ def test_image_annotator_host_with_port(transport_name): ), transport=transport_name, ) - assert client.transport._host == ("vision.googleapis.com:8000") + assert client.transport._host == ( + "vision.googleapis.com:8000" + if transport_name in ["grpc", "grpc_asyncio"] + else "https://vision.googleapis.com:8000/" + ) + + +@pytest.mark.parametrize( + "transport_name", + [ + "rest", + ], +) +def test_image_annotator_client_transport_session_collision(transport_name): + creds1 = ga_credentials.AnonymousCredentials() + creds2 = ga_credentials.AnonymousCredentials() + client1 = ImageAnnotatorClient( + credentials=creds1, + transport=transport_name, + ) + client2 = ImageAnnotatorClient( + credentials=creds2, + transport=transport_name, + ) + session1 = client1.transport.batch_annotate_images._session + session2 = client2.transport.batch_annotate_images._session + assert session1 != session2 + session1 = client1.transport.async_batch_annotate_files._session + session2 = client2.transport.async_batch_annotate_files._session + assert session1 != session2 def test_image_annotator_grpc_transport_channel(): @@ -1835,6 +2463,7 @@ async def test_transport_close_async(): def test_transport_close(): transports = { + "rest": "_session", "grpc": "_grpc_channel", } @@ -1852,6 +2481,7 @@ def test_transport_close(): def test_client_ctx(): transports = [ + "rest", "grpc", ] for transport in transports: diff --git a/tests/unit/gapic/vision_v1p3beta1/test_product_search.py b/tests/unit/gapic/vision_v1p3beta1/test_product_search.py index 02639f6b..0ff730d5 100644 --- a/tests/unit/gapic/vision_v1p3beta1/test_product_search.py +++ b/tests/unit/gapic/vision_v1p3beta1/test_product_search.py @@ -24,10 +24,17 @@ import grpc from grpc.experimental import aio +from collections.abc import Iterable +from google.protobuf import json_format +import json import math import pytest from proto.marshal.rules.dates import DurationRule, TimestampRule from proto.marshal.rules import wrappers +from requests import Response +from requests import Request, PreparedRequest +from requests.sessions import Session +from google.protobuf import json_format from google.api_core import client_options from google.api_core import exceptions as core_exceptions @@ -107,6 +114,7 @@ def test__get_default_mtls_endpoint(): [ (ProductSearchClient, "grpc"), (ProductSearchAsyncClient, "grpc_asyncio"), + (ProductSearchClient, "rest"), ], ) def test_product_search_client_from_service_account_info(client_class, transport_name): @@ -120,7 +128,11 @@ def test_product_search_client_from_service_account_info(client_class, transport assert client.transport._credentials == creds assert isinstance(client, client_class) - assert client.transport._host == ("vision.googleapis.com:443") + assert client.transport._host == ( + "vision.googleapis.com:443" + if transport_name in ["grpc", "grpc_asyncio"] + else "https://vision.googleapis.com/" + ) @pytest.mark.parametrize( @@ -128,6 +140,7 @@ def test_product_search_client_from_service_account_info(client_class, transport [ (transports.ProductSearchGrpcTransport, "grpc"), (transports.ProductSearchGrpcAsyncIOTransport, "grpc_asyncio"), + (transports.ProductSearchRestTransport, "rest"), ], ) def test_product_search_client_service_account_always_use_jwt( @@ -153,6 +166,7 @@ def test_product_search_client_service_account_always_use_jwt( [ (ProductSearchClient, "grpc"), (ProductSearchAsyncClient, "grpc_asyncio"), + (ProductSearchClient, "rest"), ], ) def test_product_search_client_from_service_account_file(client_class, transport_name): @@ -173,13 +187,18 @@ def test_product_search_client_from_service_account_file(client_class, transport assert client.transport._credentials == creds assert isinstance(client, client_class) - assert client.transport._host == ("vision.googleapis.com:443") + assert client.transport._host == ( + "vision.googleapis.com:443" + if transport_name in ["grpc", "grpc_asyncio"] + else "https://vision.googleapis.com/" + ) def test_product_search_client_get_transport_class(): transport = ProductSearchClient.get_transport_class() available_transports = [ transports.ProductSearchGrpcTransport, + transports.ProductSearchRestTransport, ] assert transport in available_transports @@ -196,6 +215,7 @@ def test_product_search_client_get_transport_class(): transports.ProductSearchGrpcAsyncIOTransport, "grpc_asyncio", ), + (ProductSearchClient, transports.ProductSearchRestTransport, "rest"), ], ) @mock.patch.object( @@ -341,6 +361,8 @@ def test_product_search_client_client_options( "grpc_asyncio", "false", ), + (ProductSearchClient, transports.ProductSearchRestTransport, "rest", "true"), + (ProductSearchClient, transports.ProductSearchRestTransport, "rest", "false"), ], ) @mock.patch.object( @@ -540,6 +562,7 @@ def test_product_search_client_get_mtls_endpoint_and_cert_source(client_class): transports.ProductSearchGrpcAsyncIOTransport, "grpc_asyncio", ), + (ProductSearchClient, transports.ProductSearchRestTransport, "rest"), ], ) def test_product_search_client_client_options_scopes( @@ -580,6 +603,7 @@ def test_product_search_client_client_options_scopes( "grpc_asyncio", grpc_helpers_async, ), + (ProductSearchClient, transports.ProductSearchRestTransport, "rest", None), ], ) def test_product_search_client_client_options_credentials_file( @@ -5965,210 +5989,5564 @@ async def test_import_product_sets_flattened_error_async(): ) -def test_credentials_transport_error(): - # It is an error to provide credentials and a transport instance. - transport = transports.ProductSearchGrpcTransport( +@pytest.mark.parametrize( + "request_type", + [ + product_search_service.CreateProductSetRequest, + dict, + ], +) +def test_create_product_set_rest(request_type): + client = ProductSearchClient( credentials=ga_credentials.AnonymousCredentials(), - ) - with pytest.raises(ValueError): - client = ProductSearchClient( - credentials=ga_credentials.AnonymousCredentials(), - transport=transport, + transport="rest", + ) + + # send a request that will satisfy transcoding + request_init = {"parent": "projects/sample1/locations/sample2"} + request_init["product_set"] = { + "name": "name_value", + "display_name": "display_name_value", + "index_time": {"seconds": 751, "nanos": 543}, + "index_error": { + "code": 411, + "message": "message_value", + "details": [ + { + "type_url": "type.googleapis.com/google.protobuf.Duration", + "value": b"\x08\x0c\x10\xdb\x07", + } + ], + }, + } + request = request_type(**request_init) + + # Mock the http request call within the method and fake a response. + with mock.patch.object(type(client.transport._session), "request") as req: + # Designate an appropriate value for the returned response. + return_value = product_search_service.ProductSet( + name="name_value", + display_name="display_name_value", ) - # It is an error to provide a credentials file and a transport instance. - transport = transports.ProductSearchGrpcTransport( - credentials=ga_credentials.AnonymousCredentials(), - ) - with pytest.raises(ValueError): - client = ProductSearchClient( - client_options={"credentials_file": "credentials.json"}, - transport=transport, + # Wrap the value into a proper Response obj + response_value = Response() + response_value.status_code = 200 + pb_return_value = product_search_service.ProductSet.pb(return_value) + json_return_value = json_format.MessageToJson(pb_return_value) + + response_value._content = json_return_value.encode("UTF-8") + req.return_value = response_value + response = client.create_product_set(request) + + # Establish that the response is the type that we expect. + assert isinstance(response, product_search_service.ProductSet) + assert response.name == "name_value" + assert response.display_name == "display_name_value" + + +def test_create_product_set_rest_required_fields( + request_type=product_search_service.CreateProductSetRequest, +): + transport_class = transports.ProductSearchRestTransport + + request_init = {} + request_init["parent"] = "" + request = request_type(**request_init) + pb_request = request_type.pb(request) + jsonified_request = json.loads( + json_format.MessageToJson( + pb_request, + including_default_value_fields=False, + use_integers_for_enums=False, ) + ) - # It is an error to provide an api_key and a transport instance. - transport = transports.ProductSearchGrpcTransport( + # verify fields with default values are dropped + + unset_fields = transport_class( + credentials=ga_credentials.AnonymousCredentials() + ).create_product_set._get_unset_required_fields(jsonified_request) + jsonified_request.update(unset_fields) + + # verify required fields with default values are now present + + jsonified_request["parent"] = "parent_value" + + unset_fields = transport_class( + credentials=ga_credentials.AnonymousCredentials() + ).create_product_set._get_unset_required_fields(jsonified_request) + # Check that path parameters and body parameters are not mixing in. + assert not set(unset_fields) - set(("product_set_id",)) + jsonified_request.update(unset_fields) + + # verify required fields with non-default values are left alone + assert "parent" in jsonified_request + assert jsonified_request["parent"] == "parent_value" + + client = ProductSearchClient( credentials=ga_credentials.AnonymousCredentials(), - ) - options = client_options.ClientOptions() - options.api_key = "api_key" - with pytest.raises(ValueError): - client = ProductSearchClient( - client_options=options, - transport=transport, + transport="rest", + ) + request = request_type(**request_init) + + # Designate an appropriate value for the returned response. + return_value = product_search_service.ProductSet() + # Mock the http request call within the method and fake a response. + with mock.patch.object(Session, "request") as req: + # We need to mock transcode() because providing default values + # for required fields will fail the real version if the http_options + # expect actual values for those fields. + with mock.patch.object(path_template, "transcode") as transcode: + # A uri without fields and an empty body will force all the + # request fields to show up in the query_params. + pb_request = request_type.pb(request) + transcode_result = { + "uri": "v1/sample_method", + "method": "post", + "query_params": pb_request, + } + transcode_result["body"] = pb_request + transcode.return_value = transcode_result + + response_value = Response() + response_value.status_code = 200 + + pb_return_value = product_search_service.ProductSet.pb(return_value) + json_return_value = json_format.MessageToJson(pb_return_value) + + response_value._content = json_return_value.encode("UTF-8") + req.return_value = response_value + + response = client.create_product_set(request) + + expected_params = [("$alt", "json;enum-encoding=int")] + actual_params = req.call_args.kwargs["params"] + assert expected_params == actual_params + + +def test_create_product_set_rest_unset_required_fields(): + transport = transports.ProductSearchRestTransport( + credentials=ga_credentials.AnonymousCredentials + ) + + unset_fields = transport.create_product_set._get_unset_required_fields({}) + assert set(unset_fields) == ( + set(("productSetId",)) + & set( + ( + "parent", + "productSet", + ) ) + ) - # It is an error to provide an api_key and a credential. - options = mock.Mock() - options.api_key = "api_key" - with pytest.raises(ValueError): - client = ProductSearchClient( - client_options=options, credentials=ga_credentials.AnonymousCredentials() - ) - # It is an error to provide scopes and a transport instance. - transport = transports.ProductSearchGrpcTransport( +@pytest.mark.parametrize("null_interceptor", [True, False]) +def test_create_product_set_rest_interceptors(null_interceptor): + transport = transports.ProductSearchRestTransport( credentials=ga_credentials.AnonymousCredentials(), + interceptor=None + if null_interceptor + else transports.ProductSearchRestInterceptor(), ) - with pytest.raises(ValueError): - client = ProductSearchClient( - client_options={"scopes": ["1", "2"]}, - transport=transport, + client = ProductSearchClient(transport=transport) + with mock.patch.object( + type(client.transport._session), "request" + ) as req, mock.patch.object( + path_template, "transcode" + ) as transcode, mock.patch.object( + transports.ProductSearchRestInterceptor, "post_create_product_set" + ) as post, mock.patch.object( + transports.ProductSearchRestInterceptor, "pre_create_product_set" + ) as pre: + pre.assert_not_called() + post.assert_not_called() + pb_message = product_search_service.CreateProductSetRequest.pb( + product_search_service.CreateProductSetRequest() + ) + transcode.return_value = { + "method": "post", + "uri": "my_uri", + "body": pb_message, + "query_params": pb_message, + } + + req.return_value = Response() + req.return_value.status_code = 200 + req.return_value.request = PreparedRequest() + req.return_value._content = product_search_service.ProductSet.to_json( + product_search_service.ProductSet() ) + request = product_search_service.CreateProductSetRequest() + metadata = [ + ("key", "val"), + ("cephalopod", "squid"), + ] + pre.return_value = request, metadata + post.return_value = product_search_service.ProductSet() -def test_transport_instance(): - # A client may be instantiated with a custom transport instance. - transport = transports.ProductSearchGrpcTransport( + client.create_product_set( + request, + metadata=[ + ("key", "val"), + ("cephalopod", "squid"), + ], + ) + + pre.assert_called_once() + post.assert_called_once() + + +def test_create_product_set_rest_bad_request( + transport: str = "rest", request_type=product_search_service.CreateProductSetRequest +): + client = ProductSearchClient( credentials=ga_credentials.AnonymousCredentials(), + transport=transport, ) - client = ProductSearchClient(transport=transport) - assert client.transport is transport + # send a request that will satisfy transcoding + request_init = {"parent": "projects/sample1/locations/sample2"} + request_init["product_set"] = { + "name": "name_value", + "display_name": "display_name_value", + "index_time": {"seconds": 751, "nanos": 543}, + "index_error": { + "code": 411, + "message": "message_value", + "details": [ + { + "type_url": "type.googleapis.com/google.protobuf.Duration", + "value": b"\x08\x0c\x10\xdb\x07", + } + ], + }, + } + request = request_type(**request_init) -def test_transport_get_channel(): - # A client may be instantiated with a custom transport instance. - transport = transports.ProductSearchGrpcTransport( + # Mock the http request call within the method and fake a BadRequest error. + with mock.patch.object(Session, "request") as req, pytest.raises( + core_exceptions.BadRequest + ): + # Wrap the value into a proper Response obj + response_value = Response() + response_value.status_code = 400 + response_value.request = Request() + req.return_value = response_value + client.create_product_set(request) + + +def test_create_product_set_rest_flattened(): + client = ProductSearchClient( credentials=ga_credentials.AnonymousCredentials(), + transport="rest", ) - channel = transport.grpc_channel - assert channel - transport = transports.ProductSearchGrpcAsyncIOTransport( + # Mock the http request call within the method and fake a response. + with mock.patch.object(type(client.transport._session), "request") as req: + # Designate an appropriate value for the returned response. + return_value = product_search_service.ProductSet() + + # get arguments that satisfy an http rule for this method + sample_request = {"parent": "projects/sample1/locations/sample2"} + + # get truthy value for each flattened field + mock_args = dict( + parent="parent_value", + product_set=product_search_service.ProductSet(name="name_value"), + product_set_id="product_set_id_value", + ) + mock_args.update(sample_request) + + # Wrap the value into a proper Response obj + response_value = Response() + response_value.status_code = 200 + pb_return_value = product_search_service.ProductSet.pb(return_value) + json_return_value = json_format.MessageToJson(pb_return_value) + response_value._content = json_return_value.encode("UTF-8") + req.return_value = response_value + + client.create_product_set(**mock_args) + + # Establish that the underlying call was made with the expected + # request object values. + assert len(req.mock_calls) == 1 + _, args, _ = req.mock_calls[0] + assert path_template.validate( + "%s/v1p3beta1/{parent=projects/*/locations/*}/productSets" + % client.transport._host, + args[1], + ) + + +def test_create_product_set_rest_flattened_error(transport: str = "rest"): + client = ProductSearchClient( credentials=ga_credentials.AnonymousCredentials(), + transport=transport, ) - channel = transport.grpc_channel - assert channel + + # Attempting to call a method with both a request object and flattened + # fields is an error. + with pytest.raises(ValueError): + client.create_product_set( + product_search_service.CreateProductSetRequest(), + parent="parent_value", + product_set=product_search_service.ProductSet(name="name_value"), + product_set_id="product_set_id_value", + ) -@pytest.mark.parametrize( - "transport_class", - [ - transports.ProductSearchGrpcTransport, - transports.ProductSearchGrpcAsyncIOTransport, - ], -) -def test_transport_adc(transport_class): - # Test default credentials are used if not provided. - with mock.patch.object(google.auth, "default") as adc: - adc.return_value = (ga_credentials.AnonymousCredentials(), None) - transport_class() - adc.assert_called_once() +def test_create_product_set_rest_error(): + client = ProductSearchClient( + credentials=ga_credentials.AnonymousCredentials(), transport="rest" + ) @pytest.mark.parametrize( - "transport_name", + "request_type", [ - "grpc", + product_search_service.ListProductSetsRequest, + dict, ], ) -def test_transport_kind(transport_name): - transport = ProductSearchClient.get_transport_class(transport_name)( - credentials=ga_credentials.AnonymousCredentials(), - ) - assert transport.kind == transport_name - - -def test_transport_grpc_default(): - # A client should use the gRPC transport by default. +def test_list_product_sets_rest(request_type): client = ProductSearchClient( credentials=ga_credentials.AnonymousCredentials(), - ) - assert isinstance( - client.transport, - transports.ProductSearchGrpcTransport, + transport="rest", ) + # send a request that will satisfy transcoding + request_init = {"parent": "projects/sample1/locations/sample2"} + request = request_type(**request_init) -def test_product_search_base_transport_error(): - # Passing both a credentials object and credentials_file should raise an error - with pytest.raises(core_exceptions.DuplicateCredentialArgs): - transport = transports.ProductSearchTransport( - credentials=ga_credentials.AnonymousCredentials(), - credentials_file="credentials.json", + # Mock the http request call within the method and fake a response. + with mock.patch.object(type(client.transport._session), "request") as req: + # Designate an appropriate value for the returned response. + return_value = product_search_service.ListProductSetsResponse( + next_page_token="next_page_token_value", ) - -def test_product_search_base_transport(): - # Instantiate the base transport. - with mock.patch( - "google.cloud.vision_v1p3beta1.services.product_search.transports.ProductSearchTransport.__init__" - ) as Transport: - Transport.return_value = None - transport = transports.ProductSearchTransport( - credentials=ga_credentials.AnonymousCredentials(), + # Wrap the value into a proper Response obj + response_value = Response() + response_value.status_code = 200 + pb_return_value = product_search_service.ListProductSetsResponse.pb( + return_value ) + json_return_value = json_format.MessageToJson(pb_return_value) - # Every method on the transport should just blindly - # raise NotImplementedError. - methods = ( - "create_product_set", - "list_product_sets", - "get_product_set", - "update_product_set", - "delete_product_set", - "create_product", - "list_products", - "get_product", - "update_product", - "delete_product", - "create_reference_image", - "delete_reference_image", - "list_reference_images", - "get_reference_image", - "add_product_to_product_set", - "remove_product_from_product_set", - "list_products_in_product_set", - "import_product_sets", + response_value._content = json_return_value.encode("UTF-8") + req.return_value = response_value + response = client.list_product_sets(request) + + # Establish that the response is the type that we expect. + assert isinstance(response, pagers.ListProductSetsPager) + assert response.next_page_token == "next_page_token_value" + + +def test_list_product_sets_rest_required_fields( + request_type=product_search_service.ListProductSetsRequest, +): + transport_class = transports.ProductSearchRestTransport + + request_init = {} + request_init["parent"] = "" + request = request_type(**request_init) + pb_request = request_type.pb(request) + jsonified_request = json.loads( + json_format.MessageToJson( + pb_request, + including_default_value_fields=False, + use_integers_for_enums=False, + ) ) - for method in methods: - with pytest.raises(NotImplementedError): - getattr(transport, method)(request=object()) - with pytest.raises(NotImplementedError): - transport.close() + # verify fields with default values are dropped - # Additionally, the LRO client (a property) should - # also raise NotImplementedError - with pytest.raises(NotImplementedError): - transport.operations_client + unset_fields = transport_class( + credentials=ga_credentials.AnonymousCredentials() + ).list_product_sets._get_unset_required_fields(jsonified_request) + jsonified_request.update(unset_fields) - # Catch all for all remaining methods and properties - remainder = [ - "kind", - ] - for r in remainder: - with pytest.raises(NotImplementedError): - getattr(transport, r)() + # verify required fields with default values are now present + jsonified_request["parent"] = "parent_value" -def test_product_search_base_transport_with_credentials_file(): - # 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.vision_v1p3beta1.services.product_search.transports.ProductSearchTransport._prep_wrapped_messages" - ) as Transport: - Transport.return_value = None - load_creds.return_value = (ga_credentials.AnonymousCredentials(), None) - transport = transports.ProductSearchTransport( - credentials_file="credentials.json", - quota_project_id="octopus", - ) - load_creds.assert_called_once_with( - "credentials.json", - scopes=None, - default_scopes=( - "https://www.googleapis.com/auth/cloud-platform", - "https://www.googleapis.com/auth/cloud-vision", - ), - quota_project_id="octopus", + unset_fields = transport_class( + credentials=ga_credentials.AnonymousCredentials() + ).list_product_sets._get_unset_required_fields(jsonified_request) + # Check that path parameters and body parameters are not mixing in. + assert not set(unset_fields) - set( + ( + "page_size", + "page_token", ) + ) + jsonified_request.update(unset_fields) + # verify required fields with non-default values are left alone + assert "parent" in jsonified_request + assert jsonified_request["parent"] == "parent_value" -def test_product_search_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( + client = ProductSearchClient( + credentials=ga_credentials.AnonymousCredentials(), + transport="rest", + ) + request = request_type(**request_init) + + # Designate an appropriate value for the returned response. + return_value = product_search_service.ListProductSetsResponse() + # Mock the http request call within the method and fake a response. + with mock.patch.object(Session, "request") as req: + # We need to mock transcode() because providing default values + # for required fields will fail the real version if the http_options + # expect actual values for those fields. + with mock.patch.object(path_template, "transcode") as transcode: + # A uri without fields and an empty body will force all the + # request fields to show up in the query_params. + pb_request = request_type.pb(request) + transcode_result = { + "uri": "v1/sample_method", + "method": "get", + "query_params": pb_request, + } + transcode.return_value = transcode_result + + response_value = Response() + response_value.status_code = 200 + + pb_return_value = product_search_service.ListProductSetsResponse.pb( + return_value + ) + json_return_value = json_format.MessageToJson(pb_return_value) + + response_value._content = json_return_value.encode("UTF-8") + req.return_value = response_value + + response = client.list_product_sets(request) + + expected_params = [("$alt", "json;enum-encoding=int")] + actual_params = req.call_args.kwargs["params"] + assert expected_params == actual_params + + +def test_list_product_sets_rest_unset_required_fields(): + transport = transports.ProductSearchRestTransport( + credentials=ga_credentials.AnonymousCredentials + ) + + unset_fields = transport.list_product_sets._get_unset_required_fields({}) + assert set(unset_fields) == ( + set( + ( + "pageSize", + "pageToken", + ) + ) + & set(("parent",)) + ) + + +@pytest.mark.parametrize("null_interceptor", [True, False]) +def test_list_product_sets_rest_interceptors(null_interceptor): + transport = transports.ProductSearchRestTransport( + credentials=ga_credentials.AnonymousCredentials(), + interceptor=None + if null_interceptor + else transports.ProductSearchRestInterceptor(), + ) + client = ProductSearchClient(transport=transport) + with mock.patch.object( + type(client.transport._session), "request" + ) as req, mock.patch.object( + path_template, "transcode" + ) as transcode, mock.patch.object( + transports.ProductSearchRestInterceptor, "post_list_product_sets" + ) as post, mock.patch.object( + transports.ProductSearchRestInterceptor, "pre_list_product_sets" + ) as pre: + pre.assert_not_called() + post.assert_not_called() + pb_message = product_search_service.ListProductSetsRequest.pb( + product_search_service.ListProductSetsRequest() + ) + transcode.return_value = { + "method": "post", + "uri": "my_uri", + "body": pb_message, + "query_params": pb_message, + } + + req.return_value = Response() + req.return_value.status_code = 200 + req.return_value.request = PreparedRequest() + req.return_value._content = ( + product_search_service.ListProductSetsResponse.to_json( + product_search_service.ListProductSetsResponse() + ) + ) + + request = product_search_service.ListProductSetsRequest() + metadata = [ + ("key", "val"), + ("cephalopod", "squid"), + ] + pre.return_value = request, metadata + post.return_value = product_search_service.ListProductSetsResponse() + + client.list_product_sets( + request, + metadata=[ + ("key", "val"), + ("cephalopod", "squid"), + ], + ) + + pre.assert_called_once() + post.assert_called_once() + + +def test_list_product_sets_rest_bad_request( + transport: str = "rest", request_type=product_search_service.ListProductSetsRequest +): + client = ProductSearchClient( + credentials=ga_credentials.AnonymousCredentials(), + transport=transport, + ) + + # send a request that will satisfy transcoding + request_init = {"parent": "projects/sample1/locations/sample2"} + request = request_type(**request_init) + + # Mock the http request call within the method and fake a BadRequest error. + with mock.patch.object(Session, "request") as req, pytest.raises( + core_exceptions.BadRequest + ): + # Wrap the value into a proper Response obj + response_value = Response() + response_value.status_code = 400 + response_value.request = Request() + req.return_value = response_value + client.list_product_sets(request) + + +def test_list_product_sets_rest_flattened(): + client = ProductSearchClient( + credentials=ga_credentials.AnonymousCredentials(), + transport="rest", + ) + + # Mock the http request call within the method and fake a response. + with mock.patch.object(type(client.transport._session), "request") as req: + # Designate an appropriate value for the returned response. + return_value = product_search_service.ListProductSetsResponse() + + # get arguments that satisfy an http rule for this method + sample_request = {"parent": "projects/sample1/locations/sample2"} + + # get truthy value for each flattened field + mock_args = dict( + parent="parent_value", + ) + mock_args.update(sample_request) + + # Wrap the value into a proper Response obj + response_value = Response() + response_value.status_code = 200 + pb_return_value = product_search_service.ListProductSetsResponse.pb( + return_value + ) + json_return_value = json_format.MessageToJson(pb_return_value) + response_value._content = json_return_value.encode("UTF-8") + req.return_value = response_value + + client.list_product_sets(**mock_args) + + # Establish that the underlying call was made with the expected + # request object values. + assert len(req.mock_calls) == 1 + _, args, _ = req.mock_calls[0] + assert path_template.validate( + "%s/v1p3beta1/{parent=projects/*/locations/*}/productSets" + % client.transport._host, + args[1], + ) + + +def test_list_product_sets_rest_flattened_error(transport: str = "rest"): + client = ProductSearchClient( + credentials=ga_credentials.AnonymousCredentials(), + transport=transport, + ) + + # Attempting to call a method with both a request object and flattened + # fields is an error. + with pytest.raises(ValueError): + client.list_product_sets( + product_search_service.ListProductSetsRequest(), + parent="parent_value", + ) + + +def test_list_product_sets_rest_pager(transport: str = "rest"): + client = ProductSearchClient( + credentials=ga_credentials.AnonymousCredentials(), + transport=transport, + ) + + # Mock the http request call within the method and fake a response. + with mock.patch.object(Session, "request") as req: + # TODO(kbandes): remove this mock unless there's a good reason for it. + # with mock.patch.object(path_template, 'transcode') as transcode: + # Set the response as a series of pages + response = ( + product_search_service.ListProductSetsResponse( + product_sets=[ + product_search_service.ProductSet(), + product_search_service.ProductSet(), + product_search_service.ProductSet(), + ], + next_page_token="abc", + ), + product_search_service.ListProductSetsResponse( + product_sets=[], + next_page_token="def", + ), + product_search_service.ListProductSetsResponse( + product_sets=[ + product_search_service.ProductSet(), + ], + next_page_token="ghi", + ), + product_search_service.ListProductSetsResponse( + product_sets=[ + product_search_service.ProductSet(), + product_search_service.ProductSet(), + ], + ), + ) + # Two responses for two calls + response = response + response + + # Wrap the values into proper Response objs + response = tuple( + product_search_service.ListProductSetsResponse.to_json(x) for x in response + ) + return_values = tuple(Response() for i in response) + for return_val, response_val in zip(return_values, response): + return_val._content = response_val.encode("UTF-8") + return_val.status_code = 200 + req.side_effect = return_values + + sample_request = {"parent": "projects/sample1/locations/sample2"} + + pager = client.list_product_sets(request=sample_request) + + results = list(pager) + assert len(results) == 6 + assert all(isinstance(i, product_search_service.ProductSet) for i in results) + + pages = list(client.list_product_sets(request=sample_request).pages) + for page_, token in zip(pages, ["abc", "def", "ghi", ""]): + assert page_.raw_page.next_page_token == token + + +@pytest.mark.parametrize( + "request_type", + [ + product_search_service.GetProductSetRequest, + dict, + ], +) +def test_get_product_set_rest(request_type): + client = ProductSearchClient( + credentials=ga_credentials.AnonymousCredentials(), + transport="rest", + ) + + # send a request that will satisfy transcoding + request_init = {"name": "projects/sample1/locations/sample2/productSets/sample3"} + request = request_type(**request_init) + + # Mock the http request call within the method and fake a response. + with mock.patch.object(type(client.transport._session), "request") as req: + # Designate an appropriate value for the returned response. + return_value = product_search_service.ProductSet( + name="name_value", + display_name="display_name_value", + ) + + # Wrap the value into a proper Response obj + response_value = Response() + response_value.status_code = 200 + pb_return_value = product_search_service.ProductSet.pb(return_value) + json_return_value = json_format.MessageToJson(pb_return_value) + + response_value._content = json_return_value.encode("UTF-8") + req.return_value = response_value + response = client.get_product_set(request) + + # Establish that the response is the type that we expect. + assert isinstance(response, product_search_service.ProductSet) + assert response.name == "name_value" + assert response.display_name == "display_name_value" + + +def test_get_product_set_rest_required_fields( + request_type=product_search_service.GetProductSetRequest, +): + transport_class = transports.ProductSearchRestTransport + + request_init = {} + request_init["name"] = "" + request = request_type(**request_init) + pb_request = request_type.pb(request) + jsonified_request = json.loads( + json_format.MessageToJson( + pb_request, + including_default_value_fields=False, + use_integers_for_enums=False, + ) + ) + + # verify fields with default values are dropped + + unset_fields = transport_class( + credentials=ga_credentials.AnonymousCredentials() + ).get_product_set._get_unset_required_fields(jsonified_request) + jsonified_request.update(unset_fields) + + # verify required fields with default values are now present + + jsonified_request["name"] = "name_value" + + unset_fields = transport_class( + credentials=ga_credentials.AnonymousCredentials() + ).get_product_set._get_unset_required_fields(jsonified_request) + jsonified_request.update(unset_fields) + + # verify required fields with non-default values are left alone + assert "name" in jsonified_request + assert jsonified_request["name"] == "name_value" + + client = ProductSearchClient( + credentials=ga_credentials.AnonymousCredentials(), + transport="rest", + ) + request = request_type(**request_init) + + # Designate an appropriate value for the returned response. + return_value = product_search_service.ProductSet() + # Mock the http request call within the method and fake a response. + with mock.patch.object(Session, "request") as req: + # We need to mock transcode() because providing default values + # for required fields will fail the real version if the http_options + # expect actual values for those fields. + with mock.patch.object(path_template, "transcode") as transcode: + # A uri without fields and an empty body will force all the + # request fields to show up in the query_params. + pb_request = request_type.pb(request) + transcode_result = { + "uri": "v1/sample_method", + "method": "get", + "query_params": pb_request, + } + transcode.return_value = transcode_result + + response_value = Response() + response_value.status_code = 200 + + pb_return_value = product_search_service.ProductSet.pb(return_value) + json_return_value = json_format.MessageToJson(pb_return_value) + + response_value._content = json_return_value.encode("UTF-8") + req.return_value = response_value + + response = client.get_product_set(request) + + expected_params = [("$alt", "json;enum-encoding=int")] + actual_params = req.call_args.kwargs["params"] + assert expected_params == actual_params + + +def test_get_product_set_rest_unset_required_fields(): + transport = transports.ProductSearchRestTransport( + credentials=ga_credentials.AnonymousCredentials + ) + + unset_fields = transport.get_product_set._get_unset_required_fields({}) + assert set(unset_fields) == (set(()) & set(("name",))) + + +@pytest.mark.parametrize("null_interceptor", [True, False]) +def test_get_product_set_rest_interceptors(null_interceptor): + transport = transports.ProductSearchRestTransport( + credentials=ga_credentials.AnonymousCredentials(), + interceptor=None + if null_interceptor + else transports.ProductSearchRestInterceptor(), + ) + client = ProductSearchClient(transport=transport) + with mock.patch.object( + type(client.transport._session), "request" + ) as req, mock.patch.object( + path_template, "transcode" + ) as transcode, mock.patch.object( + transports.ProductSearchRestInterceptor, "post_get_product_set" + ) as post, mock.patch.object( + transports.ProductSearchRestInterceptor, "pre_get_product_set" + ) as pre: + pre.assert_not_called() + post.assert_not_called() + pb_message = product_search_service.GetProductSetRequest.pb( + product_search_service.GetProductSetRequest() + ) + transcode.return_value = { + "method": "post", + "uri": "my_uri", + "body": pb_message, + "query_params": pb_message, + } + + req.return_value = Response() + req.return_value.status_code = 200 + req.return_value.request = PreparedRequest() + req.return_value._content = product_search_service.ProductSet.to_json( + product_search_service.ProductSet() + ) + + request = product_search_service.GetProductSetRequest() + metadata = [ + ("key", "val"), + ("cephalopod", "squid"), + ] + pre.return_value = request, metadata + post.return_value = product_search_service.ProductSet() + + client.get_product_set( + request, + metadata=[ + ("key", "val"), + ("cephalopod", "squid"), + ], + ) + + pre.assert_called_once() + post.assert_called_once() + + +def test_get_product_set_rest_bad_request( + transport: str = "rest", request_type=product_search_service.GetProductSetRequest +): + client = ProductSearchClient( + credentials=ga_credentials.AnonymousCredentials(), + transport=transport, + ) + + # send a request that will satisfy transcoding + request_init = {"name": "projects/sample1/locations/sample2/productSets/sample3"} + request = request_type(**request_init) + + # Mock the http request call within the method and fake a BadRequest error. + with mock.patch.object(Session, "request") as req, pytest.raises( + core_exceptions.BadRequest + ): + # Wrap the value into a proper Response obj + response_value = Response() + response_value.status_code = 400 + response_value.request = Request() + req.return_value = response_value + client.get_product_set(request) + + +def test_get_product_set_rest_flattened(): + client = ProductSearchClient( + credentials=ga_credentials.AnonymousCredentials(), + transport="rest", + ) + + # Mock the http request call within the method and fake a response. + with mock.patch.object(type(client.transport._session), "request") as req: + # Designate an appropriate value for the returned response. + return_value = product_search_service.ProductSet() + + # get arguments that satisfy an http rule for this method + sample_request = { + "name": "projects/sample1/locations/sample2/productSets/sample3" + } + + # get truthy value for each flattened field + mock_args = dict( + name="name_value", + ) + mock_args.update(sample_request) + + # Wrap the value into a proper Response obj + response_value = Response() + response_value.status_code = 200 + pb_return_value = product_search_service.ProductSet.pb(return_value) + json_return_value = json_format.MessageToJson(pb_return_value) + response_value._content = json_return_value.encode("UTF-8") + req.return_value = response_value + + client.get_product_set(**mock_args) + + # Establish that the underlying call was made with the expected + # request object values. + assert len(req.mock_calls) == 1 + _, args, _ = req.mock_calls[0] + assert path_template.validate( + "%s/v1p3beta1/{name=projects/*/locations/*/productSets/*}" + % client.transport._host, + args[1], + ) + + +def test_get_product_set_rest_flattened_error(transport: str = "rest"): + client = ProductSearchClient( + credentials=ga_credentials.AnonymousCredentials(), + transport=transport, + ) + + # Attempting to call a method with both a request object and flattened + # fields is an error. + with pytest.raises(ValueError): + client.get_product_set( + product_search_service.GetProductSetRequest(), + name="name_value", + ) + + +def test_get_product_set_rest_error(): + client = ProductSearchClient( + credentials=ga_credentials.AnonymousCredentials(), transport="rest" + ) + + +@pytest.mark.parametrize( + "request_type", + [ + product_search_service.UpdateProductSetRequest, + dict, + ], +) +def test_update_product_set_rest(request_type): + client = ProductSearchClient( + credentials=ga_credentials.AnonymousCredentials(), + transport="rest", + ) + + # send a request that will satisfy transcoding + request_init = { + "product_set": { + "name": "projects/sample1/locations/sample2/productSets/sample3" + } + } + request_init["product_set"] = { + "name": "projects/sample1/locations/sample2/productSets/sample3", + "display_name": "display_name_value", + "index_time": {"seconds": 751, "nanos": 543}, + "index_error": { + "code": 411, + "message": "message_value", + "details": [ + { + "type_url": "type.googleapis.com/google.protobuf.Duration", + "value": b"\x08\x0c\x10\xdb\x07", + } + ], + }, + } + request = request_type(**request_init) + + # Mock the http request call within the method and fake a response. + with mock.patch.object(type(client.transport._session), "request") as req: + # Designate an appropriate value for the returned response. + return_value = product_search_service.ProductSet( + name="name_value", + display_name="display_name_value", + ) + + # Wrap the value into a proper Response obj + response_value = Response() + response_value.status_code = 200 + pb_return_value = product_search_service.ProductSet.pb(return_value) + json_return_value = json_format.MessageToJson(pb_return_value) + + response_value._content = json_return_value.encode("UTF-8") + req.return_value = response_value + response = client.update_product_set(request) + + # Establish that the response is the type that we expect. + assert isinstance(response, product_search_service.ProductSet) + assert response.name == "name_value" + assert response.display_name == "display_name_value" + + +def test_update_product_set_rest_required_fields( + request_type=product_search_service.UpdateProductSetRequest, +): + transport_class = transports.ProductSearchRestTransport + + request_init = {} + request = request_type(**request_init) + pb_request = request_type.pb(request) + jsonified_request = json.loads( + json_format.MessageToJson( + pb_request, + including_default_value_fields=False, + use_integers_for_enums=False, + ) + ) + + # verify fields with default values are dropped + + unset_fields = transport_class( + credentials=ga_credentials.AnonymousCredentials() + ).update_product_set._get_unset_required_fields(jsonified_request) + jsonified_request.update(unset_fields) + + # verify required fields with default values are now present + + unset_fields = transport_class( + credentials=ga_credentials.AnonymousCredentials() + ).update_product_set._get_unset_required_fields(jsonified_request) + # Check that path parameters and body parameters are not mixing in. + assert not set(unset_fields) - set(("update_mask",)) + jsonified_request.update(unset_fields) + + # verify required fields with non-default values are left alone + + client = ProductSearchClient( + credentials=ga_credentials.AnonymousCredentials(), + transport="rest", + ) + request = request_type(**request_init) + + # Designate an appropriate value for the returned response. + return_value = product_search_service.ProductSet() + # Mock the http request call within the method and fake a response. + with mock.patch.object(Session, "request") as req: + # We need to mock transcode() because providing default values + # for required fields will fail the real version if the http_options + # expect actual values for those fields. + with mock.patch.object(path_template, "transcode") as transcode: + # A uri without fields and an empty body will force all the + # request fields to show up in the query_params. + pb_request = request_type.pb(request) + transcode_result = { + "uri": "v1/sample_method", + "method": "patch", + "query_params": pb_request, + } + transcode_result["body"] = pb_request + transcode.return_value = transcode_result + + response_value = Response() + response_value.status_code = 200 + + pb_return_value = product_search_service.ProductSet.pb(return_value) + json_return_value = json_format.MessageToJson(pb_return_value) + + response_value._content = json_return_value.encode("UTF-8") + req.return_value = response_value + + response = client.update_product_set(request) + + expected_params = [("$alt", "json;enum-encoding=int")] + actual_params = req.call_args.kwargs["params"] + assert expected_params == actual_params + + +def test_update_product_set_rest_unset_required_fields(): + transport = transports.ProductSearchRestTransport( + credentials=ga_credentials.AnonymousCredentials + ) + + unset_fields = transport.update_product_set._get_unset_required_fields({}) + assert set(unset_fields) == (set(("updateMask",)) & set(("productSet",))) + + +@pytest.mark.parametrize("null_interceptor", [True, False]) +def test_update_product_set_rest_interceptors(null_interceptor): + transport = transports.ProductSearchRestTransport( + credentials=ga_credentials.AnonymousCredentials(), + interceptor=None + if null_interceptor + else transports.ProductSearchRestInterceptor(), + ) + client = ProductSearchClient(transport=transport) + with mock.patch.object( + type(client.transport._session), "request" + ) as req, mock.patch.object( + path_template, "transcode" + ) as transcode, mock.patch.object( + transports.ProductSearchRestInterceptor, "post_update_product_set" + ) as post, mock.patch.object( + transports.ProductSearchRestInterceptor, "pre_update_product_set" + ) as pre: + pre.assert_not_called() + post.assert_not_called() + pb_message = product_search_service.UpdateProductSetRequest.pb( + product_search_service.UpdateProductSetRequest() + ) + transcode.return_value = { + "method": "post", + "uri": "my_uri", + "body": pb_message, + "query_params": pb_message, + } + + req.return_value = Response() + req.return_value.status_code = 200 + req.return_value.request = PreparedRequest() + req.return_value._content = product_search_service.ProductSet.to_json( + product_search_service.ProductSet() + ) + + request = product_search_service.UpdateProductSetRequest() + metadata = [ + ("key", "val"), + ("cephalopod", "squid"), + ] + pre.return_value = request, metadata + post.return_value = product_search_service.ProductSet() + + client.update_product_set( + request, + metadata=[ + ("key", "val"), + ("cephalopod", "squid"), + ], + ) + + pre.assert_called_once() + post.assert_called_once() + + +def test_update_product_set_rest_bad_request( + transport: str = "rest", request_type=product_search_service.UpdateProductSetRequest +): + client = ProductSearchClient( + credentials=ga_credentials.AnonymousCredentials(), + transport=transport, + ) + + # send a request that will satisfy transcoding + request_init = { + "product_set": { + "name": "projects/sample1/locations/sample2/productSets/sample3" + } + } + request_init["product_set"] = { + "name": "projects/sample1/locations/sample2/productSets/sample3", + "display_name": "display_name_value", + "index_time": {"seconds": 751, "nanos": 543}, + "index_error": { + "code": 411, + "message": "message_value", + "details": [ + { + "type_url": "type.googleapis.com/google.protobuf.Duration", + "value": b"\x08\x0c\x10\xdb\x07", + } + ], + }, + } + request = request_type(**request_init) + + # Mock the http request call within the method and fake a BadRequest error. + with mock.patch.object(Session, "request") as req, pytest.raises( + core_exceptions.BadRequest + ): + # Wrap the value into a proper Response obj + response_value = Response() + response_value.status_code = 400 + response_value.request = Request() + req.return_value = response_value + client.update_product_set(request) + + +def test_update_product_set_rest_flattened(): + client = ProductSearchClient( + credentials=ga_credentials.AnonymousCredentials(), + transport="rest", + ) + + # Mock the http request call within the method and fake a response. + with mock.patch.object(type(client.transport._session), "request") as req: + # Designate an appropriate value for the returned response. + return_value = product_search_service.ProductSet() + + # get arguments that satisfy an http rule for this method + sample_request = { + "product_set": { + "name": "projects/sample1/locations/sample2/productSets/sample3" + } + } + + # get truthy value for each flattened field + mock_args = dict( + product_set=product_search_service.ProductSet(name="name_value"), + update_mask=field_mask_pb2.FieldMask(paths=["paths_value"]), + ) + mock_args.update(sample_request) + + # Wrap the value into a proper Response obj + response_value = Response() + response_value.status_code = 200 + pb_return_value = product_search_service.ProductSet.pb(return_value) + json_return_value = json_format.MessageToJson(pb_return_value) + response_value._content = json_return_value.encode("UTF-8") + req.return_value = response_value + + client.update_product_set(**mock_args) + + # Establish that the underlying call was made with the expected + # request object values. + assert len(req.mock_calls) == 1 + _, args, _ = req.mock_calls[0] + assert path_template.validate( + "%s/v1p3beta1/{product_set.name=projects/*/locations/*/productSets/*}" + % client.transport._host, + args[1], + ) + + +def test_update_product_set_rest_flattened_error(transport: str = "rest"): + client = ProductSearchClient( + credentials=ga_credentials.AnonymousCredentials(), + transport=transport, + ) + + # Attempting to call a method with both a request object and flattened + # fields is an error. + with pytest.raises(ValueError): + client.update_product_set( + product_search_service.UpdateProductSetRequest(), + product_set=product_search_service.ProductSet(name="name_value"), + update_mask=field_mask_pb2.FieldMask(paths=["paths_value"]), + ) + + +def test_update_product_set_rest_error(): + client = ProductSearchClient( + credentials=ga_credentials.AnonymousCredentials(), transport="rest" + ) + + +@pytest.mark.parametrize( + "request_type", + [ + product_search_service.DeleteProductSetRequest, + dict, + ], +) +def test_delete_product_set_rest(request_type): + client = ProductSearchClient( + credentials=ga_credentials.AnonymousCredentials(), + transport="rest", + ) + + # send a request that will satisfy transcoding + request_init = {"name": "projects/sample1/locations/sample2/productSets/sample3"} + request = request_type(**request_init) + + # Mock the http request call within the method and fake a response. + with mock.patch.object(type(client.transport._session), "request") as req: + # Designate an appropriate value for the returned response. + return_value = None + + # Wrap the value into a proper Response obj + response_value = Response() + response_value.status_code = 200 + json_return_value = "" + + response_value._content = json_return_value.encode("UTF-8") + req.return_value = response_value + response = client.delete_product_set(request) + + # Establish that the response is the type that we expect. + assert response is None + + +def test_delete_product_set_rest_required_fields( + request_type=product_search_service.DeleteProductSetRequest, +): + transport_class = transports.ProductSearchRestTransport + + request_init = {} + request_init["name"] = "" + request = request_type(**request_init) + pb_request = request_type.pb(request) + jsonified_request = json.loads( + json_format.MessageToJson( + pb_request, + including_default_value_fields=False, + use_integers_for_enums=False, + ) + ) + + # verify fields with default values are dropped + + unset_fields = transport_class( + credentials=ga_credentials.AnonymousCredentials() + ).delete_product_set._get_unset_required_fields(jsonified_request) + jsonified_request.update(unset_fields) + + # verify required fields with default values are now present + + jsonified_request["name"] = "name_value" + + unset_fields = transport_class( + credentials=ga_credentials.AnonymousCredentials() + ).delete_product_set._get_unset_required_fields(jsonified_request) + jsonified_request.update(unset_fields) + + # verify required fields with non-default values are left alone + assert "name" in jsonified_request + assert jsonified_request["name"] == "name_value" + + client = ProductSearchClient( + credentials=ga_credentials.AnonymousCredentials(), + transport="rest", + ) + request = request_type(**request_init) + + # Designate an appropriate value for the returned response. + return_value = None + # Mock the http request call within the method and fake a response. + with mock.patch.object(Session, "request") as req: + # We need to mock transcode() because providing default values + # for required fields will fail the real version if the http_options + # expect actual values for those fields. + with mock.patch.object(path_template, "transcode") as transcode: + # A uri without fields and an empty body will force all the + # request fields to show up in the query_params. + pb_request = request_type.pb(request) + transcode_result = { + "uri": "v1/sample_method", + "method": "delete", + "query_params": pb_request, + } + transcode.return_value = transcode_result + + response_value = Response() + response_value.status_code = 200 + json_return_value = "" + + response_value._content = json_return_value.encode("UTF-8") + req.return_value = response_value + + response = client.delete_product_set(request) + + expected_params = [("$alt", "json;enum-encoding=int")] + actual_params = req.call_args.kwargs["params"] + assert expected_params == actual_params + + +def test_delete_product_set_rest_unset_required_fields(): + transport = transports.ProductSearchRestTransport( + credentials=ga_credentials.AnonymousCredentials + ) + + unset_fields = transport.delete_product_set._get_unset_required_fields({}) + assert set(unset_fields) == (set(()) & set(("name",))) + + +@pytest.mark.parametrize("null_interceptor", [True, False]) +def test_delete_product_set_rest_interceptors(null_interceptor): + transport = transports.ProductSearchRestTransport( + credentials=ga_credentials.AnonymousCredentials(), + interceptor=None + if null_interceptor + else transports.ProductSearchRestInterceptor(), + ) + client = ProductSearchClient(transport=transport) + with mock.patch.object( + type(client.transport._session), "request" + ) as req, mock.patch.object( + path_template, "transcode" + ) as transcode, mock.patch.object( + transports.ProductSearchRestInterceptor, "pre_delete_product_set" + ) as pre: + pre.assert_not_called() + pb_message = product_search_service.DeleteProductSetRequest.pb( + product_search_service.DeleteProductSetRequest() + ) + transcode.return_value = { + "method": "post", + "uri": "my_uri", + "body": pb_message, + "query_params": pb_message, + } + + req.return_value = Response() + req.return_value.status_code = 200 + req.return_value.request = PreparedRequest() + + request = product_search_service.DeleteProductSetRequest() + metadata = [ + ("key", "val"), + ("cephalopod", "squid"), + ] + pre.return_value = request, metadata + + client.delete_product_set( + request, + metadata=[ + ("key", "val"), + ("cephalopod", "squid"), + ], + ) + + pre.assert_called_once() + + +def test_delete_product_set_rest_bad_request( + transport: str = "rest", request_type=product_search_service.DeleteProductSetRequest +): + client = ProductSearchClient( + credentials=ga_credentials.AnonymousCredentials(), + transport=transport, + ) + + # send a request that will satisfy transcoding + request_init = {"name": "projects/sample1/locations/sample2/productSets/sample3"} + request = request_type(**request_init) + + # Mock the http request call within the method and fake a BadRequest error. + with mock.patch.object(Session, "request") as req, pytest.raises( + core_exceptions.BadRequest + ): + # Wrap the value into a proper Response obj + response_value = Response() + response_value.status_code = 400 + response_value.request = Request() + req.return_value = response_value + client.delete_product_set(request) + + +def test_delete_product_set_rest_flattened(): + client = ProductSearchClient( + credentials=ga_credentials.AnonymousCredentials(), + transport="rest", + ) + + # Mock the http request call within the method and fake a response. + with mock.patch.object(type(client.transport._session), "request") as req: + # Designate an appropriate value for the returned response. + return_value = None + + # get arguments that satisfy an http rule for this method + sample_request = { + "name": "projects/sample1/locations/sample2/productSets/sample3" + } + + # get truthy value for each flattened field + mock_args = dict( + name="name_value", + ) + mock_args.update(sample_request) + + # Wrap the value into a proper Response obj + response_value = Response() + response_value.status_code = 200 + json_return_value = "" + response_value._content = json_return_value.encode("UTF-8") + req.return_value = response_value + + client.delete_product_set(**mock_args) + + # Establish that the underlying call was made with the expected + # request object values. + assert len(req.mock_calls) == 1 + _, args, _ = req.mock_calls[0] + assert path_template.validate( + "%s/v1p3beta1/{name=projects/*/locations/*/productSets/*}" + % client.transport._host, + args[1], + ) + + +def test_delete_product_set_rest_flattened_error(transport: str = "rest"): + client = ProductSearchClient( + credentials=ga_credentials.AnonymousCredentials(), + transport=transport, + ) + + # Attempting to call a method with both a request object and flattened + # fields is an error. + with pytest.raises(ValueError): + client.delete_product_set( + product_search_service.DeleteProductSetRequest(), + name="name_value", + ) + + +def test_delete_product_set_rest_error(): + client = ProductSearchClient( + credentials=ga_credentials.AnonymousCredentials(), transport="rest" + ) + + +@pytest.mark.parametrize( + "request_type", + [ + product_search_service.CreateProductRequest, + dict, + ], +) +def test_create_product_rest(request_type): + client = ProductSearchClient( + credentials=ga_credentials.AnonymousCredentials(), + transport="rest", + ) + + # send a request that will satisfy transcoding + request_init = {"parent": "projects/sample1/locations/sample2"} + request_init["product"] = { + "name": "name_value", + "display_name": "display_name_value", + "description": "description_value", + "product_category": "product_category_value", + "product_labels": [{"key": "key_value", "value": "value_value"}], + } + request = request_type(**request_init) + + # Mock the http request call within the method and fake a response. + with mock.patch.object(type(client.transport._session), "request") as req: + # Designate an appropriate value for the returned response. + return_value = product_search_service.Product( + name="name_value", + display_name="display_name_value", + description="description_value", + product_category="product_category_value", + ) + + # Wrap the value into a proper Response obj + response_value = Response() + response_value.status_code = 200 + pb_return_value = product_search_service.Product.pb(return_value) + json_return_value = json_format.MessageToJson(pb_return_value) + + response_value._content = json_return_value.encode("UTF-8") + req.return_value = response_value + response = client.create_product(request) + + # Establish that the response is the type that we expect. + assert isinstance(response, product_search_service.Product) + assert response.name == "name_value" + assert response.display_name == "display_name_value" + assert response.description == "description_value" + assert response.product_category == "product_category_value" + + +def test_create_product_rest_required_fields( + request_type=product_search_service.CreateProductRequest, +): + transport_class = transports.ProductSearchRestTransport + + request_init = {} + request_init["parent"] = "" + request = request_type(**request_init) + pb_request = request_type.pb(request) + jsonified_request = json.loads( + json_format.MessageToJson( + pb_request, + including_default_value_fields=False, + use_integers_for_enums=False, + ) + ) + + # verify fields with default values are dropped + + unset_fields = transport_class( + credentials=ga_credentials.AnonymousCredentials() + ).create_product._get_unset_required_fields(jsonified_request) + jsonified_request.update(unset_fields) + + # verify required fields with default values are now present + + jsonified_request["parent"] = "parent_value" + + unset_fields = transport_class( + credentials=ga_credentials.AnonymousCredentials() + ).create_product._get_unset_required_fields(jsonified_request) + # Check that path parameters and body parameters are not mixing in. + assert not set(unset_fields) - set(("product_id",)) + jsonified_request.update(unset_fields) + + # verify required fields with non-default values are left alone + assert "parent" in jsonified_request + assert jsonified_request["parent"] == "parent_value" + + client = ProductSearchClient( + credentials=ga_credentials.AnonymousCredentials(), + transport="rest", + ) + request = request_type(**request_init) + + # Designate an appropriate value for the returned response. + return_value = product_search_service.Product() + # Mock the http request call within the method and fake a response. + with mock.patch.object(Session, "request") as req: + # We need to mock transcode() because providing default values + # for required fields will fail the real version if the http_options + # expect actual values for those fields. + with mock.patch.object(path_template, "transcode") as transcode: + # A uri without fields and an empty body will force all the + # request fields to show up in the query_params. + pb_request = request_type.pb(request) + transcode_result = { + "uri": "v1/sample_method", + "method": "post", + "query_params": pb_request, + } + transcode_result["body"] = pb_request + transcode.return_value = transcode_result + + response_value = Response() + response_value.status_code = 200 + + pb_return_value = product_search_service.Product.pb(return_value) + json_return_value = json_format.MessageToJson(pb_return_value) + + response_value._content = json_return_value.encode("UTF-8") + req.return_value = response_value + + response = client.create_product(request) + + expected_params = [("$alt", "json;enum-encoding=int")] + actual_params = req.call_args.kwargs["params"] + assert expected_params == actual_params + + +def test_create_product_rest_unset_required_fields(): + transport = transports.ProductSearchRestTransport( + credentials=ga_credentials.AnonymousCredentials + ) + + unset_fields = transport.create_product._get_unset_required_fields({}) + assert set(unset_fields) == ( + set(("productId",)) + & set( + ( + "parent", + "product", + ) + ) + ) + + +@pytest.mark.parametrize("null_interceptor", [True, False]) +def test_create_product_rest_interceptors(null_interceptor): + transport = transports.ProductSearchRestTransport( + credentials=ga_credentials.AnonymousCredentials(), + interceptor=None + if null_interceptor + else transports.ProductSearchRestInterceptor(), + ) + client = ProductSearchClient(transport=transport) + with mock.patch.object( + type(client.transport._session), "request" + ) as req, mock.patch.object( + path_template, "transcode" + ) as transcode, mock.patch.object( + transports.ProductSearchRestInterceptor, "post_create_product" + ) as post, mock.patch.object( + transports.ProductSearchRestInterceptor, "pre_create_product" + ) as pre: + pre.assert_not_called() + post.assert_not_called() + pb_message = product_search_service.CreateProductRequest.pb( + product_search_service.CreateProductRequest() + ) + transcode.return_value = { + "method": "post", + "uri": "my_uri", + "body": pb_message, + "query_params": pb_message, + } + + req.return_value = Response() + req.return_value.status_code = 200 + req.return_value.request = PreparedRequest() + req.return_value._content = product_search_service.Product.to_json( + product_search_service.Product() + ) + + request = product_search_service.CreateProductRequest() + metadata = [ + ("key", "val"), + ("cephalopod", "squid"), + ] + pre.return_value = request, metadata + post.return_value = product_search_service.Product() + + client.create_product( + request, + metadata=[ + ("key", "val"), + ("cephalopod", "squid"), + ], + ) + + pre.assert_called_once() + post.assert_called_once() + + +def test_create_product_rest_bad_request( + transport: str = "rest", request_type=product_search_service.CreateProductRequest +): + client = ProductSearchClient( + credentials=ga_credentials.AnonymousCredentials(), + transport=transport, + ) + + # send a request that will satisfy transcoding + request_init = {"parent": "projects/sample1/locations/sample2"} + request_init["product"] = { + "name": "name_value", + "display_name": "display_name_value", + "description": "description_value", + "product_category": "product_category_value", + "product_labels": [{"key": "key_value", "value": "value_value"}], + } + request = request_type(**request_init) + + # Mock the http request call within the method and fake a BadRequest error. + with mock.patch.object(Session, "request") as req, pytest.raises( + core_exceptions.BadRequest + ): + # Wrap the value into a proper Response obj + response_value = Response() + response_value.status_code = 400 + response_value.request = Request() + req.return_value = response_value + client.create_product(request) + + +def test_create_product_rest_flattened(): + client = ProductSearchClient( + credentials=ga_credentials.AnonymousCredentials(), + transport="rest", + ) + + # Mock the http request call within the method and fake a response. + with mock.patch.object(type(client.transport._session), "request") as req: + # Designate an appropriate value for the returned response. + return_value = product_search_service.Product() + + # get arguments that satisfy an http rule for this method + sample_request = {"parent": "projects/sample1/locations/sample2"} + + # get truthy value for each flattened field + mock_args = dict( + parent="parent_value", + product=product_search_service.Product(name="name_value"), + product_id="product_id_value", + ) + mock_args.update(sample_request) + + # Wrap the value into a proper Response obj + response_value = Response() + response_value.status_code = 200 + pb_return_value = product_search_service.Product.pb(return_value) + json_return_value = json_format.MessageToJson(pb_return_value) + response_value._content = json_return_value.encode("UTF-8") + req.return_value = response_value + + client.create_product(**mock_args) + + # Establish that the underlying call was made with the expected + # request object values. + assert len(req.mock_calls) == 1 + _, args, _ = req.mock_calls[0] + assert path_template.validate( + "%s/v1p3beta1/{parent=projects/*/locations/*}/products" + % client.transport._host, + args[1], + ) + + +def test_create_product_rest_flattened_error(transport: str = "rest"): + client = ProductSearchClient( + credentials=ga_credentials.AnonymousCredentials(), + transport=transport, + ) + + # Attempting to call a method with both a request object and flattened + # fields is an error. + with pytest.raises(ValueError): + client.create_product( + product_search_service.CreateProductRequest(), + parent="parent_value", + product=product_search_service.Product(name="name_value"), + product_id="product_id_value", + ) + + +def test_create_product_rest_error(): + client = ProductSearchClient( + credentials=ga_credentials.AnonymousCredentials(), transport="rest" + ) + + +@pytest.mark.parametrize( + "request_type", + [ + product_search_service.ListProductsRequest, + dict, + ], +) +def test_list_products_rest(request_type): + client = ProductSearchClient( + credentials=ga_credentials.AnonymousCredentials(), + transport="rest", + ) + + # send a request that will satisfy transcoding + request_init = {"parent": "projects/sample1/locations/sample2"} + request = request_type(**request_init) + + # Mock the http request call within the method and fake a response. + with mock.patch.object(type(client.transport._session), "request") as req: + # Designate an appropriate value for the returned response. + return_value = product_search_service.ListProductsResponse( + next_page_token="next_page_token_value", + ) + + # Wrap the value into a proper Response obj + response_value = Response() + response_value.status_code = 200 + pb_return_value = product_search_service.ListProductsResponse.pb(return_value) + json_return_value = json_format.MessageToJson(pb_return_value) + + response_value._content = json_return_value.encode("UTF-8") + req.return_value = response_value + response = client.list_products(request) + + # Establish that the response is the type that we expect. + assert isinstance(response, pagers.ListProductsPager) + assert response.next_page_token == "next_page_token_value" + + +def test_list_products_rest_required_fields( + request_type=product_search_service.ListProductsRequest, +): + transport_class = transports.ProductSearchRestTransport + + request_init = {} + request_init["parent"] = "" + request = request_type(**request_init) + pb_request = request_type.pb(request) + jsonified_request = json.loads( + json_format.MessageToJson( + pb_request, + including_default_value_fields=False, + use_integers_for_enums=False, + ) + ) + + # verify fields with default values are dropped + + unset_fields = transport_class( + credentials=ga_credentials.AnonymousCredentials() + ).list_products._get_unset_required_fields(jsonified_request) + jsonified_request.update(unset_fields) + + # verify required fields with default values are now present + + jsonified_request["parent"] = "parent_value" + + unset_fields = transport_class( + credentials=ga_credentials.AnonymousCredentials() + ).list_products._get_unset_required_fields(jsonified_request) + # Check that path parameters and body parameters are not mixing in. + assert not set(unset_fields) - set( + ( + "page_size", + "page_token", + ) + ) + jsonified_request.update(unset_fields) + + # verify required fields with non-default values are left alone + assert "parent" in jsonified_request + assert jsonified_request["parent"] == "parent_value" + + client = ProductSearchClient( + credentials=ga_credentials.AnonymousCredentials(), + transport="rest", + ) + request = request_type(**request_init) + + # Designate an appropriate value for the returned response. + return_value = product_search_service.ListProductsResponse() + # Mock the http request call within the method and fake a response. + with mock.patch.object(Session, "request") as req: + # We need to mock transcode() because providing default values + # for required fields will fail the real version if the http_options + # expect actual values for those fields. + with mock.patch.object(path_template, "transcode") as transcode: + # A uri without fields and an empty body will force all the + # request fields to show up in the query_params. + pb_request = request_type.pb(request) + transcode_result = { + "uri": "v1/sample_method", + "method": "get", + "query_params": pb_request, + } + transcode.return_value = transcode_result + + response_value = Response() + response_value.status_code = 200 + + pb_return_value = product_search_service.ListProductsResponse.pb( + return_value + ) + json_return_value = json_format.MessageToJson(pb_return_value) + + response_value._content = json_return_value.encode("UTF-8") + req.return_value = response_value + + response = client.list_products(request) + + expected_params = [("$alt", "json;enum-encoding=int")] + actual_params = req.call_args.kwargs["params"] + assert expected_params == actual_params + + +def test_list_products_rest_unset_required_fields(): + transport = transports.ProductSearchRestTransport( + credentials=ga_credentials.AnonymousCredentials + ) + + unset_fields = transport.list_products._get_unset_required_fields({}) + assert set(unset_fields) == ( + set( + ( + "pageSize", + "pageToken", + ) + ) + & set(("parent",)) + ) + + +@pytest.mark.parametrize("null_interceptor", [True, False]) +def test_list_products_rest_interceptors(null_interceptor): + transport = transports.ProductSearchRestTransport( + credentials=ga_credentials.AnonymousCredentials(), + interceptor=None + if null_interceptor + else transports.ProductSearchRestInterceptor(), + ) + client = ProductSearchClient(transport=transport) + with mock.patch.object( + type(client.transport._session), "request" + ) as req, mock.patch.object( + path_template, "transcode" + ) as transcode, mock.patch.object( + transports.ProductSearchRestInterceptor, "post_list_products" + ) as post, mock.patch.object( + transports.ProductSearchRestInterceptor, "pre_list_products" + ) as pre: + pre.assert_not_called() + post.assert_not_called() + pb_message = product_search_service.ListProductsRequest.pb( + product_search_service.ListProductsRequest() + ) + transcode.return_value = { + "method": "post", + "uri": "my_uri", + "body": pb_message, + "query_params": pb_message, + } + + req.return_value = Response() + req.return_value.status_code = 200 + req.return_value.request = PreparedRequest() + req.return_value._content = product_search_service.ListProductsResponse.to_json( + product_search_service.ListProductsResponse() + ) + + request = product_search_service.ListProductsRequest() + metadata = [ + ("key", "val"), + ("cephalopod", "squid"), + ] + pre.return_value = request, metadata + post.return_value = product_search_service.ListProductsResponse() + + client.list_products( + request, + metadata=[ + ("key", "val"), + ("cephalopod", "squid"), + ], + ) + + pre.assert_called_once() + post.assert_called_once() + + +def test_list_products_rest_bad_request( + transport: str = "rest", request_type=product_search_service.ListProductsRequest +): + client = ProductSearchClient( + credentials=ga_credentials.AnonymousCredentials(), + transport=transport, + ) + + # send a request that will satisfy transcoding + request_init = {"parent": "projects/sample1/locations/sample2"} + request = request_type(**request_init) + + # Mock the http request call within the method and fake a BadRequest error. + with mock.patch.object(Session, "request") as req, pytest.raises( + core_exceptions.BadRequest + ): + # Wrap the value into a proper Response obj + response_value = Response() + response_value.status_code = 400 + response_value.request = Request() + req.return_value = response_value + client.list_products(request) + + +def test_list_products_rest_flattened(): + client = ProductSearchClient( + credentials=ga_credentials.AnonymousCredentials(), + transport="rest", + ) + + # Mock the http request call within the method and fake a response. + with mock.patch.object(type(client.transport._session), "request") as req: + # Designate an appropriate value for the returned response. + return_value = product_search_service.ListProductsResponse() + + # get arguments that satisfy an http rule for this method + sample_request = {"parent": "projects/sample1/locations/sample2"} + + # get truthy value for each flattened field + mock_args = dict( + parent="parent_value", + ) + mock_args.update(sample_request) + + # Wrap the value into a proper Response obj + response_value = Response() + response_value.status_code = 200 + pb_return_value = product_search_service.ListProductsResponse.pb(return_value) + json_return_value = json_format.MessageToJson(pb_return_value) + response_value._content = json_return_value.encode("UTF-8") + req.return_value = response_value + + client.list_products(**mock_args) + + # Establish that the underlying call was made with the expected + # request object values. + assert len(req.mock_calls) == 1 + _, args, _ = req.mock_calls[0] + assert path_template.validate( + "%s/v1p3beta1/{parent=projects/*/locations/*}/products" + % client.transport._host, + args[1], + ) + + +def test_list_products_rest_flattened_error(transport: str = "rest"): + client = ProductSearchClient( + credentials=ga_credentials.AnonymousCredentials(), + transport=transport, + ) + + # Attempting to call a method with both a request object and flattened + # fields is an error. + with pytest.raises(ValueError): + client.list_products( + product_search_service.ListProductsRequest(), + parent="parent_value", + ) + + +def test_list_products_rest_pager(transport: str = "rest"): + client = ProductSearchClient( + credentials=ga_credentials.AnonymousCredentials(), + transport=transport, + ) + + # Mock the http request call within the method and fake a response. + with mock.patch.object(Session, "request") as req: + # TODO(kbandes): remove this mock unless there's a good reason for it. + # with mock.patch.object(path_template, 'transcode') as transcode: + # Set the response as a series of pages + response = ( + product_search_service.ListProductsResponse( + products=[ + product_search_service.Product(), + product_search_service.Product(), + product_search_service.Product(), + ], + next_page_token="abc", + ), + product_search_service.ListProductsResponse( + products=[], + next_page_token="def", + ), + product_search_service.ListProductsResponse( + products=[ + product_search_service.Product(), + ], + next_page_token="ghi", + ), + product_search_service.ListProductsResponse( + products=[ + product_search_service.Product(), + product_search_service.Product(), + ], + ), + ) + # Two responses for two calls + response = response + response + + # Wrap the values into proper Response objs + response = tuple( + product_search_service.ListProductsResponse.to_json(x) for x in response + ) + return_values = tuple(Response() for i in response) + for return_val, response_val in zip(return_values, response): + return_val._content = response_val.encode("UTF-8") + return_val.status_code = 200 + req.side_effect = return_values + + sample_request = {"parent": "projects/sample1/locations/sample2"} + + pager = client.list_products(request=sample_request) + + results = list(pager) + assert len(results) == 6 + assert all(isinstance(i, product_search_service.Product) for i in results) + + pages = list(client.list_products(request=sample_request).pages) + for page_, token in zip(pages, ["abc", "def", "ghi", ""]): + assert page_.raw_page.next_page_token == token + + +@pytest.mark.parametrize( + "request_type", + [ + product_search_service.GetProductRequest, + dict, + ], +) +def test_get_product_rest(request_type): + client = ProductSearchClient( + credentials=ga_credentials.AnonymousCredentials(), + transport="rest", + ) + + # send a request that will satisfy transcoding + request_init = {"name": "projects/sample1/locations/sample2/products/sample3"} + request = request_type(**request_init) + + # Mock the http request call within the method and fake a response. + with mock.patch.object(type(client.transport._session), "request") as req: + # Designate an appropriate value for the returned response. + return_value = product_search_service.Product( + name="name_value", + display_name="display_name_value", + description="description_value", + product_category="product_category_value", + ) + + # Wrap the value into a proper Response obj + response_value = Response() + response_value.status_code = 200 + pb_return_value = product_search_service.Product.pb(return_value) + json_return_value = json_format.MessageToJson(pb_return_value) + + response_value._content = json_return_value.encode("UTF-8") + req.return_value = response_value + response = client.get_product(request) + + # Establish that the response is the type that we expect. + assert isinstance(response, product_search_service.Product) + assert response.name == "name_value" + assert response.display_name == "display_name_value" + assert response.description == "description_value" + assert response.product_category == "product_category_value" + + +def test_get_product_rest_required_fields( + request_type=product_search_service.GetProductRequest, +): + transport_class = transports.ProductSearchRestTransport + + request_init = {} + request_init["name"] = "" + request = request_type(**request_init) + pb_request = request_type.pb(request) + jsonified_request = json.loads( + json_format.MessageToJson( + pb_request, + including_default_value_fields=False, + use_integers_for_enums=False, + ) + ) + + # verify fields with default values are dropped + + unset_fields = transport_class( + credentials=ga_credentials.AnonymousCredentials() + ).get_product._get_unset_required_fields(jsonified_request) + jsonified_request.update(unset_fields) + + # verify required fields with default values are now present + + jsonified_request["name"] = "name_value" + + unset_fields = transport_class( + credentials=ga_credentials.AnonymousCredentials() + ).get_product._get_unset_required_fields(jsonified_request) + jsonified_request.update(unset_fields) + + # verify required fields with non-default values are left alone + assert "name" in jsonified_request + assert jsonified_request["name"] == "name_value" + + client = ProductSearchClient( + credentials=ga_credentials.AnonymousCredentials(), + transport="rest", + ) + request = request_type(**request_init) + + # Designate an appropriate value for the returned response. + return_value = product_search_service.Product() + # Mock the http request call within the method and fake a response. + with mock.patch.object(Session, "request") as req: + # We need to mock transcode() because providing default values + # for required fields will fail the real version if the http_options + # expect actual values for those fields. + with mock.patch.object(path_template, "transcode") as transcode: + # A uri without fields and an empty body will force all the + # request fields to show up in the query_params. + pb_request = request_type.pb(request) + transcode_result = { + "uri": "v1/sample_method", + "method": "get", + "query_params": pb_request, + } + transcode.return_value = transcode_result + + response_value = Response() + response_value.status_code = 200 + + pb_return_value = product_search_service.Product.pb(return_value) + json_return_value = json_format.MessageToJson(pb_return_value) + + response_value._content = json_return_value.encode("UTF-8") + req.return_value = response_value + + response = client.get_product(request) + + expected_params = [("$alt", "json;enum-encoding=int")] + actual_params = req.call_args.kwargs["params"] + assert expected_params == actual_params + + +def test_get_product_rest_unset_required_fields(): + transport = transports.ProductSearchRestTransport( + credentials=ga_credentials.AnonymousCredentials + ) + + unset_fields = transport.get_product._get_unset_required_fields({}) + assert set(unset_fields) == (set(()) & set(("name",))) + + +@pytest.mark.parametrize("null_interceptor", [True, False]) +def test_get_product_rest_interceptors(null_interceptor): + transport = transports.ProductSearchRestTransport( + credentials=ga_credentials.AnonymousCredentials(), + interceptor=None + if null_interceptor + else transports.ProductSearchRestInterceptor(), + ) + client = ProductSearchClient(transport=transport) + with mock.patch.object( + type(client.transport._session), "request" + ) as req, mock.patch.object( + path_template, "transcode" + ) as transcode, mock.patch.object( + transports.ProductSearchRestInterceptor, "post_get_product" + ) as post, mock.patch.object( + transports.ProductSearchRestInterceptor, "pre_get_product" + ) as pre: + pre.assert_not_called() + post.assert_not_called() + pb_message = product_search_service.GetProductRequest.pb( + product_search_service.GetProductRequest() + ) + transcode.return_value = { + "method": "post", + "uri": "my_uri", + "body": pb_message, + "query_params": pb_message, + } + + req.return_value = Response() + req.return_value.status_code = 200 + req.return_value.request = PreparedRequest() + req.return_value._content = product_search_service.Product.to_json( + product_search_service.Product() + ) + + request = product_search_service.GetProductRequest() + metadata = [ + ("key", "val"), + ("cephalopod", "squid"), + ] + pre.return_value = request, metadata + post.return_value = product_search_service.Product() + + client.get_product( + request, + metadata=[ + ("key", "val"), + ("cephalopod", "squid"), + ], + ) + + pre.assert_called_once() + post.assert_called_once() + + +def test_get_product_rest_bad_request( + transport: str = "rest", request_type=product_search_service.GetProductRequest +): + client = ProductSearchClient( + credentials=ga_credentials.AnonymousCredentials(), + transport=transport, + ) + + # send a request that will satisfy transcoding + request_init = {"name": "projects/sample1/locations/sample2/products/sample3"} + request = request_type(**request_init) + + # Mock the http request call within the method and fake a BadRequest error. + with mock.patch.object(Session, "request") as req, pytest.raises( + core_exceptions.BadRequest + ): + # Wrap the value into a proper Response obj + response_value = Response() + response_value.status_code = 400 + response_value.request = Request() + req.return_value = response_value + client.get_product(request) + + +def test_get_product_rest_flattened(): + client = ProductSearchClient( + credentials=ga_credentials.AnonymousCredentials(), + transport="rest", + ) + + # Mock the http request call within the method and fake a response. + with mock.patch.object(type(client.transport._session), "request") as req: + # Designate an appropriate value for the returned response. + return_value = product_search_service.Product() + + # get arguments that satisfy an http rule for this method + sample_request = {"name": "projects/sample1/locations/sample2/products/sample3"} + + # get truthy value for each flattened field + mock_args = dict( + name="name_value", + ) + mock_args.update(sample_request) + + # Wrap the value into a proper Response obj + response_value = Response() + response_value.status_code = 200 + pb_return_value = product_search_service.Product.pb(return_value) + json_return_value = json_format.MessageToJson(pb_return_value) + response_value._content = json_return_value.encode("UTF-8") + req.return_value = response_value + + client.get_product(**mock_args) + + # Establish that the underlying call was made with the expected + # request object values. + assert len(req.mock_calls) == 1 + _, args, _ = req.mock_calls[0] + assert path_template.validate( + "%s/v1p3beta1/{name=projects/*/locations/*/products/*}" + % client.transport._host, + args[1], + ) + + +def test_get_product_rest_flattened_error(transport: str = "rest"): + client = ProductSearchClient( + credentials=ga_credentials.AnonymousCredentials(), + transport=transport, + ) + + # Attempting to call a method with both a request object and flattened + # fields is an error. + with pytest.raises(ValueError): + client.get_product( + product_search_service.GetProductRequest(), + name="name_value", + ) + + +def test_get_product_rest_error(): + client = ProductSearchClient( + credentials=ga_credentials.AnonymousCredentials(), transport="rest" + ) + + +@pytest.mark.parametrize( + "request_type", + [ + product_search_service.UpdateProductRequest, + dict, + ], +) +def test_update_product_rest(request_type): + client = ProductSearchClient( + credentials=ga_credentials.AnonymousCredentials(), + transport="rest", + ) + + # send a request that will satisfy transcoding + request_init = { + "product": {"name": "projects/sample1/locations/sample2/products/sample3"} + } + request_init["product"] = { + "name": "projects/sample1/locations/sample2/products/sample3", + "display_name": "display_name_value", + "description": "description_value", + "product_category": "product_category_value", + "product_labels": [{"key": "key_value", "value": "value_value"}], + } + request = request_type(**request_init) + + # Mock the http request call within the method and fake a response. + with mock.patch.object(type(client.transport._session), "request") as req: + # Designate an appropriate value for the returned response. + return_value = product_search_service.Product( + name="name_value", + display_name="display_name_value", + description="description_value", + product_category="product_category_value", + ) + + # Wrap the value into a proper Response obj + response_value = Response() + response_value.status_code = 200 + pb_return_value = product_search_service.Product.pb(return_value) + json_return_value = json_format.MessageToJson(pb_return_value) + + response_value._content = json_return_value.encode("UTF-8") + req.return_value = response_value + response = client.update_product(request) + + # Establish that the response is the type that we expect. + assert isinstance(response, product_search_service.Product) + assert response.name == "name_value" + assert response.display_name == "display_name_value" + assert response.description == "description_value" + assert response.product_category == "product_category_value" + + +def test_update_product_rest_required_fields( + request_type=product_search_service.UpdateProductRequest, +): + transport_class = transports.ProductSearchRestTransport + + request_init = {} + request = request_type(**request_init) + pb_request = request_type.pb(request) + jsonified_request = json.loads( + json_format.MessageToJson( + pb_request, + including_default_value_fields=False, + use_integers_for_enums=False, + ) + ) + + # verify fields with default values are dropped + + unset_fields = transport_class( + credentials=ga_credentials.AnonymousCredentials() + ).update_product._get_unset_required_fields(jsonified_request) + jsonified_request.update(unset_fields) + + # verify required fields with default values are now present + + unset_fields = transport_class( + credentials=ga_credentials.AnonymousCredentials() + ).update_product._get_unset_required_fields(jsonified_request) + # Check that path parameters and body parameters are not mixing in. + assert not set(unset_fields) - set(("update_mask",)) + jsonified_request.update(unset_fields) + + # verify required fields with non-default values are left alone + + client = ProductSearchClient( + credentials=ga_credentials.AnonymousCredentials(), + transport="rest", + ) + request = request_type(**request_init) + + # Designate an appropriate value for the returned response. + return_value = product_search_service.Product() + # Mock the http request call within the method and fake a response. + with mock.patch.object(Session, "request") as req: + # We need to mock transcode() because providing default values + # for required fields will fail the real version if the http_options + # expect actual values for those fields. + with mock.patch.object(path_template, "transcode") as transcode: + # A uri without fields and an empty body will force all the + # request fields to show up in the query_params. + pb_request = request_type.pb(request) + transcode_result = { + "uri": "v1/sample_method", + "method": "patch", + "query_params": pb_request, + } + transcode_result["body"] = pb_request + transcode.return_value = transcode_result + + response_value = Response() + response_value.status_code = 200 + + pb_return_value = product_search_service.Product.pb(return_value) + json_return_value = json_format.MessageToJson(pb_return_value) + + response_value._content = json_return_value.encode("UTF-8") + req.return_value = response_value + + response = client.update_product(request) + + expected_params = [("$alt", "json;enum-encoding=int")] + actual_params = req.call_args.kwargs["params"] + assert expected_params == actual_params + + +def test_update_product_rest_unset_required_fields(): + transport = transports.ProductSearchRestTransport( + credentials=ga_credentials.AnonymousCredentials + ) + + unset_fields = transport.update_product._get_unset_required_fields({}) + assert set(unset_fields) == (set(("updateMask",)) & set(("product",))) + + +@pytest.mark.parametrize("null_interceptor", [True, False]) +def test_update_product_rest_interceptors(null_interceptor): + transport = transports.ProductSearchRestTransport( + credentials=ga_credentials.AnonymousCredentials(), + interceptor=None + if null_interceptor + else transports.ProductSearchRestInterceptor(), + ) + client = ProductSearchClient(transport=transport) + with mock.patch.object( + type(client.transport._session), "request" + ) as req, mock.patch.object( + path_template, "transcode" + ) as transcode, mock.patch.object( + transports.ProductSearchRestInterceptor, "post_update_product" + ) as post, mock.patch.object( + transports.ProductSearchRestInterceptor, "pre_update_product" + ) as pre: + pre.assert_not_called() + post.assert_not_called() + pb_message = product_search_service.UpdateProductRequest.pb( + product_search_service.UpdateProductRequest() + ) + transcode.return_value = { + "method": "post", + "uri": "my_uri", + "body": pb_message, + "query_params": pb_message, + } + + req.return_value = Response() + req.return_value.status_code = 200 + req.return_value.request = PreparedRequest() + req.return_value._content = product_search_service.Product.to_json( + product_search_service.Product() + ) + + request = product_search_service.UpdateProductRequest() + metadata = [ + ("key", "val"), + ("cephalopod", "squid"), + ] + pre.return_value = request, metadata + post.return_value = product_search_service.Product() + + client.update_product( + request, + metadata=[ + ("key", "val"), + ("cephalopod", "squid"), + ], + ) + + pre.assert_called_once() + post.assert_called_once() + + +def test_update_product_rest_bad_request( + transport: str = "rest", request_type=product_search_service.UpdateProductRequest +): + client = ProductSearchClient( + credentials=ga_credentials.AnonymousCredentials(), + transport=transport, + ) + + # send a request that will satisfy transcoding + request_init = { + "product": {"name": "projects/sample1/locations/sample2/products/sample3"} + } + request_init["product"] = { + "name": "projects/sample1/locations/sample2/products/sample3", + "display_name": "display_name_value", + "description": "description_value", + "product_category": "product_category_value", + "product_labels": [{"key": "key_value", "value": "value_value"}], + } + request = request_type(**request_init) + + # Mock the http request call within the method and fake a BadRequest error. + with mock.patch.object(Session, "request") as req, pytest.raises( + core_exceptions.BadRequest + ): + # Wrap the value into a proper Response obj + response_value = Response() + response_value.status_code = 400 + response_value.request = Request() + req.return_value = response_value + client.update_product(request) + + +def test_update_product_rest_flattened(): + client = ProductSearchClient( + credentials=ga_credentials.AnonymousCredentials(), + transport="rest", + ) + + # Mock the http request call within the method and fake a response. + with mock.patch.object(type(client.transport._session), "request") as req: + # Designate an appropriate value for the returned response. + return_value = product_search_service.Product() + + # get arguments that satisfy an http rule for this method + sample_request = { + "product": {"name": "projects/sample1/locations/sample2/products/sample3"} + } + + # get truthy value for each flattened field + mock_args = dict( + product=product_search_service.Product(name="name_value"), + update_mask=field_mask_pb2.FieldMask(paths=["paths_value"]), + ) + mock_args.update(sample_request) + + # Wrap the value into a proper Response obj + response_value = Response() + response_value.status_code = 200 + pb_return_value = product_search_service.Product.pb(return_value) + json_return_value = json_format.MessageToJson(pb_return_value) + response_value._content = json_return_value.encode("UTF-8") + req.return_value = response_value + + client.update_product(**mock_args) + + # Establish that the underlying call was made with the expected + # request object values. + assert len(req.mock_calls) == 1 + _, args, _ = req.mock_calls[0] + assert path_template.validate( + "%s/v1p3beta1/{product.name=projects/*/locations/*/products/*}" + % client.transport._host, + args[1], + ) + + +def test_update_product_rest_flattened_error(transport: str = "rest"): + client = ProductSearchClient( + credentials=ga_credentials.AnonymousCredentials(), + transport=transport, + ) + + # Attempting to call a method with both a request object and flattened + # fields is an error. + with pytest.raises(ValueError): + client.update_product( + product_search_service.UpdateProductRequest(), + product=product_search_service.Product(name="name_value"), + update_mask=field_mask_pb2.FieldMask(paths=["paths_value"]), + ) + + +def test_update_product_rest_error(): + client = ProductSearchClient( + credentials=ga_credentials.AnonymousCredentials(), transport="rest" + ) + + +@pytest.mark.parametrize( + "request_type", + [ + product_search_service.DeleteProductRequest, + dict, + ], +) +def test_delete_product_rest(request_type): + client = ProductSearchClient( + credentials=ga_credentials.AnonymousCredentials(), + transport="rest", + ) + + # send a request that will satisfy transcoding + request_init = {"name": "projects/sample1/locations/sample2/products/sample3"} + request = request_type(**request_init) + + # Mock the http request call within the method and fake a response. + with mock.patch.object(type(client.transport._session), "request") as req: + # Designate an appropriate value for the returned response. + return_value = None + + # Wrap the value into a proper Response obj + response_value = Response() + response_value.status_code = 200 + json_return_value = "" + + response_value._content = json_return_value.encode("UTF-8") + req.return_value = response_value + response = client.delete_product(request) + + # Establish that the response is the type that we expect. + assert response is None + + +def test_delete_product_rest_required_fields( + request_type=product_search_service.DeleteProductRequest, +): + transport_class = transports.ProductSearchRestTransport + + request_init = {} + request_init["name"] = "" + request = request_type(**request_init) + pb_request = request_type.pb(request) + jsonified_request = json.loads( + json_format.MessageToJson( + pb_request, + including_default_value_fields=False, + use_integers_for_enums=False, + ) + ) + + # verify fields with default values are dropped + + unset_fields = transport_class( + credentials=ga_credentials.AnonymousCredentials() + ).delete_product._get_unset_required_fields(jsonified_request) + jsonified_request.update(unset_fields) + + # verify required fields with default values are now present + + jsonified_request["name"] = "name_value" + + unset_fields = transport_class( + credentials=ga_credentials.AnonymousCredentials() + ).delete_product._get_unset_required_fields(jsonified_request) + jsonified_request.update(unset_fields) + + # verify required fields with non-default values are left alone + assert "name" in jsonified_request + assert jsonified_request["name"] == "name_value" + + client = ProductSearchClient( + credentials=ga_credentials.AnonymousCredentials(), + transport="rest", + ) + request = request_type(**request_init) + + # Designate an appropriate value for the returned response. + return_value = None + # Mock the http request call within the method and fake a response. + with mock.patch.object(Session, "request") as req: + # We need to mock transcode() because providing default values + # for required fields will fail the real version if the http_options + # expect actual values for those fields. + with mock.patch.object(path_template, "transcode") as transcode: + # A uri without fields and an empty body will force all the + # request fields to show up in the query_params. + pb_request = request_type.pb(request) + transcode_result = { + "uri": "v1/sample_method", + "method": "delete", + "query_params": pb_request, + } + transcode.return_value = transcode_result + + response_value = Response() + response_value.status_code = 200 + json_return_value = "" + + response_value._content = json_return_value.encode("UTF-8") + req.return_value = response_value + + response = client.delete_product(request) + + expected_params = [("$alt", "json;enum-encoding=int")] + actual_params = req.call_args.kwargs["params"] + assert expected_params == actual_params + + +def test_delete_product_rest_unset_required_fields(): + transport = transports.ProductSearchRestTransport( + credentials=ga_credentials.AnonymousCredentials + ) + + unset_fields = transport.delete_product._get_unset_required_fields({}) + assert set(unset_fields) == (set(()) & set(("name",))) + + +@pytest.mark.parametrize("null_interceptor", [True, False]) +def test_delete_product_rest_interceptors(null_interceptor): + transport = transports.ProductSearchRestTransport( + credentials=ga_credentials.AnonymousCredentials(), + interceptor=None + if null_interceptor + else transports.ProductSearchRestInterceptor(), + ) + client = ProductSearchClient(transport=transport) + with mock.patch.object( + type(client.transport._session), "request" + ) as req, mock.patch.object( + path_template, "transcode" + ) as transcode, mock.patch.object( + transports.ProductSearchRestInterceptor, "pre_delete_product" + ) as pre: + pre.assert_not_called() + pb_message = product_search_service.DeleteProductRequest.pb( + product_search_service.DeleteProductRequest() + ) + transcode.return_value = { + "method": "post", + "uri": "my_uri", + "body": pb_message, + "query_params": pb_message, + } + + req.return_value = Response() + req.return_value.status_code = 200 + req.return_value.request = PreparedRequest() + + request = product_search_service.DeleteProductRequest() + metadata = [ + ("key", "val"), + ("cephalopod", "squid"), + ] + pre.return_value = request, metadata + + client.delete_product( + request, + metadata=[ + ("key", "val"), + ("cephalopod", "squid"), + ], + ) + + pre.assert_called_once() + + +def test_delete_product_rest_bad_request( + transport: str = "rest", request_type=product_search_service.DeleteProductRequest +): + client = ProductSearchClient( + credentials=ga_credentials.AnonymousCredentials(), + transport=transport, + ) + + # send a request that will satisfy transcoding + request_init = {"name": "projects/sample1/locations/sample2/products/sample3"} + request = request_type(**request_init) + + # Mock the http request call within the method and fake a BadRequest error. + with mock.patch.object(Session, "request") as req, pytest.raises( + core_exceptions.BadRequest + ): + # Wrap the value into a proper Response obj + response_value = Response() + response_value.status_code = 400 + response_value.request = Request() + req.return_value = response_value + client.delete_product(request) + + +def test_delete_product_rest_flattened(): + client = ProductSearchClient( + credentials=ga_credentials.AnonymousCredentials(), + transport="rest", + ) + + # Mock the http request call within the method and fake a response. + with mock.patch.object(type(client.transport._session), "request") as req: + # Designate an appropriate value for the returned response. + return_value = None + + # get arguments that satisfy an http rule for this method + sample_request = {"name": "projects/sample1/locations/sample2/products/sample3"} + + # get truthy value for each flattened field + mock_args = dict( + name="name_value", + ) + mock_args.update(sample_request) + + # Wrap the value into a proper Response obj + response_value = Response() + response_value.status_code = 200 + json_return_value = "" + response_value._content = json_return_value.encode("UTF-8") + req.return_value = response_value + + client.delete_product(**mock_args) + + # Establish that the underlying call was made with the expected + # request object values. + assert len(req.mock_calls) == 1 + _, args, _ = req.mock_calls[0] + assert path_template.validate( + "%s/v1p3beta1/{name=projects/*/locations/*/products/*}" + % client.transport._host, + args[1], + ) + + +def test_delete_product_rest_flattened_error(transport: str = "rest"): + client = ProductSearchClient( + credentials=ga_credentials.AnonymousCredentials(), + transport=transport, + ) + + # Attempting to call a method with both a request object and flattened + # fields is an error. + with pytest.raises(ValueError): + client.delete_product( + product_search_service.DeleteProductRequest(), + name="name_value", + ) + + +def test_delete_product_rest_error(): + client = ProductSearchClient( + credentials=ga_credentials.AnonymousCredentials(), transport="rest" + ) + + +@pytest.mark.parametrize( + "request_type", + [ + product_search_service.CreateReferenceImageRequest, + dict, + ], +) +def test_create_reference_image_rest(request_type): + client = ProductSearchClient( + credentials=ga_credentials.AnonymousCredentials(), + transport="rest", + ) + + # send a request that will satisfy transcoding + request_init = {"parent": "projects/sample1/locations/sample2/products/sample3"} + request_init["reference_image"] = { + "name": "name_value", + "uri": "uri_value", + "bounding_polys": [ + { + "vertices": [{"x": 120, "y": 121}], + "normalized_vertices": [{"x": 0.12, "y": 0.121}], + } + ], + } + request = request_type(**request_init) + + # Mock the http request call within the method and fake a response. + with mock.patch.object(type(client.transport._session), "request") as req: + # Designate an appropriate value for the returned response. + return_value = product_search_service.ReferenceImage( + name="name_value", + uri="uri_value", + ) + + # Wrap the value into a proper Response obj + response_value = Response() + response_value.status_code = 200 + pb_return_value = product_search_service.ReferenceImage.pb(return_value) + json_return_value = json_format.MessageToJson(pb_return_value) + + response_value._content = json_return_value.encode("UTF-8") + req.return_value = response_value + response = client.create_reference_image(request) + + # Establish that the response is the type that we expect. + assert isinstance(response, product_search_service.ReferenceImage) + assert response.name == "name_value" + assert response.uri == "uri_value" + + +def test_create_reference_image_rest_required_fields( + request_type=product_search_service.CreateReferenceImageRequest, +): + transport_class = transports.ProductSearchRestTransport + + request_init = {} + request_init["parent"] = "" + request = request_type(**request_init) + pb_request = request_type.pb(request) + jsonified_request = json.loads( + json_format.MessageToJson( + pb_request, + including_default_value_fields=False, + use_integers_for_enums=False, + ) + ) + + # verify fields with default values are dropped + + unset_fields = transport_class( + credentials=ga_credentials.AnonymousCredentials() + ).create_reference_image._get_unset_required_fields(jsonified_request) + jsonified_request.update(unset_fields) + + # verify required fields with default values are now present + + jsonified_request["parent"] = "parent_value" + + unset_fields = transport_class( + credentials=ga_credentials.AnonymousCredentials() + ).create_reference_image._get_unset_required_fields(jsonified_request) + # Check that path parameters and body parameters are not mixing in. + assert not set(unset_fields) - set(("reference_image_id",)) + jsonified_request.update(unset_fields) + + # verify required fields with non-default values are left alone + assert "parent" in jsonified_request + assert jsonified_request["parent"] == "parent_value" + + client = ProductSearchClient( + credentials=ga_credentials.AnonymousCredentials(), + transport="rest", + ) + request = request_type(**request_init) + + # Designate an appropriate value for the returned response. + return_value = product_search_service.ReferenceImage() + # Mock the http request call within the method and fake a response. + with mock.patch.object(Session, "request") as req: + # We need to mock transcode() because providing default values + # for required fields will fail the real version if the http_options + # expect actual values for those fields. + with mock.patch.object(path_template, "transcode") as transcode: + # A uri without fields and an empty body will force all the + # request fields to show up in the query_params. + pb_request = request_type.pb(request) + transcode_result = { + "uri": "v1/sample_method", + "method": "post", + "query_params": pb_request, + } + transcode_result["body"] = pb_request + transcode.return_value = transcode_result + + response_value = Response() + response_value.status_code = 200 + + pb_return_value = product_search_service.ReferenceImage.pb(return_value) + json_return_value = json_format.MessageToJson(pb_return_value) + + response_value._content = json_return_value.encode("UTF-8") + req.return_value = response_value + + response = client.create_reference_image(request) + + expected_params = [("$alt", "json;enum-encoding=int")] + actual_params = req.call_args.kwargs["params"] + assert expected_params == actual_params + + +def test_create_reference_image_rest_unset_required_fields(): + transport = transports.ProductSearchRestTransport( + credentials=ga_credentials.AnonymousCredentials + ) + + unset_fields = transport.create_reference_image._get_unset_required_fields({}) + assert set(unset_fields) == ( + set(("referenceImageId",)) + & set( + ( + "parent", + "referenceImage", + ) + ) + ) + + +@pytest.mark.parametrize("null_interceptor", [True, False]) +def test_create_reference_image_rest_interceptors(null_interceptor): + transport = transports.ProductSearchRestTransport( + credentials=ga_credentials.AnonymousCredentials(), + interceptor=None + if null_interceptor + else transports.ProductSearchRestInterceptor(), + ) + client = ProductSearchClient(transport=transport) + with mock.patch.object( + type(client.transport._session), "request" + ) as req, mock.patch.object( + path_template, "transcode" + ) as transcode, mock.patch.object( + transports.ProductSearchRestInterceptor, "post_create_reference_image" + ) as post, mock.patch.object( + transports.ProductSearchRestInterceptor, "pre_create_reference_image" + ) as pre: + pre.assert_not_called() + post.assert_not_called() + pb_message = product_search_service.CreateReferenceImageRequest.pb( + product_search_service.CreateReferenceImageRequest() + ) + transcode.return_value = { + "method": "post", + "uri": "my_uri", + "body": pb_message, + "query_params": pb_message, + } + + req.return_value = Response() + req.return_value.status_code = 200 + req.return_value.request = PreparedRequest() + req.return_value._content = product_search_service.ReferenceImage.to_json( + product_search_service.ReferenceImage() + ) + + request = product_search_service.CreateReferenceImageRequest() + metadata = [ + ("key", "val"), + ("cephalopod", "squid"), + ] + pre.return_value = request, metadata + post.return_value = product_search_service.ReferenceImage() + + client.create_reference_image( + request, + metadata=[ + ("key", "val"), + ("cephalopod", "squid"), + ], + ) + + pre.assert_called_once() + post.assert_called_once() + + +def test_create_reference_image_rest_bad_request( + transport: str = "rest", + request_type=product_search_service.CreateReferenceImageRequest, +): + client = ProductSearchClient( + credentials=ga_credentials.AnonymousCredentials(), + transport=transport, + ) + + # send a request that will satisfy transcoding + request_init = {"parent": "projects/sample1/locations/sample2/products/sample3"} + request_init["reference_image"] = { + "name": "name_value", + "uri": "uri_value", + "bounding_polys": [ + { + "vertices": [{"x": 120, "y": 121}], + "normalized_vertices": [{"x": 0.12, "y": 0.121}], + } + ], + } + request = request_type(**request_init) + + # Mock the http request call within the method and fake a BadRequest error. + with mock.patch.object(Session, "request") as req, pytest.raises( + core_exceptions.BadRequest + ): + # Wrap the value into a proper Response obj + response_value = Response() + response_value.status_code = 400 + response_value.request = Request() + req.return_value = response_value + client.create_reference_image(request) + + +def test_create_reference_image_rest_flattened(): + client = ProductSearchClient( + credentials=ga_credentials.AnonymousCredentials(), + transport="rest", + ) + + # Mock the http request call within the method and fake a response. + with mock.patch.object(type(client.transport._session), "request") as req: + # Designate an appropriate value for the returned response. + return_value = product_search_service.ReferenceImage() + + # get arguments that satisfy an http rule for this method + sample_request = { + "parent": "projects/sample1/locations/sample2/products/sample3" + } + + # get truthy value for each flattened field + mock_args = dict( + parent="parent_value", + reference_image=product_search_service.ReferenceImage(name="name_value"), + reference_image_id="reference_image_id_value", + ) + mock_args.update(sample_request) + + # Wrap the value into a proper Response obj + response_value = Response() + response_value.status_code = 200 + pb_return_value = product_search_service.ReferenceImage.pb(return_value) + json_return_value = json_format.MessageToJson(pb_return_value) + response_value._content = json_return_value.encode("UTF-8") + req.return_value = response_value + + client.create_reference_image(**mock_args) + + # Establish that the underlying call was made with the expected + # request object values. + assert len(req.mock_calls) == 1 + _, args, _ = req.mock_calls[0] + assert path_template.validate( + "%s/v1p3beta1/{parent=projects/*/locations/*/products/*}/referenceImages" + % client.transport._host, + args[1], + ) + + +def test_create_reference_image_rest_flattened_error(transport: str = "rest"): + client = ProductSearchClient( + credentials=ga_credentials.AnonymousCredentials(), + transport=transport, + ) + + # Attempting to call a method with both a request object and flattened + # fields is an error. + with pytest.raises(ValueError): + client.create_reference_image( + product_search_service.CreateReferenceImageRequest(), + parent="parent_value", + reference_image=product_search_service.ReferenceImage(name="name_value"), + reference_image_id="reference_image_id_value", + ) + + +def test_create_reference_image_rest_error(): + client = ProductSearchClient( + credentials=ga_credentials.AnonymousCredentials(), transport="rest" + ) + + +@pytest.mark.parametrize( + "request_type", + [ + product_search_service.DeleteReferenceImageRequest, + dict, + ], +) +def test_delete_reference_image_rest(request_type): + client = ProductSearchClient( + credentials=ga_credentials.AnonymousCredentials(), + transport="rest", + ) + + # send a request that will satisfy transcoding + request_init = { + "name": "projects/sample1/locations/sample2/products/sample3/referenceImages/sample4" + } + request = request_type(**request_init) + + # Mock the http request call within the method and fake a response. + with mock.patch.object(type(client.transport._session), "request") as req: + # Designate an appropriate value for the returned response. + return_value = None + + # Wrap the value into a proper Response obj + response_value = Response() + response_value.status_code = 200 + json_return_value = "" + + response_value._content = json_return_value.encode("UTF-8") + req.return_value = response_value + response = client.delete_reference_image(request) + + # Establish that the response is the type that we expect. + assert response is None + + +def test_delete_reference_image_rest_required_fields( + request_type=product_search_service.DeleteReferenceImageRequest, +): + transport_class = transports.ProductSearchRestTransport + + request_init = {} + request_init["name"] = "" + request = request_type(**request_init) + pb_request = request_type.pb(request) + jsonified_request = json.loads( + json_format.MessageToJson( + pb_request, + including_default_value_fields=False, + use_integers_for_enums=False, + ) + ) + + # verify fields with default values are dropped + + unset_fields = transport_class( + credentials=ga_credentials.AnonymousCredentials() + ).delete_reference_image._get_unset_required_fields(jsonified_request) + jsonified_request.update(unset_fields) + + # verify required fields with default values are now present + + jsonified_request["name"] = "name_value" + + unset_fields = transport_class( + credentials=ga_credentials.AnonymousCredentials() + ).delete_reference_image._get_unset_required_fields(jsonified_request) + jsonified_request.update(unset_fields) + + # verify required fields with non-default values are left alone + assert "name" in jsonified_request + assert jsonified_request["name"] == "name_value" + + client = ProductSearchClient( + credentials=ga_credentials.AnonymousCredentials(), + transport="rest", + ) + request = request_type(**request_init) + + # Designate an appropriate value for the returned response. + return_value = None + # Mock the http request call within the method and fake a response. + with mock.patch.object(Session, "request") as req: + # We need to mock transcode() because providing default values + # for required fields will fail the real version if the http_options + # expect actual values for those fields. + with mock.patch.object(path_template, "transcode") as transcode: + # A uri without fields and an empty body will force all the + # request fields to show up in the query_params. + pb_request = request_type.pb(request) + transcode_result = { + "uri": "v1/sample_method", + "method": "delete", + "query_params": pb_request, + } + transcode.return_value = transcode_result + + response_value = Response() + response_value.status_code = 200 + json_return_value = "" + + response_value._content = json_return_value.encode("UTF-8") + req.return_value = response_value + + response = client.delete_reference_image(request) + + expected_params = [("$alt", "json;enum-encoding=int")] + actual_params = req.call_args.kwargs["params"] + assert expected_params == actual_params + + +def test_delete_reference_image_rest_unset_required_fields(): + transport = transports.ProductSearchRestTransport( + credentials=ga_credentials.AnonymousCredentials + ) + + unset_fields = transport.delete_reference_image._get_unset_required_fields({}) + assert set(unset_fields) == (set(()) & set(("name",))) + + +@pytest.mark.parametrize("null_interceptor", [True, False]) +def test_delete_reference_image_rest_interceptors(null_interceptor): + transport = transports.ProductSearchRestTransport( + credentials=ga_credentials.AnonymousCredentials(), + interceptor=None + if null_interceptor + else transports.ProductSearchRestInterceptor(), + ) + client = ProductSearchClient(transport=transport) + with mock.patch.object( + type(client.transport._session), "request" + ) as req, mock.patch.object( + path_template, "transcode" + ) as transcode, mock.patch.object( + transports.ProductSearchRestInterceptor, "pre_delete_reference_image" + ) as pre: + pre.assert_not_called() + pb_message = product_search_service.DeleteReferenceImageRequest.pb( + product_search_service.DeleteReferenceImageRequest() + ) + transcode.return_value = { + "method": "post", + "uri": "my_uri", + "body": pb_message, + "query_params": pb_message, + } + + req.return_value = Response() + req.return_value.status_code = 200 + req.return_value.request = PreparedRequest() + + request = product_search_service.DeleteReferenceImageRequest() + metadata = [ + ("key", "val"), + ("cephalopod", "squid"), + ] + pre.return_value = request, metadata + + client.delete_reference_image( + request, + metadata=[ + ("key", "val"), + ("cephalopod", "squid"), + ], + ) + + pre.assert_called_once() + + +def test_delete_reference_image_rest_bad_request( + transport: str = "rest", + request_type=product_search_service.DeleteReferenceImageRequest, +): + client = ProductSearchClient( + credentials=ga_credentials.AnonymousCredentials(), + transport=transport, + ) + + # send a request that will satisfy transcoding + request_init = { + "name": "projects/sample1/locations/sample2/products/sample3/referenceImages/sample4" + } + request = request_type(**request_init) + + # Mock the http request call within the method and fake a BadRequest error. + with mock.patch.object(Session, "request") as req, pytest.raises( + core_exceptions.BadRequest + ): + # Wrap the value into a proper Response obj + response_value = Response() + response_value.status_code = 400 + response_value.request = Request() + req.return_value = response_value + client.delete_reference_image(request) + + +def test_delete_reference_image_rest_flattened(): + client = ProductSearchClient( + credentials=ga_credentials.AnonymousCredentials(), + transport="rest", + ) + + # Mock the http request call within the method and fake a response. + with mock.patch.object(type(client.transport._session), "request") as req: + # Designate an appropriate value for the returned response. + return_value = None + + # get arguments that satisfy an http rule for this method + sample_request = { + "name": "projects/sample1/locations/sample2/products/sample3/referenceImages/sample4" + } + + # get truthy value for each flattened field + mock_args = dict( + name="name_value", + ) + mock_args.update(sample_request) + + # Wrap the value into a proper Response obj + response_value = Response() + response_value.status_code = 200 + json_return_value = "" + response_value._content = json_return_value.encode("UTF-8") + req.return_value = response_value + + client.delete_reference_image(**mock_args) + + # Establish that the underlying call was made with the expected + # request object values. + assert len(req.mock_calls) == 1 + _, args, _ = req.mock_calls[0] + assert path_template.validate( + "%s/v1p3beta1/{name=projects/*/locations/*/products/*/referenceImages/*}" + % client.transport._host, + args[1], + ) + + +def test_delete_reference_image_rest_flattened_error(transport: str = "rest"): + client = ProductSearchClient( + credentials=ga_credentials.AnonymousCredentials(), + transport=transport, + ) + + # Attempting to call a method with both a request object and flattened + # fields is an error. + with pytest.raises(ValueError): + client.delete_reference_image( + product_search_service.DeleteReferenceImageRequest(), + name="name_value", + ) + + +def test_delete_reference_image_rest_error(): + client = ProductSearchClient( + credentials=ga_credentials.AnonymousCredentials(), transport="rest" + ) + + +@pytest.mark.parametrize( + "request_type", + [ + product_search_service.ListReferenceImagesRequest, + dict, + ], +) +def test_list_reference_images_rest(request_type): + client = ProductSearchClient( + credentials=ga_credentials.AnonymousCredentials(), + transport="rest", + ) + + # send a request that will satisfy transcoding + request_init = {"parent": "projects/sample1/locations/sample2/products/sample3"} + request = request_type(**request_init) + + # Mock the http request call within the method and fake a response. + with mock.patch.object(type(client.transport._session), "request") as req: + # Designate an appropriate value for the returned response. + return_value = product_search_service.ListReferenceImagesResponse( + page_size=951, + next_page_token="next_page_token_value", + ) + + # Wrap the value into a proper Response obj + response_value = Response() + response_value.status_code = 200 + pb_return_value = product_search_service.ListReferenceImagesResponse.pb( + return_value + ) + json_return_value = json_format.MessageToJson(pb_return_value) + + response_value._content = json_return_value.encode("UTF-8") + req.return_value = response_value + response = client.list_reference_images(request) + + # Establish that the response is the type that we expect. + assert isinstance(response, pagers.ListReferenceImagesPager) + assert response.page_size == 951 + assert response.next_page_token == "next_page_token_value" + + +def test_list_reference_images_rest_required_fields( + request_type=product_search_service.ListReferenceImagesRequest, +): + transport_class = transports.ProductSearchRestTransport + + request_init = {} + request_init["parent"] = "" + request = request_type(**request_init) + pb_request = request_type.pb(request) + jsonified_request = json.loads( + json_format.MessageToJson( + pb_request, + including_default_value_fields=False, + use_integers_for_enums=False, + ) + ) + + # verify fields with default values are dropped + + unset_fields = transport_class( + credentials=ga_credentials.AnonymousCredentials() + ).list_reference_images._get_unset_required_fields(jsonified_request) + jsonified_request.update(unset_fields) + + # verify required fields with default values are now present + + jsonified_request["parent"] = "parent_value" + + unset_fields = transport_class( + credentials=ga_credentials.AnonymousCredentials() + ).list_reference_images._get_unset_required_fields(jsonified_request) + # Check that path parameters and body parameters are not mixing in. + assert not set(unset_fields) - set( + ( + "page_size", + "page_token", + ) + ) + jsonified_request.update(unset_fields) + + # verify required fields with non-default values are left alone + assert "parent" in jsonified_request + assert jsonified_request["parent"] == "parent_value" + + client = ProductSearchClient( + credentials=ga_credentials.AnonymousCredentials(), + transport="rest", + ) + request = request_type(**request_init) + + # Designate an appropriate value for the returned response. + return_value = product_search_service.ListReferenceImagesResponse() + # Mock the http request call within the method and fake a response. + with mock.patch.object(Session, "request") as req: + # We need to mock transcode() because providing default values + # for required fields will fail the real version if the http_options + # expect actual values for those fields. + with mock.patch.object(path_template, "transcode") as transcode: + # A uri without fields and an empty body will force all the + # request fields to show up in the query_params. + pb_request = request_type.pb(request) + transcode_result = { + "uri": "v1/sample_method", + "method": "get", + "query_params": pb_request, + } + transcode.return_value = transcode_result + + response_value = Response() + response_value.status_code = 200 + + pb_return_value = product_search_service.ListReferenceImagesResponse.pb( + return_value + ) + json_return_value = json_format.MessageToJson(pb_return_value) + + response_value._content = json_return_value.encode("UTF-8") + req.return_value = response_value + + response = client.list_reference_images(request) + + expected_params = [("$alt", "json;enum-encoding=int")] + actual_params = req.call_args.kwargs["params"] + assert expected_params == actual_params + + +def test_list_reference_images_rest_unset_required_fields(): + transport = transports.ProductSearchRestTransport( + credentials=ga_credentials.AnonymousCredentials + ) + + unset_fields = transport.list_reference_images._get_unset_required_fields({}) + assert set(unset_fields) == ( + set( + ( + "pageSize", + "pageToken", + ) + ) + & set(("parent",)) + ) + + +@pytest.mark.parametrize("null_interceptor", [True, False]) +def test_list_reference_images_rest_interceptors(null_interceptor): + transport = transports.ProductSearchRestTransport( + credentials=ga_credentials.AnonymousCredentials(), + interceptor=None + if null_interceptor + else transports.ProductSearchRestInterceptor(), + ) + client = ProductSearchClient(transport=transport) + with mock.patch.object( + type(client.transport._session), "request" + ) as req, mock.patch.object( + path_template, "transcode" + ) as transcode, mock.patch.object( + transports.ProductSearchRestInterceptor, "post_list_reference_images" + ) as post, mock.patch.object( + transports.ProductSearchRestInterceptor, "pre_list_reference_images" + ) as pre: + pre.assert_not_called() + post.assert_not_called() + pb_message = product_search_service.ListReferenceImagesRequest.pb( + product_search_service.ListReferenceImagesRequest() + ) + transcode.return_value = { + "method": "post", + "uri": "my_uri", + "body": pb_message, + "query_params": pb_message, + } + + req.return_value = Response() + req.return_value.status_code = 200 + req.return_value.request = PreparedRequest() + req.return_value._content = ( + product_search_service.ListReferenceImagesResponse.to_json( + product_search_service.ListReferenceImagesResponse() + ) + ) + + request = product_search_service.ListReferenceImagesRequest() + metadata = [ + ("key", "val"), + ("cephalopod", "squid"), + ] + pre.return_value = request, metadata + post.return_value = product_search_service.ListReferenceImagesResponse() + + client.list_reference_images( + request, + metadata=[ + ("key", "val"), + ("cephalopod", "squid"), + ], + ) + + pre.assert_called_once() + post.assert_called_once() + + +def test_list_reference_images_rest_bad_request( + transport: str = "rest", + request_type=product_search_service.ListReferenceImagesRequest, +): + client = ProductSearchClient( + credentials=ga_credentials.AnonymousCredentials(), + transport=transport, + ) + + # send a request that will satisfy transcoding + request_init = {"parent": "projects/sample1/locations/sample2/products/sample3"} + request = request_type(**request_init) + + # Mock the http request call within the method and fake a BadRequest error. + with mock.patch.object(Session, "request") as req, pytest.raises( + core_exceptions.BadRequest + ): + # Wrap the value into a proper Response obj + response_value = Response() + response_value.status_code = 400 + response_value.request = Request() + req.return_value = response_value + client.list_reference_images(request) + + +def test_list_reference_images_rest_flattened(): + client = ProductSearchClient( + credentials=ga_credentials.AnonymousCredentials(), + transport="rest", + ) + + # Mock the http request call within the method and fake a response. + with mock.patch.object(type(client.transport._session), "request") as req: + # Designate an appropriate value for the returned response. + return_value = product_search_service.ListReferenceImagesResponse() + + # get arguments that satisfy an http rule for this method + sample_request = { + "parent": "projects/sample1/locations/sample2/products/sample3" + } + + # get truthy value for each flattened field + mock_args = dict( + parent="parent_value", + ) + mock_args.update(sample_request) + + # Wrap the value into a proper Response obj + response_value = Response() + response_value.status_code = 200 + pb_return_value = product_search_service.ListReferenceImagesResponse.pb( + return_value + ) + json_return_value = json_format.MessageToJson(pb_return_value) + response_value._content = json_return_value.encode("UTF-8") + req.return_value = response_value + + client.list_reference_images(**mock_args) + + # Establish that the underlying call was made with the expected + # request object values. + assert len(req.mock_calls) == 1 + _, args, _ = req.mock_calls[0] + assert path_template.validate( + "%s/v1p3beta1/{parent=projects/*/locations/*/products/*}/referenceImages" + % client.transport._host, + args[1], + ) + + +def test_list_reference_images_rest_flattened_error(transport: str = "rest"): + client = ProductSearchClient( + credentials=ga_credentials.AnonymousCredentials(), + transport=transport, + ) + + # Attempting to call a method with both a request object and flattened + # fields is an error. + with pytest.raises(ValueError): + client.list_reference_images( + product_search_service.ListReferenceImagesRequest(), + parent="parent_value", + ) + + +def test_list_reference_images_rest_pager(transport: str = "rest"): + client = ProductSearchClient( + credentials=ga_credentials.AnonymousCredentials(), + transport=transport, + ) + + # Mock the http request call within the method and fake a response. + with mock.patch.object(Session, "request") as req: + # TODO(kbandes): remove this mock unless there's a good reason for it. + # with mock.patch.object(path_template, 'transcode') as transcode: + # Set the response as a series of pages + response = ( + product_search_service.ListReferenceImagesResponse( + reference_images=[ + product_search_service.ReferenceImage(), + product_search_service.ReferenceImage(), + product_search_service.ReferenceImage(), + ], + next_page_token="abc", + ), + product_search_service.ListReferenceImagesResponse( + reference_images=[], + next_page_token="def", + ), + product_search_service.ListReferenceImagesResponse( + reference_images=[ + product_search_service.ReferenceImage(), + ], + next_page_token="ghi", + ), + product_search_service.ListReferenceImagesResponse( + reference_images=[ + product_search_service.ReferenceImage(), + product_search_service.ReferenceImage(), + ], + ), + ) + # Two responses for two calls + response = response + response + + # Wrap the values into proper Response objs + response = tuple( + product_search_service.ListReferenceImagesResponse.to_json(x) + for x in response + ) + return_values = tuple(Response() for i in response) + for return_val, response_val in zip(return_values, response): + return_val._content = response_val.encode("UTF-8") + return_val.status_code = 200 + req.side_effect = return_values + + sample_request = { + "parent": "projects/sample1/locations/sample2/products/sample3" + } + + pager = client.list_reference_images(request=sample_request) + + results = list(pager) + assert len(results) == 6 + assert all( + isinstance(i, product_search_service.ReferenceImage) for i in results + ) + + pages = list(client.list_reference_images(request=sample_request).pages) + for page_, token in zip(pages, ["abc", "def", "ghi", ""]): + assert page_.raw_page.next_page_token == token + + +@pytest.mark.parametrize( + "request_type", + [ + product_search_service.GetReferenceImageRequest, + dict, + ], +) +def test_get_reference_image_rest(request_type): + client = ProductSearchClient( + credentials=ga_credentials.AnonymousCredentials(), + transport="rest", + ) + + # send a request that will satisfy transcoding + request_init = { + "name": "projects/sample1/locations/sample2/products/sample3/referenceImages/sample4" + } + request = request_type(**request_init) + + # Mock the http request call within the method and fake a response. + with mock.patch.object(type(client.transport._session), "request") as req: + # Designate an appropriate value for the returned response. + return_value = product_search_service.ReferenceImage( + name="name_value", + uri="uri_value", + ) + + # Wrap the value into a proper Response obj + response_value = Response() + response_value.status_code = 200 + pb_return_value = product_search_service.ReferenceImage.pb(return_value) + json_return_value = json_format.MessageToJson(pb_return_value) + + response_value._content = json_return_value.encode("UTF-8") + req.return_value = response_value + response = client.get_reference_image(request) + + # Establish that the response is the type that we expect. + assert isinstance(response, product_search_service.ReferenceImage) + assert response.name == "name_value" + assert response.uri == "uri_value" + + +def test_get_reference_image_rest_required_fields( + request_type=product_search_service.GetReferenceImageRequest, +): + transport_class = transports.ProductSearchRestTransport + + request_init = {} + request_init["name"] = "" + request = request_type(**request_init) + pb_request = request_type.pb(request) + jsonified_request = json.loads( + json_format.MessageToJson( + pb_request, + including_default_value_fields=False, + use_integers_for_enums=False, + ) + ) + + # verify fields with default values are dropped + + unset_fields = transport_class( + credentials=ga_credentials.AnonymousCredentials() + ).get_reference_image._get_unset_required_fields(jsonified_request) + jsonified_request.update(unset_fields) + + # verify required fields with default values are now present + + jsonified_request["name"] = "name_value" + + unset_fields = transport_class( + credentials=ga_credentials.AnonymousCredentials() + ).get_reference_image._get_unset_required_fields(jsonified_request) + jsonified_request.update(unset_fields) + + # verify required fields with non-default values are left alone + assert "name" in jsonified_request + assert jsonified_request["name"] == "name_value" + + client = ProductSearchClient( + credentials=ga_credentials.AnonymousCredentials(), + transport="rest", + ) + request = request_type(**request_init) + + # Designate an appropriate value for the returned response. + return_value = product_search_service.ReferenceImage() + # Mock the http request call within the method and fake a response. + with mock.patch.object(Session, "request") as req: + # We need to mock transcode() because providing default values + # for required fields will fail the real version if the http_options + # expect actual values for those fields. + with mock.patch.object(path_template, "transcode") as transcode: + # A uri without fields and an empty body will force all the + # request fields to show up in the query_params. + pb_request = request_type.pb(request) + transcode_result = { + "uri": "v1/sample_method", + "method": "get", + "query_params": pb_request, + } + transcode.return_value = transcode_result + + response_value = Response() + response_value.status_code = 200 + + pb_return_value = product_search_service.ReferenceImage.pb(return_value) + json_return_value = json_format.MessageToJson(pb_return_value) + + response_value._content = json_return_value.encode("UTF-8") + req.return_value = response_value + + response = client.get_reference_image(request) + + expected_params = [("$alt", "json;enum-encoding=int")] + actual_params = req.call_args.kwargs["params"] + assert expected_params == actual_params + + +def test_get_reference_image_rest_unset_required_fields(): + transport = transports.ProductSearchRestTransport( + credentials=ga_credentials.AnonymousCredentials + ) + + unset_fields = transport.get_reference_image._get_unset_required_fields({}) + assert set(unset_fields) == (set(()) & set(("name",))) + + +@pytest.mark.parametrize("null_interceptor", [True, False]) +def test_get_reference_image_rest_interceptors(null_interceptor): + transport = transports.ProductSearchRestTransport( + credentials=ga_credentials.AnonymousCredentials(), + interceptor=None + if null_interceptor + else transports.ProductSearchRestInterceptor(), + ) + client = ProductSearchClient(transport=transport) + with mock.patch.object( + type(client.transport._session), "request" + ) as req, mock.patch.object( + path_template, "transcode" + ) as transcode, mock.patch.object( + transports.ProductSearchRestInterceptor, "post_get_reference_image" + ) as post, mock.patch.object( + transports.ProductSearchRestInterceptor, "pre_get_reference_image" + ) as pre: + pre.assert_not_called() + post.assert_not_called() + pb_message = product_search_service.GetReferenceImageRequest.pb( + product_search_service.GetReferenceImageRequest() + ) + transcode.return_value = { + "method": "post", + "uri": "my_uri", + "body": pb_message, + "query_params": pb_message, + } + + req.return_value = Response() + req.return_value.status_code = 200 + req.return_value.request = PreparedRequest() + req.return_value._content = product_search_service.ReferenceImage.to_json( + product_search_service.ReferenceImage() + ) + + request = product_search_service.GetReferenceImageRequest() + metadata = [ + ("key", "val"), + ("cephalopod", "squid"), + ] + pre.return_value = request, metadata + post.return_value = product_search_service.ReferenceImage() + + client.get_reference_image( + request, + metadata=[ + ("key", "val"), + ("cephalopod", "squid"), + ], + ) + + pre.assert_called_once() + post.assert_called_once() + + +def test_get_reference_image_rest_bad_request( + transport: str = "rest", + request_type=product_search_service.GetReferenceImageRequest, +): + client = ProductSearchClient( + credentials=ga_credentials.AnonymousCredentials(), + transport=transport, + ) + + # send a request that will satisfy transcoding + request_init = { + "name": "projects/sample1/locations/sample2/products/sample3/referenceImages/sample4" + } + request = request_type(**request_init) + + # Mock the http request call within the method and fake a BadRequest error. + with mock.patch.object(Session, "request") as req, pytest.raises( + core_exceptions.BadRequest + ): + # Wrap the value into a proper Response obj + response_value = Response() + response_value.status_code = 400 + response_value.request = Request() + req.return_value = response_value + client.get_reference_image(request) + + +def test_get_reference_image_rest_flattened(): + client = ProductSearchClient( + credentials=ga_credentials.AnonymousCredentials(), + transport="rest", + ) + + # Mock the http request call within the method and fake a response. + with mock.patch.object(type(client.transport._session), "request") as req: + # Designate an appropriate value for the returned response. + return_value = product_search_service.ReferenceImage() + + # get arguments that satisfy an http rule for this method + sample_request = { + "name": "projects/sample1/locations/sample2/products/sample3/referenceImages/sample4" + } + + # get truthy value for each flattened field + mock_args = dict( + name="name_value", + ) + mock_args.update(sample_request) + + # Wrap the value into a proper Response obj + response_value = Response() + response_value.status_code = 200 + pb_return_value = product_search_service.ReferenceImage.pb(return_value) + json_return_value = json_format.MessageToJson(pb_return_value) + response_value._content = json_return_value.encode("UTF-8") + req.return_value = response_value + + client.get_reference_image(**mock_args) + + # Establish that the underlying call was made with the expected + # request object values. + assert len(req.mock_calls) == 1 + _, args, _ = req.mock_calls[0] + assert path_template.validate( + "%s/v1p3beta1/{name=projects/*/locations/*/products/*/referenceImages/*}" + % client.transport._host, + args[1], + ) + + +def test_get_reference_image_rest_flattened_error(transport: str = "rest"): + client = ProductSearchClient( + credentials=ga_credentials.AnonymousCredentials(), + transport=transport, + ) + + # Attempting to call a method with both a request object and flattened + # fields is an error. + with pytest.raises(ValueError): + client.get_reference_image( + product_search_service.GetReferenceImageRequest(), + name="name_value", + ) + + +def test_get_reference_image_rest_error(): + client = ProductSearchClient( + credentials=ga_credentials.AnonymousCredentials(), transport="rest" + ) + + +@pytest.mark.parametrize( + "request_type", + [ + product_search_service.AddProductToProductSetRequest, + dict, + ], +) +def test_add_product_to_product_set_rest(request_type): + client = ProductSearchClient( + credentials=ga_credentials.AnonymousCredentials(), + transport="rest", + ) + + # send a request that will satisfy transcoding + request_init = {"name": "projects/sample1/locations/sample2/productSets/sample3"} + request = request_type(**request_init) + + # Mock the http request call within the method and fake a response. + with mock.patch.object(type(client.transport._session), "request") as req: + # Designate an appropriate value for the returned response. + return_value = None + + # Wrap the value into a proper Response obj + response_value = Response() + response_value.status_code = 200 + json_return_value = "" + + response_value._content = json_return_value.encode("UTF-8") + req.return_value = response_value + response = client.add_product_to_product_set(request) + + # Establish that the response is the type that we expect. + assert response is None + + +def test_add_product_to_product_set_rest_required_fields( + request_type=product_search_service.AddProductToProductSetRequest, +): + transport_class = transports.ProductSearchRestTransport + + request_init = {} + request_init["name"] = "" + request_init["product"] = "" + request = request_type(**request_init) + pb_request = request_type.pb(request) + jsonified_request = json.loads( + json_format.MessageToJson( + pb_request, + including_default_value_fields=False, + use_integers_for_enums=False, + ) + ) + + # verify fields with default values are dropped + + unset_fields = transport_class( + credentials=ga_credentials.AnonymousCredentials() + ).add_product_to_product_set._get_unset_required_fields(jsonified_request) + jsonified_request.update(unset_fields) + + # verify required fields with default values are now present + + jsonified_request["name"] = "name_value" + jsonified_request["product"] = "product_value" + + unset_fields = transport_class( + credentials=ga_credentials.AnonymousCredentials() + ).add_product_to_product_set._get_unset_required_fields(jsonified_request) + jsonified_request.update(unset_fields) + + # verify required fields with non-default values are left alone + assert "name" in jsonified_request + assert jsonified_request["name"] == "name_value" + assert "product" in jsonified_request + assert jsonified_request["product"] == "product_value" + + client = ProductSearchClient( + credentials=ga_credentials.AnonymousCredentials(), + transport="rest", + ) + request = request_type(**request_init) + + # Designate an appropriate value for the returned response. + return_value = None + # Mock the http request call within the method and fake a response. + with mock.patch.object(Session, "request") as req: + # We need to mock transcode() because providing default values + # for required fields will fail the real version if the http_options + # expect actual values for those fields. + with mock.patch.object(path_template, "transcode") as transcode: + # A uri without fields and an empty body will force all the + # request fields to show up in the query_params. + pb_request = request_type.pb(request) + transcode_result = { + "uri": "v1/sample_method", + "method": "post", + "query_params": pb_request, + } + transcode_result["body"] = pb_request + transcode.return_value = transcode_result + + response_value = Response() + response_value.status_code = 200 + json_return_value = "" + + response_value._content = json_return_value.encode("UTF-8") + req.return_value = response_value + + response = client.add_product_to_product_set(request) + + expected_params = [("$alt", "json;enum-encoding=int")] + actual_params = req.call_args.kwargs["params"] + assert expected_params == actual_params + + +def test_add_product_to_product_set_rest_unset_required_fields(): + transport = transports.ProductSearchRestTransport( + credentials=ga_credentials.AnonymousCredentials + ) + + unset_fields = transport.add_product_to_product_set._get_unset_required_fields({}) + assert set(unset_fields) == ( + set(()) + & set( + ( + "name", + "product", + ) + ) + ) + + +@pytest.mark.parametrize("null_interceptor", [True, False]) +def test_add_product_to_product_set_rest_interceptors(null_interceptor): + transport = transports.ProductSearchRestTransport( + credentials=ga_credentials.AnonymousCredentials(), + interceptor=None + if null_interceptor + else transports.ProductSearchRestInterceptor(), + ) + client = ProductSearchClient(transport=transport) + with mock.patch.object( + type(client.transport._session), "request" + ) as req, mock.patch.object( + path_template, "transcode" + ) as transcode, mock.patch.object( + transports.ProductSearchRestInterceptor, "pre_add_product_to_product_set" + ) as pre: + pre.assert_not_called() + pb_message = product_search_service.AddProductToProductSetRequest.pb( + product_search_service.AddProductToProductSetRequest() + ) + transcode.return_value = { + "method": "post", + "uri": "my_uri", + "body": pb_message, + "query_params": pb_message, + } + + req.return_value = Response() + req.return_value.status_code = 200 + req.return_value.request = PreparedRequest() + + request = product_search_service.AddProductToProductSetRequest() + metadata = [ + ("key", "val"), + ("cephalopod", "squid"), + ] + pre.return_value = request, metadata + + client.add_product_to_product_set( + request, + metadata=[ + ("key", "val"), + ("cephalopod", "squid"), + ], + ) + + pre.assert_called_once() + + +def test_add_product_to_product_set_rest_bad_request( + transport: str = "rest", + request_type=product_search_service.AddProductToProductSetRequest, +): + client = ProductSearchClient( + credentials=ga_credentials.AnonymousCredentials(), + transport=transport, + ) + + # send a request that will satisfy transcoding + request_init = {"name": "projects/sample1/locations/sample2/productSets/sample3"} + request = request_type(**request_init) + + # Mock the http request call within the method and fake a BadRequest error. + with mock.patch.object(Session, "request") as req, pytest.raises( + core_exceptions.BadRequest + ): + # Wrap the value into a proper Response obj + response_value = Response() + response_value.status_code = 400 + response_value.request = Request() + req.return_value = response_value + client.add_product_to_product_set(request) + + +def test_add_product_to_product_set_rest_flattened(): + client = ProductSearchClient( + credentials=ga_credentials.AnonymousCredentials(), + transport="rest", + ) + + # Mock the http request call within the method and fake a response. + with mock.patch.object(type(client.transport._session), "request") as req: + # Designate an appropriate value for the returned response. + return_value = None + + # get arguments that satisfy an http rule for this method + sample_request = { + "name": "projects/sample1/locations/sample2/productSets/sample3" + } + + # get truthy value for each flattened field + mock_args = dict( + name="name_value", + product="product_value", + ) + mock_args.update(sample_request) + + # Wrap the value into a proper Response obj + response_value = Response() + response_value.status_code = 200 + json_return_value = "" + response_value._content = json_return_value.encode("UTF-8") + req.return_value = response_value + + client.add_product_to_product_set(**mock_args) + + # Establish that the underlying call was made with the expected + # request object values. + assert len(req.mock_calls) == 1 + _, args, _ = req.mock_calls[0] + assert path_template.validate( + "%s/v1p3beta1/{name=projects/*/locations/*/productSets/*}:addProduct" + % client.transport._host, + args[1], + ) + + +def test_add_product_to_product_set_rest_flattened_error(transport: str = "rest"): + client = ProductSearchClient( + credentials=ga_credentials.AnonymousCredentials(), + transport=transport, + ) + + # Attempting to call a method with both a request object and flattened + # fields is an error. + with pytest.raises(ValueError): + client.add_product_to_product_set( + product_search_service.AddProductToProductSetRequest(), + name="name_value", + product="product_value", + ) + + +def test_add_product_to_product_set_rest_error(): + client = ProductSearchClient( + credentials=ga_credentials.AnonymousCredentials(), transport="rest" + ) + + +@pytest.mark.parametrize( + "request_type", + [ + product_search_service.RemoveProductFromProductSetRequest, + dict, + ], +) +def test_remove_product_from_product_set_rest(request_type): + client = ProductSearchClient( + credentials=ga_credentials.AnonymousCredentials(), + transport="rest", + ) + + # send a request that will satisfy transcoding + request_init = {"name": "projects/sample1/locations/sample2/productSets/sample3"} + request = request_type(**request_init) + + # Mock the http request call within the method and fake a response. + with mock.patch.object(type(client.transport._session), "request") as req: + # Designate an appropriate value for the returned response. + return_value = None + + # Wrap the value into a proper Response obj + response_value = Response() + response_value.status_code = 200 + json_return_value = "" + + response_value._content = json_return_value.encode("UTF-8") + req.return_value = response_value + response = client.remove_product_from_product_set(request) + + # Establish that the response is the type that we expect. + assert response is None + + +def test_remove_product_from_product_set_rest_required_fields( + request_type=product_search_service.RemoveProductFromProductSetRequest, +): + transport_class = transports.ProductSearchRestTransport + + request_init = {} + request_init["name"] = "" + request_init["product"] = "" + request = request_type(**request_init) + pb_request = request_type.pb(request) + jsonified_request = json.loads( + json_format.MessageToJson( + pb_request, + including_default_value_fields=False, + use_integers_for_enums=False, + ) + ) + + # verify fields with default values are dropped + + unset_fields = transport_class( + credentials=ga_credentials.AnonymousCredentials() + ).remove_product_from_product_set._get_unset_required_fields(jsonified_request) + jsonified_request.update(unset_fields) + + # verify required fields with default values are now present + + jsonified_request["name"] = "name_value" + jsonified_request["product"] = "product_value" + + unset_fields = transport_class( + credentials=ga_credentials.AnonymousCredentials() + ).remove_product_from_product_set._get_unset_required_fields(jsonified_request) + jsonified_request.update(unset_fields) + + # verify required fields with non-default values are left alone + assert "name" in jsonified_request + assert jsonified_request["name"] == "name_value" + assert "product" in jsonified_request + assert jsonified_request["product"] == "product_value" + + client = ProductSearchClient( + credentials=ga_credentials.AnonymousCredentials(), + transport="rest", + ) + request = request_type(**request_init) + + # Designate an appropriate value for the returned response. + return_value = None + # Mock the http request call within the method and fake a response. + with mock.patch.object(Session, "request") as req: + # We need to mock transcode() because providing default values + # for required fields will fail the real version if the http_options + # expect actual values for those fields. + with mock.patch.object(path_template, "transcode") as transcode: + # A uri without fields and an empty body will force all the + # request fields to show up in the query_params. + pb_request = request_type.pb(request) + transcode_result = { + "uri": "v1/sample_method", + "method": "post", + "query_params": pb_request, + } + transcode_result["body"] = pb_request + transcode.return_value = transcode_result + + response_value = Response() + response_value.status_code = 200 + json_return_value = "" + + response_value._content = json_return_value.encode("UTF-8") + req.return_value = response_value + + response = client.remove_product_from_product_set(request) + + expected_params = [("$alt", "json;enum-encoding=int")] + actual_params = req.call_args.kwargs["params"] + assert expected_params == actual_params + + +def test_remove_product_from_product_set_rest_unset_required_fields(): + transport = transports.ProductSearchRestTransport( + credentials=ga_credentials.AnonymousCredentials + ) + + unset_fields = transport.remove_product_from_product_set._get_unset_required_fields( + {} + ) + assert set(unset_fields) == ( + set(()) + & set( + ( + "name", + "product", + ) + ) + ) + + +@pytest.mark.parametrize("null_interceptor", [True, False]) +def test_remove_product_from_product_set_rest_interceptors(null_interceptor): + transport = transports.ProductSearchRestTransport( + credentials=ga_credentials.AnonymousCredentials(), + interceptor=None + if null_interceptor + else transports.ProductSearchRestInterceptor(), + ) + client = ProductSearchClient(transport=transport) + with mock.patch.object( + type(client.transport._session), "request" + ) as req, mock.patch.object( + path_template, "transcode" + ) as transcode, mock.patch.object( + transports.ProductSearchRestInterceptor, "pre_remove_product_from_product_set" + ) as pre: + pre.assert_not_called() + pb_message = product_search_service.RemoveProductFromProductSetRequest.pb( + product_search_service.RemoveProductFromProductSetRequest() + ) + transcode.return_value = { + "method": "post", + "uri": "my_uri", + "body": pb_message, + "query_params": pb_message, + } + + req.return_value = Response() + req.return_value.status_code = 200 + req.return_value.request = PreparedRequest() + + request = product_search_service.RemoveProductFromProductSetRequest() + metadata = [ + ("key", "val"), + ("cephalopod", "squid"), + ] + pre.return_value = request, metadata + + client.remove_product_from_product_set( + request, + metadata=[ + ("key", "val"), + ("cephalopod", "squid"), + ], + ) + + pre.assert_called_once() + + +def test_remove_product_from_product_set_rest_bad_request( + transport: str = "rest", + request_type=product_search_service.RemoveProductFromProductSetRequest, +): + client = ProductSearchClient( + credentials=ga_credentials.AnonymousCredentials(), + transport=transport, + ) + + # send a request that will satisfy transcoding + request_init = {"name": "projects/sample1/locations/sample2/productSets/sample3"} + request = request_type(**request_init) + + # Mock the http request call within the method and fake a BadRequest error. + with mock.patch.object(Session, "request") as req, pytest.raises( + core_exceptions.BadRequest + ): + # Wrap the value into a proper Response obj + response_value = Response() + response_value.status_code = 400 + response_value.request = Request() + req.return_value = response_value + client.remove_product_from_product_set(request) + + +def test_remove_product_from_product_set_rest_flattened(): + client = ProductSearchClient( + credentials=ga_credentials.AnonymousCredentials(), + transport="rest", + ) + + # Mock the http request call within the method and fake a response. + with mock.patch.object(type(client.transport._session), "request") as req: + # Designate an appropriate value for the returned response. + return_value = None + + # get arguments that satisfy an http rule for this method + sample_request = { + "name": "projects/sample1/locations/sample2/productSets/sample3" + } + + # get truthy value for each flattened field + mock_args = dict( + name="name_value", + product="product_value", + ) + mock_args.update(sample_request) + + # Wrap the value into a proper Response obj + response_value = Response() + response_value.status_code = 200 + json_return_value = "" + response_value._content = json_return_value.encode("UTF-8") + req.return_value = response_value + + client.remove_product_from_product_set(**mock_args) + + # Establish that the underlying call was made with the expected + # request object values. + assert len(req.mock_calls) == 1 + _, args, _ = req.mock_calls[0] + assert path_template.validate( + "%s/v1p3beta1/{name=projects/*/locations/*/productSets/*}:removeProduct" + % client.transport._host, + args[1], + ) + + +def test_remove_product_from_product_set_rest_flattened_error(transport: str = "rest"): + client = ProductSearchClient( + credentials=ga_credentials.AnonymousCredentials(), + transport=transport, + ) + + # Attempting to call a method with both a request object and flattened + # fields is an error. + with pytest.raises(ValueError): + client.remove_product_from_product_set( + product_search_service.RemoveProductFromProductSetRequest(), + name="name_value", + product="product_value", + ) + + +def test_remove_product_from_product_set_rest_error(): + client = ProductSearchClient( + credentials=ga_credentials.AnonymousCredentials(), transport="rest" + ) + + +@pytest.mark.parametrize( + "request_type", + [ + product_search_service.ListProductsInProductSetRequest, + dict, + ], +) +def test_list_products_in_product_set_rest(request_type): + client = ProductSearchClient( + credentials=ga_credentials.AnonymousCredentials(), + transport="rest", + ) + + # send a request that will satisfy transcoding + request_init = {"name": "projects/sample1/locations/sample2/productSets/sample3"} + request = request_type(**request_init) + + # Mock the http request call within the method and fake a response. + with mock.patch.object(type(client.transport._session), "request") as req: + # Designate an appropriate value for the returned response. + return_value = product_search_service.ListProductsInProductSetResponse( + next_page_token="next_page_token_value", + ) + + # Wrap the value into a proper Response obj + response_value = Response() + response_value.status_code = 200 + pb_return_value = product_search_service.ListProductsInProductSetResponse.pb( + return_value + ) + json_return_value = json_format.MessageToJson(pb_return_value) + + response_value._content = json_return_value.encode("UTF-8") + req.return_value = response_value + response = client.list_products_in_product_set(request) + + # Establish that the response is the type that we expect. + assert isinstance(response, pagers.ListProductsInProductSetPager) + assert response.next_page_token == "next_page_token_value" + + +def test_list_products_in_product_set_rest_required_fields( + request_type=product_search_service.ListProductsInProductSetRequest, +): + transport_class = transports.ProductSearchRestTransport + + request_init = {} + request_init["name"] = "" + request = request_type(**request_init) + pb_request = request_type.pb(request) + jsonified_request = json.loads( + json_format.MessageToJson( + pb_request, + including_default_value_fields=False, + use_integers_for_enums=False, + ) + ) + + # verify fields with default values are dropped + + unset_fields = transport_class( + credentials=ga_credentials.AnonymousCredentials() + ).list_products_in_product_set._get_unset_required_fields(jsonified_request) + jsonified_request.update(unset_fields) + + # verify required fields with default values are now present + + jsonified_request["name"] = "name_value" + + unset_fields = transport_class( + credentials=ga_credentials.AnonymousCredentials() + ).list_products_in_product_set._get_unset_required_fields(jsonified_request) + # Check that path parameters and body parameters are not mixing in. + assert not set(unset_fields) - set( + ( + "page_size", + "page_token", + ) + ) + jsonified_request.update(unset_fields) + + # verify required fields with non-default values are left alone + assert "name" in jsonified_request + assert jsonified_request["name"] == "name_value" + + client = ProductSearchClient( + credentials=ga_credentials.AnonymousCredentials(), + transport="rest", + ) + request = request_type(**request_init) + + # Designate an appropriate value for the returned response. + return_value = product_search_service.ListProductsInProductSetResponse() + # Mock the http request call within the method and fake a response. + with mock.patch.object(Session, "request") as req: + # We need to mock transcode() because providing default values + # for required fields will fail the real version if the http_options + # expect actual values for those fields. + with mock.patch.object(path_template, "transcode") as transcode: + # A uri without fields and an empty body will force all the + # request fields to show up in the query_params. + pb_request = request_type.pb(request) + transcode_result = { + "uri": "v1/sample_method", + "method": "get", + "query_params": pb_request, + } + transcode.return_value = transcode_result + + response_value = Response() + response_value.status_code = 200 + + pb_return_value = ( + product_search_service.ListProductsInProductSetResponse.pb(return_value) + ) + json_return_value = json_format.MessageToJson(pb_return_value) + + response_value._content = json_return_value.encode("UTF-8") + req.return_value = response_value + + response = client.list_products_in_product_set(request) + + expected_params = [("$alt", "json;enum-encoding=int")] + actual_params = req.call_args.kwargs["params"] + assert expected_params == actual_params + + +def test_list_products_in_product_set_rest_unset_required_fields(): + transport = transports.ProductSearchRestTransport( + credentials=ga_credentials.AnonymousCredentials + ) + + unset_fields = transport.list_products_in_product_set._get_unset_required_fields({}) + assert set(unset_fields) == ( + set( + ( + "pageSize", + "pageToken", + ) + ) + & set(("name",)) + ) + + +@pytest.mark.parametrize("null_interceptor", [True, False]) +def test_list_products_in_product_set_rest_interceptors(null_interceptor): + transport = transports.ProductSearchRestTransport( + credentials=ga_credentials.AnonymousCredentials(), + interceptor=None + if null_interceptor + else transports.ProductSearchRestInterceptor(), + ) + client = ProductSearchClient(transport=transport) + with mock.patch.object( + type(client.transport._session), "request" + ) as req, mock.patch.object( + path_template, "transcode" + ) as transcode, mock.patch.object( + transports.ProductSearchRestInterceptor, "post_list_products_in_product_set" + ) as post, mock.patch.object( + transports.ProductSearchRestInterceptor, "pre_list_products_in_product_set" + ) as pre: + pre.assert_not_called() + post.assert_not_called() + pb_message = product_search_service.ListProductsInProductSetRequest.pb( + product_search_service.ListProductsInProductSetRequest() + ) + transcode.return_value = { + "method": "post", + "uri": "my_uri", + "body": pb_message, + "query_params": pb_message, + } + + req.return_value = Response() + req.return_value.status_code = 200 + req.return_value.request = PreparedRequest() + req.return_value._content = ( + product_search_service.ListProductsInProductSetResponse.to_json( + product_search_service.ListProductsInProductSetResponse() + ) + ) + + request = product_search_service.ListProductsInProductSetRequest() + metadata = [ + ("key", "val"), + ("cephalopod", "squid"), + ] + pre.return_value = request, metadata + post.return_value = product_search_service.ListProductsInProductSetResponse() + + client.list_products_in_product_set( + request, + metadata=[ + ("key", "val"), + ("cephalopod", "squid"), + ], + ) + + pre.assert_called_once() + post.assert_called_once() + + +def test_list_products_in_product_set_rest_bad_request( + transport: str = "rest", + request_type=product_search_service.ListProductsInProductSetRequest, +): + client = ProductSearchClient( + credentials=ga_credentials.AnonymousCredentials(), + transport=transport, + ) + + # send a request that will satisfy transcoding + request_init = {"name": "projects/sample1/locations/sample2/productSets/sample3"} + request = request_type(**request_init) + + # Mock the http request call within the method and fake a BadRequest error. + with mock.patch.object(Session, "request") as req, pytest.raises( + core_exceptions.BadRequest + ): + # Wrap the value into a proper Response obj + response_value = Response() + response_value.status_code = 400 + response_value.request = Request() + req.return_value = response_value + client.list_products_in_product_set(request) + + +def test_list_products_in_product_set_rest_flattened(): + client = ProductSearchClient( + credentials=ga_credentials.AnonymousCredentials(), + transport="rest", + ) + + # Mock the http request call within the method and fake a response. + with mock.patch.object(type(client.transport._session), "request") as req: + # Designate an appropriate value for the returned response. + return_value = product_search_service.ListProductsInProductSetResponse() + + # get arguments that satisfy an http rule for this method + sample_request = { + "name": "projects/sample1/locations/sample2/productSets/sample3" + } + + # get truthy value for each flattened field + mock_args = dict( + name="name_value", + ) + mock_args.update(sample_request) + + # Wrap the value into a proper Response obj + response_value = Response() + response_value.status_code = 200 + pb_return_value = product_search_service.ListProductsInProductSetResponse.pb( + return_value + ) + json_return_value = json_format.MessageToJson(pb_return_value) + response_value._content = json_return_value.encode("UTF-8") + req.return_value = response_value + + client.list_products_in_product_set(**mock_args) + + # Establish that the underlying call was made with the expected + # request object values. + assert len(req.mock_calls) == 1 + _, args, _ = req.mock_calls[0] + assert path_template.validate( + "%s/v1p3beta1/{name=projects/*/locations/*/productSets/*}/products" + % client.transport._host, + args[1], + ) + + +def test_list_products_in_product_set_rest_flattened_error(transport: str = "rest"): + client = ProductSearchClient( + credentials=ga_credentials.AnonymousCredentials(), + transport=transport, + ) + + # Attempting to call a method with both a request object and flattened + # fields is an error. + with pytest.raises(ValueError): + client.list_products_in_product_set( + product_search_service.ListProductsInProductSetRequest(), + name="name_value", + ) + + +def test_list_products_in_product_set_rest_pager(transport: str = "rest"): + client = ProductSearchClient( + credentials=ga_credentials.AnonymousCredentials(), + transport=transport, + ) + + # Mock the http request call within the method and fake a response. + with mock.patch.object(Session, "request") as req: + # TODO(kbandes): remove this mock unless there's a good reason for it. + # with mock.patch.object(path_template, 'transcode') as transcode: + # Set the response as a series of pages + response = ( + product_search_service.ListProductsInProductSetResponse( + products=[ + product_search_service.Product(), + product_search_service.Product(), + product_search_service.Product(), + ], + next_page_token="abc", + ), + product_search_service.ListProductsInProductSetResponse( + products=[], + next_page_token="def", + ), + product_search_service.ListProductsInProductSetResponse( + products=[ + product_search_service.Product(), + ], + next_page_token="ghi", + ), + product_search_service.ListProductsInProductSetResponse( + products=[ + product_search_service.Product(), + product_search_service.Product(), + ], + ), + ) + # Two responses for two calls + response = response + response + + # Wrap the values into proper Response objs + response = tuple( + product_search_service.ListProductsInProductSetResponse.to_json(x) + for x in response + ) + return_values = tuple(Response() for i in response) + for return_val, response_val in zip(return_values, response): + return_val._content = response_val.encode("UTF-8") + return_val.status_code = 200 + req.side_effect = return_values + + sample_request = { + "name": "projects/sample1/locations/sample2/productSets/sample3" + } + + pager = client.list_products_in_product_set(request=sample_request) + + results = list(pager) + assert len(results) == 6 + assert all(isinstance(i, product_search_service.Product) for i in results) + + pages = list(client.list_products_in_product_set(request=sample_request).pages) + for page_, token in zip(pages, ["abc", "def", "ghi", ""]): + assert page_.raw_page.next_page_token == token + + +@pytest.mark.parametrize( + "request_type", + [ + product_search_service.ImportProductSetsRequest, + dict, + ], +) +def test_import_product_sets_rest(request_type): + client = ProductSearchClient( + credentials=ga_credentials.AnonymousCredentials(), + transport="rest", + ) + + # send a request that will satisfy transcoding + request_init = {"parent": "projects/sample1/locations/sample2"} + request = request_type(**request_init) + + # Mock the http request call within the method and fake a response. + with mock.patch.object(type(client.transport._session), "request") as req: + # Designate an appropriate value for the returned response. + return_value = operations_pb2.Operation(name="operations/spam") + + # Wrap the value into a proper Response obj + response_value = Response() + response_value.status_code = 200 + json_return_value = json_format.MessageToJson(return_value) + + response_value._content = json_return_value.encode("UTF-8") + req.return_value = response_value + response = client.import_product_sets(request) + + # Establish that the response is the type that we expect. + assert response.operation.name == "operations/spam" + + +def test_import_product_sets_rest_required_fields( + request_type=product_search_service.ImportProductSetsRequest, +): + transport_class = transports.ProductSearchRestTransport + + request_init = {} + request_init["parent"] = "" + request = request_type(**request_init) + pb_request = request_type.pb(request) + jsonified_request = json.loads( + json_format.MessageToJson( + pb_request, + including_default_value_fields=False, + use_integers_for_enums=False, + ) + ) + + # verify fields with default values are dropped + + unset_fields = transport_class( + credentials=ga_credentials.AnonymousCredentials() + ).import_product_sets._get_unset_required_fields(jsonified_request) + jsonified_request.update(unset_fields) + + # verify required fields with default values are now present + + jsonified_request["parent"] = "parent_value" + + unset_fields = transport_class( + credentials=ga_credentials.AnonymousCredentials() + ).import_product_sets._get_unset_required_fields(jsonified_request) + jsonified_request.update(unset_fields) + + # verify required fields with non-default values are left alone + assert "parent" in jsonified_request + assert jsonified_request["parent"] == "parent_value" + + client = ProductSearchClient( + credentials=ga_credentials.AnonymousCredentials(), + transport="rest", + ) + request = request_type(**request_init) + + # Designate an appropriate value for the returned response. + return_value = operations_pb2.Operation(name="operations/spam") + # Mock the http request call within the method and fake a response. + with mock.patch.object(Session, "request") as req: + # We need to mock transcode() because providing default values + # for required fields will fail the real version if the http_options + # expect actual values for those fields. + with mock.patch.object(path_template, "transcode") as transcode: + # A uri without fields and an empty body will force all the + # request fields to show up in the query_params. + pb_request = request_type.pb(request) + transcode_result = { + "uri": "v1/sample_method", + "method": "post", + "query_params": pb_request, + } + transcode_result["body"] = pb_request + transcode.return_value = transcode_result + + response_value = Response() + response_value.status_code = 200 + json_return_value = json_format.MessageToJson(return_value) + + response_value._content = json_return_value.encode("UTF-8") + req.return_value = response_value + + response = client.import_product_sets(request) + + expected_params = [("$alt", "json;enum-encoding=int")] + actual_params = req.call_args.kwargs["params"] + assert expected_params == actual_params + + +def test_import_product_sets_rest_unset_required_fields(): + transport = transports.ProductSearchRestTransport( + credentials=ga_credentials.AnonymousCredentials + ) + + unset_fields = transport.import_product_sets._get_unset_required_fields({}) + assert set(unset_fields) == ( + set(()) + & set( + ( + "parent", + "inputConfig", + ) + ) + ) + + +@pytest.mark.parametrize("null_interceptor", [True, False]) +def test_import_product_sets_rest_interceptors(null_interceptor): + transport = transports.ProductSearchRestTransport( + credentials=ga_credentials.AnonymousCredentials(), + interceptor=None + if null_interceptor + else transports.ProductSearchRestInterceptor(), + ) + client = ProductSearchClient(transport=transport) + with mock.patch.object( + type(client.transport._session), "request" + ) as req, mock.patch.object( + path_template, "transcode" + ) as transcode, mock.patch.object( + operation.Operation, "_set_result_from_operation" + ), mock.patch.object( + transports.ProductSearchRestInterceptor, "post_import_product_sets" + ) as post, mock.patch.object( + transports.ProductSearchRestInterceptor, "pre_import_product_sets" + ) as pre: + pre.assert_not_called() + post.assert_not_called() + pb_message = product_search_service.ImportProductSetsRequest.pb( + product_search_service.ImportProductSetsRequest() + ) + transcode.return_value = { + "method": "post", + "uri": "my_uri", + "body": pb_message, + "query_params": pb_message, + } + + req.return_value = Response() + req.return_value.status_code = 200 + req.return_value.request = PreparedRequest() + req.return_value._content = json_format.MessageToJson( + operations_pb2.Operation() + ) + + request = product_search_service.ImportProductSetsRequest() + metadata = [ + ("key", "val"), + ("cephalopod", "squid"), + ] + pre.return_value = request, metadata + post.return_value = operations_pb2.Operation() + + client.import_product_sets( + request, + metadata=[ + ("key", "val"), + ("cephalopod", "squid"), + ], + ) + + pre.assert_called_once() + post.assert_called_once() + + +def test_import_product_sets_rest_bad_request( + transport: str = "rest", + request_type=product_search_service.ImportProductSetsRequest, +): + client = ProductSearchClient( + credentials=ga_credentials.AnonymousCredentials(), + transport=transport, + ) + + # send a request that will satisfy transcoding + request_init = {"parent": "projects/sample1/locations/sample2"} + request = request_type(**request_init) + + # Mock the http request call within the method and fake a BadRequest error. + with mock.patch.object(Session, "request") as req, pytest.raises( + core_exceptions.BadRequest + ): + # Wrap the value into a proper Response obj + response_value = Response() + response_value.status_code = 400 + response_value.request = Request() + req.return_value = response_value + client.import_product_sets(request) + + +def test_import_product_sets_rest_flattened(): + client = ProductSearchClient( + credentials=ga_credentials.AnonymousCredentials(), + transport="rest", + ) + + # Mock the http request call within the method and fake a response. + with mock.patch.object(type(client.transport._session), "request") as req: + # Designate an appropriate value for the returned response. + return_value = operations_pb2.Operation(name="operations/spam") + + # get arguments that satisfy an http rule for this method + sample_request = {"parent": "projects/sample1/locations/sample2"} + + # get truthy value for each flattened field + mock_args = dict( + parent="parent_value", + input_config=product_search_service.ImportProductSetsInputConfig( + gcs_source=product_search_service.ImportProductSetsGcsSource( + csv_file_uri="csv_file_uri_value" + ) + ), + ) + mock_args.update(sample_request) + + # Wrap the value into a proper Response obj + response_value = Response() + response_value.status_code = 200 + json_return_value = json_format.MessageToJson(return_value) + response_value._content = json_return_value.encode("UTF-8") + req.return_value = response_value + + client.import_product_sets(**mock_args) + + # Establish that the underlying call was made with the expected + # request object values. + assert len(req.mock_calls) == 1 + _, args, _ = req.mock_calls[0] + assert path_template.validate( + "%s/v1p3beta1/{parent=projects/*/locations/*}/productSets:import" + % client.transport._host, + args[1], + ) + + +def test_import_product_sets_rest_flattened_error(transport: str = "rest"): + client = ProductSearchClient( + credentials=ga_credentials.AnonymousCredentials(), + transport=transport, + ) + + # Attempting to call a method with both a request object and flattened + # fields is an error. + with pytest.raises(ValueError): + client.import_product_sets( + product_search_service.ImportProductSetsRequest(), + parent="parent_value", + input_config=product_search_service.ImportProductSetsInputConfig( + gcs_source=product_search_service.ImportProductSetsGcsSource( + csv_file_uri="csv_file_uri_value" + ) + ), + ) + + +def test_import_product_sets_rest_error(): + client = ProductSearchClient( + credentials=ga_credentials.AnonymousCredentials(), transport="rest" + ) + + +def test_credentials_transport_error(): + # It is an error to provide credentials and a transport instance. + transport = transports.ProductSearchGrpcTransport( + credentials=ga_credentials.AnonymousCredentials(), + ) + with pytest.raises(ValueError): + client = ProductSearchClient( + credentials=ga_credentials.AnonymousCredentials(), + transport=transport, + ) + + # It is an error to provide a credentials file and a transport instance. + transport = transports.ProductSearchGrpcTransport( + credentials=ga_credentials.AnonymousCredentials(), + ) + with pytest.raises(ValueError): + client = ProductSearchClient( + client_options={"credentials_file": "credentials.json"}, + transport=transport, + ) + + # It is an error to provide an api_key and a transport instance. + transport = transports.ProductSearchGrpcTransport( + credentials=ga_credentials.AnonymousCredentials(), + ) + options = client_options.ClientOptions() + options.api_key = "api_key" + with pytest.raises(ValueError): + client = ProductSearchClient( + client_options=options, + transport=transport, + ) + + # It is an error to provide an api_key and a credential. + options = mock.Mock() + options.api_key = "api_key" + with pytest.raises(ValueError): + client = ProductSearchClient( + client_options=options, credentials=ga_credentials.AnonymousCredentials() + ) + + # It is an error to provide scopes and a transport instance. + transport = transports.ProductSearchGrpcTransport( + credentials=ga_credentials.AnonymousCredentials(), + ) + with pytest.raises(ValueError): + client = ProductSearchClient( + client_options={"scopes": ["1", "2"]}, + transport=transport, + ) + + +def test_transport_instance(): + # A client may be instantiated with a custom transport instance. + transport = transports.ProductSearchGrpcTransport( + credentials=ga_credentials.AnonymousCredentials(), + ) + client = ProductSearchClient(transport=transport) + assert client.transport is transport + + +def test_transport_get_channel(): + # A client may be instantiated with a custom transport instance. + transport = transports.ProductSearchGrpcTransport( + credentials=ga_credentials.AnonymousCredentials(), + ) + channel = transport.grpc_channel + assert channel + + transport = transports.ProductSearchGrpcAsyncIOTransport( + credentials=ga_credentials.AnonymousCredentials(), + ) + channel = transport.grpc_channel + assert channel + + +@pytest.mark.parametrize( + "transport_class", + [ + transports.ProductSearchGrpcTransport, + transports.ProductSearchGrpcAsyncIOTransport, + transports.ProductSearchRestTransport, + ], +) +def test_transport_adc(transport_class): + # Test default credentials are used if not provided. + with mock.patch.object(google.auth, "default") as adc: + adc.return_value = (ga_credentials.AnonymousCredentials(), None) + transport_class() + adc.assert_called_once() + + +@pytest.mark.parametrize( + "transport_name", + [ + "grpc", + "rest", + ], +) +def test_transport_kind(transport_name): + transport = ProductSearchClient.get_transport_class(transport_name)( + credentials=ga_credentials.AnonymousCredentials(), + ) + assert transport.kind == transport_name + + +def test_transport_grpc_default(): + # A client should use the gRPC transport by default. + client = ProductSearchClient( + credentials=ga_credentials.AnonymousCredentials(), + ) + assert isinstance( + client.transport, + transports.ProductSearchGrpcTransport, + ) + + +def test_product_search_base_transport_error(): + # Passing both a credentials object and credentials_file should raise an error + with pytest.raises(core_exceptions.DuplicateCredentialArgs): + transport = transports.ProductSearchTransport( + credentials=ga_credentials.AnonymousCredentials(), + credentials_file="credentials.json", + ) + + +def test_product_search_base_transport(): + # Instantiate the base transport. + with mock.patch( + "google.cloud.vision_v1p3beta1.services.product_search.transports.ProductSearchTransport.__init__" + ) as Transport: + Transport.return_value = None + transport = transports.ProductSearchTransport( + credentials=ga_credentials.AnonymousCredentials(), + ) + + # Every method on the transport should just blindly + # raise NotImplementedError. + methods = ( + "create_product_set", + "list_product_sets", + "get_product_set", + "update_product_set", + "delete_product_set", + "create_product", + "list_products", + "get_product", + "update_product", + "delete_product", + "create_reference_image", + "delete_reference_image", + "list_reference_images", + "get_reference_image", + "add_product_to_product_set", + "remove_product_from_product_set", + "list_products_in_product_set", + "import_product_sets", + ) + for method in methods: + 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): + transport.operations_client + + # Catch all for all remaining methods and properties + remainder = [ + "kind", + ] + for r in remainder: + with pytest.raises(NotImplementedError): + getattr(transport, r)() + + +def test_product_search_base_transport_with_credentials_file(): + # 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.vision_v1p3beta1.services.product_search.transports.ProductSearchTransport._prep_wrapped_messages" + ) as Transport: + Transport.return_value = None + load_creds.return_value = (ga_credentials.AnonymousCredentials(), None) + transport = transports.ProductSearchTransport( + credentials_file="credentials.json", + quota_project_id="octopus", + ) + load_creds.assert_called_once_with( + "credentials.json", + scopes=None, + default_scopes=( + "https://www.googleapis.com/auth/cloud-platform", + "https://www.googleapis.com/auth/cloud-vision", + ), + quota_project_id="octopus", + ) + + +def test_product_search_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( "google.cloud.vision_v1p3beta1.services.product_search.transports.ProductSearchTransport._prep_wrapped_messages" ) as Transport: Transport.return_value = None @@ -6220,6 +11598,7 @@ def test_product_search_transport_auth_adc(transport_class): [ transports.ProductSearchGrpcTransport, transports.ProductSearchGrpcAsyncIOTransport, + transports.ProductSearchRestTransport, ], ) def test_product_search_transport_auth_gdch_credentials(transport_class): @@ -6320,11 +11699,40 @@ def test_product_search_grpc_transport_client_cert_source_for_mtls(transport_cla ) +def test_product_search_http_transport_client_cert_source_for_mtls(): + cred = ga_credentials.AnonymousCredentials() + with mock.patch( + "google.auth.transport.requests.AuthorizedSession.configure_mtls_channel" + ) as mock_configure_mtls_channel: + transports.ProductSearchRestTransport( + credentials=cred, client_cert_source_for_mtls=client_cert_source_callback + ) + mock_configure_mtls_channel.assert_called_once_with(client_cert_source_callback) + + +def test_product_search_rest_lro_client(): + client = ProductSearchClient( + credentials=ga_credentials.AnonymousCredentials(), + transport="rest", + ) + transport = client.transport + + # Ensure that we have a api-core operations client. + assert isinstance( + transport.operations_client, + operations_v1.AbstractOperationsClient, + ) + + # Ensure that subsequent calls to the property send the exact same object. + assert transport.operations_client is transport.operations_client + + @pytest.mark.parametrize( "transport_name", [ "grpc", "grpc_asyncio", + "rest", ], ) def test_product_search_host_no_port(transport_name): @@ -6335,7 +11743,11 @@ def test_product_search_host_no_port(transport_name): ), transport=transport_name, ) - assert client.transport._host == ("vision.googleapis.com:443") + assert client.transport._host == ( + "vision.googleapis.com:443" + if transport_name in ["grpc", "grpc_asyncio"] + else "https://vision.googleapis.com/" + ) @pytest.mark.parametrize( @@ -6343,6 +11755,7 @@ def test_product_search_host_no_port(transport_name): [ "grpc", "grpc_asyncio", + "rest", ], ) def test_product_search_host_with_port(transport_name): @@ -6353,7 +11766,84 @@ def test_product_search_host_with_port(transport_name): ), transport=transport_name, ) - assert client.transport._host == ("vision.googleapis.com:8000") + assert client.transport._host == ( + "vision.googleapis.com:8000" + if transport_name in ["grpc", "grpc_asyncio"] + else "https://vision.googleapis.com:8000/" + ) + + +@pytest.mark.parametrize( + "transport_name", + [ + "rest", + ], +) +def test_product_search_client_transport_session_collision(transport_name): + creds1 = ga_credentials.AnonymousCredentials() + creds2 = ga_credentials.AnonymousCredentials() + client1 = ProductSearchClient( + credentials=creds1, + transport=transport_name, + ) + client2 = ProductSearchClient( + credentials=creds2, + transport=transport_name, + ) + session1 = client1.transport.create_product_set._session + session2 = client2.transport.create_product_set._session + assert session1 != session2 + session1 = client1.transport.list_product_sets._session + session2 = client2.transport.list_product_sets._session + assert session1 != session2 + session1 = client1.transport.get_product_set._session + session2 = client2.transport.get_product_set._session + assert session1 != session2 + session1 = client1.transport.update_product_set._session + session2 = client2.transport.update_product_set._session + assert session1 != session2 + session1 = client1.transport.delete_product_set._session + session2 = client2.transport.delete_product_set._session + assert session1 != session2 + session1 = client1.transport.create_product._session + session2 = client2.transport.create_product._session + assert session1 != session2 + session1 = client1.transport.list_products._session + session2 = client2.transport.list_products._session + assert session1 != session2 + session1 = client1.transport.get_product._session + session2 = client2.transport.get_product._session + assert session1 != session2 + session1 = client1.transport.update_product._session + session2 = client2.transport.update_product._session + assert session1 != session2 + session1 = client1.transport.delete_product._session + session2 = client2.transport.delete_product._session + assert session1 != session2 + session1 = client1.transport.create_reference_image._session + session2 = client2.transport.create_reference_image._session + assert session1 != session2 + session1 = client1.transport.delete_reference_image._session + session2 = client2.transport.delete_reference_image._session + assert session1 != session2 + session1 = client1.transport.list_reference_images._session + session2 = client2.transport.list_reference_images._session + assert session1 != session2 + session1 = client1.transport.get_reference_image._session + session2 = client2.transport.get_reference_image._session + assert session1 != session2 + session1 = client1.transport.add_product_to_product_set._session + session2 = client2.transport.add_product_to_product_set._session + assert session1 != session2 + session1 = client1.transport.remove_product_from_product_set._session + session2 = client2.transport.remove_product_from_product_set._session + assert session1 != session2 + session1 = client1.transport.list_products_in_product_set._session + session2 = client2.transport.list_products_in_product_set._session + assert session1 != session2 + session1 = client1.transport.import_product_sets._session + session2 = client2.transport.import_product_sets._session + assert session1 != session2 def test_product_search_grpc_transport_channel(): @@ -6741,6 +12231,7 @@ async def test_transport_close_async(): def test_transport_close(): transports = { + "rest": "_session", "grpc": "_grpc_channel", } @@ -6758,6 +12249,7 @@ def test_transport_close(): def test_client_ctx(): transports = [ + "rest", "grpc", ] for transport in transports: diff --git a/tests/unit/gapic/vision_v1p4beta1/test_image_annotator.py b/tests/unit/gapic/vision_v1p4beta1/test_image_annotator.py index 84752b69..7646b71a 100644 --- a/tests/unit/gapic/vision_v1p4beta1/test_image_annotator.py +++ b/tests/unit/gapic/vision_v1p4beta1/test_image_annotator.py @@ -24,10 +24,17 @@ import grpc from grpc.experimental import aio +from collections.abc import Iterable +from google.protobuf import json_format +import json import math import pytest from proto.marshal.rules.dates import DurationRule, TimestampRule from proto.marshal.rules import wrappers +from requests import Response +from requests import Request, PreparedRequest +from requests.sessions import Session +from google.protobuf import json_format from google.api_core import client_options from google.api_core import exceptions as core_exceptions @@ -105,6 +112,7 @@ def test__get_default_mtls_endpoint(): [ (ImageAnnotatorClient, "grpc"), (ImageAnnotatorAsyncClient, "grpc_asyncio"), + (ImageAnnotatorClient, "rest"), ], ) def test_image_annotator_client_from_service_account_info(client_class, transport_name): @@ -118,7 +126,11 @@ def test_image_annotator_client_from_service_account_info(client_class, transpor assert client.transport._credentials == creds assert isinstance(client, client_class) - assert client.transport._host == ("vision.googleapis.com:443") + assert client.transport._host == ( + "vision.googleapis.com:443" + if transport_name in ["grpc", "grpc_asyncio"] + else "https://vision.googleapis.com/" + ) @pytest.mark.parametrize( @@ -126,6 +138,7 @@ def test_image_annotator_client_from_service_account_info(client_class, transpor [ (transports.ImageAnnotatorGrpcTransport, "grpc"), (transports.ImageAnnotatorGrpcAsyncIOTransport, "grpc_asyncio"), + (transports.ImageAnnotatorRestTransport, "rest"), ], ) def test_image_annotator_client_service_account_always_use_jwt( @@ -151,6 +164,7 @@ def test_image_annotator_client_service_account_always_use_jwt( [ (ImageAnnotatorClient, "grpc"), (ImageAnnotatorAsyncClient, "grpc_asyncio"), + (ImageAnnotatorClient, "rest"), ], ) def test_image_annotator_client_from_service_account_file(client_class, transport_name): @@ -171,13 +185,18 @@ def test_image_annotator_client_from_service_account_file(client_class, transpor assert client.transport._credentials == creds assert isinstance(client, client_class) - assert client.transport._host == ("vision.googleapis.com:443") + assert client.transport._host == ( + "vision.googleapis.com:443" + if transport_name in ["grpc", "grpc_asyncio"] + else "https://vision.googleapis.com/" + ) def test_image_annotator_client_get_transport_class(): transport = ImageAnnotatorClient.get_transport_class() available_transports = [ transports.ImageAnnotatorGrpcTransport, + transports.ImageAnnotatorRestTransport, ] assert transport in available_transports @@ -194,6 +213,7 @@ def test_image_annotator_client_get_transport_class(): transports.ImageAnnotatorGrpcAsyncIOTransport, "grpc_asyncio", ), + (ImageAnnotatorClient, transports.ImageAnnotatorRestTransport, "rest"), ], ) @mock.patch.object( @@ -339,6 +359,8 @@ def test_image_annotator_client_client_options( "grpc_asyncio", "false", ), + (ImageAnnotatorClient, transports.ImageAnnotatorRestTransport, "rest", "true"), + (ImageAnnotatorClient, transports.ImageAnnotatorRestTransport, "rest", "false"), ], ) @mock.patch.object( @@ -538,6 +560,7 @@ def test_image_annotator_client_get_mtls_endpoint_and_cert_source(client_class): transports.ImageAnnotatorGrpcAsyncIOTransport, "grpc_asyncio", ), + (ImageAnnotatorClient, transports.ImageAnnotatorRestTransport, "rest"), ], ) def test_image_annotator_client_client_options_scopes( @@ -578,6 +601,7 @@ def test_image_annotator_client_client_options_scopes( "grpc_asyncio", grpc_helpers_async, ), + (ImageAnnotatorClient, transports.ImageAnnotatorRestTransport, "rest", None), ], ) def test_image_annotator_client_client_options_credentials_file( @@ -1539,6 +1563,1097 @@ async def test_async_batch_annotate_files_flattened_error_async(): ) +@pytest.mark.parametrize( + "request_type", + [ + image_annotator.BatchAnnotateImagesRequest, + dict, + ], +) +def test_batch_annotate_images_rest(request_type): + client = ImageAnnotatorClient( + credentials=ga_credentials.AnonymousCredentials(), + transport="rest", + ) + + # send a request that will satisfy transcoding + request_init = {} + request = request_type(**request_init) + + # Mock the http request call within the method and fake a response. + with mock.patch.object(type(client.transport._session), "request") as req: + # Designate an appropriate value for the returned response. + return_value = image_annotator.BatchAnnotateImagesResponse() + + # Wrap the value into a proper Response obj + response_value = Response() + response_value.status_code = 200 + pb_return_value = image_annotator.BatchAnnotateImagesResponse.pb(return_value) + json_return_value = json_format.MessageToJson(pb_return_value) + + response_value._content = json_return_value.encode("UTF-8") + req.return_value = response_value + response = client.batch_annotate_images(request) + + # Establish that the response is the type that we expect. + assert isinstance(response, image_annotator.BatchAnnotateImagesResponse) + + +def test_batch_annotate_images_rest_required_fields( + request_type=image_annotator.BatchAnnotateImagesRequest, +): + transport_class = transports.ImageAnnotatorRestTransport + + request_init = {} + request = request_type(**request_init) + pb_request = request_type.pb(request) + jsonified_request = json.loads( + json_format.MessageToJson( + pb_request, + including_default_value_fields=False, + use_integers_for_enums=False, + ) + ) + + # verify fields with default values are dropped + + unset_fields = transport_class( + credentials=ga_credentials.AnonymousCredentials() + ).batch_annotate_images._get_unset_required_fields(jsonified_request) + jsonified_request.update(unset_fields) + + # verify required fields with default values are now present + + unset_fields = transport_class( + credentials=ga_credentials.AnonymousCredentials() + ).batch_annotate_images._get_unset_required_fields(jsonified_request) + jsonified_request.update(unset_fields) + + # verify required fields with non-default values are left alone + + client = ImageAnnotatorClient( + credentials=ga_credentials.AnonymousCredentials(), + transport="rest", + ) + request = request_type(**request_init) + + # Designate an appropriate value for the returned response. + return_value = image_annotator.BatchAnnotateImagesResponse() + # Mock the http request call within the method and fake a response. + with mock.patch.object(Session, "request") as req: + # We need to mock transcode() because providing default values + # for required fields will fail the real version if the http_options + # expect actual values for those fields. + with mock.patch.object(path_template, "transcode") as transcode: + # A uri without fields and an empty body will force all the + # request fields to show up in the query_params. + pb_request = request_type.pb(request) + transcode_result = { + "uri": "v1/sample_method", + "method": "post", + "query_params": pb_request, + } + transcode_result["body"] = pb_request + transcode.return_value = transcode_result + + response_value = Response() + response_value.status_code = 200 + + pb_return_value = image_annotator.BatchAnnotateImagesResponse.pb( + return_value + ) + json_return_value = json_format.MessageToJson(pb_return_value) + + response_value._content = json_return_value.encode("UTF-8") + req.return_value = response_value + + response = client.batch_annotate_images(request) + + expected_params = [("$alt", "json;enum-encoding=int")] + actual_params = req.call_args.kwargs["params"] + assert expected_params == actual_params + + +def test_batch_annotate_images_rest_unset_required_fields(): + transport = transports.ImageAnnotatorRestTransport( + credentials=ga_credentials.AnonymousCredentials + ) + + unset_fields = transport.batch_annotate_images._get_unset_required_fields({}) + assert set(unset_fields) == (set(()) & set(("requests",))) + + +@pytest.mark.parametrize("null_interceptor", [True, False]) +def test_batch_annotate_images_rest_interceptors(null_interceptor): + transport = transports.ImageAnnotatorRestTransport( + credentials=ga_credentials.AnonymousCredentials(), + interceptor=None + if null_interceptor + else transports.ImageAnnotatorRestInterceptor(), + ) + client = ImageAnnotatorClient(transport=transport) + with mock.patch.object( + type(client.transport._session), "request" + ) as req, mock.patch.object( + path_template, "transcode" + ) as transcode, mock.patch.object( + transports.ImageAnnotatorRestInterceptor, "post_batch_annotate_images" + ) as post, mock.patch.object( + transports.ImageAnnotatorRestInterceptor, "pre_batch_annotate_images" + ) as pre: + pre.assert_not_called() + post.assert_not_called() + pb_message = image_annotator.BatchAnnotateImagesRequest.pb( + image_annotator.BatchAnnotateImagesRequest() + ) + transcode.return_value = { + "method": "post", + "uri": "my_uri", + "body": pb_message, + "query_params": pb_message, + } + + req.return_value = Response() + req.return_value.status_code = 200 + req.return_value.request = PreparedRequest() + req.return_value._content = image_annotator.BatchAnnotateImagesResponse.to_json( + image_annotator.BatchAnnotateImagesResponse() + ) + + request = image_annotator.BatchAnnotateImagesRequest() + metadata = [ + ("key", "val"), + ("cephalopod", "squid"), + ] + pre.return_value = request, metadata + post.return_value = image_annotator.BatchAnnotateImagesResponse() + + client.batch_annotate_images( + request, + metadata=[ + ("key", "val"), + ("cephalopod", "squid"), + ], + ) + + pre.assert_called_once() + post.assert_called_once() + + +def test_batch_annotate_images_rest_bad_request( + transport: str = "rest", request_type=image_annotator.BatchAnnotateImagesRequest +): + client = ImageAnnotatorClient( + credentials=ga_credentials.AnonymousCredentials(), + transport=transport, + ) + + # send a request that will satisfy transcoding + request_init = {} + request = request_type(**request_init) + + # Mock the http request call within the method and fake a BadRequest error. + with mock.patch.object(Session, "request") as req, pytest.raises( + core_exceptions.BadRequest + ): + # Wrap the value into a proper Response obj + response_value = Response() + response_value.status_code = 400 + response_value.request = Request() + req.return_value = response_value + client.batch_annotate_images(request) + + +def test_batch_annotate_images_rest_flattened(): + client = ImageAnnotatorClient( + credentials=ga_credentials.AnonymousCredentials(), + transport="rest", + ) + + # Mock the http request call within the method and fake a response. + with mock.patch.object(type(client.transport._session), "request") as req: + # Designate an appropriate value for the returned response. + return_value = image_annotator.BatchAnnotateImagesResponse() + + # get arguments that satisfy an http rule for this method + sample_request = {} + + # get truthy value for each flattened field + mock_args = dict( + requests=[ + image_annotator.AnnotateImageRequest( + image=image_annotator.Image(content=b"content_blob") + ) + ], + ) + mock_args.update(sample_request) + + # Wrap the value into a proper Response obj + response_value = Response() + response_value.status_code = 200 + pb_return_value = image_annotator.BatchAnnotateImagesResponse.pb(return_value) + json_return_value = json_format.MessageToJson(pb_return_value) + response_value._content = json_return_value.encode("UTF-8") + req.return_value = response_value + + client.batch_annotate_images(**mock_args) + + # Establish that the underlying call was made with the expected + # request object values. + assert len(req.mock_calls) == 1 + _, args, _ = req.mock_calls[0] + assert path_template.validate( + "%s/v1p4beta1/images:annotate" % client.transport._host, args[1] + ) + + +def test_batch_annotate_images_rest_flattened_error(transport: str = "rest"): + client = ImageAnnotatorClient( + credentials=ga_credentials.AnonymousCredentials(), + transport=transport, + ) + + # Attempting to call a method with both a request object and flattened + # fields is an error. + with pytest.raises(ValueError): + client.batch_annotate_images( + image_annotator.BatchAnnotateImagesRequest(), + requests=[ + image_annotator.AnnotateImageRequest( + image=image_annotator.Image(content=b"content_blob") + ) + ], + ) + + +def test_batch_annotate_images_rest_error(): + client = ImageAnnotatorClient( + credentials=ga_credentials.AnonymousCredentials(), transport="rest" + ) + + +@pytest.mark.parametrize( + "request_type", + [ + image_annotator.BatchAnnotateFilesRequest, + dict, + ], +) +def test_batch_annotate_files_rest(request_type): + client = ImageAnnotatorClient( + credentials=ga_credentials.AnonymousCredentials(), + transport="rest", + ) + + # send a request that will satisfy transcoding + request_init = {} + request = request_type(**request_init) + + # Mock the http request call within the method and fake a response. + with mock.patch.object(type(client.transport._session), "request") as req: + # Designate an appropriate value for the returned response. + return_value = image_annotator.BatchAnnotateFilesResponse() + + # Wrap the value into a proper Response obj + response_value = Response() + response_value.status_code = 200 + pb_return_value = image_annotator.BatchAnnotateFilesResponse.pb(return_value) + json_return_value = json_format.MessageToJson(pb_return_value) + + response_value._content = json_return_value.encode("UTF-8") + req.return_value = response_value + response = client.batch_annotate_files(request) + + # Establish that the response is the type that we expect. + assert isinstance(response, image_annotator.BatchAnnotateFilesResponse) + + +def test_batch_annotate_files_rest_required_fields( + request_type=image_annotator.BatchAnnotateFilesRequest, +): + transport_class = transports.ImageAnnotatorRestTransport + + request_init = {} + request = request_type(**request_init) + pb_request = request_type.pb(request) + jsonified_request = json.loads( + json_format.MessageToJson( + pb_request, + including_default_value_fields=False, + use_integers_for_enums=False, + ) + ) + + # verify fields with default values are dropped + + unset_fields = transport_class( + credentials=ga_credentials.AnonymousCredentials() + ).batch_annotate_files._get_unset_required_fields(jsonified_request) + jsonified_request.update(unset_fields) + + # verify required fields with default values are now present + + unset_fields = transport_class( + credentials=ga_credentials.AnonymousCredentials() + ).batch_annotate_files._get_unset_required_fields(jsonified_request) + jsonified_request.update(unset_fields) + + # verify required fields with non-default values are left alone + + client = ImageAnnotatorClient( + credentials=ga_credentials.AnonymousCredentials(), + transport="rest", + ) + request = request_type(**request_init) + + # Designate an appropriate value for the returned response. + return_value = image_annotator.BatchAnnotateFilesResponse() + # Mock the http request call within the method and fake a response. + with mock.patch.object(Session, "request") as req: + # We need to mock transcode() because providing default values + # for required fields will fail the real version if the http_options + # expect actual values for those fields. + with mock.patch.object(path_template, "transcode") as transcode: + # A uri without fields and an empty body will force all the + # request fields to show up in the query_params. + pb_request = request_type.pb(request) + transcode_result = { + "uri": "v1/sample_method", + "method": "post", + "query_params": pb_request, + } + transcode_result["body"] = pb_request + transcode.return_value = transcode_result + + response_value = Response() + response_value.status_code = 200 + + pb_return_value = image_annotator.BatchAnnotateFilesResponse.pb( + return_value + ) + json_return_value = json_format.MessageToJson(pb_return_value) + + response_value._content = json_return_value.encode("UTF-8") + req.return_value = response_value + + response = client.batch_annotate_files(request) + + expected_params = [("$alt", "json;enum-encoding=int")] + actual_params = req.call_args.kwargs["params"] + assert expected_params == actual_params + + +def test_batch_annotate_files_rest_unset_required_fields(): + transport = transports.ImageAnnotatorRestTransport( + credentials=ga_credentials.AnonymousCredentials + ) + + unset_fields = transport.batch_annotate_files._get_unset_required_fields({}) + assert set(unset_fields) == (set(()) & set(("requests",))) + + +@pytest.mark.parametrize("null_interceptor", [True, False]) +def test_batch_annotate_files_rest_interceptors(null_interceptor): + transport = transports.ImageAnnotatorRestTransport( + credentials=ga_credentials.AnonymousCredentials(), + interceptor=None + if null_interceptor + else transports.ImageAnnotatorRestInterceptor(), + ) + client = ImageAnnotatorClient(transport=transport) + with mock.patch.object( + type(client.transport._session), "request" + ) as req, mock.patch.object( + path_template, "transcode" + ) as transcode, mock.patch.object( + transports.ImageAnnotatorRestInterceptor, "post_batch_annotate_files" + ) as post, mock.patch.object( + transports.ImageAnnotatorRestInterceptor, "pre_batch_annotate_files" + ) as pre: + pre.assert_not_called() + post.assert_not_called() + pb_message = image_annotator.BatchAnnotateFilesRequest.pb( + image_annotator.BatchAnnotateFilesRequest() + ) + transcode.return_value = { + "method": "post", + "uri": "my_uri", + "body": pb_message, + "query_params": pb_message, + } + + req.return_value = Response() + req.return_value.status_code = 200 + req.return_value.request = PreparedRequest() + req.return_value._content = image_annotator.BatchAnnotateFilesResponse.to_json( + image_annotator.BatchAnnotateFilesResponse() + ) + + request = image_annotator.BatchAnnotateFilesRequest() + metadata = [ + ("key", "val"), + ("cephalopod", "squid"), + ] + pre.return_value = request, metadata + post.return_value = image_annotator.BatchAnnotateFilesResponse() + + client.batch_annotate_files( + request, + metadata=[ + ("key", "val"), + ("cephalopod", "squid"), + ], + ) + + pre.assert_called_once() + post.assert_called_once() + + +def test_batch_annotate_files_rest_bad_request( + transport: str = "rest", request_type=image_annotator.BatchAnnotateFilesRequest +): + client = ImageAnnotatorClient( + credentials=ga_credentials.AnonymousCredentials(), + transport=transport, + ) + + # send a request that will satisfy transcoding + request_init = {} + request = request_type(**request_init) + + # Mock the http request call within the method and fake a BadRequest error. + with mock.patch.object(Session, "request") as req, pytest.raises( + core_exceptions.BadRequest + ): + # Wrap the value into a proper Response obj + response_value = Response() + response_value.status_code = 400 + response_value.request = Request() + req.return_value = response_value + client.batch_annotate_files(request) + + +def test_batch_annotate_files_rest_flattened(): + client = ImageAnnotatorClient( + credentials=ga_credentials.AnonymousCredentials(), + transport="rest", + ) + + # Mock the http request call within the method and fake a response. + with mock.patch.object(type(client.transport._session), "request") as req: + # Designate an appropriate value for the returned response. + return_value = image_annotator.BatchAnnotateFilesResponse() + + # get arguments that satisfy an http rule for this method + sample_request = {} + + # get truthy value for each flattened field + mock_args = dict( + requests=[ + image_annotator.AnnotateFileRequest( + input_config=image_annotator.InputConfig( + gcs_source=image_annotator.GcsSource(uri="uri_value") + ) + ) + ], + ) + mock_args.update(sample_request) + + # Wrap the value into a proper Response obj + response_value = Response() + response_value.status_code = 200 + pb_return_value = image_annotator.BatchAnnotateFilesResponse.pb(return_value) + json_return_value = json_format.MessageToJson(pb_return_value) + response_value._content = json_return_value.encode("UTF-8") + req.return_value = response_value + + client.batch_annotate_files(**mock_args) + + # Establish that the underlying call was made with the expected + # request object values. + assert len(req.mock_calls) == 1 + _, args, _ = req.mock_calls[0] + assert path_template.validate( + "%s/v1p4beta1/files:annotate" % client.transport._host, args[1] + ) + + +def test_batch_annotate_files_rest_flattened_error(transport: str = "rest"): + client = ImageAnnotatorClient( + credentials=ga_credentials.AnonymousCredentials(), + transport=transport, + ) + + # Attempting to call a method with both a request object and flattened + # fields is an error. + with pytest.raises(ValueError): + client.batch_annotate_files( + image_annotator.BatchAnnotateFilesRequest(), + requests=[ + image_annotator.AnnotateFileRequest( + input_config=image_annotator.InputConfig( + gcs_source=image_annotator.GcsSource(uri="uri_value") + ) + ) + ], + ) + + +def test_batch_annotate_files_rest_error(): + client = ImageAnnotatorClient( + credentials=ga_credentials.AnonymousCredentials(), transport="rest" + ) + + +@pytest.mark.parametrize( + "request_type", + [ + image_annotator.AsyncBatchAnnotateImagesRequest, + dict, + ], +) +def test_async_batch_annotate_images_rest(request_type): + client = ImageAnnotatorClient( + credentials=ga_credentials.AnonymousCredentials(), + transport="rest", + ) + + # send a request that will satisfy transcoding + request_init = {} + request = request_type(**request_init) + + # Mock the http request call within the method and fake a response. + with mock.patch.object(type(client.transport._session), "request") as req: + # Designate an appropriate value for the returned response. + return_value = operations_pb2.Operation(name="operations/spam") + + # Wrap the value into a proper Response obj + response_value = Response() + response_value.status_code = 200 + json_return_value = json_format.MessageToJson(return_value) + + response_value._content = json_return_value.encode("UTF-8") + req.return_value = response_value + response = client.async_batch_annotate_images(request) + + # Establish that the response is the type that we expect. + assert response.operation.name == "operations/spam" + + +def test_async_batch_annotate_images_rest_required_fields( + request_type=image_annotator.AsyncBatchAnnotateImagesRequest, +): + transport_class = transports.ImageAnnotatorRestTransport + + request_init = {} + request = request_type(**request_init) + pb_request = request_type.pb(request) + jsonified_request = json.loads( + json_format.MessageToJson( + pb_request, + including_default_value_fields=False, + use_integers_for_enums=False, + ) + ) + + # verify fields with default values are dropped + + unset_fields = transport_class( + credentials=ga_credentials.AnonymousCredentials() + ).async_batch_annotate_images._get_unset_required_fields(jsonified_request) + jsonified_request.update(unset_fields) + + # verify required fields with default values are now present + + unset_fields = transport_class( + credentials=ga_credentials.AnonymousCredentials() + ).async_batch_annotate_images._get_unset_required_fields(jsonified_request) + jsonified_request.update(unset_fields) + + # verify required fields with non-default values are left alone + + client = ImageAnnotatorClient( + credentials=ga_credentials.AnonymousCredentials(), + transport="rest", + ) + request = request_type(**request_init) + + # Designate an appropriate value for the returned response. + return_value = operations_pb2.Operation(name="operations/spam") + # Mock the http request call within the method and fake a response. + with mock.patch.object(Session, "request") as req: + # We need to mock transcode() because providing default values + # for required fields will fail the real version if the http_options + # expect actual values for those fields. + with mock.patch.object(path_template, "transcode") as transcode: + # A uri without fields and an empty body will force all the + # request fields to show up in the query_params. + pb_request = request_type.pb(request) + transcode_result = { + "uri": "v1/sample_method", + "method": "post", + "query_params": pb_request, + } + transcode_result["body"] = pb_request + transcode.return_value = transcode_result + + response_value = Response() + response_value.status_code = 200 + json_return_value = json_format.MessageToJson(return_value) + + response_value._content = json_return_value.encode("UTF-8") + req.return_value = response_value + + response = client.async_batch_annotate_images(request) + + expected_params = [("$alt", "json;enum-encoding=int")] + actual_params = req.call_args.kwargs["params"] + assert expected_params == actual_params + + +def test_async_batch_annotate_images_rest_unset_required_fields(): + transport = transports.ImageAnnotatorRestTransport( + credentials=ga_credentials.AnonymousCredentials + ) + + unset_fields = transport.async_batch_annotate_images._get_unset_required_fields({}) + assert set(unset_fields) == ( + set(()) + & set( + ( + "requests", + "outputConfig", + ) + ) + ) + + +@pytest.mark.parametrize("null_interceptor", [True, False]) +def test_async_batch_annotate_images_rest_interceptors(null_interceptor): + transport = transports.ImageAnnotatorRestTransport( + credentials=ga_credentials.AnonymousCredentials(), + interceptor=None + if null_interceptor + else transports.ImageAnnotatorRestInterceptor(), + ) + client = ImageAnnotatorClient(transport=transport) + with mock.patch.object( + type(client.transport._session), "request" + ) as req, mock.patch.object( + path_template, "transcode" + ) as transcode, mock.patch.object( + operation.Operation, "_set_result_from_operation" + ), mock.patch.object( + transports.ImageAnnotatorRestInterceptor, "post_async_batch_annotate_images" + ) as post, mock.patch.object( + transports.ImageAnnotatorRestInterceptor, "pre_async_batch_annotate_images" + ) as pre: + pre.assert_not_called() + post.assert_not_called() + pb_message = image_annotator.AsyncBatchAnnotateImagesRequest.pb( + image_annotator.AsyncBatchAnnotateImagesRequest() + ) + transcode.return_value = { + "method": "post", + "uri": "my_uri", + "body": pb_message, + "query_params": pb_message, + } + + req.return_value = Response() + req.return_value.status_code = 200 + req.return_value.request = PreparedRequest() + req.return_value._content = json_format.MessageToJson( + operations_pb2.Operation() + ) + + request = image_annotator.AsyncBatchAnnotateImagesRequest() + metadata = [ + ("key", "val"), + ("cephalopod", "squid"), + ] + pre.return_value = request, metadata + post.return_value = operations_pb2.Operation() + + client.async_batch_annotate_images( + request, + metadata=[ + ("key", "val"), + ("cephalopod", "squid"), + ], + ) + + pre.assert_called_once() + post.assert_called_once() + + +def test_async_batch_annotate_images_rest_bad_request( + transport: str = "rest", + request_type=image_annotator.AsyncBatchAnnotateImagesRequest, +): + client = ImageAnnotatorClient( + credentials=ga_credentials.AnonymousCredentials(), + transport=transport, + ) + + # send a request that will satisfy transcoding + request_init = {} + request = request_type(**request_init) + + # Mock the http request call within the method and fake a BadRequest error. + with mock.patch.object(Session, "request") as req, pytest.raises( + core_exceptions.BadRequest + ): + # Wrap the value into a proper Response obj + response_value = Response() + response_value.status_code = 400 + response_value.request = Request() + req.return_value = response_value + client.async_batch_annotate_images(request) + + +def test_async_batch_annotate_images_rest_flattened(): + client = ImageAnnotatorClient( + credentials=ga_credentials.AnonymousCredentials(), + transport="rest", + ) + + # Mock the http request call within the method and fake a response. + with mock.patch.object(type(client.transport._session), "request") as req: + # Designate an appropriate value for the returned response. + return_value = operations_pb2.Operation(name="operations/spam") + + # get arguments that satisfy an http rule for this method + sample_request = {} + + # get truthy value for each flattened field + mock_args = dict( + requests=[ + image_annotator.AnnotateImageRequest( + image=image_annotator.Image(content=b"content_blob") + ) + ], + output_config=image_annotator.OutputConfig( + gcs_destination=image_annotator.GcsDestination(uri="uri_value") + ), + ) + mock_args.update(sample_request) + + # Wrap the value into a proper Response obj + response_value = Response() + response_value.status_code = 200 + json_return_value = json_format.MessageToJson(return_value) + response_value._content = json_return_value.encode("UTF-8") + req.return_value = response_value + + client.async_batch_annotate_images(**mock_args) + + # Establish that the underlying call was made with the expected + # request object values. + assert len(req.mock_calls) == 1 + _, args, _ = req.mock_calls[0] + assert path_template.validate( + "%s/v1p4beta1/images:asyncBatchAnnotate" % client.transport._host, args[1] + ) + + +def test_async_batch_annotate_images_rest_flattened_error(transport: str = "rest"): + client = ImageAnnotatorClient( + credentials=ga_credentials.AnonymousCredentials(), + transport=transport, + ) + + # Attempting to call a method with both a request object and flattened + # fields is an error. + with pytest.raises(ValueError): + client.async_batch_annotate_images( + image_annotator.AsyncBatchAnnotateImagesRequest(), + requests=[ + image_annotator.AnnotateImageRequest( + image=image_annotator.Image(content=b"content_blob") + ) + ], + output_config=image_annotator.OutputConfig( + gcs_destination=image_annotator.GcsDestination(uri="uri_value") + ), + ) + + +def test_async_batch_annotate_images_rest_error(): + client = ImageAnnotatorClient( + credentials=ga_credentials.AnonymousCredentials(), transport="rest" + ) + + +@pytest.mark.parametrize( + "request_type", + [ + image_annotator.AsyncBatchAnnotateFilesRequest, + dict, + ], +) +def test_async_batch_annotate_files_rest(request_type): + client = ImageAnnotatorClient( + credentials=ga_credentials.AnonymousCredentials(), + transport="rest", + ) + + # send a request that will satisfy transcoding + request_init = {} + request = request_type(**request_init) + + # Mock the http request call within the method and fake a response. + with mock.patch.object(type(client.transport._session), "request") as req: + # Designate an appropriate value for the returned response. + return_value = operations_pb2.Operation(name="operations/spam") + + # Wrap the value into a proper Response obj + response_value = Response() + response_value.status_code = 200 + json_return_value = json_format.MessageToJson(return_value) + + response_value._content = json_return_value.encode("UTF-8") + req.return_value = response_value + response = client.async_batch_annotate_files(request) + + # Establish that the response is the type that we expect. + assert response.operation.name == "operations/spam" + + +def test_async_batch_annotate_files_rest_required_fields( + request_type=image_annotator.AsyncBatchAnnotateFilesRequest, +): + transport_class = transports.ImageAnnotatorRestTransport + + request_init = {} + request = request_type(**request_init) + pb_request = request_type.pb(request) + jsonified_request = json.loads( + json_format.MessageToJson( + pb_request, + including_default_value_fields=False, + use_integers_for_enums=False, + ) + ) + + # verify fields with default values are dropped + + unset_fields = transport_class( + credentials=ga_credentials.AnonymousCredentials() + ).async_batch_annotate_files._get_unset_required_fields(jsonified_request) + jsonified_request.update(unset_fields) + + # verify required fields with default values are now present + + unset_fields = transport_class( + credentials=ga_credentials.AnonymousCredentials() + ).async_batch_annotate_files._get_unset_required_fields(jsonified_request) + jsonified_request.update(unset_fields) + + # verify required fields with non-default values are left alone + + client = ImageAnnotatorClient( + credentials=ga_credentials.AnonymousCredentials(), + transport="rest", + ) + request = request_type(**request_init) + + # Designate an appropriate value for the returned response. + return_value = operations_pb2.Operation(name="operations/spam") + # Mock the http request call within the method and fake a response. + with mock.patch.object(Session, "request") as req: + # We need to mock transcode() because providing default values + # for required fields will fail the real version if the http_options + # expect actual values for those fields. + with mock.patch.object(path_template, "transcode") as transcode: + # A uri without fields and an empty body will force all the + # request fields to show up in the query_params. + pb_request = request_type.pb(request) + transcode_result = { + "uri": "v1/sample_method", + "method": "post", + "query_params": pb_request, + } + transcode_result["body"] = pb_request + transcode.return_value = transcode_result + + response_value = Response() + response_value.status_code = 200 + json_return_value = json_format.MessageToJson(return_value) + + response_value._content = json_return_value.encode("UTF-8") + req.return_value = response_value + + response = client.async_batch_annotate_files(request) + + expected_params = [("$alt", "json;enum-encoding=int")] + actual_params = req.call_args.kwargs["params"] + assert expected_params == actual_params + + +def test_async_batch_annotate_files_rest_unset_required_fields(): + transport = transports.ImageAnnotatorRestTransport( + credentials=ga_credentials.AnonymousCredentials + ) + + unset_fields = transport.async_batch_annotate_files._get_unset_required_fields({}) + assert set(unset_fields) == (set(()) & set(("requests",))) + + +@pytest.mark.parametrize("null_interceptor", [True, False]) +def test_async_batch_annotate_files_rest_interceptors(null_interceptor): + transport = transports.ImageAnnotatorRestTransport( + credentials=ga_credentials.AnonymousCredentials(), + interceptor=None + if null_interceptor + else transports.ImageAnnotatorRestInterceptor(), + ) + client = ImageAnnotatorClient(transport=transport) + with mock.patch.object( + type(client.transport._session), "request" + ) as req, mock.patch.object( + path_template, "transcode" + ) as transcode, mock.patch.object( + operation.Operation, "_set_result_from_operation" + ), mock.patch.object( + transports.ImageAnnotatorRestInterceptor, "post_async_batch_annotate_files" + ) as post, mock.patch.object( + transports.ImageAnnotatorRestInterceptor, "pre_async_batch_annotate_files" + ) as pre: + pre.assert_not_called() + post.assert_not_called() + pb_message = image_annotator.AsyncBatchAnnotateFilesRequest.pb( + image_annotator.AsyncBatchAnnotateFilesRequest() + ) + transcode.return_value = { + "method": "post", + "uri": "my_uri", + "body": pb_message, + "query_params": pb_message, + } + + req.return_value = Response() + req.return_value.status_code = 200 + req.return_value.request = PreparedRequest() + req.return_value._content = json_format.MessageToJson( + operations_pb2.Operation() + ) + + request = image_annotator.AsyncBatchAnnotateFilesRequest() + metadata = [ + ("key", "val"), + ("cephalopod", "squid"), + ] + pre.return_value = request, metadata + post.return_value = operations_pb2.Operation() + + client.async_batch_annotate_files( + request, + metadata=[ + ("key", "val"), + ("cephalopod", "squid"), + ], + ) + + pre.assert_called_once() + post.assert_called_once() + + +def test_async_batch_annotate_files_rest_bad_request( + transport: str = "rest", request_type=image_annotator.AsyncBatchAnnotateFilesRequest +): + client = ImageAnnotatorClient( + credentials=ga_credentials.AnonymousCredentials(), + transport=transport, + ) + + # send a request that will satisfy transcoding + request_init = {} + request = request_type(**request_init) + + # Mock the http request call within the method and fake a BadRequest error. + with mock.patch.object(Session, "request") as req, pytest.raises( + core_exceptions.BadRequest + ): + # Wrap the value into a proper Response obj + response_value = Response() + response_value.status_code = 400 + response_value.request = Request() + req.return_value = response_value + client.async_batch_annotate_files(request) + + +def test_async_batch_annotate_files_rest_flattened(): + client = ImageAnnotatorClient( + credentials=ga_credentials.AnonymousCredentials(), + transport="rest", + ) + + # Mock the http request call within the method and fake a response. + with mock.patch.object(type(client.transport._session), "request") as req: + # Designate an appropriate value for the returned response. + return_value = operations_pb2.Operation(name="operations/spam") + + # get arguments that satisfy an http rule for this method + sample_request = {} + + # get truthy value for each flattened field + mock_args = dict( + requests=[ + image_annotator.AsyncAnnotateFileRequest( + input_config=image_annotator.InputConfig( + gcs_source=image_annotator.GcsSource(uri="uri_value") + ) + ) + ], + ) + mock_args.update(sample_request) + + # Wrap the value into a proper Response obj + response_value = Response() + response_value.status_code = 200 + json_return_value = json_format.MessageToJson(return_value) + response_value._content = json_return_value.encode("UTF-8") + req.return_value = response_value + + client.async_batch_annotate_files(**mock_args) + + # Establish that the underlying call was made with the expected + # request object values. + assert len(req.mock_calls) == 1 + _, args, _ = req.mock_calls[0] + assert path_template.validate( + "%s/v1p4beta1/files:asyncBatchAnnotate" % client.transport._host, args[1] + ) + + +def test_async_batch_annotate_files_rest_flattened_error(transport: str = "rest"): + client = ImageAnnotatorClient( + credentials=ga_credentials.AnonymousCredentials(), + transport=transport, + ) + + # Attempting to call a method with both a request object and flattened + # fields is an error. + with pytest.raises(ValueError): + client.async_batch_annotate_files( + image_annotator.AsyncBatchAnnotateFilesRequest(), + requests=[ + image_annotator.AsyncAnnotateFileRequest( + input_config=image_annotator.InputConfig( + gcs_source=image_annotator.GcsSource(uri="uri_value") + ) + ) + ], + ) + + +def test_async_batch_annotate_files_rest_error(): + client = ImageAnnotatorClient( + credentials=ga_credentials.AnonymousCredentials(), transport="rest" + ) + + def test_credentials_transport_error(): # It is an error to provide credentials and a transport instance. transport = transports.ImageAnnotatorGrpcTransport( @@ -1620,6 +2735,7 @@ def test_transport_get_channel(): [ transports.ImageAnnotatorGrpcTransport, transports.ImageAnnotatorGrpcAsyncIOTransport, + transports.ImageAnnotatorRestTransport, ], ) def test_transport_adc(transport_class): @@ -1634,6 +2750,7 @@ def test_transport_adc(transport_class): "transport_name", [ "grpc", + "rest", ], ) def test_transport_kind(transport_name): @@ -1780,6 +2897,7 @@ def test_image_annotator_transport_auth_adc(transport_class): [ transports.ImageAnnotatorGrpcTransport, transports.ImageAnnotatorGrpcAsyncIOTransport, + transports.ImageAnnotatorRestTransport, ], ) def test_image_annotator_transport_auth_gdch_credentials(transport_class): @@ -1880,11 +2998,40 @@ def test_image_annotator_grpc_transport_client_cert_source_for_mtls(transport_cl ) +def test_image_annotator_http_transport_client_cert_source_for_mtls(): + cred = ga_credentials.AnonymousCredentials() + with mock.patch( + "google.auth.transport.requests.AuthorizedSession.configure_mtls_channel" + ) as mock_configure_mtls_channel: + transports.ImageAnnotatorRestTransport( + credentials=cred, client_cert_source_for_mtls=client_cert_source_callback + ) + mock_configure_mtls_channel.assert_called_once_with(client_cert_source_callback) + + +def test_image_annotator_rest_lro_client(): + client = ImageAnnotatorClient( + credentials=ga_credentials.AnonymousCredentials(), + transport="rest", + ) + transport = client.transport + + # Ensure that we have a api-core operations client. + assert isinstance( + transport.operations_client, + operations_v1.AbstractOperationsClient, + ) + + # Ensure that subsequent calls to the property send the exact same object. + assert transport.operations_client is transport.operations_client + + @pytest.mark.parametrize( "transport_name", [ "grpc", "grpc_asyncio", + "rest", ], ) def test_image_annotator_host_no_port(transport_name): @@ -1895,7 +3042,11 @@ def test_image_annotator_host_no_port(transport_name): ), transport=transport_name, ) - assert client.transport._host == ("vision.googleapis.com:443") + assert client.transport._host == ( + "vision.googleapis.com:443" + if transport_name in ["grpc", "grpc_asyncio"] + else "https://vision.googleapis.com/" + ) @pytest.mark.parametrize( @@ -1903,6 +3054,7 @@ def test_image_annotator_host_no_port(transport_name): [ "grpc", "grpc_asyncio", + "rest", ], ) def test_image_annotator_host_with_port(transport_name): @@ -1913,7 +3065,42 @@ def test_image_annotator_host_with_port(transport_name): ), transport=transport_name, ) - assert client.transport._host == ("vision.googleapis.com:8000") + assert client.transport._host == ( + "vision.googleapis.com:8000" + if transport_name in ["grpc", "grpc_asyncio"] + else "https://vision.googleapis.com:8000/" + ) + + +@pytest.mark.parametrize( + "transport_name", + [ + "rest", + ], +) +def test_image_annotator_client_transport_session_collision(transport_name): + creds1 = ga_credentials.AnonymousCredentials() + creds2 = ga_credentials.AnonymousCredentials() + client1 = ImageAnnotatorClient( + credentials=creds1, + transport=transport_name, + ) + client2 = ImageAnnotatorClient( + credentials=creds2, + transport=transport_name, + ) + session1 = client1.transport.batch_annotate_images._session + session2 = client2.transport.batch_annotate_images._session + assert session1 != session2 + session1 = client1.transport.batch_annotate_files._session + session2 = client2.transport.batch_annotate_files._session + assert session1 != session2 + session1 = client1.transport.async_batch_annotate_images._session + session2 = client2.transport.async_batch_annotate_images._session + assert session1 != session2 + session1 = client1.transport.async_batch_annotate_files._session + session2 = client2.transport.async_batch_annotate_files._session + assert session1 != session2 def test_image_annotator_grpc_transport_channel(): @@ -2272,6 +3459,7 @@ async def test_transport_close_async(): def test_transport_close(): transports = { + "rest": "_session", "grpc": "_grpc_channel", } @@ -2289,6 +3477,7 @@ def test_transport_close(): def test_client_ctx(): transports = [ + "rest", "grpc", ] for transport in transports: diff --git a/tests/unit/gapic/vision_v1p4beta1/test_product_search.py b/tests/unit/gapic/vision_v1p4beta1/test_product_search.py index 9191539f..563926be 100644 --- a/tests/unit/gapic/vision_v1p4beta1/test_product_search.py +++ b/tests/unit/gapic/vision_v1p4beta1/test_product_search.py @@ -24,10 +24,17 @@ import grpc from grpc.experimental import aio +from collections.abc import Iterable +from google.protobuf import json_format +import json import math import pytest from proto.marshal.rules.dates import DurationRule, TimestampRule from proto.marshal.rules import wrappers +from requests import Response +from requests import Request, PreparedRequest +from requests.sessions import Session +from google.protobuf import json_format from google.api_core import client_options from google.api_core import exceptions as core_exceptions @@ -108,6 +115,7 @@ def test__get_default_mtls_endpoint(): [ (ProductSearchClient, "grpc"), (ProductSearchAsyncClient, "grpc_asyncio"), + (ProductSearchClient, "rest"), ], ) def test_product_search_client_from_service_account_info(client_class, transport_name): @@ -121,7 +129,11 @@ def test_product_search_client_from_service_account_info(client_class, transport assert client.transport._credentials == creds assert isinstance(client, client_class) - assert client.transport._host == ("vision.googleapis.com:443") + assert client.transport._host == ( + "vision.googleapis.com:443" + if transport_name in ["grpc", "grpc_asyncio"] + else "https://vision.googleapis.com/" + ) @pytest.mark.parametrize( @@ -129,6 +141,7 @@ def test_product_search_client_from_service_account_info(client_class, transport [ (transports.ProductSearchGrpcTransport, "grpc"), (transports.ProductSearchGrpcAsyncIOTransport, "grpc_asyncio"), + (transports.ProductSearchRestTransport, "rest"), ], ) def test_product_search_client_service_account_always_use_jwt( @@ -154,6 +167,7 @@ def test_product_search_client_service_account_always_use_jwt( [ (ProductSearchClient, "grpc"), (ProductSearchAsyncClient, "grpc_asyncio"), + (ProductSearchClient, "rest"), ], ) def test_product_search_client_from_service_account_file(client_class, transport_name): @@ -174,13 +188,18 @@ def test_product_search_client_from_service_account_file(client_class, transport assert client.transport._credentials == creds assert isinstance(client, client_class) - assert client.transport._host == ("vision.googleapis.com:443") + assert client.transport._host == ( + "vision.googleapis.com:443" + if transport_name in ["grpc", "grpc_asyncio"] + else "https://vision.googleapis.com/" + ) def test_product_search_client_get_transport_class(): transport = ProductSearchClient.get_transport_class() available_transports = [ transports.ProductSearchGrpcTransport, + transports.ProductSearchRestTransport, ] assert transport in available_transports @@ -197,6 +216,7 @@ def test_product_search_client_get_transport_class(): transports.ProductSearchGrpcAsyncIOTransport, "grpc_asyncio", ), + (ProductSearchClient, transports.ProductSearchRestTransport, "rest"), ], ) @mock.patch.object( @@ -342,6 +362,8 @@ def test_product_search_client_client_options( "grpc_asyncio", "false", ), + (ProductSearchClient, transports.ProductSearchRestTransport, "rest", "true"), + (ProductSearchClient, transports.ProductSearchRestTransport, "rest", "false"), ], ) @mock.patch.object( @@ -541,6 +563,7 @@ def test_product_search_client_get_mtls_endpoint_and_cert_source(client_class): transports.ProductSearchGrpcAsyncIOTransport, "grpc_asyncio", ), + (ProductSearchClient, transports.ProductSearchRestTransport, "rest"), ], ) def test_product_search_client_client_options_scopes( @@ -581,6 +604,7 @@ def test_product_search_client_client_options_scopes( "grpc_asyncio", grpc_helpers_async, ), + (ProductSearchClient, transports.ProductSearchRestTransport, "rest", None), ], ) def test_product_search_client_client_options_credentials_file( @@ -6193,210 +6217,5828 @@ async def test_purge_products_flattened_error_async(): ) -def test_credentials_transport_error(): - # It is an error to provide credentials and a transport instance. - transport = transports.ProductSearchGrpcTransport( +@pytest.mark.parametrize( + "request_type", + [ + product_search_service.CreateProductSetRequest, + dict, + ], +) +def test_create_product_set_rest(request_type): + client = ProductSearchClient( credentials=ga_credentials.AnonymousCredentials(), - ) - with pytest.raises(ValueError): - client = ProductSearchClient( - credentials=ga_credentials.AnonymousCredentials(), - transport=transport, + transport="rest", + ) + + # send a request that will satisfy transcoding + request_init = {"parent": "projects/sample1/locations/sample2"} + request_init["product_set"] = { + "name": "name_value", + "display_name": "display_name_value", + "index_time": {"seconds": 751, "nanos": 543}, + "index_error": { + "code": 411, + "message": "message_value", + "details": [ + { + "type_url": "type.googleapis.com/google.protobuf.Duration", + "value": b"\x08\x0c\x10\xdb\x07", + } + ], + }, + } + request = request_type(**request_init) + + # Mock the http request call within the method and fake a response. + with mock.patch.object(type(client.transport._session), "request") as req: + # Designate an appropriate value for the returned response. + return_value = product_search_service.ProductSet( + name="name_value", + display_name="display_name_value", ) - # It is an error to provide a credentials file and a transport instance. - transport = transports.ProductSearchGrpcTransport( - credentials=ga_credentials.AnonymousCredentials(), - ) - with pytest.raises(ValueError): - client = ProductSearchClient( - client_options={"credentials_file": "credentials.json"}, - transport=transport, + # Wrap the value into a proper Response obj + response_value = Response() + response_value.status_code = 200 + pb_return_value = product_search_service.ProductSet.pb(return_value) + json_return_value = json_format.MessageToJson(pb_return_value) + + response_value._content = json_return_value.encode("UTF-8") + req.return_value = response_value + response = client.create_product_set(request) + + # Establish that the response is the type that we expect. + assert isinstance(response, product_search_service.ProductSet) + assert response.name == "name_value" + assert response.display_name == "display_name_value" + + +def test_create_product_set_rest_required_fields( + request_type=product_search_service.CreateProductSetRequest, +): + transport_class = transports.ProductSearchRestTransport + + request_init = {} + request_init["parent"] = "" + request = request_type(**request_init) + pb_request = request_type.pb(request) + jsonified_request = json.loads( + json_format.MessageToJson( + pb_request, + including_default_value_fields=False, + use_integers_for_enums=False, ) + ) - # It is an error to provide an api_key and a transport instance. - transport = transports.ProductSearchGrpcTransport( + # verify fields with default values are dropped + + unset_fields = transport_class( + credentials=ga_credentials.AnonymousCredentials() + ).create_product_set._get_unset_required_fields(jsonified_request) + jsonified_request.update(unset_fields) + + # verify required fields with default values are now present + + jsonified_request["parent"] = "parent_value" + + unset_fields = transport_class( + credentials=ga_credentials.AnonymousCredentials() + ).create_product_set._get_unset_required_fields(jsonified_request) + # Check that path parameters and body parameters are not mixing in. + assert not set(unset_fields) - set(("product_set_id",)) + jsonified_request.update(unset_fields) + + # verify required fields with non-default values are left alone + assert "parent" in jsonified_request + assert jsonified_request["parent"] == "parent_value" + + client = ProductSearchClient( credentials=ga_credentials.AnonymousCredentials(), - ) - options = client_options.ClientOptions() - options.api_key = "api_key" - with pytest.raises(ValueError): - client = ProductSearchClient( - client_options=options, - transport=transport, + transport="rest", + ) + request = request_type(**request_init) + + # Designate an appropriate value for the returned response. + return_value = product_search_service.ProductSet() + # Mock the http request call within the method and fake a response. + with mock.patch.object(Session, "request") as req: + # We need to mock transcode() because providing default values + # for required fields will fail the real version if the http_options + # expect actual values for those fields. + with mock.patch.object(path_template, "transcode") as transcode: + # A uri without fields and an empty body will force all the + # request fields to show up in the query_params. + pb_request = request_type.pb(request) + transcode_result = { + "uri": "v1/sample_method", + "method": "post", + "query_params": pb_request, + } + transcode_result["body"] = pb_request + transcode.return_value = transcode_result + + response_value = Response() + response_value.status_code = 200 + + pb_return_value = product_search_service.ProductSet.pb(return_value) + json_return_value = json_format.MessageToJson(pb_return_value) + + response_value._content = json_return_value.encode("UTF-8") + req.return_value = response_value + + response = client.create_product_set(request) + + expected_params = [("$alt", "json;enum-encoding=int")] + actual_params = req.call_args.kwargs["params"] + assert expected_params == actual_params + + +def test_create_product_set_rest_unset_required_fields(): + transport = transports.ProductSearchRestTransport( + credentials=ga_credentials.AnonymousCredentials + ) + + unset_fields = transport.create_product_set._get_unset_required_fields({}) + assert set(unset_fields) == ( + set(("productSetId",)) + & set( + ( + "parent", + "productSet", + ) ) + ) - # It is an error to provide an api_key and a credential. - options = mock.Mock() - options.api_key = "api_key" - with pytest.raises(ValueError): - client = ProductSearchClient( - client_options=options, credentials=ga_credentials.AnonymousCredentials() - ) - # It is an error to provide scopes and a transport instance. - transport = transports.ProductSearchGrpcTransport( +@pytest.mark.parametrize("null_interceptor", [True, False]) +def test_create_product_set_rest_interceptors(null_interceptor): + transport = transports.ProductSearchRestTransport( credentials=ga_credentials.AnonymousCredentials(), + interceptor=None + if null_interceptor + else transports.ProductSearchRestInterceptor(), ) - with pytest.raises(ValueError): - client = ProductSearchClient( - client_options={"scopes": ["1", "2"]}, - transport=transport, + client = ProductSearchClient(transport=transport) + with mock.patch.object( + type(client.transport._session), "request" + ) as req, mock.patch.object( + path_template, "transcode" + ) as transcode, mock.patch.object( + transports.ProductSearchRestInterceptor, "post_create_product_set" + ) as post, mock.patch.object( + transports.ProductSearchRestInterceptor, "pre_create_product_set" + ) as pre: + pre.assert_not_called() + post.assert_not_called() + pb_message = product_search_service.CreateProductSetRequest.pb( + product_search_service.CreateProductSetRequest() + ) + transcode.return_value = { + "method": "post", + "uri": "my_uri", + "body": pb_message, + "query_params": pb_message, + } + + req.return_value = Response() + req.return_value.status_code = 200 + req.return_value.request = PreparedRequest() + req.return_value._content = product_search_service.ProductSet.to_json( + product_search_service.ProductSet() ) + request = product_search_service.CreateProductSetRequest() + metadata = [ + ("key", "val"), + ("cephalopod", "squid"), + ] + pre.return_value = request, metadata + post.return_value = product_search_service.ProductSet() -def test_transport_instance(): - # A client may be instantiated with a custom transport instance. - transport = transports.ProductSearchGrpcTransport( + client.create_product_set( + request, + metadata=[ + ("key", "val"), + ("cephalopod", "squid"), + ], + ) + + pre.assert_called_once() + post.assert_called_once() + + +def test_create_product_set_rest_bad_request( + transport: str = "rest", request_type=product_search_service.CreateProductSetRequest +): + client = ProductSearchClient( credentials=ga_credentials.AnonymousCredentials(), + transport=transport, ) - client = ProductSearchClient(transport=transport) - assert client.transport is transport + # send a request that will satisfy transcoding + request_init = {"parent": "projects/sample1/locations/sample2"} + request_init["product_set"] = { + "name": "name_value", + "display_name": "display_name_value", + "index_time": {"seconds": 751, "nanos": 543}, + "index_error": { + "code": 411, + "message": "message_value", + "details": [ + { + "type_url": "type.googleapis.com/google.protobuf.Duration", + "value": b"\x08\x0c\x10\xdb\x07", + } + ], + }, + } + request = request_type(**request_init) -def test_transport_get_channel(): - # A client may be instantiated with a custom transport instance. - transport = transports.ProductSearchGrpcTransport( + # Mock the http request call within the method and fake a BadRequest error. + with mock.patch.object(Session, "request") as req, pytest.raises( + core_exceptions.BadRequest + ): + # Wrap the value into a proper Response obj + response_value = Response() + response_value.status_code = 400 + response_value.request = Request() + req.return_value = response_value + client.create_product_set(request) + + +def test_create_product_set_rest_flattened(): + client = ProductSearchClient( credentials=ga_credentials.AnonymousCredentials(), + transport="rest", ) - channel = transport.grpc_channel - assert channel - transport = transports.ProductSearchGrpcAsyncIOTransport( + # Mock the http request call within the method and fake a response. + with mock.patch.object(type(client.transport._session), "request") as req: + # Designate an appropriate value for the returned response. + return_value = product_search_service.ProductSet() + + # get arguments that satisfy an http rule for this method + sample_request = {"parent": "projects/sample1/locations/sample2"} + + # get truthy value for each flattened field + mock_args = dict( + parent="parent_value", + product_set=product_search_service.ProductSet(name="name_value"), + product_set_id="product_set_id_value", + ) + mock_args.update(sample_request) + + # Wrap the value into a proper Response obj + response_value = Response() + response_value.status_code = 200 + pb_return_value = product_search_service.ProductSet.pb(return_value) + json_return_value = json_format.MessageToJson(pb_return_value) + response_value._content = json_return_value.encode("UTF-8") + req.return_value = response_value + + client.create_product_set(**mock_args) + + # Establish that the underlying call was made with the expected + # request object values. + assert len(req.mock_calls) == 1 + _, args, _ = req.mock_calls[0] + assert path_template.validate( + "%s/v1p4beta1/{parent=projects/*/locations/*}/productSets" + % client.transport._host, + args[1], + ) + + +def test_create_product_set_rest_flattened_error(transport: str = "rest"): + client = ProductSearchClient( credentials=ga_credentials.AnonymousCredentials(), + transport=transport, ) - channel = transport.grpc_channel - assert channel + + # Attempting to call a method with both a request object and flattened + # fields is an error. + with pytest.raises(ValueError): + client.create_product_set( + product_search_service.CreateProductSetRequest(), + parent="parent_value", + product_set=product_search_service.ProductSet(name="name_value"), + product_set_id="product_set_id_value", + ) -@pytest.mark.parametrize( - "transport_class", - [ - transports.ProductSearchGrpcTransport, - transports.ProductSearchGrpcAsyncIOTransport, - ], -) -def test_transport_adc(transport_class): - # Test default credentials are used if not provided. - with mock.patch.object(google.auth, "default") as adc: - adc.return_value = (ga_credentials.AnonymousCredentials(), None) - transport_class() - adc.assert_called_once() +def test_create_product_set_rest_error(): + client = ProductSearchClient( + credentials=ga_credentials.AnonymousCredentials(), transport="rest" + ) @pytest.mark.parametrize( - "transport_name", + "request_type", [ - "grpc", + product_search_service.ListProductSetsRequest, + dict, ], ) -def test_transport_kind(transport_name): - transport = ProductSearchClient.get_transport_class(transport_name)( - credentials=ga_credentials.AnonymousCredentials(), - ) - assert transport.kind == transport_name - - -def test_transport_grpc_default(): - # A client should use the gRPC transport by default. +def test_list_product_sets_rest(request_type): client = ProductSearchClient( credentials=ga_credentials.AnonymousCredentials(), - ) - assert isinstance( - client.transport, - transports.ProductSearchGrpcTransport, + transport="rest", ) + # send a request that will satisfy transcoding + request_init = {"parent": "projects/sample1/locations/sample2"} + request = request_type(**request_init) -def test_product_search_base_transport_error(): - # Passing both a credentials object and credentials_file should raise an error - with pytest.raises(core_exceptions.DuplicateCredentialArgs): - transport = transports.ProductSearchTransport( - credentials=ga_credentials.AnonymousCredentials(), - credentials_file="credentials.json", + # Mock the http request call within the method and fake a response. + with mock.patch.object(type(client.transport._session), "request") as req: + # Designate an appropriate value for the returned response. + return_value = product_search_service.ListProductSetsResponse( + next_page_token="next_page_token_value", ) - -def test_product_search_base_transport(): - # Instantiate the base transport. - with mock.patch( - "google.cloud.vision_v1p4beta1.services.product_search.transports.ProductSearchTransport.__init__" - ) as Transport: - Transport.return_value = None - transport = transports.ProductSearchTransport( - credentials=ga_credentials.AnonymousCredentials(), + # Wrap the value into a proper Response obj + response_value = Response() + response_value.status_code = 200 + pb_return_value = product_search_service.ListProductSetsResponse.pb( + return_value ) + json_return_value = json_format.MessageToJson(pb_return_value) - # Every method on the transport should just blindly - # raise NotImplementedError. - methods = ( - "create_product_set", - "list_product_sets", - "get_product_set", - "update_product_set", - "delete_product_set", - "create_product", - "list_products", - "get_product", - "update_product", - "delete_product", - "create_reference_image", - "delete_reference_image", - "list_reference_images", - "get_reference_image", - "add_product_to_product_set", - "remove_product_from_product_set", - "list_products_in_product_set", - "import_product_sets", - "purge_products", + response_value._content = json_return_value.encode("UTF-8") + req.return_value = response_value + response = client.list_product_sets(request) + + # Establish that the response is the type that we expect. + assert isinstance(response, pagers.ListProductSetsPager) + assert response.next_page_token == "next_page_token_value" + + +def test_list_product_sets_rest_required_fields( + request_type=product_search_service.ListProductSetsRequest, +): + transport_class = transports.ProductSearchRestTransport + + request_init = {} + request_init["parent"] = "" + request = request_type(**request_init) + pb_request = request_type.pb(request) + jsonified_request = json.loads( + json_format.MessageToJson( + pb_request, + including_default_value_fields=False, + use_integers_for_enums=False, + ) ) - for method in methods: - with pytest.raises(NotImplementedError): - getattr(transport, method)(request=object()) - with pytest.raises(NotImplementedError): - transport.close() + # verify fields with default values are dropped - # Additionally, the LRO client (a property) should - # also raise NotImplementedError - with pytest.raises(NotImplementedError): - transport.operations_client + unset_fields = transport_class( + credentials=ga_credentials.AnonymousCredentials() + ).list_product_sets._get_unset_required_fields(jsonified_request) + jsonified_request.update(unset_fields) - # Catch all for all remaining methods and properties - remainder = [ - "kind", - ] - for r in remainder: - with pytest.raises(NotImplementedError): - getattr(transport, r)() + # verify required fields with default values are now present + jsonified_request["parent"] = "parent_value" -def test_product_search_base_transport_with_credentials_file(): - # 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.vision_v1p4beta1.services.product_search.transports.ProductSearchTransport._prep_wrapped_messages" - ) as Transport: - Transport.return_value = None - load_creds.return_value = (ga_credentials.AnonymousCredentials(), None) - transport = transports.ProductSearchTransport( - credentials_file="credentials.json", - quota_project_id="octopus", - ) - load_creds.assert_called_once_with( - "credentials.json", - scopes=None, - default_scopes=( - "https://www.googleapis.com/auth/cloud-platform", - "https://www.googleapis.com/auth/cloud-vision", - ), - quota_project_id="octopus", + unset_fields = transport_class( + credentials=ga_credentials.AnonymousCredentials() + ).list_product_sets._get_unset_required_fields(jsonified_request) + # Check that path parameters and body parameters are not mixing in. + assert not set(unset_fields) - set( + ( + "page_size", + "page_token", ) + ) + jsonified_request.update(unset_fields) + # verify required fields with non-default values are left alone + assert "parent" in jsonified_request + assert jsonified_request["parent"] == "parent_value" -def test_product_search_base_transport_with_adc(): - # Test the default credentials are used if credentials and credentials_file are None. + client = ProductSearchClient( + credentials=ga_credentials.AnonymousCredentials(), + transport="rest", + ) + request = request_type(**request_init) + + # Designate an appropriate value for the returned response. + return_value = product_search_service.ListProductSetsResponse() + # Mock the http request call within the method and fake a response. + with mock.patch.object(Session, "request") as req: + # We need to mock transcode() because providing default values + # for required fields will fail the real version if the http_options + # expect actual values for those fields. + with mock.patch.object(path_template, "transcode") as transcode: + # A uri without fields and an empty body will force all the + # request fields to show up in the query_params. + pb_request = request_type.pb(request) + transcode_result = { + "uri": "v1/sample_method", + "method": "get", + "query_params": pb_request, + } + transcode.return_value = transcode_result + + response_value = Response() + response_value.status_code = 200 + + pb_return_value = product_search_service.ListProductSetsResponse.pb( + return_value + ) + json_return_value = json_format.MessageToJson(pb_return_value) + + response_value._content = json_return_value.encode("UTF-8") + req.return_value = response_value + + response = client.list_product_sets(request) + + expected_params = [("$alt", "json;enum-encoding=int")] + actual_params = req.call_args.kwargs["params"] + assert expected_params == actual_params + + +def test_list_product_sets_rest_unset_required_fields(): + transport = transports.ProductSearchRestTransport( + credentials=ga_credentials.AnonymousCredentials + ) + + unset_fields = transport.list_product_sets._get_unset_required_fields({}) + assert set(unset_fields) == ( + set( + ( + "pageSize", + "pageToken", + ) + ) + & set(("parent",)) + ) + + +@pytest.mark.parametrize("null_interceptor", [True, False]) +def test_list_product_sets_rest_interceptors(null_interceptor): + transport = transports.ProductSearchRestTransport( + credentials=ga_credentials.AnonymousCredentials(), + interceptor=None + if null_interceptor + else transports.ProductSearchRestInterceptor(), + ) + client = ProductSearchClient(transport=transport) + with mock.patch.object( + type(client.transport._session), "request" + ) as req, mock.patch.object( + path_template, "transcode" + ) as transcode, mock.patch.object( + transports.ProductSearchRestInterceptor, "post_list_product_sets" + ) as post, mock.patch.object( + transports.ProductSearchRestInterceptor, "pre_list_product_sets" + ) as pre: + pre.assert_not_called() + post.assert_not_called() + pb_message = product_search_service.ListProductSetsRequest.pb( + product_search_service.ListProductSetsRequest() + ) + transcode.return_value = { + "method": "post", + "uri": "my_uri", + "body": pb_message, + "query_params": pb_message, + } + + req.return_value = Response() + req.return_value.status_code = 200 + req.return_value.request = PreparedRequest() + req.return_value._content = ( + product_search_service.ListProductSetsResponse.to_json( + product_search_service.ListProductSetsResponse() + ) + ) + + request = product_search_service.ListProductSetsRequest() + metadata = [ + ("key", "val"), + ("cephalopod", "squid"), + ] + pre.return_value = request, metadata + post.return_value = product_search_service.ListProductSetsResponse() + + client.list_product_sets( + request, + metadata=[ + ("key", "val"), + ("cephalopod", "squid"), + ], + ) + + pre.assert_called_once() + post.assert_called_once() + + +def test_list_product_sets_rest_bad_request( + transport: str = "rest", request_type=product_search_service.ListProductSetsRequest +): + client = ProductSearchClient( + credentials=ga_credentials.AnonymousCredentials(), + transport=transport, + ) + + # send a request that will satisfy transcoding + request_init = {"parent": "projects/sample1/locations/sample2"} + request = request_type(**request_init) + + # Mock the http request call within the method and fake a BadRequest error. + with mock.patch.object(Session, "request") as req, pytest.raises( + core_exceptions.BadRequest + ): + # Wrap the value into a proper Response obj + response_value = Response() + response_value.status_code = 400 + response_value.request = Request() + req.return_value = response_value + client.list_product_sets(request) + + +def test_list_product_sets_rest_flattened(): + client = ProductSearchClient( + credentials=ga_credentials.AnonymousCredentials(), + transport="rest", + ) + + # Mock the http request call within the method and fake a response. + with mock.patch.object(type(client.transport._session), "request") as req: + # Designate an appropriate value for the returned response. + return_value = product_search_service.ListProductSetsResponse() + + # get arguments that satisfy an http rule for this method + sample_request = {"parent": "projects/sample1/locations/sample2"} + + # get truthy value for each flattened field + mock_args = dict( + parent="parent_value", + ) + mock_args.update(sample_request) + + # Wrap the value into a proper Response obj + response_value = Response() + response_value.status_code = 200 + pb_return_value = product_search_service.ListProductSetsResponse.pb( + return_value + ) + json_return_value = json_format.MessageToJson(pb_return_value) + response_value._content = json_return_value.encode("UTF-8") + req.return_value = response_value + + client.list_product_sets(**mock_args) + + # Establish that the underlying call was made with the expected + # request object values. + assert len(req.mock_calls) == 1 + _, args, _ = req.mock_calls[0] + assert path_template.validate( + "%s/v1p4beta1/{parent=projects/*/locations/*}/productSets" + % client.transport._host, + args[1], + ) + + +def test_list_product_sets_rest_flattened_error(transport: str = "rest"): + client = ProductSearchClient( + credentials=ga_credentials.AnonymousCredentials(), + transport=transport, + ) + + # Attempting to call a method with both a request object and flattened + # fields is an error. + with pytest.raises(ValueError): + client.list_product_sets( + product_search_service.ListProductSetsRequest(), + parent="parent_value", + ) + + +def test_list_product_sets_rest_pager(transport: str = "rest"): + client = ProductSearchClient( + credentials=ga_credentials.AnonymousCredentials(), + transport=transport, + ) + + # Mock the http request call within the method and fake a response. + with mock.patch.object(Session, "request") as req: + # TODO(kbandes): remove this mock unless there's a good reason for it. + # with mock.patch.object(path_template, 'transcode') as transcode: + # Set the response as a series of pages + response = ( + product_search_service.ListProductSetsResponse( + product_sets=[ + product_search_service.ProductSet(), + product_search_service.ProductSet(), + product_search_service.ProductSet(), + ], + next_page_token="abc", + ), + product_search_service.ListProductSetsResponse( + product_sets=[], + next_page_token="def", + ), + product_search_service.ListProductSetsResponse( + product_sets=[ + product_search_service.ProductSet(), + ], + next_page_token="ghi", + ), + product_search_service.ListProductSetsResponse( + product_sets=[ + product_search_service.ProductSet(), + product_search_service.ProductSet(), + ], + ), + ) + # Two responses for two calls + response = response + response + + # Wrap the values into proper Response objs + response = tuple( + product_search_service.ListProductSetsResponse.to_json(x) for x in response + ) + return_values = tuple(Response() for i in response) + for return_val, response_val in zip(return_values, response): + return_val._content = response_val.encode("UTF-8") + return_val.status_code = 200 + req.side_effect = return_values + + sample_request = {"parent": "projects/sample1/locations/sample2"} + + pager = client.list_product_sets(request=sample_request) + + results = list(pager) + assert len(results) == 6 + assert all(isinstance(i, product_search_service.ProductSet) for i in results) + + pages = list(client.list_product_sets(request=sample_request).pages) + for page_, token in zip(pages, ["abc", "def", "ghi", ""]): + assert page_.raw_page.next_page_token == token + + +@pytest.mark.parametrize( + "request_type", + [ + product_search_service.GetProductSetRequest, + dict, + ], +) +def test_get_product_set_rest(request_type): + client = ProductSearchClient( + credentials=ga_credentials.AnonymousCredentials(), + transport="rest", + ) + + # send a request that will satisfy transcoding + request_init = {"name": "projects/sample1/locations/sample2/productSets/sample3"} + request = request_type(**request_init) + + # Mock the http request call within the method and fake a response. + with mock.patch.object(type(client.transport._session), "request") as req: + # Designate an appropriate value for the returned response. + return_value = product_search_service.ProductSet( + name="name_value", + display_name="display_name_value", + ) + + # Wrap the value into a proper Response obj + response_value = Response() + response_value.status_code = 200 + pb_return_value = product_search_service.ProductSet.pb(return_value) + json_return_value = json_format.MessageToJson(pb_return_value) + + response_value._content = json_return_value.encode("UTF-8") + req.return_value = response_value + response = client.get_product_set(request) + + # Establish that the response is the type that we expect. + assert isinstance(response, product_search_service.ProductSet) + assert response.name == "name_value" + assert response.display_name == "display_name_value" + + +def test_get_product_set_rest_required_fields( + request_type=product_search_service.GetProductSetRequest, +): + transport_class = transports.ProductSearchRestTransport + + request_init = {} + request_init["name"] = "" + request = request_type(**request_init) + pb_request = request_type.pb(request) + jsonified_request = json.loads( + json_format.MessageToJson( + pb_request, + including_default_value_fields=False, + use_integers_for_enums=False, + ) + ) + + # verify fields with default values are dropped + + unset_fields = transport_class( + credentials=ga_credentials.AnonymousCredentials() + ).get_product_set._get_unset_required_fields(jsonified_request) + jsonified_request.update(unset_fields) + + # verify required fields with default values are now present + + jsonified_request["name"] = "name_value" + + unset_fields = transport_class( + credentials=ga_credentials.AnonymousCredentials() + ).get_product_set._get_unset_required_fields(jsonified_request) + jsonified_request.update(unset_fields) + + # verify required fields with non-default values are left alone + assert "name" in jsonified_request + assert jsonified_request["name"] == "name_value" + + client = ProductSearchClient( + credentials=ga_credentials.AnonymousCredentials(), + transport="rest", + ) + request = request_type(**request_init) + + # Designate an appropriate value for the returned response. + return_value = product_search_service.ProductSet() + # Mock the http request call within the method and fake a response. + with mock.patch.object(Session, "request") as req: + # We need to mock transcode() because providing default values + # for required fields will fail the real version if the http_options + # expect actual values for those fields. + with mock.patch.object(path_template, "transcode") as transcode: + # A uri without fields and an empty body will force all the + # request fields to show up in the query_params. + pb_request = request_type.pb(request) + transcode_result = { + "uri": "v1/sample_method", + "method": "get", + "query_params": pb_request, + } + transcode.return_value = transcode_result + + response_value = Response() + response_value.status_code = 200 + + pb_return_value = product_search_service.ProductSet.pb(return_value) + json_return_value = json_format.MessageToJson(pb_return_value) + + response_value._content = json_return_value.encode("UTF-8") + req.return_value = response_value + + response = client.get_product_set(request) + + expected_params = [("$alt", "json;enum-encoding=int")] + actual_params = req.call_args.kwargs["params"] + assert expected_params == actual_params + + +def test_get_product_set_rest_unset_required_fields(): + transport = transports.ProductSearchRestTransport( + credentials=ga_credentials.AnonymousCredentials + ) + + unset_fields = transport.get_product_set._get_unset_required_fields({}) + assert set(unset_fields) == (set(()) & set(("name",))) + + +@pytest.mark.parametrize("null_interceptor", [True, False]) +def test_get_product_set_rest_interceptors(null_interceptor): + transport = transports.ProductSearchRestTransport( + credentials=ga_credentials.AnonymousCredentials(), + interceptor=None + if null_interceptor + else transports.ProductSearchRestInterceptor(), + ) + client = ProductSearchClient(transport=transport) + with mock.patch.object( + type(client.transport._session), "request" + ) as req, mock.patch.object( + path_template, "transcode" + ) as transcode, mock.patch.object( + transports.ProductSearchRestInterceptor, "post_get_product_set" + ) as post, mock.patch.object( + transports.ProductSearchRestInterceptor, "pre_get_product_set" + ) as pre: + pre.assert_not_called() + post.assert_not_called() + pb_message = product_search_service.GetProductSetRequest.pb( + product_search_service.GetProductSetRequest() + ) + transcode.return_value = { + "method": "post", + "uri": "my_uri", + "body": pb_message, + "query_params": pb_message, + } + + req.return_value = Response() + req.return_value.status_code = 200 + req.return_value.request = PreparedRequest() + req.return_value._content = product_search_service.ProductSet.to_json( + product_search_service.ProductSet() + ) + + request = product_search_service.GetProductSetRequest() + metadata = [ + ("key", "val"), + ("cephalopod", "squid"), + ] + pre.return_value = request, metadata + post.return_value = product_search_service.ProductSet() + + client.get_product_set( + request, + metadata=[ + ("key", "val"), + ("cephalopod", "squid"), + ], + ) + + pre.assert_called_once() + post.assert_called_once() + + +def test_get_product_set_rest_bad_request( + transport: str = "rest", request_type=product_search_service.GetProductSetRequest +): + client = ProductSearchClient( + credentials=ga_credentials.AnonymousCredentials(), + transport=transport, + ) + + # send a request that will satisfy transcoding + request_init = {"name": "projects/sample1/locations/sample2/productSets/sample3"} + request = request_type(**request_init) + + # Mock the http request call within the method and fake a BadRequest error. + with mock.patch.object(Session, "request") as req, pytest.raises( + core_exceptions.BadRequest + ): + # Wrap the value into a proper Response obj + response_value = Response() + response_value.status_code = 400 + response_value.request = Request() + req.return_value = response_value + client.get_product_set(request) + + +def test_get_product_set_rest_flattened(): + client = ProductSearchClient( + credentials=ga_credentials.AnonymousCredentials(), + transport="rest", + ) + + # Mock the http request call within the method and fake a response. + with mock.patch.object(type(client.transport._session), "request") as req: + # Designate an appropriate value for the returned response. + return_value = product_search_service.ProductSet() + + # get arguments that satisfy an http rule for this method + sample_request = { + "name": "projects/sample1/locations/sample2/productSets/sample3" + } + + # get truthy value for each flattened field + mock_args = dict( + name="name_value", + ) + mock_args.update(sample_request) + + # Wrap the value into a proper Response obj + response_value = Response() + response_value.status_code = 200 + pb_return_value = product_search_service.ProductSet.pb(return_value) + json_return_value = json_format.MessageToJson(pb_return_value) + response_value._content = json_return_value.encode("UTF-8") + req.return_value = response_value + + client.get_product_set(**mock_args) + + # Establish that the underlying call was made with the expected + # request object values. + assert len(req.mock_calls) == 1 + _, args, _ = req.mock_calls[0] + assert path_template.validate( + "%s/v1p4beta1/{name=projects/*/locations/*/productSets/*}" + % client.transport._host, + args[1], + ) + + +def test_get_product_set_rest_flattened_error(transport: str = "rest"): + client = ProductSearchClient( + credentials=ga_credentials.AnonymousCredentials(), + transport=transport, + ) + + # Attempting to call a method with both a request object and flattened + # fields is an error. + with pytest.raises(ValueError): + client.get_product_set( + product_search_service.GetProductSetRequest(), + name="name_value", + ) + + +def test_get_product_set_rest_error(): + client = ProductSearchClient( + credentials=ga_credentials.AnonymousCredentials(), transport="rest" + ) + + +@pytest.mark.parametrize( + "request_type", + [ + product_search_service.UpdateProductSetRequest, + dict, + ], +) +def test_update_product_set_rest(request_type): + client = ProductSearchClient( + credentials=ga_credentials.AnonymousCredentials(), + transport="rest", + ) + + # send a request that will satisfy transcoding + request_init = { + "product_set": { + "name": "projects/sample1/locations/sample2/productSets/sample3" + } + } + request_init["product_set"] = { + "name": "projects/sample1/locations/sample2/productSets/sample3", + "display_name": "display_name_value", + "index_time": {"seconds": 751, "nanos": 543}, + "index_error": { + "code": 411, + "message": "message_value", + "details": [ + { + "type_url": "type.googleapis.com/google.protobuf.Duration", + "value": b"\x08\x0c\x10\xdb\x07", + } + ], + }, + } + request = request_type(**request_init) + + # Mock the http request call within the method and fake a response. + with mock.patch.object(type(client.transport._session), "request") as req: + # Designate an appropriate value for the returned response. + return_value = product_search_service.ProductSet( + name="name_value", + display_name="display_name_value", + ) + + # Wrap the value into a proper Response obj + response_value = Response() + response_value.status_code = 200 + pb_return_value = product_search_service.ProductSet.pb(return_value) + json_return_value = json_format.MessageToJson(pb_return_value) + + response_value._content = json_return_value.encode("UTF-8") + req.return_value = response_value + response = client.update_product_set(request) + + # Establish that the response is the type that we expect. + assert isinstance(response, product_search_service.ProductSet) + assert response.name == "name_value" + assert response.display_name == "display_name_value" + + +def test_update_product_set_rest_required_fields( + request_type=product_search_service.UpdateProductSetRequest, +): + transport_class = transports.ProductSearchRestTransport + + request_init = {} + request = request_type(**request_init) + pb_request = request_type.pb(request) + jsonified_request = json.loads( + json_format.MessageToJson( + pb_request, + including_default_value_fields=False, + use_integers_for_enums=False, + ) + ) + + # verify fields with default values are dropped + + unset_fields = transport_class( + credentials=ga_credentials.AnonymousCredentials() + ).update_product_set._get_unset_required_fields(jsonified_request) + jsonified_request.update(unset_fields) + + # verify required fields with default values are now present + + unset_fields = transport_class( + credentials=ga_credentials.AnonymousCredentials() + ).update_product_set._get_unset_required_fields(jsonified_request) + # Check that path parameters and body parameters are not mixing in. + assert not set(unset_fields) - set(("update_mask",)) + jsonified_request.update(unset_fields) + + # verify required fields with non-default values are left alone + + client = ProductSearchClient( + credentials=ga_credentials.AnonymousCredentials(), + transport="rest", + ) + request = request_type(**request_init) + + # Designate an appropriate value for the returned response. + return_value = product_search_service.ProductSet() + # Mock the http request call within the method and fake a response. + with mock.patch.object(Session, "request") as req: + # We need to mock transcode() because providing default values + # for required fields will fail the real version if the http_options + # expect actual values for those fields. + with mock.patch.object(path_template, "transcode") as transcode: + # A uri without fields and an empty body will force all the + # request fields to show up in the query_params. + pb_request = request_type.pb(request) + transcode_result = { + "uri": "v1/sample_method", + "method": "patch", + "query_params": pb_request, + } + transcode_result["body"] = pb_request + transcode.return_value = transcode_result + + response_value = Response() + response_value.status_code = 200 + + pb_return_value = product_search_service.ProductSet.pb(return_value) + json_return_value = json_format.MessageToJson(pb_return_value) + + response_value._content = json_return_value.encode("UTF-8") + req.return_value = response_value + + response = client.update_product_set(request) + + expected_params = [("$alt", "json;enum-encoding=int")] + actual_params = req.call_args.kwargs["params"] + assert expected_params == actual_params + + +def test_update_product_set_rest_unset_required_fields(): + transport = transports.ProductSearchRestTransport( + credentials=ga_credentials.AnonymousCredentials + ) + + unset_fields = transport.update_product_set._get_unset_required_fields({}) + assert set(unset_fields) == (set(("updateMask",)) & set(("productSet",))) + + +@pytest.mark.parametrize("null_interceptor", [True, False]) +def test_update_product_set_rest_interceptors(null_interceptor): + transport = transports.ProductSearchRestTransport( + credentials=ga_credentials.AnonymousCredentials(), + interceptor=None + if null_interceptor + else transports.ProductSearchRestInterceptor(), + ) + client = ProductSearchClient(transport=transport) + with mock.patch.object( + type(client.transport._session), "request" + ) as req, mock.patch.object( + path_template, "transcode" + ) as transcode, mock.patch.object( + transports.ProductSearchRestInterceptor, "post_update_product_set" + ) as post, mock.patch.object( + transports.ProductSearchRestInterceptor, "pre_update_product_set" + ) as pre: + pre.assert_not_called() + post.assert_not_called() + pb_message = product_search_service.UpdateProductSetRequest.pb( + product_search_service.UpdateProductSetRequest() + ) + transcode.return_value = { + "method": "post", + "uri": "my_uri", + "body": pb_message, + "query_params": pb_message, + } + + req.return_value = Response() + req.return_value.status_code = 200 + req.return_value.request = PreparedRequest() + req.return_value._content = product_search_service.ProductSet.to_json( + product_search_service.ProductSet() + ) + + request = product_search_service.UpdateProductSetRequest() + metadata = [ + ("key", "val"), + ("cephalopod", "squid"), + ] + pre.return_value = request, metadata + post.return_value = product_search_service.ProductSet() + + client.update_product_set( + request, + metadata=[ + ("key", "val"), + ("cephalopod", "squid"), + ], + ) + + pre.assert_called_once() + post.assert_called_once() + + +def test_update_product_set_rest_bad_request( + transport: str = "rest", request_type=product_search_service.UpdateProductSetRequest +): + client = ProductSearchClient( + credentials=ga_credentials.AnonymousCredentials(), + transport=transport, + ) + + # send a request that will satisfy transcoding + request_init = { + "product_set": { + "name": "projects/sample1/locations/sample2/productSets/sample3" + } + } + request_init["product_set"] = { + "name": "projects/sample1/locations/sample2/productSets/sample3", + "display_name": "display_name_value", + "index_time": {"seconds": 751, "nanos": 543}, + "index_error": { + "code": 411, + "message": "message_value", + "details": [ + { + "type_url": "type.googleapis.com/google.protobuf.Duration", + "value": b"\x08\x0c\x10\xdb\x07", + } + ], + }, + } + request = request_type(**request_init) + + # Mock the http request call within the method and fake a BadRequest error. + with mock.patch.object(Session, "request") as req, pytest.raises( + core_exceptions.BadRequest + ): + # Wrap the value into a proper Response obj + response_value = Response() + response_value.status_code = 400 + response_value.request = Request() + req.return_value = response_value + client.update_product_set(request) + + +def test_update_product_set_rest_flattened(): + client = ProductSearchClient( + credentials=ga_credentials.AnonymousCredentials(), + transport="rest", + ) + + # Mock the http request call within the method and fake a response. + with mock.patch.object(type(client.transport._session), "request") as req: + # Designate an appropriate value for the returned response. + return_value = product_search_service.ProductSet() + + # get arguments that satisfy an http rule for this method + sample_request = { + "product_set": { + "name": "projects/sample1/locations/sample2/productSets/sample3" + } + } + + # get truthy value for each flattened field + mock_args = dict( + product_set=product_search_service.ProductSet(name="name_value"), + update_mask=field_mask_pb2.FieldMask(paths=["paths_value"]), + ) + mock_args.update(sample_request) + + # Wrap the value into a proper Response obj + response_value = Response() + response_value.status_code = 200 + pb_return_value = product_search_service.ProductSet.pb(return_value) + json_return_value = json_format.MessageToJson(pb_return_value) + response_value._content = json_return_value.encode("UTF-8") + req.return_value = response_value + + client.update_product_set(**mock_args) + + # Establish that the underlying call was made with the expected + # request object values. + assert len(req.mock_calls) == 1 + _, args, _ = req.mock_calls[0] + assert path_template.validate( + "%s/v1p4beta1/{product_set.name=projects/*/locations/*/productSets/*}" + % client.transport._host, + args[1], + ) + + +def test_update_product_set_rest_flattened_error(transport: str = "rest"): + client = ProductSearchClient( + credentials=ga_credentials.AnonymousCredentials(), + transport=transport, + ) + + # Attempting to call a method with both a request object and flattened + # fields is an error. + with pytest.raises(ValueError): + client.update_product_set( + product_search_service.UpdateProductSetRequest(), + product_set=product_search_service.ProductSet(name="name_value"), + update_mask=field_mask_pb2.FieldMask(paths=["paths_value"]), + ) + + +def test_update_product_set_rest_error(): + client = ProductSearchClient( + credentials=ga_credentials.AnonymousCredentials(), transport="rest" + ) + + +@pytest.mark.parametrize( + "request_type", + [ + product_search_service.DeleteProductSetRequest, + dict, + ], +) +def test_delete_product_set_rest(request_type): + client = ProductSearchClient( + credentials=ga_credentials.AnonymousCredentials(), + transport="rest", + ) + + # send a request that will satisfy transcoding + request_init = {"name": "projects/sample1/locations/sample2/productSets/sample3"} + request = request_type(**request_init) + + # Mock the http request call within the method and fake a response. + with mock.patch.object(type(client.transport._session), "request") as req: + # Designate an appropriate value for the returned response. + return_value = None + + # Wrap the value into a proper Response obj + response_value = Response() + response_value.status_code = 200 + json_return_value = "" + + response_value._content = json_return_value.encode("UTF-8") + req.return_value = response_value + response = client.delete_product_set(request) + + # Establish that the response is the type that we expect. + assert response is None + + +def test_delete_product_set_rest_required_fields( + request_type=product_search_service.DeleteProductSetRequest, +): + transport_class = transports.ProductSearchRestTransport + + request_init = {} + request_init["name"] = "" + request = request_type(**request_init) + pb_request = request_type.pb(request) + jsonified_request = json.loads( + json_format.MessageToJson( + pb_request, + including_default_value_fields=False, + use_integers_for_enums=False, + ) + ) + + # verify fields with default values are dropped + + unset_fields = transport_class( + credentials=ga_credentials.AnonymousCredentials() + ).delete_product_set._get_unset_required_fields(jsonified_request) + jsonified_request.update(unset_fields) + + # verify required fields with default values are now present + + jsonified_request["name"] = "name_value" + + unset_fields = transport_class( + credentials=ga_credentials.AnonymousCredentials() + ).delete_product_set._get_unset_required_fields(jsonified_request) + jsonified_request.update(unset_fields) + + # verify required fields with non-default values are left alone + assert "name" in jsonified_request + assert jsonified_request["name"] == "name_value" + + client = ProductSearchClient( + credentials=ga_credentials.AnonymousCredentials(), + transport="rest", + ) + request = request_type(**request_init) + + # Designate an appropriate value for the returned response. + return_value = None + # Mock the http request call within the method and fake a response. + with mock.patch.object(Session, "request") as req: + # We need to mock transcode() because providing default values + # for required fields will fail the real version if the http_options + # expect actual values for those fields. + with mock.patch.object(path_template, "transcode") as transcode: + # A uri without fields and an empty body will force all the + # request fields to show up in the query_params. + pb_request = request_type.pb(request) + transcode_result = { + "uri": "v1/sample_method", + "method": "delete", + "query_params": pb_request, + } + transcode.return_value = transcode_result + + response_value = Response() + response_value.status_code = 200 + json_return_value = "" + + response_value._content = json_return_value.encode("UTF-8") + req.return_value = response_value + + response = client.delete_product_set(request) + + expected_params = [("$alt", "json;enum-encoding=int")] + actual_params = req.call_args.kwargs["params"] + assert expected_params == actual_params + + +def test_delete_product_set_rest_unset_required_fields(): + transport = transports.ProductSearchRestTransport( + credentials=ga_credentials.AnonymousCredentials + ) + + unset_fields = transport.delete_product_set._get_unset_required_fields({}) + assert set(unset_fields) == (set(()) & set(("name",))) + + +@pytest.mark.parametrize("null_interceptor", [True, False]) +def test_delete_product_set_rest_interceptors(null_interceptor): + transport = transports.ProductSearchRestTransport( + credentials=ga_credentials.AnonymousCredentials(), + interceptor=None + if null_interceptor + else transports.ProductSearchRestInterceptor(), + ) + client = ProductSearchClient(transport=transport) + with mock.patch.object( + type(client.transport._session), "request" + ) as req, mock.patch.object( + path_template, "transcode" + ) as transcode, mock.patch.object( + transports.ProductSearchRestInterceptor, "pre_delete_product_set" + ) as pre: + pre.assert_not_called() + pb_message = product_search_service.DeleteProductSetRequest.pb( + product_search_service.DeleteProductSetRequest() + ) + transcode.return_value = { + "method": "post", + "uri": "my_uri", + "body": pb_message, + "query_params": pb_message, + } + + req.return_value = Response() + req.return_value.status_code = 200 + req.return_value.request = PreparedRequest() + + request = product_search_service.DeleteProductSetRequest() + metadata = [ + ("key", "val"), + ("cephalopod", "squid"), + ] + pre.return_value = request, metadata + + client.delete_product_set( + request, + metadata=[ + ("key", "val"), + ("cephalopod", "squid"), + ], + ) + + pre.assert_called_once() + + +def test_delete_product_set_rest_bad_request( + transport: str = "rest", request_type=product_search_service.DeleteProductSetRequest +): + client = ProductSearchClient( + credentials=ga_credentials.AnonymousCredentials(), + transport=transport, + ) + + # send a request that will satisfy transcoding + request_init = {"name": "projects/sample1/locations/sample2/productSets/sample3"} + request = request_type(**request_init) + + # Mock the http request call within the method and fake a BadRequest error. + with mock.patch.object(Session, "request") as req, pytest.raises( + core_exceptions.BadRequest + ): + # Wrap the value into a proper Response obj + response_value = Response() + response_value.status_code = 400 + response_value.request = Request() + req.return_value = response_value + client.delete_product_set(request) + + +def test_delete_product_set_rest_flattened(): + client = ProductSearchClient( + credentials=ga_credentials.AnonymousCredentials(), + transport="rest", + ) + + # Mock the http request call within the method and fake a response. + with mock.patch.object(type(client.transport._session), "request") as req: + # Designate an appropriate value for the returned response. + return_value = None + + # get arguments that satisfy an http rule for this method + sample_request = { + "name": "projects/sample1/locations/sample2/productSets/sample3" + } + + # get truthy value for each flattened field + mock_args = dict( + name="name_value", + ) + mock_args.update(sample_request) + + # Wrap the value into a proper Response obj + response_value = Response() + response_value.status_code = 200 + json_return_value = "" + response_value._content = json_return_value.encode("UTF-8") + req.return_value = response_value + + client.delete_product_set(**mock_args) + + # Establish that the underlying call was made with the expected + # request object values. + assert len(req.mock_calls) == 1 + _, args, _ = req.mock_calls[0] + assert path_template.validate( + "%s/v1p4beta1/{name=projects/*/locations/*/productSets/*}" + % client.transport._host, + args[1], + ) + + +def test_delete_product_set_rest_flattened_error(transport: str = "rest"): + client = ProductSearchClient( + credentials=ga_credentials.AnonymousCredentials(), + transport=transport, + ) + + # Attempting to call a method with both a request object and flattened + # fields is an error. + with pytest.raises(ValueError): + client.delete_product_set( + product_search_service.DeleteProductSetRequest(), + name="name_value", + ) + + +def test_delete_product_set_rest_error(): + client = ProductSearchClient( + credentials=ga_credentials.AnonymousCredentials(), transport="rest" + ) + + +@pytest.mark.parametrize( + "request_type", + [ + product_search_service.CreateProductRequest, + dict, + ], +) +def test_create_product_rest(request_type): + client = ProductSearchClient( + credentials=ga_credentials.AnonymousCredentials(), + transport="rest", + ) + + # send a request that will satisfy transcoding + request_init = {"parent": "projects/sample1/locations/sample2"} + request_init["product"] = { + "name": "name_value", + "display_name": "display_name_value", + "description": "description_value", + "product_category": "product_category_value", + "product_labels": [{"key": "key_value", "value": "value_value"}], + } + request = request_type(**request_init) + + # Mock the http request call within the method and fake a response. + with mock.patch.object(type(client.transport._session), "request") as req: + # Designate an appropriate value for the returned response. + return_value = product_search_service.Product( + name="name_value", + display_name="display_name_value", + description="description_value", + product_category="product_category_value", + ) + + # Wrap the value into a proper Response obj + response_value = Response() + response_value.status_code = 200 + pb_return_value = product_search_service.Product.pb(return_value) + json_return_value = json_format.MessageToJson(pb_return_value) + + response_value._content = json_return_value.encode("UTF-8") + req.return_value = response_value + response = client.create_product(request) + + # Establish that the response is the type that we expect. + assert isinstance(response, product_search_service.Product) + assert response.name == "name_value" + assert response.display_name == "display_name_value" + assert response.description == "description_value" + assert response.product_category == "product_category_value" + + +def test_create_product_rest_required_fields( + request_type=product_search_service.CreateProductRequest, +): + transport_class = transports.ProductSearchRestTransport + + request_init = {} + request_init["parent"] = "" + request = request_type(**request_init) + pb_request = request_type.pb(request) + jsonified_request = json.loads( + json_format.MessageToJson( + pb_request, + including_default_value_fields=False, + use_integers_for_enums=False, + ) + ) + + # verify fields with default values are dropped + + unset_fields = transport_class( + credentials=ga_credentials.AnonymousCredentials() + ).create_product._get_unset_required_fields(jsonified_request) + jsonified_request.update(unset_fields) + + # verify required fields with default values are now present + + jsonified_request["parent"] = "parent_value" + + unset_fields = transport_class( + credentials=ga_credentials.AnonymousCredentials() + ).create_product._get_unset_required_fields(jsonified_request) + # Check that path parameters and body parameters are not mixing in. + assert not set(unset_fields) - set(("product_id",)) + jsonified_request.update(unset_fields) + + # verify required fields with non-default values are left alone + assert "parent" in jsonified_request + assert jsonified_request["parent"] == "parent_value" + + client = ProductSearchClient( + credentials=ga_credentials.AnonymousCredentials(), + transport="rest", + ) + request = request_type(**request_init) + + # Designate an appropriate value for the returned response. + return_value = product_search_service.Product() + # Mock the http request call within the method and fake a response. + with mock.patch.object(Session, "request") as req: + # We need to mock transcode() because providing default values + # for required fields will fail the real version if the http_options + # expect actual values for those fields. + with mock.patch.object(path_template, "transcode") as transcode: + # A uri without fields and an empty body will force all the + # request fields to show up in the query_params. + pb_request = request_type.pb(request) + transcode_result = { + "uri": "v1/sample_method", + "method": "post", + "query_params": pb_request, + } + transcode_result["body"] = pb_request + transcode.return_value = transcode_result + + response_value = Response() + response_value.status_code = 200 + + pb_return_value = product_search_service.Product.pb(return_value) + json_return_value = json_format.MessageToJson(pb_return_value) + + response_value._content = json_return_value.encode("UTF-8") + req.return_value = response_value + + response = client.create_product(request) + + expected_params = [("$alt", "json;enum-encoding=int")] + actual_params = req.call_args.kwargs["params"] + assert expected_params == actual_params + + +def test_create_product_rest_unset_required_fields(): + transport = transports.ProductSearchRestTransport( + credentials=ga_credentials.AnonymousCredentials + ) + + unset_fields = transport.create_product._get_unset_required_fields({}) + assert set(unset_fields) == ( + set(("productId",)) + & set( + ( + "parent", + "product", + ) + ) + ) + + +@pytest.mark.parametrize("null_interceptor", [True, False]) +def test_create_product_rest_interceptors(null_interceptor): + transport = transports.ProductSearchRestTransport( + credentials=ga_credentials.AnonymousCredentials(), + interceptor=None + if null_interceptor + else transports.ProductSearchRestInterceptor(), + ) + client = ProductSearchClient(transport=transport) + with mock.patch.object( + type(client.transport._session), "request" + ) as req, mock.patch.object( + path_template, "transcode" + ) as transcode, mock.patch.object( + transports.ProductSearchRestInterceptor, "post_create_product" + ) as post, mock.patch.object( + transports.ProductSearchRestInterceptor, "pre_create_product" + ) as pre: + pre.assert_not_called() + post.assert_not_called() + pb_message = product_search_service.CreateProductRequest.pb( + product_search_service.CreateProductRequest() + ) + transcode.return_value = { + "method": "post", + "uri": "my_uri", + "body": pb_message, + "query_params": pb_message, + } + + req.return_value = Response() + req.return_value.status_code = 200 + req.return_value.request = PreparedRequest() + req.return_value._content = product_search_service.Product.to_json( + product_search_service.Product() + ) + + request = product_search_service.CreateProductRequest() + metadata = [ + ("key", "val"), + ("cephalopod", "squid"), + ] + pre.return_value = request, metadata + post.return_value = product_search_service.Product() + + client.create_product( + request, + metadata=[ + ("key", "val"), + ("cephalopod", "squid"), + ], + ) + + pre.assert_called_once() + post.assert_called_once() + + +def test_create_product_rest_bad_request( + transport: str = "rest", request_type=product_search_service.CreateProductRequest +): + client = ProductSearchClient( + credentials=ga_credentials.AnonymousCredentials(), + transport=transport, + ) + + # send a request that will satisfy transcoding + request_init = {"parent": "projects/sample1/locations/sample2"} + request_init["product"] = { + "name": "name_value", + "display_name": "display_name_value", + "description": "description_value", + "product_category": "product_category_value", + "product_labels": [{"key": "key_value", "value": "value_value"}], + } + request = request_type(**request_init) + + # Mock the http request call within the method and fake a BadRequest error. + with mock.patch.object(Session, "request") as req, pytest.raises( + core_exceptions.BadRequest + ): + # Wrap the value into a proper Response obj + response_value = Response() + response_value.status_code = 400 + response_value.request = Request() + req.return_value = response_value + client.create_product(request) + + +def test_create_product_rest_flattened(): + client = ProductSearchClient( + credentials=ga_credentials.AnonymousCredentials(), + transport="rest", + ) + + # Mock the http request call within the method and fake a response. + with mock.patch.object(type(client.transport._session), "request") as req: + # Designate an appropriate value for the returned response. + return_value = product_search_service.Product() + + # get arguments that satisfy an http rule for this method + sample_request = {"parent": "projects/sample1/locations/sample2"} + + # get truthy value for each flattened field + mock_args = dict( + parent="parent_value", + product=product_search_service.Product(name="name_value"), + product_id="product_id_value", + ) + mock_args.update(sample_request) + + # Wrap the value into a proper Response obj + response_value = Response() + response_value.status_code = 200 + pb_return_value = product_search_service.Product.pb(return_value) + json_return_value = json_format.MessageToJson(pb_return_value) + response_value._content = json_return_value.encode("UTF-8") + req.return_value = response_value + + client.create_product(**mock_args) + + # Establish that the underlying call was made with the expected + # request object values. + assert len(req.mock_calls) == 1 + _, args, _ = req.mock_calls[0] + assert path_template.validate( + "%s/v1p4beta1/{parent=projects/*/locations/*}/products" + % client.transport._host, + args[1], + ) + + +def test_create_product_rest_flattened_error(transport: str = "rest"): + client = ProductSearchClient( + credentials=ga_credentials.AnonymousCredentials(), + transport=transport, + ) + + # Attempting to call a method with both a request object and flattened + # fields is an error. + with pytest.raises(ValueError): + client.create_product( + product_search_service.CreateProductRequest(), + parent="parent_value", + product=product_search_service.Product(name="name_value"), + product_id="product_id_value", + ) + + +def test_create_product_rest_error(): + client = ProductSearchClient( + credentials=ga_credentials.AnonymousCredentials(), transport="rest" + ) + + +@pytest.mark.parametrize( + "request_type", + [ + product_search_service.ListProductsRequest, + dict, + ], +) +def test_list_products_rest(request_type): + client = ProductSearchClient( + credentials=ga_credentials.AnonymousCredentials(), + transport="rest", + ) + + # send a request that will satisfy transcoding + request_init = {"parent": "projects/sample1/locations/sample2"} + request = request_type(**request_init) + + # Mock the http request call within the method and fake a response. + with mock.patch.object(type(client.transport._session), "request") as req: + # Designate an appropriate value for the returned response. + return_value = product_search_service.ListProductsResponse( + next_page_token="next_page_token_value", + ) + + # Wrap the value into a proper Response obj + response_value = Response() + response_value.status_code = 200 + pb_return_value = product_search_service.ListProductsResponse.pb(return_value) + json_return_value = json_format.MessageToJson(pb_return_value) + + response_value._content = json_return_value.encode("UTF-8") + req.return_value = response_value + response = client.list_products(request) + + # Establish that the response is the type that we expect. + assert isinstance(response, pagers.ListProductsPager) + assert response.next_page_token == "next_page_token_value" + + +def test_list_products_rest_required_fields( + request_type=product_search_service.ListProductsRequest, +): + transport_class = transports.ProductSearchRestTransport + + request_init = {} + request_init["parent"] = "" + request = request_type(**request_init) + pb_request = request_type.pb(request) + jsonified_request = json.loads( + json_format.MessageToJson( + pb_request, + including_default_value_fields=False, + use_integers_for_enums=False, + ) + ) + + # verify fields with default values are dropped + + unset_fields = transport_class( + credentials=ga_credentials.AnonymousCredentials() + ).list_products._get_unset_required_fields(jsonified_request) + jsonified_request.update(unset_fields) + + # verify required fields with default values are now present + + jsonified_request["parent"] = "parent_value" + + unset_fields = transport_class( + credentials=ga_credentials.AnonymousCredentials() + ).list_products._get_unset_required_fields(jsonified_request) + # Check that path parameters and body parameters are not mixing in. + assert not set(unset_fields) - set( + ( + "page_size", + "page_token", + ) + ) + jsonified_request.update(unset_fields) + + # verify required fields with non-default values are left alone + assert "parent" in jsonified_request + assert jsonified_request["parent"] == "parent_value" + + client = ProductSearchClient( + credentials=ga_credentials.AnonymousCredentials(), + transport="rest", + ) + request = request_type(**request_init) + + # Designate an appropriate value for the returned response. + return_value = product_search_service.ListProductsResponse() + # Mock the http request call within the method and fake a response. + with mock.patch.object(Session, "request") as req: + # We need to mock transcode() because providing default values + # for required fields will fail the real version if the http_options + # expect actual values for those fields. + with mock.patch.object(path_template, "transcode") as transcode: + # A uri without fields and an empty body will force all the + # request fields to show up in the query_params. + pb_request = request_type.pb(request) + transcode_result = { + "uri": "v1/sample_method", + "method": "get", + "query_params": pb_request, + } + transcode.return_value = transcode_result + + response_value = Response() + response_value.status_code = 200 + + pb_return_value = product_search_service.ListProductsResponse.pb( + return_value + ) + json_return_value = json_format.MessageToJson(pb_return_value) + + response_value._content = json_return_value.encode("UTF-8") + req.return_value = response_value + + response = client.list_products(request) + + expected_params = [("$alt", "json;enum-encoding=int")] + actual_params = req.call_args.kwargs["params"] + assert expected_params == actual_params + + +def test_list_products_rest_unset_required_fields(): + transport = transports.ProductSearchRestTransport( + credentials=ga_credentials.AnonymousCredentials + ) + + unset_fields = transport.list_products._get_unset_required_fields({}) + assert set(unset_fields) == ( + set( + ( + "pageSize", + "pageToken", + ) + ) + & set(("parent",)) + ) + + +@pytest.mark.parametrize("null_interceptor", [True, False]) +def test_list_products_rest_interceptors(null_interceptor): + transport = transports.ProductSearchRestTransport( + credentials=ga_credentials.AnonymousCredentials(), + interceptor=None + if null_interceptor + else transports.ProductSearchRestInterceptor(), + ) + client = ProductSearchClient(transport=transport) + with mock.patch.object( + type(client.transport._session), "request" + ) as req, mock.patch.object( + path_template, "transcode" + ) as transcode, mock.patch.object( + transports.ProductSearchRestInterceptor, "post_list_products" + ) as post, mock.patch.object( + transports.ProductSearchRestInterceptor, "pre_list_products" + ) as pre: + pre.assert_not_called() + post.assert_not_called() + pb_message = product_search_service.ListProductsRequest.pb( + product_search_service.ListProductsRequest() + ) + transcode.return_value = { + "method": "post", + "uri": "my_uri", + "body": pb_message, + "query_params": pb_message, + } + + req.return_value = Response() + req.return_value.status_code = 200 + req.return_value.request = PreparedRequest() + req.return_value._content = product_search_service.ListProductsResponse.to_json( + product_search_service.ListProductsResponse() + ) + + request = product_search_service.ListProductsRequest() + metadata = [ + ("key", "val"), + ("cephalopod", "squid"), + ] + pre.return_value = request, metadata + post.return_value = product_search_service.ListProductsResponse() + + client.list_products( + request, + metadata=[ + ("key", "val"), + ("cephalopod", "squid"), + ], + ) + + pre.assert_called_once() + post.assert_called_once() + + +def test_list_products_rest_bad_request( + transport: str = "rest", request_type=product_search_service.ListProductsRequest +): + client = ProductSearchClient( + credentials=ga_credentials.AnonymousCredentials(), + transport=transport, + ) + + # send a request that will satisfy transcoding + request_init = {"parent": "projects/sample1/locations/sample2"} + request = request_type(**request_init) + + # Mock the http request call within the method and fake a BadRequest error. + with mock.patch.object(Session, "request") as req, pytest.raises( + core_exceptions.BadRequest + ): + # Wrap the value into a proper Response obj + response_value = Response() + response_value.status_code = 400 + response_value.request = Request() + req.return_value = response_value + client.list_products(request) + + +def test_list_products_rest_flattened(): + client = ProductSearchClient( + credentials=ga_credentials.AnonymousCredentials(), + transport="rest", + ) + + # Mock the http request call within the method and fake a response. + with mock.patch.object(type(client.transport._session), "request") as req: + # Designate an appropriate value for the returned response. + return_value = product_search_service.ListProductsResponse() + + # get arguments that satisfy an http rule for this method + sample_request = {"parent": "projects/sample1/locations/sample2"} + + # get truthy value for each flattened field + mock_args = dict( + parent="parent_value", + ) + mock_args.update(sample_request) + + # Wrap the value into a proper Response obj + response_value = Response() + response_value.status_code = 200 + pb_return_value = product_search_service.ListProductsResponse.pb(return_value) + json_return_value = json_format.MessageToJson(pb_return_value) + response_value._content = json_return_value.encode("UTF-8") + req.return_value = response_value + + client.list_products(**mock_args) + + # Establish that the underlying call was made with the expected + # request object values. + assert len(req.mock_calls) == 1 + _, args, _ = req.mock_calls[0] + assert path_template.validate( + "%s/v1p4beta1/{parent=projects/*/locations/*}/products" + % client.transport._host, + args[1], + ) + + +def test_list_products_rest_flattened_error(transport: str = "rest"): + client = ProductSearchClient( + credentials=ga_credentials.AnonymousCredentials(), + transport=transport, + ) + + # Attempting to call a method with both a request object and flattened + # fields is an error. + with pytest.raises(ValueError): + client.list_products( + product_search_service.ListProductsRequest(), + parent="parent_value", + ) + + +def test_list_products_rest_pager(transport: str = "rest"): + client = ProductSearchClient( + credentials=ga_credentials.AnonymousCredentials(), + transport=transport, + ) + + # Mock the http request call within the method and fake a response. + with mock.patch.object(Session, "request") as req: + # TODO(kbandes): remove this mock unless there's a good reason for it. + # with mock.patch.object(path_template, 'transcode') as transcode: + # Set the response as a series of pages + response = ( + product_search_service.ListProductsResponse( + products=[ + product_search_service.Product(), + product_search_service.Product(), + product_search_service.Product(), + ], + next_page_token="abc", + ), + product_search_service.ListProductsResponse( + products=[], + next_page_token="def", + ), + product_search_service.ListProductsResponse( + products=[ + product_search_service.Product(), + ], + next_page_token="ghi", + ), + product_search_service.ListProductsResponse( + products=[ + product_search_service.Product(), + product_search_service.Product(), + ], + ), + ) + # Two responses for two calls + response = response + response + + # Wrap the values into proper Response objs + response = tuple( + product_search_service.ListProductsResponse.to_json(x) for x in response + ) + return_values = tuple(Response() for i in response) + for return_val, response_val in zip(return_values, response): + return_val._content = response_val.encode("UTF-8") + return_val.status_code = 200 + req.side_effect = return_values + + sample_request = {"parent": "projects/sample1/locations/sample2"} + + pager = client.list_products(request=sample_request) + + results = list(pager) + assert len(results) == 6 + assert all(isinstance(i, product_search_service.Product) for i in results) + + pages = list(client.list_products(request=sample_request).pages) + for page_, token in zip(pages, ["abc", "def", "ghi", ""]): + assert page_.raw_page.next_page_token == token + + +@pytest.mark.parametrize( + "request_type", + [ + product_search_service.GetProductRequest, + dict, + ], +) +def test_get_product_rest(request_type): + client = ProductSearchClient( + credentials=ga_credentials.AnonymousCredentials(), + transport="rest", + ) + + # send a request that will satisfy transcoding + request_init = {"name": "projects/sample1/locations/sample2/products/sample3"} + request = request_type(**request_init) + + # Mock the http request call within the method and fake a response. + with mock.patch.object(type(client.transport._session), "request") as req: + # Designate an appropriate value for the returned response. + return_value = product_search_service.Product( + name="name_value", + display_name="display_name_value", + description="description_value", + product_category="product_category_value", + ) + + # Wrap the value into a proper Response obj + response_value = Response() + response_value.status_code = 200 + pb_return_value = product_search_service.Product.pb(return_value) + json_return_value = json_format.MessageToJson(pb_return_value) + + response_value._content = json_return_value.encode("UTF-8") + req.return_value = response_value + response = client.get_product(request) + + # Establish that the response is the type that we expect. + assert isinstance(response, product_search_service.Product) + assert response.name == "name_value" + assert response.display_name == "display_name_value" + assert response.description == "description_value" + assert response.product_category == "product_category_value" + + +def test_get_product_rest_required_fields( + request_type=product_search_service.GetProductRequest, +): + transport_class = transports.ProductSearchRestTransport + + request_init = {} + request_init["name"] = "" + request = request_type(**request_init) + pb_request = request_type.pb(request) + jsonified_request = json.loads( + json_format.MessageToJson( + pb_request, + including_default_value_fields=False, + use_integers_for_enums=False, + ) + ) + + # verify fields with default values are dropped + + unset_fields = transport_class( + credentials=ga_credentials.AnonymousCredentials() + ).get_product._get_unset_required_fields(jsonified_request) + jsonified_request.update(unset_fields) + + # verify required fields with default values are now present + + jsonified_request["name"] = "name_value" + + unset_fields = transport_class( + credentials=ga_credentials.AnonymousCredentials() + ).get_product._get_unset_required_fields(jsonified_request) + jsonified_request.update(unset_fields) + + # verify required fields with non-default values are left alone + assert "name" in jsonified_request + assert jsonified_request["name"] == "name_value" + + client = ProductSearchClient( + credentials=ga_credentials.AnonymousCredentials(), + transport="rest", + ) + request = request_type(**request_init) + + # Designate an appropriate value for the returned response. + return_value = product_search_service.Product() + # Mock the http request call within the method and fake a response. + with mock.patch.object(Session, "request") as req: + # We need to mock transcode() because providing default values + # for required fields will fail the real version if the http_options + # expect actual values for those fields. + with mock.patch.object(path_template, "transcode") as transcode: + # A uri without fields and an empty body will force all the + # request fields to show up in the query_params. + pb_request = request_type.pb(request) + transcode_result = { + "uri": "v1/sample_method", + "method": "get", + "query_params": pb_request, + } + transcode.return_value = transcode_result + + response_value = Response() + response_value.status_code = 200 + + pb_return_value = product_search_service.Product.pb(return_value) + json_return_value = json_format.MessageToJson(pb_return_value) + + response_value._content = json_return_value.encode("UTF-8") + req.return_value = response_value + + response = client.get_product(request) + + expected_params = [("$alt", "json;enum-encoding=int")] + actual_params = req.call_args.kwargs["params"] + assert expected_params == actual_params + + +def test_get_product_rest_unset_required_fields(): + transport = transports.ProductSearchRestTransport( + credentials=ga_credentials.AnonymousCredentials + ) + + unset_fields = transport.get_product._get_unset_required_fields({}) + assert set(unset_fields) == (set(()) & set(("name",))) + + +@pytest.mark.parametrize("null_interceptor", [True, False]) +def test_get_product_rest_interceptors(null_interceptor): + transport = transports.ProductSearchRestTransport( + credentials=ga_credentials.AnonymousCredentials(), + interceptor=None + if null_interceptor + else transports.ProductSearchRestInterceptor(), + ) + client = ProductSearchClient(transport=transport) + with mock.patch.object( + type(client.transport._session), "request" + ) as req, mock.patch.object( + path_template, "transcode" + ) as transcode, mock.patch.object( + transports.ProductSearchRestInterceptor, "post_get_product" + ) as post, mock.patch.object( + transports.ProductSearchRestInterceptor, "pre_get_product" + ) as pre: + pre.assert_not_called() + post.assert_not_called() + pb_message = product_search_service.GetProductRequest.pb( + product_search_service.GetProductRequest() + ) + transcode.return_value = { + "method": "post", + "uri": "my_uri", + "body": pb_message, + "query_params": pb_message, + } + + req.return_value = Response() + req.return_value.status_code = 200 + req.return_value.request = PreparedRequest() + req.return_value._content = product_search_service.Product.to_json( + product_search_service.Product() + ) + + request = product_search_service.GetProductRequest() + metadata = [ + ("key", "val"), + ("cephalopod", "squid"), + ] + pre.return_value = request, metadata + post.return_value = product_search_service.Product() + + client.get_product( + request, + metadata=[ + ("key", "val"), + ("cephalopod", "squid"), + ], + ) + + pre.assert_called_once() + post.assert_called_once() + + +def test_get_product_rest_bad_request( + transport: str = "rest", request_type=product_search_service.GetProductRequest +): + client = ProductSearchClient( + credentials=ga_credentials.AnonymousCredentials(), + transport=transport, + ) + + # send a request that will satisfy transcoding + request_init = {"name": "projects/sample1/locations/sample2/products/sample3"} + request = request_type(**request_init) + + # Mock the http request call within the method and fake a BadRequest error. + with mock.patch.object(Session, "request") as req, pytest.raises( + core_exceptions.BadRequest + ): + # Wrap the value into a proper Response obj + response_value = Response() + response_value.status_code = 400 + response_value.request = Request() + req.return_value = response_value + client.get_product(request) + + +def test_get_product_rest_flattened(): + client = ProductSearchClient( + credentials=ga_credentials.AnonymousCredentials(), + transport="rest", + ) + + # Mock the http request call within the method and fake a response. + with mock.patch.object(type(client.transport._session), "request") as req: + # Designate an appropriate value for the returned response. + return_value = product_search_service.Product() + + # get arguments that satisfy an http rule for this method + sample_request = {"name": "projects/sample1/locations/sample2/products/sample3"} + + # get truthy value for each flattened field + mock_args = dict( + name="name_value", + ) + mock_args.update(sample_request) + + # Wrap the value into a proper Response obj + response_value = Response() + response_value.status_code = 200 + pb_return_value = product_search_service.Product.pb(return_value) + json_return_value = json_format.MessageToJson(pb_return_value) + response_value._content = json_return_value.encode("UTF-8") + req.return_value = response_value + + client.get_product(**mock_args) + + # Establish that the underlying call was made with the expected + # request object values. + assert len(req.mock_calls) == 1 + _, args, _ = req.mock_calls[0] + assert path_template.validate( + "%s/v1p4beta1/{name=projects/*/locations/*/products/*}" + % client.transport._host, + args[1], + ) + + +def test_get_product_rest_flattened_error(transport: str = "rest"): + client = ProductSearchClient( + credentials=ga_credentials.AnonymousCredentials(), + transport=transport, + ) + + # Attempting to call a method with both a request object and flattened + # fields is an error. + with pytest.raises(ValueError): + client.get_product( + product_search_service.GetProductRequest(), + name="name_value", + ) + + +def test_get_product_rest_error(): + client = ProductSearchClient( + credentials=ga_credentials.AnonymousCredentials(), transport="rest" + ) + + +@pytest.mark.parametrize( + "request_type", + [ + product_search_service.UpdateProductRequest, + dict, + ], +) +def test_update_product_rest(request_type): + client = ProductSearchClient( + credentials=ga_credentials.AnonymousCredentials(), + transport="rest", + ) + + # send a request that will satisfy transcoding + request_init = { + "product": {"name": "projects/sample1/locations/sample2/products/sample3"} + } + request_init["product"] = { + "name": "projects/sample1/locations/sample2/products/sample3", + "display_name": "display_name_value", + "description": "description_value", + "product_category": "product_category_value", + "product_labels": [{"key": "key_value", "value": "value_value"}], + } + request = request_type(**request_init) + + # Mock the http request call within the method and fake a response. + with mock.patch.object(type(client.transport._session), "request") as req: + # Designate an appropriate value for the returned response. + return_value = product_search_service.Product( + name="name_value", + display_name="display_name_value", + description="description_value", + product_category="product_category_value", + ) + + # Wrap the value into a proper Response obj + response_value = Response() + response_value.status_code = 200 + pb_return_value = product_search_service.Product.pb(return_value) + json_return_value = json_format.MessageToJson(pb_return_value) + + response_value._content = json_return_value.encode("UTF-8") + req.return_value = response_value + response = client.update_product(request) + + # Establish that the response is the type that we expect. + assert isinstance(response, product_search_service.Product) + assert response.name == "name_value" + assert response.display_name == "display_name_value" + assert response.description == "description_value" + assert response.product_category == "product_category_value" + + +def test_update_product_rest_required_fields( + request_type=product_search_service.UpdateProductRequest, +): + transport_class = transports.ProductSearchRestTransport + + request_init = {} + request = request_type(**request_init) + pb_request = request_type.pb(request) + jsonified_request = json.loads( + json_format.MessageToJson( + pb_request, + including_default_value_fields=False, + use_integers_for_enums=False, + ) + ) + + # verify fields with default values are dropped + + unset_fields = transport_class( + credentials=ga_credentials.AnonymousCredentials() + ).update_product._get_unset_required_fields(jsonified_request) + jsonified_request.update(unset_fields) + + # verify required fields with default values are now present + + unset_fields = transport_class( + credentials=ga_credentials.AnonymousCredentials() + ).update_product._get_unset_required_fields(jsonified_request) + # Check that path parameters and body parameters are not mixing in. + assert not set(unset_fields) - set(("update_mask",)) + jsonified_request.update(unset_fields) + + # verify required fields with non-default values are left alone + + client = ProductSearchClient( + credentials=ga_credentials.AnonymousCredentials(), + transport="rest", + ) + request = request_type(**request_init) + + # Designate an appropriate value for the returned response. + return_value = product_search_service.Product() + # Mock the http request call within the method and fake a response. + with mock.patch.object(Session, "request") as req: + # We need to mock transcode() because providing default values + # for required fields will fail the real version if the http_options + # expect actual values for those fields. + with mock.patch.object(path_template, "transcode") as transcode: + # A uri without fields and an empty body will force all the + # request fields to show up in the query_params. + pb_request = request_type.pb(request) + transcode_result = { + "uri": "v1/sample_method", + "method": "patch", + "query_params": pb_request, + } + transcode_result["body"] = pb_request + transcode.return_value = transcode_result + + response_value = Response() + response_value.status_code = 200 + + pb_return_value = product_search_service.Product.pb(return_value) + json_return_value = json_format.MessageToJson(pb_return_value) + + response_value._content = json_return_value.encode("UTF-8") + req.return_value = response_value + + response = client.update_product(request) + + expected_params = [("$alt", "json;enum-encoding=int")] + actual_params = req.call_args.kwargs["params"] + assert expected_params == actual_params + + +def test_update_product_rest_unset_required_fields(): + transport = transports.ProductSearchRestTransport( + credentials=ga_credentials.AnonymousCredentials + ) + + unset_fields = transport.update_product._get_unset_required_fields({}) + assert set(unset_fields) == (set(("updateMask",)) & set(("product",))) + + +@pytest.mark.parametrize("null_interceptor", [True, False]) +def test_update_product_rest_interceptors(null_interceptor): + transport = transports.ProductSearchRestTransport( + credentials=ga_credentials.AnonymousCredentials(), + interceptor=None + if null_interceptor + else transports.ProductSearchRestInterceptor(), + ) + client = ProductSearchClient(transport=transport) + with mock.patch.object( + type(client.transport._session), "request" + ) as req, mock.patch.object( + path_template, "transcode" + ) as transcode, mock.patch.object( + transports.ProductSearchRestInterceptor, "post_update_product" + ) as post, mock.patch.object( + transports.ProductSearchRestInterceptor, "pre_update_product" + ) as pre: + pre.assert_not_called() + post.assert_not_called() + pb_message = product_search_service.UpdateProductRequest.pb( + product_search_service.UpdateProductRequest() + ) + transcode.return_value = { + "method": "post", + "uri": "my_uri", + "body": pb_message, + "query_params": pb_message, + } + + req.return_value = Response() + req.return_value.status_code = 200 + req.return_value.request = PreparedRequest() + req.return_value._content = product_search_service.Product.to_json( + product_search_service.Product() + ) + + request = product_search_service.UpdateProductRequest() + metadata = [ + ("key", "val"), + ("cephalopod", "squid"), + ] + pre.return_value = request, metadata + post.return_value = product_search_service.Product() + + client.update_product( + request, + metadata=[ + ("key", "val"), + ("cephalopod", "squid"), + ], + ) + + pre.assert_called_once() + post.assert_called_once() + + +def test_update_product_rest_bad_request( + transport: str = "rest", request_type=product_search_service.UpdateProductRequest +): + client = ProductSearchClient( + credentials=ga_credentials.AnonymousCredentials(), + transport=transport, + ) + + # send a request that will satisfy transcoding + request_init = { + "product": {"name": "projects/sample1/locations/sample2/products/sample3"} + } + request_init["product"] = { + "name": "projects/sample1/locations/sample2/products/sample3", + "display_name": "display_name_value", + "description": "description_value", + "product_category": "product_category_value", + "product_labels": [{"key": "key_value", "value": "value_value"}], + } + request = request_type(**request_init) + + # Mock the http request call within the method and fake a BadRequest error. + with mock.patch.object(Session, "request") as req, pytest.raises( + core_exceptions.BadRequest + ): + # Wrap the value into a proper Response obj + response_value = Response() + response_value.status_code = 400 + response_value.request = Request() + req.return_value = response_value + client.update_product(request) + + +def test_update_product_rest_flattened(): + client = ProductSearchClient( + credentials=ga_credentials.AnonymousCredentials(), + transport="rest", + ) + + # Mock the http request call within the method and fake a response. + with mock.patch.object(type(client.transport._session), "request") as req: + # Designate an appropriate value for the returned response. + return_value = product_search_service.Product() + + # get arguments that satisfy an http rule for this method + sample_request = { + "product": {"name": "projects/sample1/locations/sample2/products/sample3"} + } + + # get truthy value for each flattened field + mock_args = dict( + product=product_search_service.Product(name="name_value"), + update_mask=field_mask_pb2.FieldMask(paths=["paths_value"]), + ) + mock_args.update(sample_request) + + # Wrap the value into a proper Response obj + response_value = Response() + response_value.status_code = 200 + pb_return_value = product_search_service.Product.pb(return_value) + json_return_value = json_format.MessageToJson(pb_return_value) + response_value._content = json_return_value.encode("UTF-8") + req.return_value = response_value + + client.update_product(**mock_args) + + # Establish that the underlying call was made with the expected + # request object values. + assert len(req.mock_calls) == 1 + _, args, _ = req.mock_calls[0] + assert path_template.validate( + "%s/v1p4beta1/{product.name=projects/*/locations/*/products/*}" + % client.transport._host, + args[1], + ) + + +def test_update_product_rest_flattened_error(transport: str = "rest"): + client = ProductSearchClient( + credentials=ga_credentials.AnonymousCredentials(), + transport=transport, + ) + + # Attempting to call a method with both a request object and flattened + # fields is an error. + with pytest.raises(ValueError): + client.update_product( + product_search_service.UpdateProductRequest(), + product=product_search_service.Product(name="name_value"), + update_mask=field_mask_pb2.FieldMask(paths=["paths_value"]), + ) + + +def test_update_product_rest_error(): + client = ProductSearchClient( + credentials=ga_credentials.AnonymousCredentials(), transport="rest" + ) + + +@pytest.mark.parametrize( + "request_type", + [ + product_search_service.DeleteProductRequest, + dict, + ], +) +def test_delete_product_rest(request_type): + client = ProductSearchClient( + credentials=ga_credentials.AnonymousCredentials(), + transport="rest", + ) + + # send a request that will satisfy transcoding + request_init = {"name": "projects/sample1/locations/sample2/products/sample3"} + request = request_type(**request_init) + + # Mock the http request call within the method and fake a response. + with mock.patch.object(type(client.transport._session), "request") as req: + # Designate an appropriate value for the returned response. + return_value = None + + # Wrap the value into a proper Response obj + response_value = Response() + response_value.status_code = 200 + json_return_value = "" + + response_value._content = json_return_value.encode("UTF-8") + req.return_value = response_value + response = client.delete_product(request) + + # Establish that the response is the type that we expect. + assert response is None + + +def test_delete_product_rest_required_fields( + request_type=product_search_service.DeleteProductRequest, +): + transport_class = transports.ProductSearchRestTransport + + request_init = {} + request_init["name"] = "" + request = request_type(**request_init) + pb_request = request_type.pb(request) + jsonified_request = json.loads( + json_format.MessageToJson( + pb_request, + including_default_value_fields=False, + use_integers_for_enums=False, + ) + ) + + # verify fields with default values are dropped + + unset_fields = transport_class( + credentials=ga_credentials.AnonymousCredentials() + ).delete_product._get_unset_required_fields(jsonified_request) + jsonified_request.update(unset_fields) + + # verify required fields with default values are now present + + jsonified_request["name"] = "name_value" + + unset_fields = transport_class( + credentials=ga_credentials.AnonymousCredentials() + ).delete_product._get_unset_required_fields(jsonified_request) + jsonified_request.update(unset_fields) + + # verify required fields with non-default values are left alone + assert "name" in jsonified_request + assert jsonified_request["name"] == "name_value" + + client = ProductSearchClient( + credentials=ga_credentials.AnonymousCredentials(), + transport="rest", + ) + request = request_type(**request_init) + + # Designate an appropriate value for the returned response. + return_value = None + # Mock the http request call within the method and fake a response. + with mock.patch.object(Session, "request") as req: + # We need to mock transcode() because providing default values + # for required fields will fail the real version if the http_options + # expect actual values for those fields. + with mock.patch.object(path_template, "transcode") as transcode: + # A uri without fields and an empty body will force all the + # request fields to show up in the query_params. + pb_request = request_type.pb(request) + transcode_result = { + "uri": "v1/sample_method", + "method": "delete", + "query_params": pb_request, + } + transcode.return_value = transcode_result + + response_value = Response() + response_value.status_code = 200 + json_return_value = "" + + response_value._content = json_return_value.encode("UTF-8") + req.return_value = response_value + + response = client.delete_product(request) + + expected_params = [("$alt", "json;enum-encoding=int")] + actual_params = req.call_args.kwargs["params"] + assert expected_params == actual_params + + +def test_delete_product_rest_unset_required_fields(): + transport = transports.ProductSearchRestTransport( + credentials=ga_credentials.AnonymousCredentials + ) + + unset_fields = transport.delete_product._get_unset_required_fields({}) + assert set(unset_fields) == (set(()) & set(("name",))) + + +@pytest.mark.parametrize("null_interceptor", [True, False]) +def test_delete_product_rest_interceptors(null_interceptor): + transport = transports.ProductSearchRestTransport( + credentials=ga_credentials.AnonymousCredentials(), + interceptor=None + if null_interceptor + else transports.ProductSearchRestInterceptor(), + ) + client = ProductSearchClient(transport=transport) + with mock.patch.object( + type(client.transport._session), "request" + ) as req, mock.patch.object( + path_template, "transcode" + ) as transcode, mock.patch.object( + transports.ProductSearchRestInterceptor, "pre_delete_product" + ) as pre: + pre.assert_not_called() + pb_message = product_search_service.DeleteProductRequest.pb( + product_search_service.DeleteProductRequest() + ) + transcode.return_value = { + "method": "post", + "uri": "my_uri", + "body": pb_message, + "query_params": pb_message, + } + + req.return_value = Response() + req.return_value.status_code = 200 + req.return_value.request = PreparedRequest() + + request = product_search_service.DeleteProductRequest() + metadata = [ + ("key", "val"), + ("cephalopod", "squid"), + ] + pre.return_value = request, metadata + + client.delete_product( + request, + metadata=[ + ("key", "val"), + ("cephalopod", "squid"), + ], + ) + + pre.assert_called_once() + + +def test_delete_product_rest_bad_request( + transport: str = "rest", request_type=product_search_service.DeleteProductRequest +): + client = ProductSearchClient( + credentials=ga_credentials.AnonymousCredentials(), + transport=transport, + ) + + # send a request that will satisfy transcoding + request_init = {"name": "projects/sample1/locations/sample2/products/sample3"} + request = request_type(**request_init) + + # Mock the http request call within the method and fake a BadRequest error. + with mock.patch.object(Session, "request") as req, pytest.raises( + core_exceptions.BadRequest + ): + # Wrap the value into a proper Response obj + response_value = Response() + response_value.status_code = 400 + response_value.request = Request() + req.return_value = response_value + client.delete_product(request) + + +def test_delete_product_rest_flattened(): + client = ProductSearchClient( + credentials=ga_credentials.AnonymousCredentials(), + transport="rest", + ) + + # Mock the http request call within the method and fake a response. + with mock.patch.object(type(client.transport._session), "request") as req: + # Designate an appropriate value for the returned response. + return_value = None + + # get arguments that satisfy an http rule for this method + sample_request = {"name": "projects/sample1/locations/sample2/products/sample3"} + + # get truthy value for each flattened field + mock_args = dict( + name="name_value", + ) + mock_args.update(sample_request) + + # Wrap the value into a proper Response obj + response_value = Response() + response_value.status_code = 200 + json_return_value = "" + response_value._content = json_return_value.encode("UTF-8") + req.return_value = response_value + + client.delete_product(**mock_args) + + # Establish that the underlying call was made with the expected + # request object values. + assert len(req.mock_calls) == 1 + _, args, _ = req.mock_calls[0] + assert path_template.validate( + "%s/v1p4beta1/{name=projects/*/locations/*/products/*}" + % client.transport._host, + args[1], + ) + + +def test_delete_product_rest_flattened_error(transport: str = "rest"): + client = ProductSearchClient( + credentials=ga_credentials.AnonymousCredentials(), + transport=transport, + ) + + # Attempting to call a method with both a request object and flattened + # fields is an error. + with pytest.raises(ValueError): + client.delete_product( + product_search_service.DeleteProductRequest(), + name="name_value", + ) + + +def test_delete_product_rest_error(): + client = ProductSearchClient( + credentials=ga_credentials.AnonymousCredentials(), transport="rest" + ) + + +@pytest.mark.parametrize( + "request_type", + [ + product_search_service.CreateReferenceImageRequest, + dict, + ], +) +def test_create_reference_image_rest(request_type): + client = ProductSearchClient( + credentials=ga_credentials.AnonymousCredentials(), + transport="rest", + ) + + # send a request that will satisfy transcoding + request_init = {"parent": "projects/sample1/locations/sample2/products/sample3"} + request_init["reference_image"] = { + "name": "name_value", + "uri": "uri_value", + "bounding_polys": [ + { + "vertices": [{"x": 120, "y": 121}], + "normalized_vertices": [{"x": 0.12, "y": 0.121}], + } + ], + } + request = request_type(**request_init) + + # Mock the http request call within the method and fake a response. + with mock.patch.object(type(client.transport._session), "request") as req: + # Designate an appropriate value for the returned response. + return_value = product_search_service.ReferenceImage( + name="name_value", + uri="uri_value", + ) + + # Wrap the value into a proper Response obj + response_value = Response() + response_value.status_code = 200 + pb_return_value = product_search_service.ReferenceImage.pb(return_value) + json_return_value = json_format.MessageToJson(pb_return_value) + + response_value._content = json_return_value.encode("UTF-8") + req.return_value = response_value + response = client.create_reference_image(request) + + # Establish that the response is the type that we expect. + assert isinstance(response, product_search_service.ReferenceImage) + assert response.name == "name_value" + assert response.uri == "uri_value" + + +def test_create_reference_image_rest_required_fields( + request_type=product_search_service.CreateReferenceImageRequest, +): + transport_class = transports.ProductSearchRestTransport + + request_init = {} + request_init["parent"] = "" + request = request_type(**request_init) + pb_request = request_type.pb(request) + jsonified_request = json.loads( + json_format.MessageToJson( + pb_request, + including_default_value_fields=False, + use_integers_for_enums=False, + ) + ) + + # verify fields with default values are dropped + + unset_fields = transport_class( + credentials=ga_credentials.AnonymousCredentials() + ).create_reference_image._get_unset_required_fields(jsonified_request) + jsonified_request.update(unset_fields) + + # verify required fields with default values are now present + + jsonified_request["parent"] = "parent_value" + + unset_fields = transport_class( + credentials=ga_credentials.AnonymousCredentials() + ).create_reference_image._get_unset_required_fields(jsonified_request) + # Check that path parameters and body parameters are not mixing in. + assert not set(unset_fields) - set(("reference_image_id",)) + jsonified_request.update(unset_fields) + + # verify required fields with non-default values are left alone + assert "parent" in jsonified_request + assert jsonified_request["parent"] == "parent_value" + + client = ProductSearchClient( + credentials=ga_credentials.AnonymousCredentials(), + transport="rest", + ) + request = request_type(**request_init) + + # Designate an appropriate value for the returned response. + return_value = product_search_service.ReferenceImage() + # Mock the http request call within the method and fake a response. + with mock.patch.object(Session, "request") as req: + # We need to mock transcode() because providing default values + # for required fields will fail the real version if the http_options + # expect actual values for those fields. + with mock.patch.object(path_template, "transcode") as transcode: + # A uri without fields and an empty body will force all the + # request fields to show up in the query_params. + pb_request = request_type.pb(request) + transcode_result = { + "uri": "v1/sample_method", + "method": "post", + "query_params": pb_request, + } + transcode_result["body"] = pb_request + transcode.return_value = transcode_result + + response_value = Response() + response_value.status_code = 200 + + pb_return_value = product_search_service.ReferenceImage.pb(return_value) + json_return_value = json_format.MessageToJson(pb_return_value) + + response_value._content = json_return_value.encode("UTF-8") + req.return_value = response_value + + response = client.create_reference_image(request) + + expected_params = [("$alt", "json;enum-encoding=int")] + actual_params = req.call_args.kwargs["params"] + assert expected_params == actual_params + + +def test_create_reference_image_rest_unset_required_fields(): + transport = transports.ProductSearchRestTransport( + credentials=ga_credentials.AnonymousCredentials + ) + + unset_fields = transport.create_reference_image._get_unset_required_fields({}) + assert set(unset_fields) == ( + set(("referenceImageId",)) + & set( + ( + "parent", + "referenceImage", + ) + ) + ) + + +@pytest.mark.parametrize("null_interceptor", [True, False]) +def test_create_reference_image_rest_interceptors(null_interceptor): + transport = transports.ProductSearchRestTransport( + credentials=ga_credentials.AnonymousCredentials(), + interceptor=None + if null_interceptor + else transports.ProductSearchRestInterceptor(), + ) + client = ProductSearchClient(transport=transport) + with mock.patch.object( + type(client.transport._session), "request" + ) as req, mock.patch.object( + path_template, "transcode" + ) as transcode, mock.patch.object( + transports.ProductSearchRestInterceptor, "post_create_reference_image" + ) as post, mock.patch.object( + transports.ProductSearchRestInterceptor, "pre_create_reference_image" + ) as pre: + pre.assert_not_called() + post.assert_not_called() + pb_message = product_search_service.CreateReferenceImageRequest.pb( + product_search_service.CreateReferenceImageRequest() + ) + transcode.return_value = { + "method": "post", + "uri": "my_uri", + "body": pb_message, + "query_params": pb_message, + } + + req.return_value = Response() + req.return_value.status_code = 200 + req.return_value.request = PreparedRequest() + req.return_value._content = product_search_service.ReferenceImage.to_json( + product_search_service.ReferenceImage() + ) + + request = product_search_service.CreateReferenceImageRequest() + metadata = [ + ("key", "val"), + ("cephalopod", "squid"), + ] + pre.return_value = request, metadata + post.return_value = product_search_service.ReferenceImage() + + client.create_reference_image( + request, + metadata=[ + ("key", "val"), + ("cephalopod", "squid"), + ], + ) + + pre.assert_called_once() + post.assert_called_once() + + +def test_create_reference_image_rest_bad_request( + transport: str = "rest", + request_type=product_search_service.CreateReferenceImageRequest, +): + client = ProductSearchClient( + credentials=ga_credentials.AnonymousCredentials(), + transport=transport, + ) + + # send a request that will satisfy transcoding + request_init = {"parent": "projects/sample1/locations/sample2/products/sample3"} + request_init["reference_image"] = { + "name": "name_value", + "uri": "uri_value", + "bounding_polys": [ + { + "vertices": [{"x": 120, "y": 121}], + "normalized_vertices": [{"x": 0.12, "y": 0.121}], + } + ], + } + request = request_type(**request_init) + + # Mock the http request call within the method and fake a BadRequest error. + with mock.patch.object(Session, "request") as req, pytest.raises( + core_exceptions.BadRequest + ): + # Wrap the value into a proper Response obj + response_value = Response() + response_value.status_code = 400 + response_value.request = Request() + req.return_value = response_value + client.create_reference_image(request) + + +def test_create_reference_image_rest_flattened(): + client = ProductSearchClient( + credentials=ga_credentials.AnonymousCredentials(), + transport="rest", + ) + + # Mock the http request call within the method and fake a response. + with mock.patch.object(type(client.transport._session), "request") as req: + # Designate an appropriate value for the returned response. + return_value = product_search_service.ReferenceImage() + + # get arguments that satisfy an http rule for this method + sample_request = { + "parent": "projects/sample1/locations/sample2/products/sample3" + } + + # get truthy value for each flattened field + mock_args = dict( + parent="parent_value", + reference_image=product_search_service.ReferenceImage(name="name_value"), + reference_image_id="reference_image_id_value", + ) + mock_args.update(sample_request) + + # Wrap the value into a proper Response obj + response_value = Response() + response_value.status_code = 200 + pb_return_value = product_search_service.ReferenceImage.pb(return_value) + json_return_value = json_format.MessageToJson(pb_return_value) + response_value._content = json_return_value.encode("UTF-8") + req.return_value = response_value + + client.create_reference_image(**mock_args) + + # Establish that the underlying call was made with the expected + # request object values. + assert len(req.mock_calls) == 1 + _, args, _ = req.mock_calls[0] + assert path_template.validate( + "%s/v1p4beta1/{parent=projects/*/locations/*/products/*}/referenceImages" + % client.transport._host, + args[1], + ) + + +def test_create_reference_image_rest_flattened_error(transport: str = "rest"): + client = ProductSearchClient( + credentials=ga_credentials.AnonymousCredentials(), + transport=transport, + ) + + # Attempting to call a method with both a request object and flattened + # fields is an error. + with pytest.raises(ValueError): + client.create_reference_image( + product_search_service.CreateReferenceImageRequest(), + parent="parent_value", + reference_image=product_search_service.ReferenceImage(name="name_value"), + reference_image_id="reference_image_id_value", + ) + + +def test_create_reference_image_rest_error(): + client = ProductSearchClient( + credentials=ga_credentials.AnonymousCredentials(), transport="rest" + ) + + +@pytest.mark.parametrize( + "request_type", + [ + product_search_service.DeleteReferenceImageRequest, + dict, + ], +) +def test_delete_reference_image_rest(request_type): + client = ProductSearchClient( + credentials=ga_credentials.AnonymousCredentials(), + transport="rest", + ) + + # send a request that will satisfy transcoding + request_init = { + "name": "projects/sample1/locations/sample2/products/sample3/referenceImages/sample4" + } + request = request_type(**request_init) + + # Mock the http request call within the method and fake a response. + with mock.patch.object(type(client.transport._session), "request") as req: + # Designate an appropriate value for the returned response. + return_value = None + + # Wrap the value into a proper Response obj + response_value = Response() + response_value.status_code = 200 + json_return_value = "" + + response_value._content = json_return_value.encode("UTF-8") + req.return_value = response_value + response = client.delete_reference_image(request) + + # Establish that the response is the type that we expect. + assert response is None + + +def test_delete_reference_image_rest_required_fields( + request_type=product_search_service.DeleteReferenceImageRequest, +): + transport_class = transports.ProductSearchRestTransport + + request_init = {} + request_init["name"] = "" + request = request_type(**request_init) + pb_request = request_type.pb(request) + jsonified_request = json.loads( + json_format.MessageToJson( + pb_request, + including_default_value_fields=False, + use_integers_for_enums=False, + ) + ) + + # verify fields with default values are dropped + + unset_fields = transport_class( + credentials=ga_credentials.AnonymousCredentials() + ).delete_reference_image._get_unset_required_fields(jsonified_request) + jsonified_request.update(unset_fields) + + # verify required fields with default values are now present + + jsonified_request["name"] = "name_value" + + unset_fields = transport_class( + credentials=ga_credentials.AnonymousCredentials() + ).delete_reference_image._get_unset_required_fields(jsonified_request) + jsonified_request.update(unset_fields) + + # verify required fields with non-default values are left alone + assert "name" in jsonified_request + assert jsonified_request["name"] == "name_value" + + client = ProductSearchClient( + credentials=ga_credentials.AnonymousCredentials(), + transport="rest", + ) + request = request_type(**request_init) + + # Designate an appropriate value for the returned response. + return_value = None + # Mock the http request call within the method and fake a response. + with mock.patch.object(Session, "request") as req: + # We need to mock transcode() because providing default values + # for required fields will fail the real version if the http_options + # expect actual values for those fields. + with mock.patch.object(path_template, "transcode") as transcode: + # A uri without fields and an empty body will force all the + # request fields to show up in the query_params. + pb_request = request_type.pb(request) + transcode_result = { + "uri": "v1/sample_method", + "method": "delete", + "query_params": pb_request, + } + transcode.return_value = transcode_result + + response_value = Response() + response_value.status_code = 200 + json_return_value = "" + + response_value._content = json_return_value.encode("UTF-8") + req.return_value = response_value + + response = client.delete_reference_image(request) + + expected_params = [("$alt", "json;enum-encoding=int")] + actual_params = req.call_args.kwargs["params"] + assert expected_params == actual_params + + +def test_delete_reference_image_rest_unset_required_fields(): + transport = transports.ProductSearchRestTransport( + credentials=ga_credentials.AnonymousCredentials + ) + + unset_fields = transport.delete_reference_image._get_unset_required_fields({}) + assert set(unset_fields) == (set(()) & set(("name",))) + + +@pytest.mark.parametrize("null_interceptor", [True, False]) +def test_delete_reference_image_rest_interceptors(null_interceptor): + transport = transports.ProductSearchRestTransport( + credentials=ga_credentials.AnonymousCredentials(), + interceptor=None + if null_interceptor + else transports.ProductSearchRestInterceptor(), + ) + client = ProductSearchClient(transport=transport) + with mock.patch.object( + type(client.transport._session), "request" + ) as req, mock.patch.object( + path_template, "transcode" + ) as transcode, mock.patch.object( + transports.ProductSearchRestInterceptor, "pre_delete_reference_image" + ) as pre: + pre.assert_not_called() + pb_message = product_search_service.DeleteReferenceImageRequest.pb( + product_search_service.DeleteReferenceImageRequest() + ) + transcode.return_value = { + "method": "post", + "uri": "my_uri", + "body": pb_message, + "query_params": pb_message, + } + + req.return_value = Response() + req.return_value.status_code = 200 + req.return_value.request = PreparedRequest() + + request = product_search_service.DeleteReferenceImageRequest() + metadata = [ + ("key", "val"), + ("cephalopod", "squid"), + ] + pre.return_value = request, metadata + + client.delete_reference_image( + request, + metadata=[ + ("key", "val"), + ("cephalopod", "squid"), + ], + ) + + pre.assert_called_once() + + +def test_delete_reference_image_rest_bad_request( + transport: str = "rest", + request_type=product_search_service.DeleteReferenceImageRequest, +): + client = ProductSearchClient( + credentials=ga_credentials.AnonymousCredentials(), + transport=transport, + ) + + # send a request that will satisfy transcoding + request_init = { + "name": "projects/sample1/locations/sample2/products/sample3/referenceImages/sample4" + } + request = request_type(**request_init) + + # Mock the http request call within the method and fake a BadRequest error. + with mock.patch.object(Session, "request") as req, pytest.raises( + core_exceptions.BadRequest + ): + # Wrap the value into a proper Response obj + response_value = Response() + response_value.status_code = 400 + response_value.request = Request() + req.return_value = response_value + client.delete_reference_image(request) + + +def test_delete_reference_image_rest_flattened(): + client = ProductSearchClient( + credentials=ga_credentials.AnonymousCredentials(), + transport="rest", + ) + + # Mock the http request call within the method and fake a response. + with mock.patch.object(type(client.transport._session), "request") as req: + # Designate an appropriate value for the returned response. + return_value = None + + # get arguments that satisfy an http rule for this method + sample_request = { + "name": "projects/sample1/locations/sample2/products/sample3/referenceImages/sample4" + } + + # get truthy value for each flattened field + mock_args = dict( + name="name_value", + ) + mock_args.update(sample_request) + + # Wrap the value into a proper Response obj + response_value = Response() + response_value.status_code = 200 + json_return_value = "" + response_value._content = json_return_value.encode("UTF-8") + req.return_value = response_value + + client.delete_reference_image(**mock_args) + + # Establish that the underlying call was made with the expected + # request object values. + assert len(req.mock_calls) == 1 + _, args, _ = req.mock_calls[0] + assert path_template.validate( + "%s/v1p4beta1/{name=projects/*/locations/*/products/*/referenceImages/*}" + % client.transport._host, + args[1], + ) + + +def test_delete_reference_image_rest_flattened_error(transport: str = "rest"): + client = ProductSearchClient( + credentials=ga_credentials.AnonymousCredentials(), + transport=transport, + ) + + # Attempting to call a method with both a request object and flattened + # fields is an error. + with pytest.raises(ValueError): + client.delete_reference_image( + product_search_service.DeleteReferenceImageRequest(), + name="name_value", + ) + + +def test_delete_reference_image_rest_error(): + client = ProductSearchClient( + credentials=ga_credentials.AnonymousCredentials(), transport="rest" + ) + + +@pytest.mark.parametrize( + "request_type", + [ + product_search_service.ListReferenceImagesRequest, + dict, + ], +) +def test_list_reference_images_rest(request_type): + client = ProductSearchClient( + credentials=ga_credentials.AnonymousCredentials(), + transport="rest", + ) + + # send a request that will satisfy transcoding + request_init = {"parent": "projects/sample1/locations/sample2/products/sample3"} + request = request_type(**request_init) + + # Mock the http request call within the method and fake a response. + with mock.patch.object(type(client.transport._session), "request") as req: + # Designate an appropriate value for the returned response. + return_value = product_search_service.ListReferenceImagesResponse( + page_size=951, + next_page_token="next_page_token_value", + ) + + # Wrap the value into a proper Response obj + response_value = Response() + response_value.status_code = 200 + pb_return_value = product_search_service.ListReferenceImagesResponse.pb( + return_value + ) + json_return_value = json_format.MessageToJson(pb_return_value) + + response_value._content = json_return_value.encode("UTF-8") + req.return_value = response_value + response = client.list_reference_images(request) + + # Establish that the response is the type that we expect. + assert isinstance(response, pagers.ListReferenceImagesPager) + assert response.page_size == 951 + assert response.next_page_token == "next_page_token_value" + + +def test_list_reference_images_rest_required_fields( + request_type=product_search_service.ListReferenceImagesRequest, +): + transport_class = transports.ProductSearchRestTransport + + request_init = {} + request_init["parent"] = "" + request = request_type(**request_init) + pb_request = request_type.pb(request) + jsonified_request = json.loads( + json_format.MessageToJson( + pb_request, + including_default_value_fields=False, + use_integers_for_enums=False, + ) + ) + + # verify fields with default values are dropped + + unset_fields = transport_class( + credentials=ga_credentials.AnonymousCredentials() + ).list_reference_images._get_unset_required_fields(jsonified_request) + jsonified_request.update(unset_fields) + + # verify required fields with default values are now present + + jsonified_request["parent"] = "parent_value" + + unset_fields = transport_class( + credentials=ga_credentials.AnonymousCredentials() + ).list_reference_images._get_unset_required_fields(jsonified_request) + # Check that path parameters and body parameters are not mixing in. + assert not set(unset_fields) - set( + ( + "page_size", + "page_token", + ) + ) + jsonified_request.update(unset_fields) + + # verify required fields with non-default values are left alone + assert "parent" in jsonified_request + assert jsonified_request["parent"] == "parent_value" + + client = ProductSearchClient( + credentials=ga_credentials.AnonymousCredentials(), + transport="rest", + ) + request = request_type(**request_init) + + # Designate an appropriate value for the returned response. + return_value = product_search_service.ListReferenceImagesResponse() + # Mock the http request call within the method and fake a response. + with mock.patch.object(Session, "request") as req: + # We need to mock transcode() because providing default values + # for required fields will fail the real version if the http_options + # expect actual values for those fields. + with mock.patch.object(path_template, "transcode") as transcode: + # A uri without fields and an empty body will force all the + # request fields to show up in the query_params. + pb_request = request_type.pb(request) + transcode_result = { + "uri": "v1/sample_method", + "method": "get", + "query_params": pb_request, + } + transcode.return_value = transcode_result + + response_value = Response() + response_value.status_code = 200 + + pb_return_value = product_search_service.ListReferenceImagesResponse.pb( + return_value + ) + json_return_value = json_format.MessageToJson(pb_return_value) + + response_value._content = json_return_value.encode("UTF-8") + req.return_value = response_value + + response = client.list_reference_images(request) + + expected_params = [("$alt", "json;enum-encoding=int")] + actual_params = req.call_args.kwargs["params"] + assert expected_params == actual_params + + +def test_list_reference_images_rest_unset_required_fields(): + transport = transports.ProductSearchRestTransport( + credentials=ga_credentials.AnonymousCredentials + ) + + unset_fields = transport.list_reference_images._get_unset_required_fields({}) + assert set(unset_fields) == ( + set( + ( + "pageSize", + "pageToken", + ) + ) + & set(("parent",)) + ) + + +@pytest.mark.parametrize("null_interceptor", [True, False]) +def test_list_reference_images_rest_interceptors(null_interceptor): + transport = transports.ProductSearchRestTransport( + credentials=ga_credentials.AnonymousCredentials(), + interceptor=None + if null_interceptor + else transports.ProductSearchRestInterceptor(), + ) + client = ProductSearchClient(transport=transport) + with mock.patch.object( + type(client.transport._session), "request" + ) as req, mock.patch.object( + path_template, "transcode" + ) as transcode, mock.patch.object( + transports.ProductSearchRestInterceptor, "post_list_reference_images" + ) as post, mock.patch.object( + transports.ProductSearchRestInterceptor, "pre_list_reference_images" + ) as pre: + pre.assert_not_called() + post.assert_not_called() + pb_message = product_search_service.ListReferenceImagesRequest.pb( + product_search_service.ListReferenceImagesRequest() + ) + transcode.return_value = { + "method": "post", + "uri": "my_uri", + "body": pb_message, + "query_params": pb_message, + } + + req.return_value = Response() + req.return_value.status_code = 200 + req.return_value.request = PreparedRequest() + req.return_value._content = ( + product_search_service.ListReferenceImagesResponse.to_json( + product_search_service.ListReferenceImagesResponse() + ) + ) + + request = product_search_service.ListReferenceImagesRequest() + metadata = [ + ("key", "val"), + ("cephalopod", "squid"), + ] + pre.return_value = request, metadata + post.return_value = product_search_service.ListReferenceImagesResponse() + + client.list_reference_images( + request, + metadata=[ + ("key", "val"), + ("cephalopod", "squid"), + ], + ) + + pre.assert_called_once() + post.assert_called_once() + + +def test_list_reference_images_rest_bad_request( + transport: str = "rest", + request_type=product_search_service.ListReferenceImagesRequest, +): + client = ProductSearchClient( + credentials=ga_credentials.AnonymousCredentials(), + transport=transport, + ) + + # send a request that will satisfy transcoding + request_init = {"parent": "projects/sample1/locations/sample2/products/sample3"} + request = request_type(**request_init) + + # Mock the http request call within the method and fake a BadRequest error. + with mock.patch.object(Session, "request") as req, pytest.raises( + core_exceptions.BadRequest + ): + # Wrap the value into a proper Response obj + response_value = Response() + response_value.status_code = 400 + response_value.request = Request() + req.return_value = response_value + client.list_reference_images(request) + + +def test_list_reference_images_rest_flattened(): + client = ProductSearchClient( + credentials=ga_credentials.AnonymousCredentials(), + transport="rest", + ) + + # Mock the http request call within the method and fake a response. + with mock.patch.object(type(client.transport._session), "request") as req: + # Designate an appropriate value for the returned response. + return_value = product_search_service.ListReferenceImagesResponse() + + # get arguments that satisfy an http rule for this method + sample_request = { + "parent": "projects/sample1/locations/sample2/products/sample3" + } + + # get truthy value for each flattened field + mock_args = dict( + parent="parent_value", + ) + mock_args.update(sample_request) + + # Wrap the value into a proper Response obj + response_value = Response() + response_value.status_code = 200 + pb_return_value = product_search_service.ListReferenceImagesResponse.pb( + return_value + ) + json_return_value = json_format.MessageToJson(pb_return_value) + response_value._content = json_return_value.encode("UTF-8") + req.return_value = response_value + + client.list_reference_images(**mock_args) + + # Establish that the underlying call was made with the expected + # request object values. + assert len(req.mock_calls) == 1 + _, args, _ = req.mock_calls[0] + assert path_template.validate( + "%s/v1p4beta1/{parent=projects/*/locations/*/products/*}/referenceImages" + % client.transport._host, + args[1], + ) + + +def test_list_reference_images_rest_flattened_error(transport: str = "rest"): + client = ProductSearchClient( + credentials=ga_credentials.AnonymousCredentials(), + transport=transport, + ) + + # Attempting to call a method with both a request object and flattened + # fields is an error. + with pytest.raises(ValueError): + client.list_reference_images( + product_search_service.ListReferenceImagesRequest(), + parent="parent_value", + ) + + +def test_list_reference_images_rest_pager(transport: str = "rest"): + client = ProductSearchClient( + credentials=ga_credentials.AnonymousCredentials(), + transport=transport, + ) + + # Mock the http request call within the method and fake a response. + with mock.patch.object(Session, "request") as req: + # TODO(kbandes): remove this mock unless there's a good reason for it. + # with mock.patch.object(path_template, 'transcode') as transcode: + # Set the response as a series of pages + response = ( + product_search_service.ListReferenceImagesResponse( + reference_images=[ + product_search_service.ReferenceImage(), + product_search_service.ReferenceImage(), + product_search_service.ReferenceImage(), + ], + next_page_token="abc", + ), + product_search_service.ListReferenceImagesResponse( + reference_images=[], + next_page_token="def", + ), + product_search_service.ListReferenceImagesResponse( + reference_images=[ + product_search_service.ReferenceImage(), + ], + next_page_token="ghi", + ), + product_search_service.ListReferenceImagesResponse( + reference_images=[ + product_search_service.ReferenceImage(), + product_search_service.ReferenceImage(), + ], + ), + ) + # Two responses for two calls + response = response + response + + # Wrap the values into proper Response objs + response = tuple( + product_search_service.ListReferenceImagesResponse.to_json(x) + for x in response + ) + return_values = tuple(Response() for i in response) + for return_val, response_val in zip(return_values, response): + return_val._content = response_val.encode("UTF-8") + return_val.status_code = 200 + req.side_effect = return_values + + sample_request = { + "parent": "projects/sample1/locations/sample2/products/sample3" + } + + pager = client.list_reference_images(request=sample_request) + + results = list(pager) + assert len(results) == 6 + assert all( + isinstance(i, product_search_service.ReferenceImage) for i in results + ) + + pages = list(client.list_reference_images(request=sample_request).pages) + for page_, token in zip(pages, ["abc", "def", "ghi", ""]): + assert page_.raw_page.next_page_token == token + + +@pytest.mark.parametrize( + "request_type", + [ + product_search_service.GetReferenceImageRequest, + dict, + ], +) +def test_get_reference_image_rest(request_type): + client = ProductSearchClient( + credentials=ga_credentials.AnonymousCredentials(), + transport="rest", + ) + + # send a request that will satisfy transcoding + request_init = { + "name": "projects/sample1/locations/sample2/products/sample3/referenceImages/sample4" + } + request = request_type(**request_init) + + # Mock the http request call within the method and fake a response. + with mock.patch.object(type(client.transport._session), "request") as req: + # Designate an appropriate value for the returned response. + return_value = product_search_service.ReferenceImage( + name="name_value", + uri="uri_value", + ) + + # Wrap the value into a proper Response obj + response_value = Response() + response_value.status_code = 200 + pb_return_value = product_search_service.ReferenceImage.pb(return_value) + json_return_value = json_format.MessageToJson(pb_return_value) + + response_value._content = json_return_value.encode("UTF-8") + req.return_value = response_value + response = client.get_reference_image(request) + + # Establish that the response is the type that we expect. + assert isinstance(response, product_search_service.ReferenceImage) + assert response.name == "name_value" + assert response.uri == "uri_value" + + +def test_get_reference_image_rest_required_fields( + request_type=product_search_service.GetReferenceImageRequest, +): + transport_class = transports.ProductSearchRestTransport + + request_init = {} + request_init["name"] = "" + request = request_type(**request_init) + pb_request = request_type.pb(request) + jsonified_request = json.loads( + json_format.MessageToJson( + pb_request, + including_default_value_fields=False, + use_integers_for_enums=False, + ) + ) + + # verify fields with default values are dropped + + unset_fields = transport_class( + credentials=ga_credentials.AnonymousCredentials() + ).get_reference_image._get_unset_required_fields(jsonified_request) + jsonified_request.update(unset_fields) + + # verify required fields with default values are now present + + jsonified_request["name"] = "name_value" + + unset_fields = transport_class( + credentials=ga_credentials.AnonymousCredentials() + ).get_reference_image._get_unset_required_fields(jsonified_request) + jsonified_request.update(unset_fields) + + # verify required fields with non-default values are left alone + assert "name" in jsonified_request + assert jsonified_request["name"] == "name_value" + + client = ProductSearchClient( + credentials=ga_credentials.AnonymousCredentials(), + transport="rest", + ) + request = request_type(**request_init) + + # Designate an appropriate value for the returned response. + return_value = product_search_service.ReferenceImage() + # Mock the http request call within the method and fake a response. + with mock.patch.object(Session, "request") as req: + # We need to mock transcode() because providing default values + # for required fields will fail the real version if the http_options + # expect actual values for those fields. + with mock.patch.object(path_template, "transcode") as transcode: + # A uri without fields and an empty body will force all the + # request fields to show up in the query_params. + pb_request = request_type.pb(request) + transcode_result = { + "uri": "v1/sample_method", + "method": "get", + "query_params": pb_request, + } + transcode.return_value = transcode_result + + response_value = Response() + response_value.status_code = 200 + + pb_return_value = product_search_service.ReferenceImage.pb(return_value) + json_return_value = json_format.MessageToJson(pb_return_value) + + response_value._content = json_return_value.encode("UTF-8") + req.return_value = response_value + + response = client.get_reference_image(request) + + expected_params = [("$alt", "json;enum-encoding=int")] + actual_params = req.call_args.kwargs["params"] + assert expected_params == actual_params + + +def test_get_reference_image_rest_unset_required_fields(): + transport = transports.ProductSearchRestTransport( + credentials=ga_credentials.AnonymousCredentials + ) + + unset_fields = transport.get_reference_image._get_unset_required_fields({}) + assert set(unset_fields) == (set(()) & set(("name",))) + + +@pytest.mark.parametrize("null_interceptor", [True, False]) +def test_get_reference_image_rest_interceptors(null_interceptor): + transport = transports.ProductSearchRestTransport( + credentials=ga_credentials.AnonymousCredentials(), + interceptor=None + if null_interceptor + else transports.ProductSearchRestInterceptor(), + ) + client = ProductSearchClient(transport=transport) + with mock.patch.object( + type(client.transport._session), "request" + ) as req, mock.patch.object( + path_template, "transcode" + ) as transcode, mock.patch.object( + transports.ProductSearchRestInterceptor, "post_get_reference_image" + ) as post, mock.patch.object( + transports.ProductSearchRestInterceptor, "pre_get_reference_image" + ) as pre: + pre.assert_not_called() + post.assert_not_called() + pb_message = product_search_service.GetReferenceImageRequest.pb( + product_search_service.GetReferenceImageRequest() + ) + transcode.return_value = { + "method": "post", + "uri": "my_uri", + "body": pb_message, + "query_params": pb_message, + } + + req.return_value = Response() + req.return_value.status_code = 200 + req.return_value.request = PreparedRequest() + req.return_value._content = product_search_service.ReferenceImage.to_json( + product_search_service.ReferenceImage() + ) + + request = product_search_service.GetReferenceImageRequest() + metadata = [ + ("key", "val"), + ("cephalopod", "squid"), + ] + pre.return_value = request, metadata + post.return_value = product_search_service.ReferenceImage() + + client.get_reference_image( + request, + metadata=[ + ("key", "val"), + ("cephalopod", "squid"), + ], + ) + + pre.assert_called_once() + post.assert_called_once() + + +def test_get_reference_image_rest_bad_request( + transport: str = "rest", + request_type=product_search_service.GetReferenceImageRequest, +): + client = ProductSearchClient( + credentials=ga_credentials.AnonymousCredentials(), + transport=transport, + ) + + # send a request that will satisfy transcoding + request_init = { + "name": "projects/sample1/locations/sample2/products/sample3/referenceImages/sample4" + } + request = request_type(**request_init) + + # Mock the http request call within the method and fake a BadRequest error. + with mock.patch.object(Session, "request") as req, pytest.raises( + core_exceptions.BadRequest + ): + # Wrap the value into a proper Response obj + response_value = Response() + response_value.status_code = 400 + response_value.request = Request() + req.return_value = response_value + client.get_reference_image(request) + + +def test_get_reference_image_rest_flattened(): + client = ProductSearchClient( + credentials=ga_credentials.AnonymousCredentials(), + transport="rest", + ) + + # Mock the http request call within the method and fake a response. + with mock.patch.object(type(client.transport._session), "request") as req: + # Designate an appropriate value for the returned response. + return_value = product_search_service.ReferenceImage() + + # get arguments that satisfy an http rule for this method + sample_request = { + "name": "projects/sample1/locations/sample2/products/sample3/referenceImages/sample4" + } + + # get truthy value for each flattened field + mock_args = dict( + name="name_value", + ) + mock_args.update(sample_request) + + # Wrap the value into a proper Response obj + response_value = Response() + response_value.status_code = 200 + pb_return_value = product_search_service.ReferenceImage.pb(return_value) + json_return_value = json_format.MessageToJson(pb_return_value) + response_value._content = json_return_value.encode("UTF-8") + req.return_value = response_value + + client.get_reference_image(**mock_args) + + # Establish that the underlying call was made with the expected + # request object values. + assert len(req.mock_calls) == 1 + _, args, _ = req.mock_calls[0] + assert path_template.validate( + "%s/v1p4beta1/{name=projects/*/locations/*/products/*/referenceImages/*}" + % client.transport._host, + args[1], + ) + + +def test_get_reference_image_rest_flattened_error(transport: str = "rest"): + client = ProductSearchClient( + credentials=ga_credentials.AnonymousCredentials(), + transport=transport, + ) + + # Attempting to call a method with both a request object and flattened + # fields is an error. + with pytest.raises(ValueError): + client.get_reference_image( + product_search_service.GetReferenceImageRequest(), + name="name_value", + ) + + +def test_get_reference_image_rest_error(): + client = ProductSearchClient( + credentials=ga_credentials.AnonymousCredentials(), transport="rest" + ) + + +@pytest.mark.parametrize( + "request_type", + [ + product_search_service.AddProductToProductSetRequest, + dict, + ], +) +def test_add_product_to_product_set_rest(request_type): + client = ProductSearchClient( + credentials=ga_credentials.AnonymousCredentials(), + transport="rest", + ) + + # send a request that will satisfy transcoding + request_init = {"name": "projects/sample1/locations/sample2/productSets/sample3"} + request = request_type(**request_init) + + # Mock the http request call within the method and fake a response. + with mock.patch.object(type(client.transport._session), "request") as req: + # Designate an appropriate value for the returned response. + return_value = None + + # Wrap the value into a proper Response obj + response_value = Response() + response_value.status_code = 200 + json_return_value = "" + + response_value._content = json_return_value.encode("UTF-8") + req.return_value = response_value + response = client.add_product_to_product_set(request) + + # Establish that the response is the type that we expect. + assert response is None + + +def test_add_product_to_product_set_rest_required_fields( + request_type=product_search_service.AddProductToProductSetRequest, +): + transport_class = transports.ProductSearchRestTransport + + request_init = {} + request_init["name"] = "" + request_init["product"] = "" + request = request_type(**request_init) + pb_request = request_type.pb(request) + jsonified_request = json.loads( + json_format.MessageToJson( + pb_request, + including_default_value_fields=False, + use_integers_for_enums=False, + ) + ) + + # verify fields with default values are dropped + + unset_fields = transport_class( + credentials=ga_credentials.AnonymousCredentials() + ).add_product_to_product_set._get_unset_required_fields(jsonified_request) + jsonified_request.update(unset_fields) + + # verify required fields with default values are now present + + jsonified_request["name"] = "name_value" + jsonified_request["product"] = "product_value" + + unset_fields = transport_class( + credentials=ga_credentials.AnonymousCredentials() + ).add_product_to_product_set._get_unset_required_fields(jsonified_request) + jsonified_request.update(unset_fields) + + # verify required fields with non-default values are left alone + assert "name" in jsonified_request + assert jsonified_request["name"] == "name_value" + assert "product" in jsonified_request + assert jsonified_request["product"] == "product_value" + + client = ProductSearchClient( + credentials=ga_credentials.AnonymousCredentials(), + transport="rest", + ) + request = request_type(**request_init) + + # Designate an appropriate value for the returned response. + return_value = None + # Mock the http request call within the method and fake a response. + with mock.patch.object(Session, "request") as req: + # We need to mock transcode() because providing default values + # for required fields will fail the real version if the http_options + # expect actual values for those fields. + with mock.patch.object(path_template, "transcode") as transcode: + # A uri without fields and an empty body will force all the + # request fields to show up in the query_params. + pb_request = request_type.pb(request) + transcode_result = { + "uri": "v1/sample_method", + "method": "post", + "query_params": pb_request, + } + transcode_result["body"] = pb_request + transcode.return_value = transcode_result + + response_value = Response() + response_value.status_code = 200 + json_return_value = "" + + response_value._content = json_return_value.encode("UTF-8") + req.return_value = response_value + + response = client.add_product_to_product_set(request) + + expected_params = [("$alt", "json;enum-encoding=int")] + actual_params = req.call_args.kwargs["params"] + assert expected_params == actual_params + + +def test_add_product_to_product_set_rest_unset_required_fields(): + transport = transports.ProductSearchRestTransport( + credentials=ga_credentials.AnonymousCredentials + ) + + unset_fields = transport.add_product_to_product_set._get_unset_required_fields({}) + assert set(unset_fields) == ( + set(()) + & set( + ( + "name", + "product", + ) + ) + ) + + +@pytest.mark.parametrize("null_interceptor", [True, False]) +def test_add_product_to_product_set_rest_interceptors(null_interceptor): + transport = transports.ProductSearchRestTransport( + credentials=ga_credentials.AnonymousCredentials(), + interceptor=None + if null_interceptor + else transports.ProductSearchRestInterceptor(), + ) + client = ProductSearchClient(transport=transport) + with mock.patch.object( + type(client.transport._session), "request" + ) as req, mock.patch.object( + path_template, "transcode" + ) as transcode, mock.patch.object( + transports.ProductSearchRestInterceptor, "pre_add_product_to_product_set" + ) as pre: + pre.assert_not_called() + pb_message = product_search_service.AddProductToProductSetRequest.pb( + product_search_service.AddProductToProductSetRequest() + ) + transcode.return_value = { + "method": "post", + "uri": "my_uri", + "body": pb_message, + "query_params": pb_message, + } + + req.return_value = Response() + req.return_value.status_code = 200 + req.return_value.request = PreparedRequest() + + request = product_search_service.AddProductToProductSetRequest() + metadata = [ + ("key", "val"), + ("cephalopod", "squid"), + ] + pre.return_value = request, metadata + + client.add_product_to_product_set( + request, + metadata=[ + ("key", "val"), + ("cephalopod", "squid"), + ], + ) + + pre.assert_called_once() + + +def test_add_product_to_product_set_rest_bad_request( + transport: str = "rest", + request_type=product_search_service.AddProductToProductSetRequest, +): + client = ProductSearchClient( + credentials=ga_credentials.AnonymousCredentials(), + transport=transport, + ) + + # send a request that will satisfy transcoding + request_init = {"name": "projects/sample1/locations/sample2/productSets/sample3"} + request = request_type(**request_init) + + # Mock the http request call within the method and fake a BadRequest error. + with mock.patch.object(Session, "request") as req, pytest.raises( + core_exceptions.BadRequest + ): + # Wrap the value into a proper Response obj + response_value = Response() + response_value.status_code = 400 + response_value.request = Request() + req.return_value = response_value + client.add_product_to_product_set(request) + + +def test_add_product_to_product_set_rest_flattened(): + client = ProductSearchClient( + credentials=ga_credentials.AnonymousCredentials(), + transport="rest", + ) + + # Mock the http request call within the method and fake a response. + with mock.patch.object(type(client.transport._session), "request") as req: + # Designate an appropriate value for the returned response. + return_value = None + + # get arguments that satisfy an http rule for this method + sample_request = { + "name": "projects/sample1/locations/sample2/productSets/sample3" + } + + # get truthy value for each flattened field + mock_args = dict( + name="name_value", + product="product_value", + ) + mock_args.update(sample_request) + + # Wrap the value into a proper Response obj + response_value = Response() + response_value.status_code = 200 + json_return_value = "" + response_value._content = json_return_value.encode("UTF-8") + req.return_value = response_value + + client.add_product_to_product_set(**mock_args) + + # Establish that the underlying call was made with the expected + # request object values. + assert len(req.mock_calls) == 1 + _, args, _ = req.mock_calls[0] + assert path_template.validate( + "%s/v1p4beta1/{name=projects/*/locations/*/productSets/*}:addProduct" + % client.transport._host, + args[1], + ) + + +def test_add_product_to_product_set_rest_flattened_error(transport: str = "rest"): + client = ProductSearchClient( + credentials=ga_credentials.AnonymousCredentials(), + transport=transport, + ) + + # Attempting to call a method with both a request object and flattened + # fields is an error. + with pytest.raises(ValueError): + client.add_product_to_product_set( + product_search_service.AddProductToProductSetRequest(), + name="name_value", + product="product_value", + ) + + +def test_add_product_to_product_set_rest_error(): + client = ProductSearchClient( + credentials=ga_credentials.AnonymousCredentials(), transport="rest" + ) + + +@pytest.mark.parametrize( + "request_type", + [ + product_search_service.RemoveProductFromProductSetRequest, + dict, + ], +) +def test_remove_product_from_product_set_rest(request_type): + client = ProductSearchClient( + credentials=ga_credentials.AnonymousCredentials(), + transport="rest", + ) + + # send a request that will satisfy transcoding + request_init = {"name": "projects/sample1/locations/sample2/productSets/sample3"} + request = request_type(**request_init) + + # Mock the http request call within the method and fake a response. + with mock.patch.object(type(client.transport._session), "request") as req: + # Designate an appropriate value for the returned response. + return_value = None + + # Wrap the value into a proper Response obj + response_value = Response() + response_value.status_code = 200 + json_return_value = "" + + response_value._content = json_return_value.encode("UTF-8") + req.return_value = response_value + response = client.remove_product_from_product_set(request) + + # Establish that the response is the type that we expect. + assert response is None + + +def test_remove_product_from_product_set_rest_required_fields( + request_type=product_search_service.RemoveProductFromProductSetRequest, +): + transport_class = transports.ProductSearchRestTransport + + request_init = {} + request_init["name"] = "" + request_init["product"] = "" + request = request_type(**request_init) + pb_request = request_type.pb(request) + jsonified_request = json.loads( + json_format.MessageToJson( + pb_request, + including_default_value_fields=False, + use_integers_for_enums=False, + ) + ) + + # verify fields with default values are dropped + + unset_fields = transport_class( + credentials=ga_credentials.AnonymousCredentials() + ).remove_product_from_product_set._get_unset_required_fields(jsonified_request) + jsonified_request.update(unset_fields) + + # verify required fields with default values are now present + + jsonified_request["name"] = "name_value" + jsonified_request["product"] = "product_value" + + unset_fields = transport_class( + credentials=ga_credentials.AnonymousCredentials() + ).remove_product_from_product_set._get_unset_required_fields(jsonified_request) + jsonified_request.update(unset_fields) + + # verify required fields with non-default values are left alone + assert "name" in jsonified_request + assert jsonified_request["name"] == "name_value" + assert "product" in jsonified_request + assert jsonified_request["product"] == "product_value" + + client = ProductSearchClient( + credentials=ga_credentials.AnonymousCredentials(), + transport="rest", + ) + request = request_type(**request_init) + + # Designate an appropriate value for the returned response. + return_value = None + # Mock the http request call within the method and fake a response. + with mock.patch.object(Session, "request") as req: + # We need to mock transcode() because providing default values + # for required fields will fail the real version if the http_options + # expect actual values for those fields. + with mock.patch.object(path_template, "transcode") as transcode: + # A uri without fields and an empty body will force all the + # request fields to show up in the query_params. + pb_request = request_type.pb(request) + transcode_result = { + "uri": "v1/sample_method", + "method": "post", + "query_params": pb_request, + } + transcode_result["body"] = pb_request + transcode.return_value = transcode_result + + response_value = Response() + response_value.status_code = 200 + json_return_value = "" + + response_value._content = json_return_value.encode("UTF-8") + req.return_value = response_value + + response = client.remove_product_from_product_set(request) + + expected_params = [("$alt", "json;enum-encoding=int")] + actual_params = req.call_args.kwargs["params"] + assert expected_params == actual_params + + +def test_remove_product_from_product_set_rest_unset_required_fields(): + transport = transports.ProductSearchRestTransport( + credentials=ga_credentials.AnonymousCredentials + ) + + unset_fields = transport.remove_product_from_product_set._get_unset_required_fields( + {} + ) + assert set(unset_fields) == ( + set(()) + & set( + ( + "name", + "product", + ) + ) + ) + + +@pytest.mark.parametrize("null_interceptor", [True, False]) +def test_remove_product_from_product_set_rest_interceptors(null_interceptor): + transport = transports.ProductSearchRestTransport( + credentials=ga_credentials.AnonymousCredentials(), + interceptor=None + if null_interceptor + else transports.ProductSearchRestInterceptor(), + ) + client = ProductSearchClient(transport=transport) + with mock.patch.object( + type(client.transport._session), "request" + ) as req, mock.patch.object( + path_template, "transcode" + ) as transcode, mock.patch.object( + transports.ProductSearchRestInterceptor, "pre_remove_product_from_product_set" + ) as pre: + pre.assert_not_called() + pb_message = product_search_service.RemoveProductFromProductSetRequest.pb( + product_search_service.RemoveProductFromProductSetRequest() + ) + transcode.return_value = { + "method": "post", + "uri": "my_uri", + "body": pb_message, + "query_params": pb_message, + } + + req.return_value = Response() + req.return_value.status_code = 200 + req.return_value.request = PreparedRequest() + + request = product_search_service.RemoveProductFromProductSetRequest() + metadata = [ + ("key", "val"), + ("cephalopod", "squid"), + ] + pre.return_value = request, metadata + + client.remove_product_from_product_set( + request, + metadata=[ + ("key", "val"), + ("cephalopod", "squid"), + ], + ) + + pre.assert_called_once() + + +def test_remove_product_from_product_set_rest_bad_request( + transport: str = "rest", + request_type=product_search_service.RemoveProductFromProductSetRequest, +): + client = ProductSearchClient( + credentials=ga_credentials.AnonymousCredentials(), + transport=transport, + ) + + # send a request that will satisfy transcoding + request_init = {"name": "projects/sample1/locations/sample2/productSets/sample3"} + request = request_type(**request_init) + + # Mock the http request call within the method and fake a BadRequest error. + with mock.patch.object(Session, "request") as req, pytest.raises( + core_exceptions.BadRequest + ): + # Wrap the value into a proper Response obj + response_value = Response() + response_value.status_code = 400 + response_value.request = Request() + req.return_value = response_value + client.remove_product_from_product_set(request) + + +def test_remove_product_from_product_set_rest_flattened(): + client = ProductSearchClient( + credentials=ga_credentials.AnonymousCredentials(), + transport="rest", + ) + + # Mock the http request call within the method and fake a response. + with mock.patch.object(type(client.transport._session), "request") as req: + # Designate an appropriate value for the returned response. + return_value = None + + # get arguments that satisfy an http rule for this method + sample_request = { + "name": "projects/sample1/locations/sample2/productSets/sample3" + } + + # get truthy value for each flattened field + mock_args = dict( + name="name_value", + product="product_value", + ) + mock_args.update(sample_request) + + # Wrap the value into a proper Response obj + response_value = Response() + response_value.status_code = 200 + json_return_value = "" + response_value._content = json_return_value.encode("UTF-8") + req.return_value = response_value + + client.remove_product_from_product_set(**mock_args) + + # Establish that the underlying call was made with the expected + # request object values. + assert len(req.mock_calls) == 1 + _, args, _ = req.mock_calls[0] + assert path_template.validate( + "%s/v1p4beta1/{name=projects/*/locations/*/productSets/*}:removeProduct" + % client.transport._host, + args[1], + ) + + +def test_remove_product_from_product_set_rest_flattened_error(transport: str = "rest"): + client = ProductSearchClient( + credentials=ga_credentials.AnonymousCredentials(), + transport=transport, + ) + + # Attempting to call a method with both a request object and flattened + # fields is an error. + with pytest.raises(ValueError): + client.remove_product_from_product_set( + product_search_service.RemoveProductFromProductSetRequest(), + name="name_value", + product="product_value", + ) + + +def test_remove_product_from_product_set_rest_error(): + client = ProductSearchClient( + credentials=ga_credentials.AnonymousCredentials(), transport="rest" + ) + + +@pytest.mark.parametrize( + "request_type", + [ + product_search_service.ListProductsInProductSetRequest, + dict, + ], +) +def test_list_products_in_product_set_rest(request_type): + client = ProductSearchClient( + credentials=ga_credentials.AnonymousCredentials(), + transport="rest", + ) + + # send a request that will satisfy transcoding + request_init = {"name": "projects/sample1/locations/sample2/productSets/sample3"} + request = request_type(**request_init) + + # Mock the http request call within the method and fake a response. + with mock.patch.object(type(client.transport._session), "request") as req: + # Designate an appropriate value for the returned response. + return_value = product_search_service.ListProductsInProductSetResponse( + next_page_token="next_page_token_value", + ) + + # Wrap the value into a proper Response obj + response_value = Response() + response_value.status_code = 200 + pb_return_value = product_search_service.ListProductsInProductSetResponse.pb( + return_value + ) + json_return_value = json_format.MessageToJson(pb_return_value) + + response_value._content = json_return_value.encode("UTF-8") + req.return_value = response_value + response = client.list_products_in_product_set(request) + + # Establish that the response is the type that we expect. + assert isinstance(response, pagers.ListProductsInProductSetPager) + assert response.next_page_token == "next_page_token_value" + + +def test_list_products_in_product_set_rest_required_fields( + request_type=product_search_service.ListProductsInProductSetRequest, +): + transport_class = transports.ProductSearchRestTransport + + request_init = {} + request_init["name"] = "" + request = request_type(**request_init) + pb_request = request_type.pb(request) + jsonified_request = json.loads( + json_format.MessageToJson( + pb_request, + including_default_value_fields=False, + use_integers_for_enums=False, + ) + ) + + # verify fields with default values are dropped + + unset_fields = transport_class( + credentials=ga_credentials.AnonymousCredentials() + ).list_products_in_product_set._get_unset_required_fields(jsonified_request) + jsonified_request.update(unset_fields) + + # verify required fields with default values are now present + + jsonified_request["name"] = "name_value" + + unset_fields = transport_class( + credentials=ga_credentials.AnonymousCredentials() + ).list_products_in_product_set._get_unset_required_fields(jsonified_request) + # Check that path parameters and body parameters are not mixing in. + assert not set(unset_fields) - set( + ( + "page_size", + "page_token", + ) + ) + jsonified_request.update(unset_fields) + + # verify required fields with non-default values are left alone + assert "name" in jsonified_request + assert jsonified_request["name"] == "name_value" + + client = ProductSearchClient( + credentials=ga_credentials.AnonymousCredentials(), + transport="rest", + ) + request = request_type(**request_init) + + # Designate an appropriate value for the returned response. + return_value = product_search_service.ListProductsInProductSetResponse() + # Mock the http request call within the method and fake a response. + with mock.patch.object(Session, "request") as req: + # We need to mock transcode() because providing default values + # for required fields will fail the real version if the http_options + # expect actual values for those fields. + with mock.patch.object(path_template, "transcode") as transcode: + # A uri without fields and an empty body will force all the + # request fields to show up in the query_params. + pb_request = request_type.pb(request) + transcode_result = { + "uri": "v1/sample_method", + "method": "get", + "query_params": pb_request, + } + transcode.return_value = transcode_result + + response_value = Response() + response_value.status_code = 200 + + pb_return_value = ( + product_search_service.ListProductsInProductSetResponse.pb(return_value) + ) + json_return_value = json_format.MessageToJson(pb_return_value) + + response_value._content = json_return_value.encode("UTF-8") + req.return_value = response_value + + response = client.list_products_in_product_set(request) + + expected_params = [("$alt", "json;enum-encoding=int")] + actual_params = req.call_args.kwargs["params"] + assert expected_params == actual_params + + +def test_list_products_in_product_set_rest_unset_required_fields(): + transport = transports.ProductSearchRestTransport( + credentials=ga_credentials.AnonymousCredentials + ) + + unset_fields = transport.list_products_in_product_set._get_unset_required_fields({}) + assert set(unset_fields) == ( + set( + ( + "pageSize", + "pageToken", + ) + ) + & set(("name",)) + ) + + +@pytest.mark.parametrize("null_interceptor", [True, False]) +def test_list_products_in_product_set_rest_interceptors(null_interceptor): + transport = transports.ProductSearchRestTransport( + credentials=ga_credentials.AnonymousCredentials(), + interceptor=None + if null_interceptor + else transports.ProductSearchRestInterceptor(), + ) + client = ProductSearchClient(transport=transport) + with mock.patch.object( + type(client.transport._session), "request" + ) as req, mock.patch.object( + path_template, "transcode" + ) as transcode, mock.patch.object( + transports.ProductSearchRestInterceptor, "post_list_products_in_product_set" + ) as post, mock.patch.object( + transports.ProductSearchRestInterceptor, "pre_list_products_in_product_set" + ) as pre: + pre.assert_not_called() + post.assert_not_called() + pb_message = product_search_service.ListProductsInProductSetRequest.pb( + product_search_service.ListProductsInProductSetRequest() + ) + transcode.return_value = { + "method": "post", + "uri": "my_uri", + "body": pb_message, + "query_params": pb_message, + } + + req.return_value = Response() + req.return_value.status_code = 200 + req.return_value.request = PreparedRequest() + req.return_value._content = ( + product_search_service.ListProductsInProductSetResponse.to_json( + product_search_service.ListProductsInProductSetResponse() + ) + ) + + request = product_search_service.ListProductsInProductSetRequest() + metadata = [ + ("key", "val"), + ("cephalopod", "squid"), + ] + pre.return_value = request, metadata + post.return_value = product_search_service.ListProductsInProductSetResponse() + + client.list_products_in_product_set( + request, + metadata=[ + ("key", "val"), + ("cephalopod", "squid"), + ], + ) + + pre.assert_called_once() + post.assert_called_once() + + +def test_list_products_in_product_set_rest_bad_request( + transport: str = "rest", + request_type=product_search_service.ListProductsInProductSetRequest, +): + client = ProductSearchClient( + credentials=ga_credentials.AnonymousCredentials(), + transport=transport, + ) + + # send a request that will satisfy transcoding + request_init = {"name": "projects/sample1/locations/sample2/productSets/sample3"} + request = request_type(**request_init) + + # Mock the http request call within the method and fake a BadRequest error. + with mock.patch.object(Session, "request") as req, pytest.raises( + core_exceptions.BadRequest + ): + # Wrap the value into a proper Response obj + response_value = Response() + response_value.status_code = 400 + response_value.request = Request() + req.return_value = response_value + client.list_products_in_product_set(request) + + +def test_list_products_in_product_set_rest_flattened(): + client = ProductSearchClient( + credentials=ga_credentials.AnonymousCredentials(), + transport="rest", + ) + + # Mock the http request call within the method and fake a response. + with mock.patch.object(type(client.transport._session), "request") as req: + # Designate an appropriate value for the returned response. + return_value = product_search_service.ListProductsInProductSetResponse() + + # get arguments that satisfy an http rule for this method + sample_request = { + "name": "projects/sample1/locations/sample2/productSets/sample3" + } + + # get truthy value for each flattened field + mock_args = dict( + name="name_value", + ) + mock_args.update(sample_request) + + # Wrap the value into a proper Response obj + response_value = Response() + response_value.status_code = 200 + pb_return_value = product_search_service.ListProductsInProductSetResponse.pb( + return_value + ) + json_return_value = json_format.MessageToJson(pb_return_value) + response_value._content = json_return_value.encode("UTF-8") + req.return_value = response_value + + client.list_products_in_product_set(**mock_args) + + # Establish that the underlying call was made with the expected + # request object values. + assert len(req.mock_calls) == 1 + _, args, _ = req.mock_calls[0] + assert path_template.validate( + "%s/v1p4beta1/{name=projects/*/locations/*/productSets/*}/products" + % client.transport._host, + args[1], + ) + + +def test_list_products_in_product_set_rest_flattened_error(transport: str = "rest"): + client = ProductSearchClient( + credentials=ga_credentials.AnonymousCredentials(), + transport=transport, + ) + + # Attempting to call a method with both a request object and flattened + # fields is an error. + with pytest.raises(ValueError): + client.list_products_in_product_set( + product_search_service.ListProductsInProductSetRequest(), + name="name_value", + ) + + +def test_list_products_in_product_set_rest_pager(transport: str = "rest"): + client = ProductSearchClient( + credentials=ga_credentials.AnonymousCredentials(), + transport=transport, + ) + + # Mock the http request call within the method and fake a response. + with mock.patch.object(Session, "request") as req: + # TODO(kbandes): remove this mock unless there's a good reason for it. + # with mock.patch.object(path_template, 'transcode') as transcode: + # Set the response as a series of pages + response = ( + product_search_service.ListProductsInProductSetResponse( + products=[ + product_search_service.Product(), + product_search_service.Product(), + product_search_service.Product(), + ], + next_page_token="abc", + ), + product_search_service.ListProductsInProductSetResponse( + products=[], + next_page_token="def", + ), + product_search_service.ListProductsInProductSetResponse( + products=[ + product_search_service.Product(), + ], + next_page_token="ghi", + ), + product_search_service.ListProductsInProductSetResponse( + products=[ + product_search_service.Product(), + product_search_service.Product(), + ], + ), + ) + # Two responses for two calls + response = response + response + + # Wrap the values into proper Response objs + response = tuple( + product_search_service.ListProductsInProductSetResponse.to_json(x) + for x in response + ) + return_values = tuple(Response() for i in response) + for return_val, response_val in zip(return_values, response): + return_val._content = response_val.encode("UTF-8") + return_val.status_code = 200 + req.side_effect = return_values + + sample_request = { + "name": "projects/sample1/locations/sample2/productSets/sample3" + } + + pager = client.list_products_in_product_set(request=sample_request) + + results = list(pager) + assert len(results) == 6 + assert all(isinstance(i, product_search_service.Product) for i in results) + + pages = list(client.list_products_in_product_set(request=sample_request).pages) + for page_, token in zip(pages, ["abc", "def", "ghi", ""]): + assert page_.raw_page.next_page_token == token + + +@pytest.mark.parametrize( + "request_type", + [ + product_search_service.ImportProductSetsRequest, + dict, + ], +) +def test_import_product_sets_rest(request_type): + client = ProductSearchClient( + credentials=ga_credentials.AnonymousCredentials(), + transport="rest", + ) + + # send a request that will satisfy transcoding + request_init = {"parent": "projects/sample1/locations/sample2"} + request = request_type(**request_init) + + # Mock the http request call within the method and fake a response. + with mock.patch.object(type(client.transport._session), "request") as req: + # Designate an appropriate value for the returned response. + return_value = operations_pb2.Operation(name="operations/spam") + + # Wrap the value into a proper Response obj + response_value = Response() + response_value.status_code = 200 + json_return_value = json_format.MessageToJson(return_value) + + response_value._content = json_return_value.encode("UTF-8") + req.return_value = response_value + response = client.import_product_sets(request) + + # Establish that the response is the type that we expect. + assert response.operation.name == "operations/spam" + + +def test_import_product_sets_rest_required_fields( + request_type=product_search_service.ImportProductSetsRequest, +): + transport_class = transports.ProductSearchRestTransport + + request_init = {} + request_init["parent"] = "" + request = request_type(**request_init) + pb_request = request_type.pb(request) + jsonified_request = json.loads( + json_format.MessageToJson( + pb_request, + including_default_value_fields=False, + use_integers_for_enums=False, + ) + ) + + # verify fields with default values are dropped + + unset_fields = transport_class( + credentials=ga_credentials.AnonymousCredentials() + ).import_product_sets._get_unset_required_fields(jsonified_request) + jsonified_request.update(unset_fields) + + # verify required fields with default values are now present + + jsonified_request["parent"] = "parent_value" + + unset_fields = transport_class( + credentials=ga_credentials.AnonymousCredentials() + ).import_product_sets._get_unset_required_fields(jsonified_request) + jsonified_request.update(unset_fields) + + # verify required fields with non-default values are left alone + assert "parent" in jsonified_request + assert jsonified_request["parent"] == "parent_value" + + client = ProductSearchClient( + credentials=ga_credentials.AnonymousCredentials(), + transport="rest", + ) + request = request_type(**request_init) + + # Designate an appropriate value for the returned response. + return_value = operations_pb2.Operation(name="operations/spam") + # Mock the http request call within the method and fake a response. + with mock.patch.object(Session, "request") as req: + # We need to mock transcode() because providing default values + # for required fields will fail the real version if the http_options + # expect actual values for those fields. + with mock.patch.object(path_template, "transcode") as transcode: + # A uri without fields and an empty body will force all the + # request fields to show up in the query_params. + pb_request = request_type.pb(request) + transcode_result = { + "uri": "v1/sample_method", + "method": "post", + "query_params": pb_request, + } + transcode_result["body"] = pb_request + transcode.return_value = transcode_result + + response_value = Response() + response_value.status_code = 200 + json_return_value = json_format.MessageToJson(return_value) + + response_value._content = json_return_value.encode("UTF-8") + req.return_value = response_value + + response = client.import_product_sets(request) + + expected_params = [("$alt", "json;enum-encoding=int")] + actual_params = req.call_args.kwargs["params"] + assert expected_params == actual_params + + +def test_import_product_sets_rest_unset_required_fields(): + transport = transports.ProductSearchRestTransport( + credentials=ga_credentials.AnonymousCredentials + ) + + unset_fields = transport.import_product_sets._get_unset_required_fields({}) + assert set(unset_fields) == ( + set(()) + & set( + ( + "parent", + "inputConfig", + ) + ) + ) + + +@pytest.mark.parametrize("null_interceptor", [True, False]) +def test_import_product_sets_rest_interceptors(null_interceptor): + transport = transports.ProductSearchRestTransport( + credentials=ga_credentials.AnonymousCredentials(), + interceptor=None + if null_interceptor + else transports.ProductSearchRestInterceptor(), + ) + client = ProductSearchClient(transport=transport) + with mock.patch.object( + type(client.transport._session), "request" + ) as req, mock.patch.object( + path_template, "transcode" + ) as transcode, mock.patch.object( + operation.Operation, "_set_result_from_operation" + ), mock.patch.object( + transports.ProductSearchRestInterceptor, "post_import_product_sets" + ) as post, mock.patch.object( + transports.ProductSearchRestInterceptor, "pre_import_product_sets" + ) as pre: + pre.assert_not_called() + post.assert_not_called() + pb_message = product_search_service.ImportProductSetsRequest.pb( + product_search_service.ImportProductSetsRequest() + ) + transcode.return_value = { + "method": "post", + "uri": "my_uri", + "body": pb_message, + "query_params": pb_message, + } + + req.return_value = Response() + req.return_value.status_code = 200 + req.return_value.request = PreparedRequest() + req.return_value._content = json_format.MessageToJson( + operations_pb2.Operation() + ) + + request = product_search_service.ImportProductSetsRequest() + metadata = [ + ("key", "val"), + ("cephalopod", "squid"), + ] + pre.return_value = request, metadata + post.return_value = operations_pb2.Operation() + + client.import_product_sets( + request, + metadata=[ + ("key", "val"), + ("cephalopod", "squid"), + ], + ) + + pre.assert_called_once() + post.assert_called_once() + + +def test_import_product_sets_rest_bad_request( + transport: str = "rest", + request_type=product_search_service.ImportProductSetsRequest, +): + client = ProductSearchClient( + credentials=ga_credentials.AnonymousCredentials(), + transport=transport, + ) + + # send a request that will satisfy transcoding + request_init = {"parent": "projects/sample1/locations/sample2"} + request = request_type(**request_init) + + # Mock the http request call within the method and fake a BadRequest error. + with mock.patch.object(Session, "request") as req, pytest.raises( + core_exceptions.BadRequest + ): + # Wrap the value into a proper Response obj + response_value = Response() + response_value.status_code = 400 + response_value.request = Request() + req.return_value = response_value + client.import_product_sets(request) + + +def test_import_product_sets_rest_flattened(): + client = ProductSearchClient( + credentials=ga_credentials.AnonymousCredentials(), + transport="rest", + ) + + # Mock the http request call within the method and fake a response. + with mock.patch.object(type(client.transport._session), "request") as req: + # Designate an appropriate value for the returned response. + return_value = operations_pb2.Operation(name="operations/spam") + + # get arguments that satisfy an http rule for this method + sample_request = {"parent": "projects/sample1/locations/sample2"} + + # get truthy value for each flattened field + mock_args = dict( + parent="parent_value", + input_config=product_search_service.ImportProductSetsInputConfig( + gcs_source=product_search_service.ImportProductSetsGcsSource( + csv_file_uri="csv_file_uri_value" + ) + ), + ) + mock_args.update(sample_request) + + # Wrap the value into a proper Response obj + response_value = Response() + response_value.status_code = 200 + json_return_value = json_format.MessageToJson(return_value) + response_value._content = json_return_value.encode("UTF-8") + req.return_value = response_value + + client.import_product_sets(**mock_args) + + # Establish that the underlying call was made with the expected + # request object values. + assert len(req.mock_calls) == 1 + _, args, _ = req.mock_calls[0] + assert path_template.validate( + "%s/v1p4beta1/{parent=projects/*/locations/*}/productSets:import" + % client.transport._host, + args[1], + ) + + +def test_import_product_sets_rest_flattened_error(transport: str = "rest"): + client = ProductSearchClient( + credentials=ga_credentials.AnonymousCredentials(), + transport=transport, + ) + + # Attempting to call a method with both a request object and flattened + # fields is an error. + with pytest.raises(ValueError): + client.import_product_sets( + product_search_service.ImportProductSetsRequest(), + parent="parent_value", + input_config=product_search_service.ImportProductSetsInputConfig( + gcs_source=product_search_service.ImportProductSetsGcsSource( + csv_file_uri="csv_file_uri_value" + ) + ), + ) + + +def test_import_product_sets_rest_error(): + client = ProductSearchClient( + credentials=ga_credentials.AnonymousCredentials(), transport="rest" + ) + + +@pytest.mark.parametrize( + "request_type", + [ + product_search_service.PurgeProductsRequest, + dict, + ], +) +def test_purge_products_rest(request_type): + client = ProductSearchClient( + credentials=ga_credentials.AnonymousCredentials(), + transport="rest", + ) + + # send a request that will satisfy transcoding + request_init = {"parent": "projects/sample1/locations/sample2"} + request = request_type(**request_init) + + # Mock the http request call within the method and fake a response. + with mock.patch.object(type(client.transport._session), "request") as req: + # Designate an appropriate value for the returned response. + return_value = operations_pb2.Operation(name="operations/spam") + + # Wrap the value into a proper Response obj + response_value = Response() + response_value.status_code = 200 + json_return_value = json_format.MessageToJson(return_value) + + response_value._content = json_return_value.encode("UTF-8") + req.return_value = response_value + response = client.purge_products(request) + + # Establish that the response is the type that we expect. + assert response.operation.name == "operations/spam" + + +def test_purge_products_rest_required_fields( + request_type=product_search_service.PurgeProductsRequest, +): + transport_class = transports.ProductSearchRestTransport + + request_init = {} + request_init["parent"] = "" + request = request_type(**request_init) + pb_request = request_type.pb(request) + jsonified_request = json.loads( + json_format.MessageToJson( + pb_request, + including_default_value_fields=False, + use_integers_for_enums=False, + ) + ) + + # verify fields with default values are dropped + + unset_fields = transport_class( + credentials=ga_credentials.AnonymousCredentials() + ).purge_products._get_unset_required_fields(jsonified_request) + jsonified_request.update(unset_fields) + + # verify required fields with default values are now present + + jsonified_request["parent"] = "parent_value" + + unset_fields = transport_class( + credentials=ga_credentials.AnonymousCredentials() + ).purge_products._get_unset_required_fields(jsonified_request) + jsonified_request.update(unset_fields) + + # verify required fields with non-default values are left alone + assert "parent" in jsonified_request + assert jsonified_request["parent"] == "parent_value" + + client = ProductSearchClient( + credentials=ga_credentials.AnonymousCredentials(), + transport="rest", + ) + request = request_type(**request_init) + + # Designate an appropriate value for the returned response. + return_value = operations_pb2.Operation(name="operations/spam") + # Mock the http request call within the method and fake a response. + with mock.patch.object(Session, "request") as req: + # We need to mock transcode() because providing default values + # for required fields will fail the real version if the http_options + # expect actual values for those fields. + with mock.patch.object(path_template, "transcode") as transcode: + # A uri without fields and an empty body will force all the + # request fields to show up in the query_params. + pb_request = request_type.pb(request) + transcode_result = { + "uri": "v1/sample_method", + "method": "post", + "query_params": pb_request, + } + transcode_result["body"] = pb_request + transcode.return_value = transcode_result + + response_value = Response() + response_value.status_code = 200 + json_return_value = json_format.MessageToJson(return_value) + + response_value._content = json_return_value.encode("UTF-8") + req.return_value = response_value + + response = client.purge_products(request) + + expected_params = [("$alt", "json;enum-encoding=int")] + actual_params = req.call_args.kwargs["params"] + assert expected_params == actual_params + + +def test_purge_products_rest_unset_required_fields(): + transport = transports.ProductSearchRestTransport( + credentials=ga_credentials.AnonymousCredentials + ) + + unset_fields = transport.purge_products._get_unset_required_fields({}) + assert set(unset_fields) == (set(()) & set(("parent",))) + + +@pytest.mark.parametrize("null_interceptor", [True, False]) +def test_purge_products_rest_interceptors(null_interceptor): + transport = transports.ProductSearchRestTransport( + credentials=ga_credentials.AnonymousCredentials(), + interceptor=None + if null_interceptor + else transports.ProductSearchRestInterceptor(), + ) + client = ProductSearchClient(transport=transport) + with mock.patch.object( + type(client.transport._session), "request" + ) as req, mock.patch.object( + path_template, "transcode" + ) as transcode, mock.patch.object( + operation.Operation, "_set_result_from_operation" + ), mock.patch.object( + transports.ProductSearchRestInterceptor, "post_purge_products" + ) as post, mock.patch.object( + transports.ProductSearchRestInterceptor, "pre_purge_products" + ) as pre: + pre.assert_not_called() + post.assert_not_called() + pb_message = product_search_service.PurgeProductsRequest.pb( + product_search_service.PurgeProductsRequest() + ) + transcode.return_value = { + "method": "post", + "uri": "my_uri", + "body": pb_message, + "query_params": pb_message, + } + + req.return_value = Response() + req.return_value.status_code = 200 + req.return_value.request = PreparedRequest() + req.return_value._content = json_format.MessageToJson( + operations_pb2.Operation() + ) + + request = product_search_service.PurgeProductsRequest() + metadata = [ + ("key", "val"), + ("cephalopod", "squid"), + ] + pre.return_value = request, metadata + post.return_value = operations_pb2.Operation() + + client.purge_products( + request, + metadata=[ + ("key", "val"), + ("cephalopod", "squid"), + ], + ) + + pre.assert_called_once() + post.assert_called_once() + + +def test_purge_products_rest_bad_request( + transport: str = "rest", request_type=product_search_service.PurgeProductsRequest +): + client = ProductSearchClient( + credentials=ga_credentials.AnonymousCredentials(), + transport=transport, + ) + + # send a request that will satisfy transcoding + request_init = {"parent": "projects/sample1/locations/sample2"} + request = request_type(**request_init) + + # Mock the http request call within the method and fake a BadRequest error. + with mock.patch.object(Session, "request") as req, pytest.raises( + core_exceptions.BadRequest + ): + # Wrap the value into a proper Response obj + response_value = Response() + response_value.status_code = 400 + response_value.request = Request() + req.return_value = response_value + client.purge_products(request) + + +def test_purge_products_rest_flattened(): + client = ProductSearchClient( + credentials=ga_credentials.AnonymousCredentials(), + transport="rest", + ) + + # Mock the http request call within the method and fake a response. + with mock.patch.object(type(client.transport._session), "request") as req: + # Designate an appropriate value for the returned response. + return_value = operations_pb2.Operation(name="operations/spam") + + # get arguments that satisfy an http rule for this method + sample_request = {"parent": "projects/sample1/locations/sample2"} + + # get truthy value for each flattened field + mock_args = dict( + parent="parent_value", + ) + mock_args.update(sample_request) + + # Wrap the value into a proper Response obj + response_value = Response() + response_value.status_code = 200 + json_return_value = json_format.MessageToJson(return_value) + response_value._content = json_return_value.encode("UTF-8") + req.return_value = response_value + + client.purge_products(**mock_args) + + # Establish that the underlying call was made with the expected + # request object values. + assert len(req.mock_calls) == 1 + _, args, _ = req.mock_calls[0] + assert path_template.validate( + "%s/v1p4beta1/{parent=projects/*/locations/*}/products:purge" + % client.transport._host, + args[1], + ) + + +def test_purge_products_rest_flattened_error(transport: str = "rest"): + client = ProductSearchClient( + credentials=ga_credentials.AnonymousCredentials(), + transport=transport, + ) + + # Attempting to call a method with both a request object and flattened + # fields is an error. + with pytest.raises(ValueError): + client.purge_products( + product_search_service.PurgeProductsRequest(), + parent="parent_value", + ) + + +def test_purge_products_rest_error(): + client = ProductSearchClient( + credentials=ga_credentials.AnonymousCredentials(), transport="rest" + ) + + +def test_credentials_transport_error(): + # It is an error to provide credentials and a transport instance. + transport = transports.ProductSearchGrpcTransport( + credentials=ga_credentials.AnonymousCredentials(), + ) + with pytest.raises(ValueError): + client = ProductSearchClient( + credentials=ga_credentials.AnonymousCredentials(), + transport=transport, + ) + + # It is an error to provide a credentials file and a transport instance. + transport = transports.ProductSearchGrpcTransport( + credentials=ga_credentials.AnonymousCredentials(), + ) + with pytest.raises(ValueError): + client = ProductSearchClient( + client_options={"credentials_file": "credentials.json"}, + transport=transport, + ) + + # It is an error to provide an api_key and a transport instance. + transport = transports.ProductSearchGrpcTransport( + credentials=ga_credentials.AnonymousCredentials(), + ) + options = client_options.ClientOptions() + options.api_key = "api_key" + with pytest.raises(ValueError): + client = ProductSearchClient( + client_options=options, + transport=transport, + ) + + # It is an error to provide an api_key and a credential. + options = mock.Mock() + options.api_key = "api_key" + with pytest.raises(ValueError): + client = ProductSearchClient( + client_options=options, credentials=ga_credentials.AnonymousCredentials() + ) + + # It is an error to provide scopes and a transport instance. + transport = transports.ProductSearchGrpcTransport( + credentials=ga_credentials.AnonymousCredentials(), + ) + with pytest.raises(ValueError): + client = ProductSearchClient( + client_options={"scopes": ["1", "2"]}, + transport=transport, + ) + + +def test_transport_instance(): + # A client may be instantiated with a custom transport instance. + transport = transports.ProductSearchGrpcTransport( + credentials=ga_credentials.AnonymousCredentials(), + ) + client = ProductSearchClient(transport=transport) + assert client.transport is transport + + +def test_transport_get_channel(): + # A client may be instantiated with a custom transport instance. + transport = transports.ProductSearchGrpcTransport( + credentials=ga_credentials.AnonymousCredentials(), + ) + channel = transport.grpc_channel + assert channel + + transport = transports.ProductSearchGrpcAsyncIOTransport( + credentials=ga_credentials.AnonymousCredentials(), + ) + channel = transport.grpc_channel + assert channel + + +@pytest.mark.parametrize( + "transport_class", + [ + transports.ProductSearchGrpcTransport, + transports.ProductSearchGrpcAsyncIOTransport, + transports.ProductSearchRestTransport, + ], +) +def test_transport_adc(transport_class): + # Test default credentials are used if not provided. + with mock.patch.object(google.auth, "default") as adc: + adc.return_value = (ga_credentials.AnonymousCredentials(), None) + transport_class() + adc.assert_called_once() + + +@pytest.mark.parametrize( + "transport_name", + [ + "grpc", + "rest", + ], +) +def test_transport_kind(transport_name): + transport = ProductSearchClient.get_transport_class(transport_name)( + credentials=ga_credentials.AnonymousCredentials(), + ) + assert transport.kind == transport_name + + +def test_transport_grpc_default(): + # A client should use the gRPC transport by default. + client = ProductSearchClient( + credentials=ga_credentials.AnonymousCredentials(), + ) + assert isinstance( + client.transport, + transports.ProductSearchGrpcTransport, + ) + + +def test_product_search_base_transport_error(): + # Passing both a credentials object and credentials_file should raise an error + with pytest.raises(core_exceptions.DuplicateCredentialArgs): + transport = transports.ProductSearchTransport( + credentials=ga_credentials.AnonymousCredentials(), + credentials_file="credentials.json", + ) + + +def test_product_search_base_transport(): + # Instantiate the base transport. + with mock.patch( + "google.cloud.vision_v1p4beta1.services.product_search.transports.ProductSearchTransport.__init__" + ) as Transport: + Transport.return_value = None + transport = transports.ProductSearchTransport( + credentials=ga_credentials.AnonymousCredentials(), + ) + + # Every method on the transport should just blindly + # raise NotImplementedError. + methods = ( + "create_product_set", + "list_product_sets", + "get_product_set", + "update_product_set", + "delete_product_set", + "create_product", + "list_products", + "get_product", + "update_product", + "delete_product", + "create_reference_image", + "delete_reference_image", + "list_reference_images", + "get_reference_image", + "add_product_to_product_set", + "remove_product_from_product_set", + "list_products_in_product_set", + "import_product_sets", + "purge_products", + ) + for method in methods: + 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): + transport.operations_client + + # Catch all for all remaining methods and properties + remainder = [ + "kind", + ] + for r in remainder: + with pytest.raises(NotImplementedError): + getattr(transport, r)() + + +def test_product_search_base_transport_with_credentials_file(): + # 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.vision_v1p4beta1.services.product_search.transports.ProductSearchTransport._prep_wrapped_messages" + ) as Transport: + Transport.return_value = None + load_creds.return_value = (ga_credentials.AnonymousCredentials(), None) + transport = transports.ProductSearchTransport( + credentials_file="credentials.json", + quota_project_id="octopus", + ) + load_creds.assert_called_once_with( + "credentials.json", + scopes=None, + default_scopes=( + "https://www.googleapis.com/auth/cloud-platform", + "https://www.googleapis.com/auth/cloud-vision", + ), + quota_project_id="octopus", + ) + + +def test_product_search_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( "google.cloud.vision_v1p4beta1.services.product_search.transports.ProductSearchTransport._prep_wrapped_messages" ) as Transport: @@ -6449,6 +12091,7 @@ def test_product_search_transport_auth_adc(transport_class): [ transports.ProductSearchGrpcTransport, transports.ProductSearchGrpcAsyncIOTransport, + transports.ProductSearchRestTransport, ], ) def test_product_search_transport_auth_gdch_credentials(transport_class): @@ -6549,11 +12192,40 @@ def test_product_search_grpc_transport_client_cert_source_for_mtls(transport_cla ) +def test_product_search_http_transport_client_cert_source_for_mtls(): + cred = ga_credentials.AnonymousCredentials() + with mock.patch( + "google.auth.transport.requests.AuthorizedSession.configure_mtls_channel" + ) as mock_configure_mtls_channel: + transports.ProductSearchRestTransport( + credentials=cred, client_cert_source_for_mtls=client_cert_source_callback + ) + mock_configure_mtls_channel.assert_called_once_with(client_cert_source_callback) + + +def test_product_search_rest_lro_client(): + client = ProductSearchClient( + credentials=ga_credentials.AnonymousCredentials(), + transport="rest", + ) + transport = client.transport + + # Ensure that we have a api-core operations client. + assert isinstance( + transport.operations_client, + operations_v1.AbstractOperationsClient, + ) + + # Ensure that subsequent calls to the property send the exact same object. + assert transport.operations_client is transport.operations_client + + @pytest.mark.parametrize( "transport_name", [ "grpc", "grpc_asyncio", + "rest", ], ) def test_product_search_host_no_port(transport_name): @@ -6564,7 +12236,11 @@ def test_product_search_host_no_port(transport_name): ), transport=transport_name, ) - assert client.transport._host == ("vision.googleapis.com:443") + assert client.transport._host == ( + "vision.googleapis.com:443" + if transport_name in ["grpc", "grpc_asyncio"] + else "https://vision.googleapis.com/" + ) @pytest.mark.parametrize( @@ -6572,6 +12248,7 @@ def test_product_search_host_no_port(transport_name): [ "grpc", "grpc_asyncio", + "rest", ], ) def test_product_search_host_with_port(transport_name): @@ -6582,7 +12259,87 @@ def test_product_search_host_with_port(transport_name): ), transport=transport_name, ) - assert client.transport._host == ("vision.googleapis.com:8000") + assert client.transport._host == ( + "vision.googleapis.com:8000" + if transport_name in ["grpc", "grpc_asyncio"] + else "https://vision.googleapis.com:8000/" + ) + + +@pytest.mark.parametrize( + "transport_name", + [ + "rest", + ], +) +def test_product_search_client_transport_session_collision(transport_name): + creds1 = ga_credentials.AnonymousCredentials() + creds2 = ga_credentials.AnonymousCredentials() + client1 = ProductSearchClient( + credentials=creds1, + transport=transport_name, + ) + client2 = ProductSearchClient( + credentials=creds2, + transport=transport_name, + ) + session1 = client1.transport.create_product_set._session + session2 = client2.transport.create_product_set._session + assert session1 != session2 + session1 = client1.transport.list_product_sets._session + session2 = client2.transport.list_product_sets._session + assert session1 != session2 + session1 = client1.transport.get_product_set._session + session2 = client2.transport.get_product_set._session + assert session1 != session2 + session1 = client1.transport.update_product_set._session + session2 = client2.transport.update_product_set._session + assert session1 != session2 + session1 = client1.transport.delete_product_set._session + session2 = client2.transport.delete_product_set._session + assert session1 != session2 + session1 = client1.transport.create_product._session + session2 = client2.transport.create_product._session + assert session1 != session2 + session1 = client1.transport.list_products._session + session2 = client2.transport.list_products._session + assert session1 != session2 + session1 = client1.transport.get_product._session + session2 = client2.transport.get_product._session + assert session1 != session2 + session1 = client1.transport.update_product._session + session2 = client2.transport.update_product._session + assert session1 != session2 + session1 = client1.transport.delete_product._session + session2 = client2.transport.delete_product._session + assert session1 != session2 + session1 = client1.transport.create_reference_image._session + session2 = client2.transport.create_reference_image._session + assert session1 != session2 + session1 = client1.transport.delete_reference_image._session + session2 = client2.transport.delete_reference_image._session + assert session1 != session2 + session1 = client1.transport.list_reference_images._session + session2 = client2.transport.list_reference_images._session + assert session1 != session2 + session1 = client1.transport.get_reference_image._session + session2 = client2.transport.get_reference_image._session + assert session1 != session2 + session1 = client1.transport.add_product_to_product_set._session + session2 = client2.transport.add_product_to_product_set._session + assert session1 != session2 + session1 = client1.transport.remove_product_from_product_set._session + session2 = client2.transport.remove_product_from_product_set._session + assert session1 != session2 + session1 = client1.transport.list_products_in_product_set._session + session2 = client2.transport.list_products_in_product_set._session + assert session1 != session2 + session1 = client1.transport.import_product_sets._session + session2 = client2.transport.import_product_sets._session + assert session1 != session2 + session1 = client1.transport.purge_products._session + session2 = client2.transport.purge_products._session + assert session1 != session2 def test_product_search_grpc_transport_channel(): @@ -6970,6 +12727,7 @@ async def test_transport_close_async(): def test_transport_close(): transports = { + "rest": "_session", "grpc": "_grpc_channel", } @@ -6987,6 +12745,7 @@ def test_transport_close(): def test_client_ctx(): transports = [ + "rest", "grpc", ] for transport in transports: