async def test_async_batch_annotate_files_async( transport: str = "grpc_asyncio"): client = ImageAnnotatorAsyncClient( 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 = image_annotator.AsyncBatchAnnotateFilesRequest() # Mock the actual call within the gRPC stub, and fake the request. with mock.patch.object( type(client._client._transport.async_batch_annotate_files), "__call__") as call: # Designate an appropriate return value for the call. call.return_value = grpc_helpers_async.FakeUnaryUnaryCall( operations_pb2.Operation(name="operations/spam")) response = await client.async_batch_annotate_files(request) # Establish that the underlying gRPC stub method was called. assert len(call.mock_calls) _, args, _ = call.mock_calls[0] assert args[0] == request # Establish that the response is the type that we expect. assert isinstance(response, future.Future)
async def test_async_batch_annotate_files_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.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_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=credentials.AnonymousCredentials(), transport="grpc", ) # Mock the actual call within the gRPC stub, and fake the request. with mock.patch.object(type(client.transport.async_batch_annotate_files), "__call__") as call: client.async_batch_annotate_files() call.assert_called() _, args, _ = call.mock_calls[0] assert args[0] == image_annotator.AsyncBatchAnnotateFilesRequest()
async def async_batch_annotate_files( self, request: image_annotator.AsyncBatchAnnotateFilesRequest = None, *, requests: Sequence[image_annotator.AsyncAnnotateFileRequest] = None, retry: retries.Retry = gapic_v1.method.DEFAULT, timeout: float = None, metadata: Sequence[Tuple[str, str]] = (), ) -> operation_async.AsyncOperation: r"""Run async image detection and annotation for a list of generic files (e.g. PDF) which may contain multiple pages and multiple images per page. Progress and results can be retrieved through the ``google.longrunning.Operations`` interface. ``Operation.metadata`` contains ``OperationMetadata`` (metadata). ``Operation.response`` contains ``AsyncBatchAnnotateFilesResponse`` (results). Args: request (:class:`~.image_annotator.AsyncBatchAnnotateFilesRequest`): The request object. Multiple async file annotation requests are batched into a single service call. requests (:class:`Sequence[~.image_annotator.AsyncAnnotateFileRequest]`): Required. Individual async file 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: ~.operation_async.AsyncOperation: An object representing a long-running operation. The result type for the operation will be :class:``~.image_annotator.AsyncBatchAnnotateFilesResponse``: Response to an async batch file 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.AsyncBatchAnnotateFilesRequest(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.async_batch_annotate_files, 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, ) # Wrap the response in an operation future. response = operation_async.from_gapic( response, self._client._transport.operations_client, image_annotator.AsyncBatchAnnotateFilesResponse, metadata_type=image_annotator.OperationMetadata, ) # Done; return the response. return response
def async_batch_annotate_files( self, request: Union[image_annotator.AsyncBatchAnnotateFilesRequest, dict] = None, *, requests: Sequence[ image_annotator.AsyncAnnotateFileRequest] = None, retry: OptionalRetry = gapic_v1.method.DEFAULT, timeout: float = None, metadata: Sequence[Tuple[str, str]] = (), ) -> operation.Operation: r"""Run async image detection and annotation for a list of generic files (e.g. PDF) which may contain multiple pages and multiple images per page. Progress and results can be retrieved through the ``google.longrunning.Operations`` interface. ``Operation.metadata`` contains ``OperationMetadata`` (metadata). ``Operation.response`` contains ``AsyncBatchAnnotateFilesResponse`` (results). Args: request (Union[google.cloud.vision_v1p2beta1.types.AsyncBatchAnnotateFilesRequest, dict]): The request object. Multiple async file annotation requests are batched into a single service call. requests (Sequence[google.cloud.vision_v1p2beta1.types.AsyncAnnotateFileRequest]): Required. Individual async file 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.api_core.operation.Operation: An object representing a long-running operation. The result type for the operation will be :class:`google.cloud.vision_v1p2beta1.types.AsyncBatchAnnotateFilesResponse` Response to an async batch file 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.AsyncBatchAnnotateFilesRequest. # There's no risk of modifying the input as we've already verified # there are no flattened fields. if not isinstance(request, image_annotator.AsyncBatchAnnotateFilesRequest): request = image_annotator.AsyncBatchAnnotateFilesRequest(request) if requests is not None: for i in range(len(requests)): requests[i] = image_annotator.AsyncAnnotateFileRequest( 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.async_batch_annotate_files] # Send the request. response = rpc( request, retry=retry, timeout=timeout, metadata=metadata, ) # Wrap the response in an operation future. response = operation.from_gapic( response, self._transport.operations_client, image_annotator.AsyncBatchAnnotateFilesResponse, metadata_type=image_annotator.OperationMetadata, ) # Done; return the response. return response