Generate Text to Speech by ammardodin · Pull Request #332 · watson-developer-cloud/python-sdk

ammardodin · 2017-12-12T03:33:32Z

Summary

Generated Text to Speech from the latest swagger
Added missing unit tests for get_voice
Updated method names in unit tests
Integration tests
Updated examples as per new .env file

codecov-io · 2017-12-12T03:39:21Z

Codecov Report

Merging #332 into next will decrease coverage by 0.33%.
The diff coverage is 37.44%.

@@            Coverage Diff             @@
##             next     #332      +/-   ##
==========================================
- Coverage   38.39%   38.05%   -0.34%     
==========================================
  Files          25       25              
  Lines        8720     9141     +421     
==========================================
+ Hits         3348     3479     +131     
- Misses       5372     5662     +290

Impacted Files	Coverage Δ
watson_developer_cloud/utils.py	`100% <100%> (ø)`	⬆️
watson_developer_cloud/text_to_speech_v1.py	`38.37% <37.31%> (-61.63%)`	⬇️
watson_developer_cloud/watson_service.py	`77.68% <0%> (-0.42%)`	⬇️

Continue to review full report at Codecov.

Legend - Click here to learn more
Δ = absolute <relative> (impact), ø = not affected, ? = missing data
Powered by Codecov. Last update 401efc1...a08b726. Read the comment docs.

mkistler

Looks good but we need to be more careful about maintaining compatibility. We should also eliminate the duplicate accept parameter.

mkistler · 2017-12-17T21:27:14Z

watson_developer_cloud/text_to_speech_v1.py

+
+        :param str text: The text to synthesize.
+        :param str accept: The requested audio format (MIME type) of the audio. You can use this header or the `accept` query parameter to specify the audio format. (For the `audio/l16` format, you can optionally specify `endianness=big-endian` or `endianness=little-endian`; the default is little endian.).
+        :param str accept2: The requested audio format (MIME type) of the audio. You can use this query parameter or the `Accept` header to specify the audio format. (For the `audio/l16` format, you can optionally specify `endianness=big-endian` or `endianness=little-endian`; the default is little endian.).


We should ignore the accept query parameter -- it duplicates the function of the accept header parameter, and the header parameter is the better approach.

mkistler · 2017-12-17T21:32:53Z

watson_developer_cloud/text_to_speech_v1.py

-        return self.request(method='GET', url='/v1/customizations',
-                            params=params, accept_json=True)
-
-    def get_customization(self, customization_id):


It will break compatibility to remove these methods, and I think that's a problem. Why not leave them? I don't think they conflict with any of the generated methods. Maybe we can mark them as deprecated, and add comments recommending the new method names. That will set us up to remove them in the next major release.

mkistler · 2017-12-18T14:01:48Z

We can use Python's warnings package to add deprecation warnings to existing methods that have different names in the generated SDK.

http://www.arruda.blog.br/programacao/python-use-warnings/

mkistler

I have some misgivings about including beta methods in the main file of the SDK, but we may be down that road too far to change it now.

mkistler · 2018-02-07T20:07:01Z

watson_developer_cloud/text_to_speech_v1.py

-# Copyright 2016 IBM All Rights Reserved.
+# coding: utf-8
+
+# Copyright 2017 IBM All Rights Reserved.


Copyright should be 2018 now, or '2017,2018'.

mkistler · 2018-02-07T20:07:21Z

watson_developer_cloud/text_to_speech_v1.py

