[MAJOR RELEASE] Auto-generated code and other changes by germanattanasio · Pull Request #286 · watson-developer-cloud/python-sdk

germanattanasio · 2017-10-24T21:35:36Z

Version 1.0 introduces automatically generated service classes for several services.

Services that are not affected in this release:

Speech to Text
Text to Speech
Retrieve and Rank
Document Conversion
Tradeoff Analytics

Services that are affected in this release:

Discovery
Conversation
Natural Language Understanding
Natural Language Classifier
Tone Analyzer
Language Translator
Personality Insights
Visual Recognition

Upon upgrading the SDK, follow the migration guide here.

Rename core service file to watson_service.py

* Return None when status_code is 204 (No Content) * Generated Python SDK * Hand-coded changes to create/updateClassifier * Updated tests for generated SDK * Updated examples for generated SDK * Updates from PR review * Update discovery tests * ignore vscode * 💚 ignore personality insights v3 failing test * 🔮 Add travis file to prevent encoding issues * Hand-coded changes to PIV3 profile for text/csv accept type * Fix and re-enable PIV3 test for csv return type * 📝 Documentation changes for v1.0 * Add the Download Times link back * Update examples and pylint errors * Unicode to fix travis issue with python 2.7 * Revert unicode for v2.7

* Generated Python SDK for multiple services * Hand-coded changes to create/updateClassifier * Hand-coded changes to PIV3 profile for text/csv accept type

mamoonraja · 2017-10-25T21:02:34Z

+global_payload = {
    'workspace_id': workspace_id,
    'input': {
        'text': "I am happy"


Line 47 under invokeToneConversation says:

invokeToneConversation calls the the Tone Analyzer service to get the

extra the is not intentional. right?

glennrfisher · 2017-10-25T21:42:39Z


-## CHANGELOG
+## Changes for v4.0
+Version 4.0 focuses on the move to programmatically-generated code for many of the services. See the [changelog](https://github.com/watson-developer-cloud/python-sdk/wiki/Changelog) for the details.


Should this be v1.0 instead of v4.0?

glennrfisher · 2017-10-25T21:48:23Z

        audio_file, content_type='audio/wav', timestamps=True,
        word_confidence=True),
-        indent=2))
+                     indent=2))


It doesn't change the meaning, but I suspect this extra indentation wasn't intended.

This was a pylint complain, so added those indentation

glennrfisher · 2017-10-25T21:50:46Z

 with open(join(dirname(__file__),
               '../resources/tone-example.json')) as tone_json:
-    tone = tone_analyzer.tone(json.load(tone_json)['text'], 'emotion')
+    tone = tone_analyzer.tone(json.load(tone_json)['text'], "text/plain")


Looks like the tones list was removed. Based on an email thread, though, I think there's a chance it will be reintroduced to maintain backwards compatibility. Not sure if y'all want to hold off on this release until there's a resolution to that discussion.

Good eye @glennrfisher! The tones parameter was reintroduced but is now optional, so it moved after the content_type parameter. That wouldn't really be backward compatible, but fortunately we don't have to worry about that for a new major release. And happily, this example is still correct even with tones being reintroduced.

@ehdsouza The reordering of the parameters might be worth mentioning in the migration guide.

Updated the migration guide.

glennrfisher · 2017-10-25T22:20:51Z

 print(json.dumps(url_result, indent=2))

-faces_result = visual_recognition.detect_faces(images_url=test_url)
+faces_result = visual_recognition.detect_faces(parameters=json.dumps({'url': test_url}))


It's unfortunate that the API for Visual Recognition expects a JSON string. Not sure what can be done to improve that without changing the service interface.

glennrfisher · 2017-10-25T22:21:05Z

+#file_path = join(dirname(__file__), '../resources/text.png')
+#with open(file_path, 'rb') as image_file:
+#    text_results = visual_recognition.recognize_text(images_file=image_file)
+#    print(json.dumps(text_results, indent=2))


Was this intended to be commented?

Yes -- the text recognition methods of VR are deprecated.

glennrfisher · 2017-10-25T23:08:19Z

+            count,
+            'return_fields':
+            ",".join(return_fields)
+            if isinstance(return_fields, list) else return_fields,


This looks awkward, although it seems to work okay. I suspect yapf formatted the code this way.

I made a quick test file, and it works as expected:

# test.py x = ['1','2','3'] params = { 'list': ','.join(x) if True else 'hello, world' } print(params['list'])

