Merge pull request #167 from opentok/style-changes-checks-lint-lesting

Style Changes and Linter

Author: superdiana

.gitignore

@@ -45,4 +45,7 @@ docs/_build/
 venv/
 
 # Mac Desktop files
-.DS_Store
+.DS_Store
+
+# IDE
+.vscode

dev_requirements.txt

@@ -0,0 +1,2 @@
+black
+pylint

opentok/archives.py

@@ -3,22 +3,30 @@
 import json
 import pytz
 from enum import Enum
+
 if PY3:
     from datetime import timezone
 
 # compat
 from six.moves import map
 
-dthandler = lambda obj: obj.isoformat() if isinstance(obj, datetime)  or isinstance(obj, date) else None
+dthandler = (
+    lambda obj: obj.isoformat()
+    if isinstance(obj, datetime) or isinstance(obj, date)
+    else None
+)
+
 
 class OutputModes(Enum):
     """List of valid settings for the output_mode parameter of the OpenTok.start_archive()
     method."""
-    composed = u('composed')
+
+    composed = u("composed")
     """All streams in the archive are recorded to a single (composed) file."""
-    individual = u('individual')
+    individual = u("individual")
     """Each stream in the archive is recorded to an individual file."""
 
+
 class Archive(object):
     """Represents an archive of an OpenTok session.
 
@@ -87,22 +95,26 @@ class Archive(object):
 
     def __init__(self, sdk, values):
         self.sdk = sdk
-        self.id = values.get('id')
-        self.name = values.get('name')
-        self.status = values.get('status')
-        self.session_id = values.get('sessionId')
-        self.partner_id = values.get('partnerId')
+        self.id = values.get("id")
+        self.name = values.get("name")
+        self.status = values.get("status")
+        self.session_id = values.get("sessionId")
+        self.partner_id = values.get("partnerId")
         if PY2:
-            self.created_at = datetime.fromtimestamp(values.get('createdAt') / 1000, pytz.UTC)
+            self.created_at = datetime.fromtimestamp(
+                values.get("createdAt") / 1000, pytz.UTC
+            )
         if PY3:
-            self.created_at = datetime.fromtimestamp(values.get('createdAt') // 1000, timezone.utc)
-        self.size = values.get('size')
-        self.duration = values.get('duration')
-        self.has_audio = values.get('hasAudio')
-        self.has_video = values.get('hasVideo')
-        self.output_mode = OutputModes[values.get('outputMode', 'composed')]
-        self.url = values.get('url')
-        self.resolution = values.get('resolution')
+            self.created_at = datetime.fromtimestamp(
+                values.get("createdAt") // 1000, timezone.utc
+            )
+        self.size = values.get("size")
+        self.duration = values.get("duration")
+        self.has_audio = values.get("hasAudio")
+        self.has_video = values.get("hasVideo")
+        self.output_mode = OutputModes[values.get("outputMode", "composed")]
+        self.url = values.get("url")
+        self.resolution = values.get("resolution")
 
     def stop(self):
         """
@@ -112,7 +124,7 @@ def stop(self):
         disconnected from the session being archived.
         """
         temp_archive = self.sdk.stop_archive(self.id)
-        for k,v in iteritems(temp_archive.attrs()):
+        for k, v in iteritems(temp_archive.attrs()):
             setattr(self, k, v)
 
     def delete(self):
@@ -138,21 +150,18 @@ def json(self):
         """
         return json.dumps(self.attrs(), default=dthandler, indent=4)
 
-class ArchiveList(object):
 
+class ArchiveList(object):
     def __init__(self, sdk, values):
-        self.count = values.get('count')
-        self.items = list(map(lambda x: Archive(sdk, x), values.get('items', [])))
+        self.count = values.get("count")
+        self.items = list(map(lambda x: Archive(sdk, x), values.get("items", [])))
 
     def __iter__(self):
         for x in self.items:
             yield x
 
     def attrs(self):
-        return {
-            'count': self.count,
-            'items': map(Archive.attrs, self.items)
-        }
+        return {"count": self.count, "items": map(Archive.attrs, self.items)}
 
     def json(self):
         return json.dumps(self.attrs(), default=dthandler, indent=4)
@@ -161,7 +170,9 @@ def __getitem__(self, key):
         return self.items.get(key)
 
     def __setitem__(self, key, item):
-        raise ArchiveError(u('Cannot set item {0} for key {1} in Archive object').format(item, key))
+        raise ArchiveError(
+            u("Cannot set item {0} for key {1} in Archive object").format(item, key)
+        )
 
     def __len__(self):
         return len(self.items)

opentok/broadcast.py

@@ -1,19 +1,20 @@
 import json
 
+
 class Broadcast(object):
     """
     Represents a live streaming broadcast
     """
 
     def __init__(self, kwargs):
-        self.id = kwargs.get('id')
-        self.sessionId = kwargs.get('sessionId')
-        self.projectId = kwargs.get('projectId')
-        self.createdAt = kwargs.get('createdAt')
-        self.updatedAt = kwargs.get('updatedAt')
-        self.resolution = kwargs.get('resolution')
-        self.status = kwargs.get('status')
-        self.broadcastUrls = kwargs.get('broadcastUrls')
+        self.id = kwargs.get("id")
+        self.sessionId = kwargs.get("sessionId")
+        self.projectId = kwargs.get("projectId")
+        self.createdAt = kwargs.get("createdAt")
+        self.updatedAt = kwargs.get("updatedAt")
+        self.resolution = kwargs.get("resolution")
+        self.status = kwargs.get("status")
+        self.broadcastUrls = kwargs.get("broadcastUrls")
 
     def json(self):
         """

opentok/endpoints.py

@@ -3,67 +3,94 @@ class Endpoints(object):
     For internal use.
     Class that provides the endpoint urls
     """
