Skip to content

Texttospeech: fix client_info bug, update docstrings. #6423

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
tseaver merged 1 commit into from
Nov 6, 2018
Merged

Texttospeech: fix client_info bug, update docstrings. #6423

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 2 additions & 2 deletions texttospeech/google/cloud/texttospeech_v1/gapic/enums.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -20,8 +20,8 @@

class SsmlVoiceGender(enum.IntEnum):
"""
Gender of the voice as described in
`SSML voice element <https://www.w3.org/TR/speech-synthesis11/#edef_voice>`_.
Gender of the voice as described in `SSML voice
element <https://www.w3.org/TR/speech-synthesis11/#edef_voice>`__.

Attributes:
SSML_VOICE_GENDER_UNSPECIFIED (int): An unspecified gender.
Expand Down
33 changes: 18 additions & 15 deletions texttospeech/google/cloud/texttospeech_v1/gapic/text_to_speech_client.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -135,9 +135,10 @@ def __init__(self,
)

if client_info is None:
client_info = (
google.api_core.gapic_v1.client_info.DEFAULT_CLIENT_INFO)
client_info.gapic_version = _GAPIC_LIBRARY_VERSION
client_info = google.api_core.gapic_v1.client_info.ClientInfo(
gapic_version=_GAPIC_LIBRARY_VERSION, )
else:
client_info.gapic_version = _GAPIC_LIBRARY_VERSION
self._client_info = client_info

# Parse out the default settings for retry and timeout for each RPC
Expand All @@ -160,8 +161,7 @@ def list_voices(self,
timeout=google.api_core.gapic_v1.method.DEFAULT,
metadata=None):
"""
Returns a list of ``Voice``
supported for synthesis.
Returns a list of ``Voice`` supported for synthesis.

