async def test_list_voices_async(transport: str = "grpc_asyncio",
request_type=cloud_tts.ListVoicesRequest):
client = TextToSpeechAsyncClient(
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.list_voices),
"__call__") as call:
# Designate an appropriate return value for the call.
call.return_value = grpc_helpers_async.FakeUnaryUnaryCall(
cloud_tts.ListVoicesResponse())
response = await client.list_voices(request)
# Establish that the underlying gRPC stub method was called.
assert len(call.mock_calls)
_, args, _ = call.mock_calls[0]
assert args[0] == cloud_tts.ListVoicesRequest()
# Establish that the response is the type that we expect.
assert isinstance(response, cloud_tts.ListVoicesResponse)
def test_list_voices_flattened_error():
client = TextToSpeechClient(credentials=credentials.AnonymousCredentials())
# Attempting to call a method with both a request object and flattened
# fields is an error.
with pytest.raises(ValueError):
client.list_voices(cloud_tts.ListVoicesRequest(),
language_code="language_code_value")
def test_list_voices_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 = TextToSpeechClient(
credentials=credentials.AnonymousCredentials(),
transport="grpc",
)
# Mock the actual call within the gRPC stub, and fake the request.
with mock.patch.object(type(client.transport.list_voices),
"__call__") as call:
client.list_voices()
call.assert_called()
_, args, _ = call.mock_calls[0]
assert args[0] == cloud_tts.ListVoicesRequest()
async def list_voices(
self,
request: cloud_tts.ListVoicesRequest = None,
*,
language_code: str = None,
retry: retries.Retry = gapic_v1.method.DEFAULT,
timeout: float = None,
metadata: Sequence[Tuple[str, str]] = (),
) -> cloud_tts.ListVoicesResponse:
r"""Returns a list of Voice supported for synthesis.
Args:
request (:class:`~.cloud_tts.ListVoicesRequest`):
The request object. The top-level message sent by the
client for the `ListVoices` method.
language_code (:class:`str`):
Optional. Recommended.
`BCP-47 <https://www.rfc-editor.org/rfc/bcp/bcp47.txt>`__
language tag. If specified, the ListVoices call will
only return voices that can be used to synthesize this
language_code. E.g. when specifying "en-NZ", you will
get supported "en-\*" voices; when specifying "no", you
will get supported "no-\*" (Norwegian) and "nb-\*"
(Norwegian Bokmal) voices; specifying "zh" will also get
supported "cmn-\*" voices; specifying "zh-hk" will also
get supported "yue-\*" voices.
This corresponds to the ``language_code`` 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:
~.cloud_tts.ListVoicesResponse:
The message returned to the client by the ``ListVoices``
method.
"""
# 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([language_code]):
raise ValueError("If the `request` argument is set, then none of "
"the individual field arguments should be set.")
request = cloud_tts.ListVoicesRequest(request)
# If we have keyword arguments corresponding to fields on the
# request, apply these.
if language_code is not None:
request.language_code = language_code
# Wrap the RPC method; this adds retry and timeout information,
# and friendly error handling.
rpc = gapic_v1.method_async.wrap_method(
self._client._transport.list_voices,
default_timeout=None,
client_info=_client_info,
)
# Send the request.
response = await rpc(
request,
retry=retry,
timeout=timeout,
metadata=metadata,
)
# Done; return the response.
return response
def list_voices(
self,
request: cloud_tts.ListVoicesRequest = None,
*,
language_code: str = None,
retry: retries.Retry = gapic_v1.method.DEFAULT,
timeout: float = None,
metadata: Sequence[Tuple[str, str]] = (),
) -> cloud_tts.ListVoicesResponse:
r"""Returns a list of Voice supported for synthesis.
Args:
request (google.cloud.texttospeech_v1beta1.types.ListVoicesRequest):
The request object. The top-level message sent by the
client for the `ListVoices` method.
language_code (str):
Optional. Recommended.
`BCP-47 <https://www.rfc-editor.org/rfc/bcp/bcp47.txt>`__
language tag. If not specified, the API will return all
supported voices. If specified, the ListVoices call will
only return voices that can be used to synthesize this
language_code. E.g. when specifying "en-NZ", you will
get supported "en-NZ" voices; when specifying "no", you
will get supported "no-\*" (Norwegian) and "nb-\*"
(Norwegian Bokmal) voices; specifying "zh" will also get
supported "cmn-\*" voices; specifying "zh-hk" will also
get supported "yue-hk" voices.
This corresponds to the ``language_code`` 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.texttospeech_v1beta1.types.ListVoicesResponse:
The message returned to the client by the ListVoices
method.
"""
# 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([language_code])
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 cloud_tts.ListVoicesRequest.
# There's no risk of modifying the input as we've already verified
# there are no flattened fields.
if not isinstance(request, cloud_tts.ListVoicesRequest):
request = cloud_tts.ListVoicesRequest(request)
# If we have keyword arguments corresponding to fields on the
# request, apply these.
if language_code is not None:
request.language_code = language_code
# Wrap the RPC method; this adds retry and timeout information,
# and friendly error handling.
rpc = self._transport._wrapped_methods[self._transport.list_voices]
# Send the request.
response = rpc(request, retry=retry, timeout=timeout, metadata=metadata,)
# Done; return the response.
return response