+
     def __init__(self, api_url, api_key):
         self.api_url = api_url
         self.api_key = api_key
 
     def session_url(self):
-        url = self.api_url + '/session/create'
+        url = self.api_url + "/session/create"
         return url
 
     def archive_url(self, archive_id=None):
-        url = self.api_url + '/v2/project/' + self.api_key + '/archive'
+        url = self.api_url + "/v2/project/" + self.api_key + "/archive"
         if archive_id:
-            url = url + '/' + archive_id
+            url = url + "/" + archive_id
         return url
 
     def signaling_url(self, session_id, connection_id=None):
-        url = self.api_url + '/v2/project/' + self.api_key + '/session/' + session_id
+        url = self.api_url + "/v2/project/" + self.api_key + "/session/" + session_id
 
         if connection_id:
-            url += '/connection/' + connection_id
+            url += "/connection/" + connection_id
 
-        url += '/signal'
+        url += "/signal"
         return url
 
     def get_stream_url(self, session_id, stream_id=None):
         """ this method returns the url to get streams information """
-        url = self.api_url + '/v2/project/' + self.api_key + '/session/' + session_id + '/stream'
+        url = (
+            self.api_url
+            + "/v2/project/"
+            + self.api_key
+            + "/session/"
+            + session_id
+            + "/stream"
+        )
         if stream_id:
-            url = url + '/' + stream_id
+            url = url + "/" + stream_id
         return url
 
     def force_disconnect_url(self, session_id, connection_id):
         """ this method returns the force disconnect url endpoint """
         url = (
-            self.api_url + '/v2/project/' + self.api_key + '/session/' +
-            session_id + '/connection/' + connection_id
+            self.api_url
+            + "/v2/project/"
+            + self.api_key
+            + "/session/"
+            + session_id
+            + "/connection/"
+            + connection_id
         )
         return url
 
     def set_archive_layout_url(self, archive_id):
         """ this method returns the url to set the archive layout """
-        url = self.api_url + '/v2/project/' + self.api_key + '/archive/' + archive_id + '/layout'
+        url = (
+            self.api_url
+            + "/v2/project/"
+            + self.api_key
+            + "/archive/"
+            + archive_id
+            + "/layout"
+        )
         return url
 
     def dial_url(self):
         """ this method returns the url to initialize a SIP call """
-        url = self.api_url + '/v2/project/' + self.api_key + '/dial'
+        url = self.api_url + "/v2/project/" + self.api_key + "/dial"
         return url
 
     def set_stream_class_lists_url(self, session_id):
         """ this method returns the url to set the stream class list """
-        url = self.api_url + '/v2/project/' + self.api_key + '/session/' + session_id + '/stream'
+        url = (
+            self.api_url
+            + "/v2/project/"
+            + self.api_key
+            + "/session/"
+            + session_id
+            + "/stream"
+        )
         return url
 
     def broadcast_url(self, broadcast_id=None, stop=False, layout=False):
         """ this method returns urls for working with broadcast """
-        url = self.api_url + '/v2/project/' + self.api_key + '/broadcast'
+        url = self.api_url + "/v2/project/" + self.api_key + "/broadcast"
 
         if broadcast_id:
-            url = url + '/' + broadcast_id
+            url = url + "/" + broadcast_id
         if stop:
-            url = url + '/stop'
+            url = url + "/stop"
         if layout:
-            url = url + '/layout'
+            url = url + "/layout"
         return url

opentok/exceptions.py

@@ -1,74 +1,90 @@
 class OpenTokException(Exception):
-    """Defines exceptions thrown by the OpenTok SDK.
-    """
+    """Defines exceptions thrown by the OpenTok SDK."""
+
     pass
 
 
 class RequestError(OpenTokException):
     """Indicates an error during the request. Most likely an error connecting
     to the OpenTok API servers. (HTTP 500 error).
     """
+
     pass
 
 
 class AuthError(OpenTokException):
     """Indicates that the problem was likely with credentials. Check your API
     key and API secret and try again.
     """
+
     pass
 
 
 class NotFoundError(OpenTokException):
     """Indicates that the element requested was not found.  Check the parameters
     of the request.
     """
+
     pass
 
 
 class ArchiveError(OpenTokException):
     """Indicates that there was a archive specific problem, probably the status
     of the requested archive is invalid.
     """
+
     pass
 
+
 class SignalingError(OpenTokException):
     """Indicates that there was a signaling specific problem, one of the parameter
     is invalid or the type|data string doesn't have a correct size"""
+
     pass
 
+
 class GetStreamError(OpenTokException):
     """Indicates that the data in the request is invalid, or the session_id or stream_id
     are invalid"""
+
     pass
 
+
 class ForceDisconnectError(OpenTokException):
     """
     Indicates that there was a force disconnect specific problem:
     One of the arguments is invalid or the client specified by the connectionId property
     is not connected to the session
     """
+
     pass
 
+
 class SipDialError(OpenTokException):
     """
     Indicates that there was a SIP dial specific problem:
     The Session ID passed in is invalid or you attempt to start a SIP call for a session
     that does not use the OpenTok Media Router.
     """
+
     pass
 
+
 class SetStreamClassError(OpenTokException):
     """
     Indicates that there is invalid data in the JSON request.
     It may also indicate that invalid layout options have been passed
     """
+
     pass
 
+
 class BroadcastError(OpenTokException):
     """
     Indicates that data in your request data is invalid JSON. It may also indicate
     that you passed in invalid layout options. Or you have exceeded the limit of five
     simultaneous RTMP streams for an OpenTok session. Or you specified and invalid resolution.
     Or The broadcast has already started for the session
     """
+
     pass