def test_batch_annotate_images( transport: str = "grpc", request_type=image_annotator.BatchAnnotateImagesRequest): client = ImageAnnotatorClient( credentials=credentials.AnonymousCredentials(), transport=transport, ) # Everything is optional in proto3 as far as the runtime is concerned, # and we are mocking out the actual API, so just send an empty request. request = request_type() # Mock the actual call within the gRPC stub, and fake the request. with mock.patch.object(type(client._transport.batch_annotate_images), "__call__") as call: # Designate an appropriate return value for the call. call.return_value = image_annotator.BatchAnnotateImagesResponse() response = client.batch_annotate_images(request) # Establish that the underlying gRPC stub method was called. assert len(call.mock_calls) == 1 _, args, _ = call.mock_calls[0] assert args[0] == image_annotator.BatchAnnotateImagesRequest() # Establish that the response is the type that we expect. assert isinstance(response, image_annotator.BatchAnnotateImagesResponse)
async def test_batch_annotate_images_flattened_error_async(): client = ImageAnnotatorAsyncClient( credentials=credentials.AnonymousCredentials(), ) # Attempting to call a method with both a request object and flattened # fields is an error. with pytest.raises(ValueError): await client.batch_annotate_images( image_annotator.BatchAnnotateImagesRequest(), requests=[ image_annotator.AnnotateImageRequest( image=image_annotator.Image(content=b"content_blob")) ], )
def test_batch_annotate_images_empty_call(): # This test is a coverage failsafe to make sure that totally empty calls, # i.e. request == None and no flattened fields passed, work. client = ImageAnnotatorClient( credentials=ga_credentials.AnonymousCredentials(), transport="grpc", ) # Mock the actual call within the gRPC stub, and fake the request. with mock.patch.object(type(client.transport.batch_annotate_images), "__call__") as call: client.batch_annotate_images() call.assert_called() _, args, _ = call.mock_calls[0] assert args[0] == image_annotator.BatchAnnotateImagesRequest()
def batch_annotate_images( self, request: Union[image_annotator.BatchAnnotateImagesRequest, dict] = None, *, requests: Sequence[image_annotator.AnnotateImageRequest] = None, retry: OptionalRetry = gapic_v1.method.DEFAULT, timeout: float = None, metadata: Sequence[Tuple[str, str]] = (), ) -> image_annotator.BatchAnnotateImagesResponse: r"""Run image detection and annotation for a batch of images. Args: request (Union[google.cloud.vision_v1p1beta1.types.BatchAnnotateImagesRequest, dict]): The request object. Multiple image annotation requests are batched into a single service call. requests (Sequence[google.cloud.vision_v1p1beta1.types.AnnotateImageRequest]): Required. Individual image annotation requests for this batch. This corresponds to the ``requests`` field on the ``request`` instance; if ``request`` is provided, this should not be set. 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: google.cloud.vision_v1p1beta1.types.BatchAnnotateImagesResponse: Response to a batch image annotation request. """ # Create or coerce a protobuf request object. # Sanity check: If we got a request object, we should *not* have # gotten any keyword arguments that map to the request. has_flattened_params = any([requests]) if request is not None and has_flattened_params: raise ValueError("If the `request` argument is set, then none of " "the individual field arguments should be set.") # Minor optimization to avoid making a copy if the user passes # in a image_annotator.BatchAnnotateImagesRequest. # There's no risk of modifying the input as we've already verified # there are no flattened fields. if not isinstance(request, image_annotator.BatchAnnotateImagesRequest): request = image_annotator.BatchAnnotateImagesRequest(request) if requests is not None: for i in range(len(requests)): requests[i] = image_annotator.AnnotateImageRequest( requests[i]) # If we have keyword arguments corresponding to fields on the # request, apply these. if requests is not None: request.requests = requests # Wrap the RPC method; this adds retry and timeout information, # and friendly error handling. rpc = self._transport._wrapped_methods[ self._transport.batch_annotate_images] # Send the request. response = rpc( request, retry=retry, timeout=timeout, metadata=metadata, ) # Done; return the response. return response
async def batch_annotate_images( self, request: Union[image_annotator.BatchAnnotateImagesRequest, dict] = None, *, requests: Sequence[image_annotator.AnnotateImageRequest] = None, retry: OptionalRetry = gapic_v1.method.DEFAULT, timeout: float = None, metadata: Sequence[Tuple[str, str]] = (), ) -> image_annotator.BatchAnnotateImagesResponse: r"""Run image detection and annotation for a batch of images. .. code-block:: python from google.cloud import vision_v1p1beta1 async def sample_batch_annotate_images(): # Create a client client = vision_v1p1beta1.ImageAnnotatorAsyncClient() # Initialize request argument(s) request = vision_v1p1beta1.BatchAnnotateImagesRequest( ) # Make the request response = await client.batch_annotate_images(request=request) # Handle the response print(response) Args: request (Union[google.cloud.vision_v1p1beta1.types.BatchAnnotateImagesRequest, dict]): The request object. Multiple image annotation requests are batched into a single service call. requests (:class:`Sequence[google.cloud.vision_v1p1beta1.types.AnnotateImageRequest]`): Required. Individual image annotation requests for this batch. This corresponds to the ``requests`` field on the ``request`` instance; if ``request`` is provided, this should not be set. 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: google.cloud.vision_v1p1beta1.types.BatchAnnotateImagesResponse: Response to a batch image annotation request. """ # Create or coerce a protobuf request object. # Quick check: If we got a request object, we should *not* have # gotten any keyword arguments that map to the request. has_flattened_params = any([requests]) if request is not None and has_flattened_params: raise ValueError("If the `request` argument is set, then none of " "the individual field arguments should be set.") request = image_annotator.BatchAnnotateImagesRequest(request) # If we have keyword arguments corresponding to fields on the # request, apply these. if requests: request.requests.extend(requests) # Wrap the RPC method; this adds retry and timeout information, # and friendly error handling. rpc = gapic_v1.method_async.wrap_method( self._client._transport.batch_annotate_images, default_retry=retries.Retry( initial=0.1, maximum=60.0, multiplier=1.3, predicate=retries.if_exception_type( core_exceptions.DeadlineExceeded, core_exceptions.ServiceUnavailable, ), deadline=600.0, ), default_timeout=600.0, client_info=DEFAULT_CLIENT_INFO, ) # Send the request. response = await rpc( request, retry=retry, timeout=timeout, metadata=metadata, ) # Done; return the response. return response
async def batch_annotate_images( self, request: image_annotator.BatchAnnotateImagesRequest = None, *, requests: Sequence[image_annotator.AnnotateImageRequest] = None, retry: retries.Retry = gapic_v1.method.DEFAULT, timeout: float = None, metadata: Sequence[Tuple[str, str]] = (), ) -> image_annotator.BatchAnnotateImagesResponse: r"""Run image detection and annotation for a batch of images. Args: request (:class:`~.image_annotator.BatchAnnotateImagesRequest`): The request object. Multiple image annotation requests are batched into a single service call. requests (:class:`Sequence[~.image_annotator.AnnotateImageRequest]`): Required. Individual image annotation requests for this batch. This corresponds to the ``requests`` field on the ``request`` instance; if ``request`` is provided, this should not be set. 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. """ # Create or coerce a protobuf request object. # Sanity check: If we got a request object, we should *not* have # gotten any keyword arguments that map to the request. if request is not None and any([requests]): raise ValueError( "If the `request` argument is set, then none of " "the individual field arguments should be set." ) request = image_annotator.BatchAnnotateImagesRequest(request) # If we have keyword arguments corresponding to fields on the # request, apply these. if requests is not None: request.requests = requests # Wrap the RPC method; this adds retry and timeout information, # and friendly error handling. rpc = gapic_v1.method_async.wrap_method( self._client._transport.batch_annotate_images, default_retry=retries.Retry( initial=0.1, maximum=60.0, multiplier=1.3, predicate=retries.if_exception_type( exceptions.ServiceUnavailable, exceptions.DeadlineExceeded, ), ), default_timeout=600.0, client_info=DEFAULT_CLIENT_INFO, ) # Send the request. response = await rpc(request, retry=retry, timeout=timeout, metadata=metadata,) # Done; return the response. return response