Merge pull request #49 from edx/waheed/PROD-774-upgrade-to-py3

Upgrade to pyhton 3.

Author: waheedahmed

.travis.yml

@@ -1,13 +1,21 @@
 language: python
-python: "2.7"
+
+python:
+  - "2.7"
+  - "3.5"
+
+sudo: false
+
 install:
   - "pip install six"
   - "make install"
-sudo: false
+
 script:
   - make quality
   - make test
+
 branches:
     only:
       - master
+
 after_success: coveralls

lti_consumer/exceptions.py

@@ -7,4 +7,3 @@ class LtiError(Exception):
     """
     General error class for LTI XBlock.
     """
-    pass

lti_consumer/lti.py

@@ -5,16 +5,18 @@
 https://www.imsglobal.org/activity/learning-tools-interoperability
 """
 
-import logging
-import urllib
+from __future__ import absolute_import, unicode_literals
+
 import json
+import logging
 
+import six.moves.urllib.error
+import six.moves.urllib.parse
 from six import text_type
 
 from .exceptions import LtiError
 from .oauth import get_oauth_request_signature, verify_oauth_body_signature
 
-
 log = logging.getLogger(__name__)
 
 
@@ -83,14 +85,14 @@ def parse_result_json(json_str):
                 log.error("[LTI] %s", msg)
                 raise LtiError(msg)
         except (TypeError, ValueError) as err:
-            msg = "Could not convert resultScore to float: {}".format(err.message)
+            msg = "Could not convert resultScore to float: {}".format(str(err))
             log.error("[LTI] %s", msg)
             raise LtiError(msg)
 
     return score, json_obj.get('comment', "")
 
 
-class LtiConsumer(object):
+class LtiConsumer(object):  # pylint: disable=bad-option-value, useless-object-inheritance
     """
     Limited implementation of the LTI 1.1/2.0 specification.
 
@@ -202,7 +204,9 @@ def get_signed_lti_parameters(self):
         # so '='' becomes '%3D'.
         # We send form via browser, so browser will encode it again,
         # So we need to decode signature back:
-        oauth_signature[u'oauth_signature'] = urllib.unquote(oauth_signature[u'oauth_signature']).decode('utf8')
+        oauth_signature[u'oauth_signature'] = six.moves.urllib.parse.unquote(
+            oauth_signature[u'oauth_signature']
+        )
 
         # Add LTI parameters to OAuth parameters for sending in form.
         lti_parameters.update(oauth_signature)
@@ -290,15 +294,15 @@ def verify_result_headers(self, request, verify_content_type=True):
         content_type = request.headers.get('Content-Type')
         if verify_content_type and content_type != LtiConsumer.CONTENT_TYPE_RESULT_JSON:
             log.error("[LTI]: v2.0 result service -- bad Content-Type: %s", content_type)