-The v1 Text to Speech service
-(https://www.ibm.com/watson/developercloud/text-to-speech.html)
+For more information about the service and its various interfaces, see [About Text to
+Speech](https://console.bluemix.net/docs/services/text-to-speech/index.html).


The link to "console.bluemix.net" is going to be deprecated very soon.

mkistler · 2018-02-07T20:46:17Z

watson_developer_cloud/text_to_speech_v1.py

+        Retrieves all voices available for speech synthesis.
+
+        Lists information about all available voices. To see information about a specific
+        voice, use the `GET /v1/voices/{voice}` method.


We need to work on removing the REST details from descriptions.

mkistler · 2018-02-07T20:47:19Z

watson_developer_cloud/text_to_speech_v1.py

-    def pronunciation(self, text, voice=None, pronunciation_format='ipa'):
+    @deprecated('Use list_voices() instead')
+    def voices(self):
+        return self.list_voices()


mkistler · 2018-02-07T20:49:45Z

watson_developer_cloud/text_to_speech_v1.py

+        You can request the pronunciation for a specific format. You can also request the
+        pronunciation for a specific voice to see the default translation for the language
+        of that voice or for a specific custom voice model to see the translation for that
+        voice model.   **Note:** This method is currently a beta release.


Should we exclude get_pronunciation from the SDK if it is still beta? Or should we mark it in some special way?

mkistler · 2018-02-07T20:52:40Z

watson_developer_cloud/text_to_speech_v1.py

+        as defined in the model. To see just the metadata for a voice model, use the `GET
+        /v1/customizations` method. You must use credentials for the instance of the
+        service that owns a model to list information about it.   **Note:** This method is
+        currently a beta release.


Another beta method.

mkistler · 2018-02-07T20:56:55Z

watson_developer_cloud/text_to_speech_v1.py

+        you own for all languages. To see the words in addition to the metadata for a
+        specific voice model, use the `GET /v1/customizations/{customization_id}` method.
+        You must use credentials for the instance of the service that owns a model to list
+        information about it.   **Note:** This method is currently a beta release.


Another beta method.

mkistler · 2018-02-07T21:13:20Z

watson_developer_cloud/text_to_speech_v1.py

+    """
+    Translation.
+
+    :attr str translation: The phonetic or sounds-like translation for the word. A phonetic translation is based on the SSML format for representing the phonetic string of a word either as an IPA translation or as an IBM SPR translation. A sounds-like is one or more words that, when combined, sound like the word.


Translation.translation is going to cause problems for C#.

mkistler · 2018-02-07T21:16:04Z

watson_developer_cloud/text_to_speech_v1.py

+    """
+    VoiceModels.
+
+    :attr list[VoiceModel] customizations: An array of `VoiceModel` objects that provides information about each available custom voice model. The array is empty if the requesting service credentials own no custom voice models (if no language is specified) or own no custom voice models for the specified language.


Seems like we want this to be named voiceModels and not customizations. I think this would be as simple as adding an x-alternate-name annotation to the swagger.

Rename Bluemix to IBM Cloud

…k into develop

This reverts commit f7ac60a.

…k into generate-text-to-speech

Ammar Dodin added 2 commits December 11, 2017 22:30

🆕 generated text-to-speech with latest swagger

f617e9a

💚 added missing tests and updated method names in tests

98a88cd

ammardodin added the Ready for review label Dec 12, 2017

ammardodin requested a review from germanattanasio December 12, 2017 03:33

ammardodin requested a review from mkistler December 14, 2017 17:24

mkistler suggested changes Dec 17, 2017

View reviewed changes

germanattanasio and others added 4 commits January 15, 2018 13:10

Merge branch 'master' into generate-text-to-speech

129a1c9

Merge branch 'master' into generate-text-to-speech

91eade8

Changes as per review Mike's comments

8a0029e

Remove unnecessary overview

ebf6819

germanattanasio changed the base branch from master to next February 7, 2018 18:07

mkistler approved these changes Feb 7, 2018

View reviewed changes

germanattanasio and others added 16 commits February 7, 2018 17:30

😒 Rename Bluemix to IBM Cloud

55bcaab

change Bluemix to IBM Cloud

1f7a053

fix capitalization of IBM CLoud

35efd07

Update README.md

e4357f0

Merge pull request #355 from watson-developer-cloud/readme

254a0c8

Rename Bluemix to IBM Cloud

📝 Update to use Watson APIs

99fe401

Merge branch 'develop' of github.com:watson-developer-cloud/python-sd…

e3f6ec8

…k into develop

Adding integration tests and removing REST description

c8be174

enable dot_env to get env variables

f7ac60a

Revert "enable dot_env to get env variables"

e3e80a6

This reverts commit f7ac60a.

Encrypt travis env file

f7457da

Adding VCAP_SERVICES

3206721

Ignoring destructive tests

c6e5852

Remove the VCAP_SERVICES keyword

20747b0

Regenerate encrypted env file for travis

ab37785

Remove the skip test for integration test

60b6317

ehdsouza added 3 commits February 9, 2018 10:44

Add in init file for integration tests

176c631

Merge branch 'develop' of github.com:watson-developer-cloud/python-sd…

d9d87f6

…k into generate-text-to-speech

Update tests as per new env file

a08b726

germanattanasio merged commit ad44aac into next Feb 9, 2018

germanattanasio deleted the generate-text-to-speech branch February 14, 2018 18:53

Conversation

ammardodin commented Dec 12, 2017 • edited by ehdsouza Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

codecov-io commented Dec 12, 2017 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Codecov Report

Uh oh!

mkistler left a comment

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

mkistler commented Dec 18, 2017

Uh oh!

mkistler left a comment

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Reviewers

Assignees

Labels

Milestone

Development

Uh oh!

6 participants

ammardodin commented Dec 12, 2017 •

edited by ehdsouza

Loading

codecov-io commented Dec 12, 2017 •

edited

Loading