Example:
>>> from google.cloud import texttospeech_v1
Expand All @@ -172,13 +172,13 @@ def list_voices(self,

Args:
language_code (str): Optional (but 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.
`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.
retry (Optional[google.api_core.retry.Retry]): A retry object used
to retry requests. If ``None`` is specified, requests will not
be retried.
Expand Down Expand Up @@ -229,25 +229,28 @@ def synthesize_speech(self,
>>>
>>> client = texttospeech_v1.TextToSpeechClient()
>>>
>>> # TODO: Initialize ``input_``:
>>> # TODO: Initialize `input_`:
>>> input_ = {}
>>>
>>> # TODO: Initialize ``voice``:
>>> # TODO: Initialize `voice`:
>>> voice = {}
>>>
>>> # TODO: Initialize ``audio_config``:
>>> # TODO: Initialize `audio_config`:
>>> audio_config = {}
>>>
>>> response = client.synthesize_speech(input_, voice, audio_config)

Args:
input_ (Union[dict, ~google.cloud.texttospeech_v1.types.SynthesisInput]): Required. The Synthesizer requires either plain text or SSML as input.

If a dict is provided, it must be of the same form as the protobuf
message :class:`~google.cloud.texttospeech_v1.types.SynthesisInput`
voice (Union[dict, ~google.cloud.texttospeech_v1.types.VoiceSelectionParams]): Required. The desired voice of the synthesized audio.

If a dict is provided, it must be of the same form as the protobuf
message :class:`~google.cloud.texttospeech_v1.types.VoiceSelectionParams`
audio_config (Union[dict, ~google.cloud.texttospeech_v1.types.AudioConfig]): Required. The configuration of the synthesized audio.

If a dict is provided, it must be of the same form as the protobuf
message :class:`~google.cloud.texttospeech_v1.types.AudioConfig`
retry (Optional[google.api_core.retry.Retry]): A retry object used
Expand Down
3 changes: 1 addition & 2 deletions texttospeech/google/cloud/texttospeech_v1/gapic/transports/text_to_speech_grpc_transport.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -96,8 +96,7 @@ def create_channel(cls,
def list_voices(self):
"""Return the gRPC stub for {$apiMethod.name}.

Returns a list of ``Voice``
supported for synthesis.
Returns a list of ``Voice`` supported for synthesis.

Returns:
Callable: A callable which accepts the appropriate
Expand Down
4 changes: 2 additions & 2 deletions texttospeech/google/cloud/texttospeech_v1beta1/gapic/enums.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -20,8 +20,8 @@

class SsmlVoiceGender(enum.IntEnum):
"""
Gender of the voice as described in
`SSML voice element <https://www.w3.org/TR/speech-synthesis11/#edef_voice>`_.
Gender of the voice as described in `SSML voice
element <https://www.w3.org/TR/speech-synthesis11/#edef_voice>`__.

Attributes:
SSML_VOICE_GENDER_UNSPECIFIED (int): An unspecified gender.
Expand Down
33 changes: 18 additions & 15 deletions texttospeech/google/cloud/texttospeech_v1beta1/gapic/text_to_speech_client.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -135,9 +135,10 @@ def __init__(self,
)

if client_info is None:
client_info = (
google.api_core.gapic_v1.client_info.DEFAULT_CLIENT_INFO)
client_info.gapic_version = _GAPIC_LIBRARY_VERSION
client_info = google.api_core.gapic_v1.client_info.ClientInfo(
gapic_version=_GAPIC_LIBRARY_VERSION, )
else:
client_info.gapic_version = _GAPIC_LIBRARY_VERSION
self._client_info = client_info

# Parse out the default settings for retry and timeout for each RPC
Expand All @@ -160,8 +161,7 @@ def list_voices(self,
timeout=google.api_core.gapic_v1.method.DEFAULT,
metadata=None):
"""
Returns a list of ``Voice``
supported for synthesis.
Returns a list of ``Voice`` supported for synthesis.

Example:
>>> from google.cloud import texttospeech_v1beta1
Expand All @@ -172,13 +172,13 @@ def list_voices(self,

Args:
language_code (str): Optional (but 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.
`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.
retry (Optional[google.api_core.retry.Retry]): A retry object used
to retry requests. If ``None`` is specified, requests will not
be retried.
Expand Down Expand Up @@ -229,25 +229,28 @@ def synthesize_speech(self,
>>>
>>> client = texttospeech_v1beta1.TextToSpeechClient()
>>>
>>> # TODO: Initialize ``input_``:
>>> # TODO: Initialize `input_`:
>>> input_ = {}
>>>
>>> # TODO: Initialize ``voice``:
>>> # TODO: Initialize `voice`:
>>> voice = {}
>>>
>>> # TODO: Initialize ``audio_config``:
>>> # TODO: Initialize `audio_config`:
>>> audio_config = {}
>>>
>>> response = client.synthesize_speech(input_, voice, audio_config)

Args:
input_ (Union[dict, ~google.cloud.texttospeech_v1beta1.types.SynthesisInput]): Required. The Synthesizer requires either plain text or SSML as input.

If a dict is provided, it must be of the same form as the protobuf
message :class:`~google.cloud.texttospeech_v1beta1.types.SynthesisInput`
voice (Union[dict, ~google.cloud.texttospeech_v1beta1.types.VoiceSelectionParams]): Required. The desired voice of the synthesized audio.

If a dict is provided, it must be of the same form as the protobuf
message :class:`~google.cloud.texttospeech_v1beta1.types.VoiceSelectionParams`
audio_config (Union[dict, ~google.cloud.texttospeech_v1beta1.types.AudioConfig]): Required. The configuration of the synthesized audio.

If a dict is provided, it must be of the same form as the protobuf
message :class:`~google.cloud.texttospeech_v1beta1.types.AudioConfig`
retry (Optional[google.api_core.retry.Retry]): A retry object used
Expand Down
3 changes: 1 addition & 2 deletions ...peech/google/cloud/texttospeech_v1beta1/gapic/transports/text_to_speech_grpc_transport.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -96,8 +96,7 @@ def create_channel(cls,
def list_voices(self):
"""Return the gRPC stub for {$apiMethod.name}.

Returns a list of ``Voice``
supported for synthesis.
Returns a list of ``Voice`` supported for synthesis.

Returns:
Callable: A callable which accepts the appropriate
Expand Down