Refactor Python v2 & v3 Compatibility Mechanism

Remove Six dependency by leveraging additional capabilities of the
Future package and refactoring unicode type checking and use.

Author: cmlccie

ciscosparkapi/__init__.py

@@ -2,9 +2,16 @@
 """Python API wrapper for the Cisco Spark APIs."""
 
 
-from __future__ import absolute_import
-from builtins import object
-from six import string_types
+# Use future for Python v2 and v3 compatibility
+from __future__ import (
+    absolute_import,
+    division,
+    print_function,
+    unicode_literals,
+)
+from builtins import *
+
+from past.builtins import basestring
 
 import os
 
@@ -91,10 +98,10 @@ def __init__(self, access_token=None, base_url=DEFAULT_BASE_URL,
         via one of these two methods.
 
         Args:
-            access_token(string_types): The access token to be used for API
+            access_token(str): The access token to be used for API
                 calls to the Cisco Spark service.  Defaults to checking for a
                 SPARK_ACCESS_TOKEN environment variable.
-            base_url(string_types): The base URL to be prefixed to the
+            base_url(str): The base URL to be prefixed to the
                 individual API endpoint suffixes.
                 Defaults to ciscosparkapi.DEFAULT_BASE_URL.
             timeout(int): Timeout (in seconds) for RESTful HTTP requests.
@@ -111,8 +118,8 @@ def __init__(self, access_token=None, base_url=DEFAULT_BASE_URL,
 
         """
         # Process args
-        assert access_token is None or isinstance(access_token, string_types)
-        assert isinstance(base_url, string_types)
+        assert access_token is None or isinstance(access_token, basestring)
+        assert isinstance(base_url, str)
         assert isinstance(timeout, int)
         spark_access_token = os.environ.get(ACCESS_TOKEN_ENVIRONMENT_VARIABLE)
         access_token = access_token if access_token else spark_access_token

ciscosparkapi/api/__init__.py

@@ -0,0 +1 @@
+# -*- coding: utf-8 -*-

ciscosparkapi/api/accesstokens.py

@@ -10,10 +10,16 @@
 """
 
 
+# Use future for Python v2 and v3 compatibility
+from __future__ import (
+    absolute_import,
+    division,
+    print_function,
+    unicode_literals,
+)
+from builtins import *
 from future import standard_library
 standard_library.install_aliases()
-from builtins import object
-from six import string_types
 
 import urllib.parse
 
@@ -44,7 +50,7 @@ def __init__(self, json):
         """Init a new AccessToken data object from a JSON dictionary or string.
 
         Args:
-            json(dict, string_types): Input JSON object.
+            json(dict, str): Input JSON object.
 
         Raises:
             TypeError: If the input object is not a dictionary or string.
@@ -85,14 +91,14 @@ def __init__(self, base_url, timeout=None):
         """Init a new AccessTokensAPI object with the provided RestSession.
 
         Args:
-            base_url(string_types): The base URL the API endpoints.
+            base_url(str): The base URL the API endpoints.
             timeout(int): Timeout in seconds for the API requests.
 
         Raises:
             AssertionError: If the parameter types are incorrect.
 
         """
-        assert isinstance(base_url, string_types)
+        assert isinstance(base_url, str)
         assert timeout is None or isinstance(timeout, int)
         super(AccessTokensAPI, self).__init__()
         self._base_url = str(validate_base_url(base_url))
@@ -116,13 +122,13 @@ def get(self, client_id, client_secret, code, redirect_uri):
         invoke the APIs.
 
         Args:
-            client_id(string_types): Provided when you created your
+            client_id(str): Provided when you created your
                 integration.
-            client_secret(string_types): Provided when you created your
+            client_secret(str): Provided when you created your
                 integration.
-            code(string_types): The Authorization Code provided by the user
+            code(str): The Authorization Code provided by the user
                 OAuth process.
-            redirect_uri(string_types): The redirect URI used in the user OAuth
+            redirect_uri(str): The redirect URI used in the user OAuth
                 process.
 
         Returns:
@@ -135,10 +141,10 @@ def get(self, client_id, client_secret, code, redirect_uri):
 
         """
         # Process args
-        assert isinstance(client_id, string_types)
-        assert isinstance(client_secret, string_types)
-        assert isinstance(code, string_types)
-        assert isinstance(redirect_uri, string_types)
+        assert isinstance(client_id, str)
+        assert isinstance(client_secret, str)
+        assert isinstance(code, str)
+        assert isinstance(redirect_uri, str)
         # Build request parameters
         data = {}
         data["grant_type"] = "authorization_code"
@@ -158,11 +164,11 @@ def refresh(self, client_id, client_secret, refresh_token):
         """Return a refreshed Access Token via the provided refresh_token.
 
         Args:
-            client_id(string_types): Provided when you created your
+            client_id(str): Provided when you created your
                 integration.
-            client_secret(string_types): Provided when you created your
+            client_secret(str): Provided when you created your
                 integration.
-            refresh_token(string_types): Provided when you requested the Access
+            refresh_token(str): Provided when you requested the Access
                 Token.
 
         Returns:
@@ -175,9 +181,9 @@ def refresh(self, client_id, client_secret, refresh_token):
 
         """
         # Process args
-        assert isinstance(client_id, string_types)
-        assert isinstance(client_secret, string_types)
-        assert isinstance(refresh_token, string_types)
+        assert isinstance(client_id, str)
+        assert isinstance(client_secret, str)
+        assert isinstance(refresh_token, str)
         # Build request parameters
         data = {}
         data["grant_type"] = "refresh_token"

ciscosparkapi/api/licenses.py

@@ -9,8 +9,14 @@
 """
 
 
-from builtins import object
-from six import string_types
+# Use future for Python v2 and v3 compatibility
+from __future__ import (
+    absolute_import,
+    division,
+    print_function,
+    unicode_literals,
+)
+from builtins import *
 
 from ciscosparkapi.utils import generator_container
 from ciscosparkapi.restsession import RestSession
@@ -30,7 +36,7 @@ def __init__(self, json):
         """Init a new License data object from a dict or JSON string.
 
         Args:
-            json(dict, string_types): Input JSON object.
+            json(dict, str): Input JSON object.
 
         Raises:
             TypeError: If the input object is not a dictionary or string.
@@ -99,7 +105,7 @@ def list(self, orgId=None, max=None):
         container.
 
         Args:
-            orgId(string_types): Filters the returned licenses to only include
+            orgId(str): Filters the returned licenses to only include
                 those liceses associated with the specified Organization
                 (orgId).
             max(int): Limits the maximum number of entries returned from the
@@ -116,7 +122,7 @@ def list(self, orgId=None, max=None):
 
         """
         # Process args
-        assert orgId is None or isinstance(orgId, string_types)
+        assert orgId is None or isinstance(orgId, str)
         assert max is None or isinstance(max, int)
         params = {}
         if orgId:
@@ -133,7 +139,7 @@ def get(self, licenseId):
         """Get the details of a License, by id.
 
         Args:
-            licenseId(string_types): The id of the License.
+            licenseId(str): The id of the License.
 
         Returns:
             License: With the details of the requested License.
@@ -144,7 +150,7 @@ def get(self, licenseId):
 
         """
         # Process args
-        assert isinstance(licenseId, string_types)
+        assert isinstance(licenseId, str)
         # API request
         json_obj = self._session.get('licenses/' + licenseId)
         # Return a License object created from the returned JSON object

ciscosparkapi/api/memberships.py

@@ -10,8 +10,14 @@
 """
 
 
-from builtins import object
-from six import string_types
+# Use future for Python v2 and v3 compatibility
+from __future__ import (
+    absolute_import,
+    division,
+    print_function,
+    unicode_literals,
+)
+from builtins import *
 
 from ciscosparkapi.exceptions import ciscosparkapiException
 from ciscosparkapi.utils import generator_container
@@ -32,7 +38,7 @@ def __init__(self, json):
         """Init a new Membership data object from a JSON dictionary or string.
 
         Args:
-            json(dict, string_types): Input JSON object.
+            json(dict, str): Input JSON object.
 
         Raises:
             TypeError: If the input object is not a dictionary or string.
@@ -120,10 +126,10 @@ def list(self, roomId=None, personId=None, personEmail=None, max=None):
         container.
 
         Args:
-            roomId(string_types): List memberships for the room with roomId.
-            personId(string_types): Filter results to include only those with
+            roomId(str): List memberships for the room with roomId.
+            personId(str): Filter results to include only those with
                 personId.
-            personEmail(string_types): Filter results to include only those
+            personEmail(str): Filter results to include only those
                 with personEmail.
             max(int): Limits the maximum number of memberships returned from
                 the Spark service per request.
@@ -141,9 +147,9 @@ def list(self, roomId=None, personId=None, personEmail=None, max=None):
 
         """
         # Process args
-        assert roomId is None or isinstance(roomId, string_types)
-        assert personId is None or isinstance(personId, string_types)
-        assert personEmail is None or isinstance(personEmail, string_types)
+        assert roomId is None or isinstance(roomId, str)
+        assert personId is None or isinstance(personId, str)
+        assert personEmail is None or isinstance(personEmail, str)
         assert max is None or isinstance(max, int)
         params = {}
         if roomId:
@@ -174,10 +180,10 @@ def create(self, roomId, personId=None, personEmail=None,
         making them a moderator.
 
         Args:
-            roomId(string_types): ID of the room to which the person will be
+            roomId(str): ID of the room to which the person will be
                 added.
-            personId(string_types): ID of the person to be added to the room.
-            personEmail(string_types): Email address of the person to be added
+            personId(str): ID of the person to be added to the room.
+            personEmail(str): Email address of the person to be added
                 to the room.
             isModerator(bool): If True, adds the person as a moderator for the
                 room. If False, adds the person as normal member of the room.
@@ -193,9 +199,9 @@ def create(self, roomId, personId=None, personEmail=None,
 
         """
         # Process args
-        assert isinstance(roomId, string_types)
-        assert personId is None or isinstance(personId, string_types)
-        assert personEmail is None or isinstance(personEmail, string_types)
+        assert isinstance(roomId, str)
+        assert personId is None or isinstance(personId, str)
+        assert personEmail is None or isinstance(personEmail, str)
         assert isModerator is None or isinstance(isModerator, bool)
         post_data = {}
         post_data['roomId'] = roomId
@@ -217,7 +223,7 @@ def get(self, membershipId):
         """Get details for a membership by ID.
 
         Args:
-            membershipId(string_types): The membershipId of the membership.
+            membershipId(str): The membershipId of the membership.
 
         Returns:
             Membership: With the details of the requested membership.
@@ -228,7 +234,7 @@ def get(self, membershipId):
 
         """
         # Process args
-        assert isinstance(membershipId, string_types)
+        assert isinstance(membershipId, str)
         # API request
         json_obj = self._session.get('memberships/' + membershipId)
         # Return a Membership object created from the response JSON data
@@ -238,7 +244,7 @@ def update(self, membershipId, **update_attributes):
         """Update details for a membership.
 
         Args:
-            membershipId(string_types): The membershipId of the membership to
+            membershipId(str): The membershipId of the membership to
                 be updated.
             isModerator(bool): If True, sets the person as a moderator for the
                 room. If False, removes the person as a moderator for the room.
@@ -253,7 +259,7 @@ def update(self, membershipId, **update_attributes):
 
         """
         # Process args
-        assert isinstance(membershipId, string_types)
+        assert isinstance(membershipId, str)
         # Process update_attributes keyword arguments
         if not update_attributes:
             error_message = "At least one **update_attributes keyword " \
@@ -269,7 +275,7 @@ def delete(self, membershipId):
         """Delete a membership, by ID.
 
         Args:
-            membershipId(string_types): The membershipId of the membership to
+            membershipId(str): The membershipId of the membership to
                 be deleted.
 
         Raises:
@@ -278,6 +284,6 @@ def delete(self, membershipId):
 
         """
         # Process args
-        assert isinstance(membershipId, string_types)
+        assert isinstance(membershipId, str)
         # API request
         self._session.delete('memberships/' + membershipId)