> python test.py 1,2,3

I noticed the same thing. It turns out that if any line in the object constructor has to break at the :, then yapf breaks all the lines consistently at the :. It looks awful but it works.

Replace latest_version with named version dates

mamoonraja · 2017-10-26T13:46:32Z


-discovery = watson_developer_cloud.DiscoveryV1(
+discovery = DiscoveryV1(
    '2016-11-07',


Using a latest version here would make more sense.

Use 2017-10-16

mkistler · 2017-10-26T13:54:04Z

+                     parallel_corpus_content_type=None,
+                     parallel_corpus_filename=None,
+                     monolingual_corpus_content_type=None,
+                     monolingual_corpus_filename=None):


I think we probably do not want the content_types or filename parameters here.

I see why this happened -- a typo in the annotations in the LT swagger.

mkistler · 2017-10-26T17:03:40Z

+    def create_classifier(self,
+                          metadata,
+                          training_data,
+                          training_metadata_filename=None,


This parameter should be named metadata_filename.

…slator Eliminate content-type parameters from LT create_model

jsstylos · 2017-10-26T20:19:40Z


-    def __init__(self, version, url=default_url, **kwargs):
-        WatsonDeveloperCloudService.__init__(self, 'conversation', url,
-                                             **kwargs)


Should continue to have the logic of **kwargs to support x_watson_learning_opt_out, etc.

def __init__(self, version, url=default_url, **kwargs): WatsonDeveloperCloudService.__init__(self, 'conversation', url, **kwargs)

You can do x_watson_learning_opt_out with the default headers. This was recently added.

@ehdsouza We should make sure this is in the migration guide.

Also, **kwargs is no longer needed for use_vcap_services, because it defaults to True -- there’s never a case where you want to specify False. Credentials passed in always override vcap services. If you want vcap services, don’t pass credentials.

…-helper Add convert_model helper function and use this in generated code

…les-tests Fix unicode error in examples tests

…xceptions Create custom exception for API errors containing the status code

🔥 enable all commands in tox to build pages 💚 Test documentation deployment Install the library before calling docs/publish.sh

Update codecov and sphinx script

codecov-io · 2017-11-07T19:30:01Z

Codecov Report

Merging #286 into master will decrease coverage by 47.19%.
The diff coverage is 37.77%.

@@            Coverage Diff             @@
##           master     #286      +/-   ##
==========================================
- Coverage   85.29%   38.09%   -47.2%     
==========================================
  Files          24       24              
  Lines        1231     8187    +6956     
==========================================
+ Hits         1050     3119    +2069     
- Misses        181     5068    +4887

Impacted Files	Coverage Δ
watson_developer_cloud/discovery_v1.py	`29.1% <ø> (-69.07%)`	⬇️
watson_developer_cloud/conversation_v1.py	`39.92% <ø> (-60.08%)`	⬇️
...veloper_cloud/natural_language_understanding_v1.py	`31.26% <ø> (-68.74%)`	⬇️
watson_developer_cloud/tradeoff_analytics_v1.py	`100% <100%> (ø)`	⬆️
watson_developer_cloud/__init__.py	`100% <100%> (ø)`	⬆️
watson_developer_cloud/dialog_v1.py	`44.44% <100%> (ø)`	⬆️
watson_developer_cloud/alchemy_language_v1.py	`42.66% <100%> (ø)`	⬆️
watson_developer_cloud/personality_insights_v2.py	`76.19% <100%> (ø)`	⬆️
watson_developer_cloud/retrieve_and_rank_v1.py	`98.14% <100%> (ø)`	⬆️
watson_developer_cloud/document_conversion_v1.py	`96.87% <100%> (ø)`	⬆️
... and 16 more

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 eec665f...37c30a9. Read the comment docs.

Add pylint test

Store datetime properties as Python datetime objects in models

…ding Fix path encoding

germanattanasio · 2017-11-13T22:39:47Z

Mike Kistler and others added 3 commits October 23, 2017 17:33

Rename core service file to watson_service.py

40aa571

Rename core service file to watson_service.py (#283)

708168c

Rename core service file to watson_service.py

germanattanasio added the Ready for review label Oct 24, 2017

germanattanasio requested review from jsstylos and mkistler October 24, 2017 21:36

germanattanasio assigned ehdsouza Oct 24, 2017

germanattanasio and others added 2 commits October 24, 2017 17:36

Merge branch 'master' into v1.0.0

9fb24f2

Final pass of codegen for v1.0.0 SDK release (#287)

9b425cc

* Generated Python SDK for multiple services * Hand-coded changes to create/updateClassifier * Hand-coded changes to PIV3 profile for text/csv accept type

germanattanasio requested a review from ehdsouza October 25, 2017 20:53

mamoonraja reviewed Oct 25, 2017

View reviewed changes

glennrfisher reviewed Oct 25, 2017

View reviewed changes

Mike Kistler and others added 2 commits October 25, 2017 16:56

Replace latest_version with named version dates

6d497cf

Replace latest_version with named version dates (#288)

df301a1

Replace latest_version with named version dates

mamoonraja reviewed Oct 26, 2017

View reviewed changes

mkistler reviewed Oct 26, 2017

View reviewed changes

Mike Kistler and others added 2 commits October 26, 2017 08:01

Eliminate content-type parameters from LT create_model

c700ab8

Based on review comments

bc0a218

mkistler reviewed Oct 26, 2017

View reviewed changes

Mike Kistler and others added 2 commits October 26, 2017 10:12

Fix generated filename for file with alternate name

a37b778

Merge pull request #289 from watson-developer-cloud/mdk/language-tran…

82f6639

…slator Eliminate content-type parameters from LT create_model

ehdsouza approved these changes Oct 26, 2017

View reviewed changes

germanattanasio added 2 commits October 26, 2017 16:07

Update discovery_v1.py

2f258fe

Update watson_service.py

bdd1eb3

jsstylos reviewed Oct 26, 2017

View reviewed changes

mkistler mentioned this pull request Nov 4, 2017

Add convert_model helper function and use this in generated code #294

Merged

Mike Kistler and others added 9 commits November 4, 2017 11:47

Fix unicode error in examples tests

6d50b6f

Merge pull request #294 from watson-developer-cloud/mdk/convert-model…

0b0e671

…-helper Add convert_model helper function and use this in generated code

Merge pull request #296 from watson-developer-cloud/mdk/295-fix-examp…

2acf477

…les-tests Fix unicode error in examples tests

Create custom exception for API errors containing the status code

f70ec85

Fix missing import

1c262fd

Fix missing message attribute on Exception in Python 3.x

70cd9d2

Merge pull request #297 from watson-developer-cloud/mdk/279-improve-e…

d8bc4ea

…xceptions Create custom exception for API errors containing the status code

🔮 Update codecov and sphinx script

8e006ce

🔥 enable all commands in tox to build pages 💚 Test documentation deployment Install the library before calling docs/publish.sh

Merge pull request #299 from watson-developer-cloud/codecov

6d6606d

Update codecov and sphinx script

ehdsouza and others added 16 commits November 7, 2017 17:22

🌈 fix pylint errors

8e158fe

🌈 Add pylint test

aeaf666

:fix Fix travis errors

d319015

💚 Fix lint issues in test folder

9503edd

Merge branch 'v1.0.0' into addPylint

8ac7406

Merge pull request #300 from watson-developer-cloud/addPylint

d794a54

Add pylint test

Machinery for parsing/serializing datetimes

5f2e9a4

Update generated SDK with datetime conversion support

ad3d72e

Update tests to exercise model (and date) conversions

526e7dc

Merge pull request #303 from watson-developer-cloud/mdk/parse-datetime

f0fda95

Store datetime properties as Python datetime objects in models

Add utility method for encoding path variables

42b8e6e

Generated service changes for encoding path variables

163668e

Test updates for path variable encoding

79dce16

lint examples and fix lint errors

5a0d7a0

Merge pull request #305 from watson-developer-cloud/mdk/fix-path-enco…

31721ed

…ding Fix path encoding

Update README.md

37c30a9

ehdsouza merged commit 254430e into master Nov 13, 2017

germanattanasio deleted the v1.0.0 branch November 14, 2017 02:15

Conversation

germanattanasio commented Oct 24, 2017

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!

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!

jsstylos Oct 26, 2017 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

mkistler Oct 26, 2017 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

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

Uh oh!

Codecov Report

Uh oh!

germanattanasio commented Nov 13, 2017

Uh oh!

Reviewers

Assignees

Labels

Milestone

Development

Uh oh!

7 participants

jsstylos Oct 26, 2017 •

edited

Loading

mkistler Oct 26, 2017 •

edited

Loading

codecov-io commented Nov 7, 2017 •

edited

Loading