lint examples and fix lint errors

Author: Mike Kistler

examples/conversation_tone_analyzer_integration/tone_detection.py

@@ -31,21 +31,20 @@
 WRITING_TONE_LABEL = 'writing_tone'
 SOCIAL_TONE_LABEL = 'social_tone'
 
-"""
-updateUserTone processes the Tone Analyzer payload to pull out the emotion,
-writing and social tones, and identify the meaningful tones (i.e.,
-those tones that meet the specified thresholds).
-The conversationPayload json object is updated to include these tones.
-@param conversationPayload json object returned by the Watson Conversation
-Service
-@param toneAnalyzerPayload json object returned by the Watson Tone Analyzer
-Service
-@returns conversationPayload where the user object has been updated with tone
-information from the toneAnalyzerPayload
-"""
-
 
 def updateUserTone(conversationPayload, toneAnalyzerPayload, maintainHistory):
+    """
+    updateUserTone processes the Tone Analyzer payload to pull out the emotion,
+    writing and social tones, and identify the meaningful tones (i.e.,
+    those tones that meet the specified thresholds).
+    The conversationPayload json object is updated to include these tones.
+    @param conversationPayload json object returned by the Watson Conversation
+    Service
+    @param toneAnalyzerPayload json object returned by the Watson Tone Analyzer
+    Service
+    @returns conversationPayload where the user object has been updated with tone
+    information from the toneAnalyzerPayload
+    """
     emotionTone = None
     writingTone = None
     socialTone = None
@@ -80,18 +79,15 @@ def updateUserTone(conversationPayload, toneAnalyzerPayload, maintainHistory):
     return conversationPayload
 
 
-'''
- initToneContext initializes a user object containing tone data (from the
- Watson Tone Analyzer)
- @returns user json object with the emotion, writing and social tones.  The
- current
- tone identifies the tone for a specific conversation turn, and the history
- provides the conversation for
- all tones up to the current tone for a conversation instance with a user.
- '''
-
-
 def initUser():
+    """
+    initUser initializes a user object containing tone data (from the
+    Watson Tone Analyzer)
+    @returns user json object with the emotion, writing and social tones.  The
+    current tone identifies the tone for a specific conversation turn, and the
+    history provides the conversation for all tones up to the current tone for a
+    conversation instance with a user.
+    """
     return {
         'user': {
             'tone': {
@@ -109,19 +105,18 @@ def initUser():
     }
 
 
-'''
- updateEmotionTone updates the user emotion tone with the primary emotion -
- the emotion tone that has
- a score greater than or equal to the EMOTION_SCORE_THRESHOLD; otherwise
- primary emotion will be 'neutral'
- @param user a json object representing user information (tone) to be used in
- conversing with the Conversation Service
- @param emotionTone a json object containing the emotion tones in the payload
- returned by the Tone Analyzer
- '''
 
 
 def updateEmotionTone(user, emotionTone, maintainHistory):
+    """
+    updateEmotionTone updates the user emotion tone with the primary emotion -
+    the emotion tone that has a score greater than or equal to the
+    EMOTION_SCORE_THRESHOLD; otherwise primary emotion will be 'neutral'
+    @param user a json object representing user information (tone) to be used in
+    conversing with the Conversation Service
+    @param emotionTone a json object containing the emotion tones in the payload
+    returned by the Tone Analyzer
+    """
     maxScore = 0.0
     primaryEmotion = None
     primaryEmotionScore = None
@@ -148,17 +143,15 @@ def updateEmotionTone(user, emotionTone, maintainHistory):
             })
 
 
-'''
- updateWritingTone updates the user with the writing tones interpreted based
- on the specified thresholds
- @param: user a json object representing user information (tone) to be used
- in conversing with the Conversation Service
- @param: writingTone a json object containing the writing tones in the
- payload returned by the Tone Analyzer
-'''
-
-
 def updateWritingTone(user, writingTone, maintainHistory):
+    """
+    updateWritingTone updates the user with the writing tones interpreted based
+    on the specified thresholds
+    @param: user a json object representing user information (tone) to be used
+    in conversing with the Conversation Service
+    @param: writingTone a json object containing the writing tones in the
+    payload returned by the Tone Analyzer
+    """
     currentWriting = []
     currentWritingObject = []
 
@@ -189,21 +182,18 @@ def updateWritingTone(user, writingTone, maintainHistory):
     if maintainHistory:
         if 'history' not in user['tone']['writing']:
             user['tone']['writing']['history'] = []
-    user['tone']['writing']['history'].append(currentWritingObject)  # TODO -
-    # is this the correct location??? AW
-
-
-"""
- updateSocialTone updates the user with the social tones interpreted based on
- the specified thresholds
- @param user a json object representing user information (tone) to be used in
- conversing with the Conversation Service
- @param socialTone a json object containing the social tones in the payload
- returned by the Tone Analyzer
-"""
+    user['tone']['writing']['history'].append(currentWritingObject)
 
 
 def updateSocialTone(user, socialTone, maintainHistory):
+    """
+    updateSocialTone updates the user with the social tones interpreted based on
+    the specified thresholds
+    @param user a json object representing user information (tone) to be used in
+    conversing with the Conversation Service
+    @param socialTone a json object containing the social tones in the payload
+    returned by the Tone Analyzer
+    """
     currentSocial = []
     currentSocialObject = []
 

examples/personality_insights_v3.py

@@ -1,13 +1,12 @@
+"""
+The example returns a JSON response whose content is the same as that in
+  ../resources/personality-v3-expect2.txt
+"""
 from __future__ import print_function
 import json
 from os.path import join, dirname
 from watson_developer_cloud import PersonalityInsightsV3
 
-"""
-The example returns a JSON response whose content is the same as that in
-   ../resources/personality-v3-expect2.txt
-"""
-
 personality_insights = PersonalityInsightsV3(
     version='2016-10-20',
     username='YOUR SERVICE USERNAME',

pylint.sh

@@ -4,6 +4,5 @@
 PYTHON_VERSION=$(python -c 'import sys; print(".".join(map(str, sys.version_info[:2])))')
 echo "Python version: $PYTHON_VERSION"
 if [ $PYTHON_VERSION = '2.7' ]; then
-  pylint watson_developer_cloud
-  pylint test
+  pylint watson_developer_cloud test examples
 fi

test/test_watson_service.py

@@ -1,7 +1,6 @@
 # coding=utf-8
 import json
 
-import watson_developer_cloud
 from watson_developer_cloud import WatsonService
 
 import responses
@@ -31,8 +30,9 @@ def op_with_path_params(self, path0, path1):
         params = {'version': self.version}
         url = '/v1/foo/{0}/bar/{1}/baz'.format(
             *self._encode_path_vars(path0, path1))
-        self.request(method='GET', url=url, params=params, accept_json=True)
-        return None
+        response = self.request(
+            method='GET', url=url, params=params, accept_json=True)
+        return response
 
 
 @responses.activate
@@ -51,12 +51,13 @@ def test_url_encoding():
 
     responses.add(responses.GET,
                   test_url,
-                  status = 200,
-                  body = json.dumps({"foobar": "baz"}),
-                  content_type = 'application/json')
+                  status=200,
+                  body=json.dumps({"foobar": "baz"}),
+                  content_type='application/json')
 
     response = service.op_with_path_params(path0, path1)
 
+    assert response is not None
     assert len(responses.calls) == 1
     assert path_encoded in responses.calls[0].request.url
     assert 'version=2017-07-07' in responses.calls[0].request.url