-            raise LtiError(
-                "For LTI 2.0 result service, Content-Type must be %s.  Got %s",
+            error_msg = "For LTI 2.0 result service, Content-Type must be {}.  Got {}".format(
                 LtiConsumer.CONTENT_TYPE_RESULT_JSON,
                 content_type
             )
+            raise LtiError(error_msg)
 
         __, secret = self.xblock.lti_provider_key_secret
         try:
             return verify_oauth_body_signature(request, secret, self.xblock.outcome_service_url)
         except (ValueError, LtiError) as err:
-            log.error("[LTI]: v2.0 result service -- OAuth body verification failed: %s", err.message)
-            raise LtiError(err.message)
+            log.error("[LTI]: v2.0 result service -- OAuth body verification failed: %s", str(err))
+            raise LtiError(str(err))

lti_consumer/lti_consumer.py

@@ -50,29 +50,29 @@
             GET / PUT / DELETE HTTP methods respectively
 """
 
+from __future__ import absolute_import, unicode_literals
+
 import logging
-import bleach
 import re
-from importlib import import_module
-import json
-import urllib
-
 from collections import namedtuple
-from webob import Response
+from importlib import import_module
 
+import six.moves.urllib.error
+import six.moves.urllib.parse
+import six
+import bleach
 from django.utils import timezone
-
-from xblock.core import String, Scope, List, XBlock
+from webob import Response
+from xblock.core import List, Scope, String, XBlock
 from xblock.fields import Boolean, Float, Integer
 from xblock.fragment import Fragment
 from xblock.validation import ValidationMessage
-
 from xblockutils.resources import ResourceLoader
 from xblockutils.studio_editable import StudioEditableXBlockMixin
 
 from .exceptions import LtiError
-from .oauth import log_authorization_header
 from .lti import LtiConsumer
+from .oauth import log_authorization_header
 from .outcomes import OutcomeService
 from .utils import _
 
@@ -155,7 +155,7 @@ def parse_handler_suffix(suffix):
 LaunchTargetOption = namedtuple('LaunchTargetOption', ['display_name', 'value'])
 
 
-class LaunchTarget(object):
+class LaunchTarget(object):  # pylint: disable=bad-option-value, useless-object-inheritance
     """
     Constants for launch_target field options
     """
@@ -476,7 +476,9 @@ def workbench_scenarios():
     def validate_field_data(self, validation, data):
         if not isinstance(data.custom_parameters, list):
             _ = self.runtime.service(self, "i18n").ugettext
-            validation.add(ValidationMessage(ValidationMessage.ERROR, unicode(_("Custom Parameters must be a list"))))
+            validation.add(ValidationMessage(ValidationMessage.ERROR, six.text_type(
+                _("Custom Parameters must be a list")
+            )))
 
     def get_settings(self):
         """
@@ -547,7 +549,7 @@ def context_id(self):
         context_id is an opaque identifier that uniquely identifies the context (e.g., a course)
         that contains the link being launched.
         """
-        return unicode(self.course_id)  # pylint: disable=no-member
+        return six.text_type(self.course_id)  # pylint: disable=no-member
 
     @property
     def role(self):
@@ -589,7 +591,7 @@ def user_id(self):
         user_id = self.runtime.anonymous_student_id
         if user_id is None:
             raise LtiError(self.ugettext("Could not get user id for current request"))
-        return unicode(urllib.quote(user_id))
+        return six.text_type(six.moves.urllib.parse.quote(user_id))
 
     @property
     def resource_link_id(self):
@@ -623,7 +625,7 @@ def resource_link_id(self):
         i4x-2-3-lti-31de800015cf4afb973356dbe81496df this part of resource_link_id:
         makes resource_link_id to be unique among courses inside same system.
         """
-        return unicode(urllib.quote(
+        return six.text_type(six.moves.urllib.parse.quote(
             "{}-{}".format(self.runtime.hostname, self.location.html_id())  # pylint: disable=no-member
         ))
 
@@ -638,7 +640,7 @@ def lis_result_sourcedid(self):
         This field is generally optional, but is required for grading.
         """
         return "{context}:{resource_link}:{user_id}".format(
-            context=urllib.quote(self.context_id),
+            context=six.moves.urllib.parse.quote(self.context_id),
             resource_link=self.resource_link_id,
             user_id=self.user_id
         )
@@ -701,7 +703,7 @@ def prefixed_custom_parameters(self):
                 if param_name not in LTI_PARAMETERS:
                     param_name = 'custom_' + param_name
 
-                custom_parameters[unicode(param_name)] = unicode(param_value)
+                custom_parameters[six.text_type(param_name)] = six.text_type(param_value)
         return custom_parameters
 
     @property
@@ -849,7 +851,7 @@ def result_service_handler(self, request, suffix=''):
             return Response(status=404)
 
         return Response(
-            json.dumps(response_body),
+            json_body=response_body,
             content_type=LtiConsumer.CONTENT_TYPE_RESULT_JSON,
         )
 

lti_consumer/oauth.py

@@ -2,20 +2,23 @@
 Utility functions for working with OAuth signatures.
 """
 
-import logging
-import hashlib
+from __future__ import absolute_import, unicode_literals
+
 import base64
-import urllib
+import hashlib
+import logging
 
+import six.moves.urllib.error
+import six.moves.urllib.parse
+import six
 from oauthlib import oauth1
 
 from .exceptions import LtiError
 
-
 log = logging.getLogger(__name__)
 
 
-class SignedRequest(object):
+class SignedRequest(object):  # pylint: disable=bad-option-value, useless-object-inheritance
     """
     Encapsulates request attributes needed when working
     with the `oauthlib.oauth1` API
@@ -45,14 +48,14 @@ def get_oauth_request_signature(key, secret, url, headers, body):
     Returns:
         str: Authorization header for the OAuth signed request
     """
-    client = oauth1.Client(client_key=unicode(key), client_secret=unicode(secret))
+    client = oauth1.Client(client_key=six.text_type(key), client_secret=six.text_type(secret))
     try:
         # Add Authorization header which looks like:
         # Authorization: OAuth oauth_nonce="80966668944732164491378916897",
         # oauth_timestamp="1378916897", oauth_version="1.0", oauth_signature_method="HMAC-SHA1",
         # oauth_consumer_key="", oauth_signature="frVp4JuvT1mVXlxktiAUjQ7%2F1cw%3D"
-        __, headers, __ = client.sign(
-            unicode(url.strip()),
+        _, headers, _ = client.sign(
+            six.text_type(url.strip()),
             http_method=u'POST',
             body=body,
             headers=headers
@@ -83,7 +86,7 @@ def verify_oauth_body_signature(request, lti_provider_secret, service_url):
     """
 
     headers = {
-        'Authorization': unicode(request.headers.get('Authorization')),
+        'Authorization': six.text_type(request.headers.get('Authorization')),
         'Content-Type': request.content_type,
     }
 
@@ -94,18 +97,18 @@ def verify_oauth_body_signature(request, lti_provider_secret, service_url):
     oauth_headers = dict(oauth_params)
     oauth_signature = oauth_headers.pop('oauth_signature')
     mock_request_lti_1 = SignedRequest(
-        uri=unicode(urllib.unquote(service_url)),
-        http_method=unicode(request.method),
-        params=oauth_headers.items(),
+        uri=six.text_type(six.moves.urllib.parse.unquote(service_url)),
+        http_method=six.text_type(request.method),
+        params=list(oauth_headers.items()),
         signature=oauth_signature
     )
     mock_request_lti_2 = SignedRequest(
-        uri=unicode(urllib.unquote(request.url)),
-        http_method=unicode(request.method),
-        params=oauth_headers.items(),
+        uri=six.text_type(six.moves.urllib.parse.unquote(request.url)),
+        http_method=six.text_type(request.method),
+        params=list(oauth_headers.items()),
         signature=oauth_signature
     )
-    if oauth_body_hash != oauth_headers.get('oauth_body_hash'):
+    if oauth_body_hash.decode('utf-8') != oauth_headers.get('oauth_body_hash'):
         log.error(
             "OAuth body hash verification failed, provided: %s, "
             "calculated: %s, for url: %s, body is: %s",
@@ -123,7 +126,7 @@ def verify_oauth_body_signature(request, lti_provider_secret, service_url):
             "headers:%s url:%s method:%s",
             oauth_headers,
             service_url,
-            unicode(request.method)
+            six.text_type(request.method)
         )
         raise LtiError("OAuth signature verification has failed.")
 
@@ -145,18 +148,18 @@ def log_authorization_header(request, client_key, client_secret):
     """
     sha1 = hashlib.sha1()
     sha1.update(request.body)
-    oauth_body_hash = unicode(base64.b64encode(sha1.digest()))  # pylint: disable=too-many-function-args
+    oauth_body_hash = six.text_type(base64.b64encode(sha1.digest()))  # pylint: disable=too-many-function-args
     log.debug("[LTI] oauth_body_hash = %s", oauth_body_hash)
     client = oauth1.Client(client_key, client_secret)
     params = client.get_oauth_params(request)
     params.append((u'oauth_body_hash', oauth_body_hash))
     mock_request = SignedRequest(
-        uri=unicode(urllib.unquote(request.url)),
+        uri=six.text_type(six.moves.urllib.parse.unquote(request.url)),
         headers=request.headers,
         body=u"",
         decoded_body=u"",
         oauth_params=params,
-        http_method=unicode(request.method),
+        http_method=six.text_type(request.method),
     )
     sig = client.get_oauth_signature(mock_request)
     mock_request.oauth_params.append((u'oauth_signature', sig))