Enhance future support for Python 3 compatibility

.travis.yml

@@ -30,7 +30,7 @@ before_script:
 script:
 - bin/code-analysis
 - bin/test
-- bin/pylint --py3k --disable=no-absolute-import sc/social/like || true
+- bin/pylint --py3k --disable=no-absolute-import sc/social/like
 after_success:
 - bin/zopepy setup.py check -mrs
 - pip install coverage

CHANGES.rst

@@ -6,6 +6,10 @@ There's a frood who really knows where his towel is.
 2.13b4 (unreleased)
 ^^^^^^^^^^^^^^^^^^^
 
+- Code refactor to increase future Python 3 compatibility;
+  add dependency on `six <https://pypi.python.org/pypi/six>`_.
+  [hvelarde]
+
 - Fix upgrade step when there are no plone.app.tiles recrods.
   [erral]
 

sc/social/like/plugins/facebook/browser.py

@@ -4,6 +4,7 @@
 More information:
 * https://developers.facebook.com/docs/plugins
 """
+from six.moves.urllib.parse import urlencode  # noqa: I001
 from Acquisition import aq_inner
 from plone import api
 from Products.Five import BrowserView
@@ -13,7 +14,6 @@
 from sc.social.like.interfaces import ISocialLikeSettings
 from sc.social.like.plugins.facebook.utils import facebook_language
 from sc.social.like.utils import get_language
-from urllib import urlencode
 
 
 class PluginView(BrowserView):

sc/social/like/plugins/facebook/utils.py

@@ -42,5 +42,6 @@ def facebook_language(languages, default):
         return default
     languages = [languages] if not isinstance(languages, list) else languages
     languages = [fix_iso(l) for l in languages]
-    prefered = [l for l in languages if l in FB_LOCALES]
+    # XXX: https://github.com/PyCQA/pylint/issues/2106
+    prefered = [l for l in languages if l in FB_LOCALES]  # noqa: E501; pylint: disable=comprehension-escape
     return prefered and prefered[0] or default

sc/social/like/plugins/gplus/browser.py

@@ -4,13 +4,13 @@
 More information:
 * https://developers.google.com/+/web/share/
 """
+from six.moves.urllib.parse import urlencode  # noqa: I001
 from Acquisition import aq_inner
 from plone import api
 from Products.Five import BrowserView
 from Products.Five.browser.pagetemplatefile import ViewPageTemplateFile
 from sc.social.like.interfaces import ISocialLikeSettings
 from sc.social.like.utils import get_language
-from urllib import urlencode
 
 
 class PluginView(BrowserView):

sc/social/like/plugins/linkedin/browser.py

@@ -5,13 +5,13 @@
 * https://developer.linkedin.com/plugins/share
 * https://developer.linkedin.com/docs/share-on-linkedin
 """
+from six.moves.urllib.parse import urlencode  # noqa: I001
 from Acquisition import aq_inner
 from plone import api
 from Products.Five import BrowserView
 from Products.Five.browser.pagetemplatefile import ViewPageTemplateFile
 from sc.social.like.interfaces import ISocialLikeSettings
 from sc.social.like.utils import get_language
-from urllib import urlencode
 
 
 class PluginView(BrowserView):

sc/social/like/plugins/pinterest/browser.py

@@ -5,13 +5,13 @@
 * https://developers.pinterest.com/docs/widgets/save/
 * https://developers.pinterest.com/docs/rich-pins/reference/
 """
+from six.moves.urllib.parse import urlencode  # noqa: I001
 from Acquisition import aq_inner
 from plone import api
 from Products.Five import BrowserView
 from Products.Five.browser.pagetemplatefile import ViewPageTemplateFile
 from sc.social.like.interfaces import ISocialLikeSettings
 from sc.social.like.utils import get_content_image
-from urllib import urlencode
 
 
 class PluginView(BrowserView):

sc/social/like/plugins/twitter/browser.py

@@ -5,14 +5,14 @@
 * https://dev.twitter.com/web/tweet-button
 * https://dev.twitter.com/web/overview/privacy
 """
+from six.moves.urllib.parse import urlencode  # noqa: I001
 from Acquisition import aq_inner
 from plone import api
 from Products.Five import BrowserView
 from Products.Five.browser.pagetemplatefile import ViewPageTemplateFile
 from sc.social.like.behaviors import ISocialMedia
 from sc.social.like.config import IS_PLONE_5
 from sc.social.like.interfaces import ISocialLikeSettings
-from urllib import urlencode
 
 
 class PluginView(BrowserView):

sc/social/like/subscribers.py

@@ -25,7 +25,6 @@
 from sc.social.like.utils import validate_og_lead_image
 from sc.social.like.utils import validate_og_title
 from zope.component import getUtility
-from zope.schema.interfaces import WrongType
 
 import requests
 import traceback
@@ -57,10 +56,10 @@ def social_media_record_synchronizer(event):
     if not IS_PLONE_5:
         return
 
-    logger.debug(u'Processing: ' + repr(event.record))
+    logger.debug('Processing: ' + repr(event.record))
     field = event.record.fieldName
     if field not in FIELDS:
-        logger.debug(u'Field name not being tracked')
+        logger.debug('Field name not being tracked')
         return
 
     # find out which record we need to synchronize
@@ -73,16 +72,12 @@ def social_media_record_synchronizer(event):
         # Plone record modified; synchronize sc.social.like record
         record = ISocialLikeSettings.__identifier__ + '.' + field
     else:
-        logger.debug(u'Schema not being tracked')
+        logger.debug('Schema not being tracked')
         return
 
     registry = getUtility(IRegistry)
     # this will fire the aditional IRecordModifiedEvent
-    try:
-        registry[record] = str(event.record.value)
-    except WrongType:
-        # Plone 5 declares records as TextLine
-        registry[record] = unicode(event.record.value)
+    registry[record] = str(event.record.value)
 
     logger.debug('{0} was synchronized; new value is "{1}"'.format(
         repr(registry.records[record]), event.record.value))
@@ -138,19 +133,19 @@ def check_sharing_best_practices(obj, event):
     try:
         validate_og_title(title)
     except ValueError as e:
-        api.portal.show_message(message=e.message, request=request, type='warning')
+        api.portal.show_message(message=str(e), request=request, type='warning')
 
     description = getattr(obj, 'description', '')
     try:
         validate_og_description(description)
     except ValueError as e:
-        api.portal.show_message(message=e.message, request=request, type='warning')
+        api.portal.show_message(message=str(e), request=request, type='warning')
 
     image = get_content_image(obj)
     try:
         validate_og_lead_image(image)
     except ValueError as e:
-        api.portal.show_message(message=e.message, request=request, type='warning')
+        api.portal.show_message(message=str(e), request=request, type='warning')
 
 
 def facebook_prefetching(obj, event):
@@ -176,7 +171,7 @@ def facebook_prefetching(obj, event):
     try:
         r = requests.post(endpoint, timeout=5)
     except requests.exceptions.RequestException as e:
-        logger.warn('Prefetch failure: ' + str(e.message))
+        logger.warn('Prefetch failure: ' + str(e))
         return
 
     if r.status_code == '200':

sc/social/like/tests/test_subscribers.py

@@ -67,12 +67,7 @@ def test_modify_social_like_settings(self):
 
     @unittest.skipIf(not IS_PLONE_5, 'This test is for Plone 5 only')
     def test_modify_plone_settings(self):
-        from zope.schema.interfaces import WrongType
-        try:
-            self.registry['plone.twitter_username'] = 'hvelarde'
-        except WrongType:
-            # in Plone 5.0 this field type was TextLine
-            self.registry['plone.twitter_username'] = u'hvelarde'
+        self.registry['plone.twitter_username'] = 'hvelarde'
         self.assertEqual(self.settings.twitter_username, 'hvelarde')
         # changing other fields don't break anything
         self.registry['plone.share_social_data'] = False

sc/social/like/tests/test_upgrades.py

@@ -1,4 +1,5 @@
 # -*- coding: utf-8 -*-
+from six.moves import range  # noqa: I001
 from plone import api
 from plone.registry.interfaces import IRegistry
 from sc.social.like.config import IS_PLONE_5
@@ -189,7 +190,7 @@ def test_register_cover_tiles(self):
         self.execute_upgrade_step(step)
 
         registered = api.portal.get_registry_record('plone.app.tiles')
-        [self.assertIn(t, registered) for t in TILES]
+        [self.assertIn(t, registered) for t in TILES]  # noqa: E501; pylint: disable=W1662
 
 
 class To3042TestCase(UpgradeTestCaseBase):
@@ -308,7 +309,7 @@ def test_reindex_catalog(self):
         from sc.social.like.behaviors import ISocialMedia
         from sc.social.like.tests.utils import enable_social_media_behavior
         with api.env.adopt_roles(['Manager']):
-            for i in xrange(0, 10):
+            for i in range(0, 10):
                 api.content.create(self.portal, 'News Item', str(i))
 
         # break the catalog by deleting an object without notifying

sc/social/like/tests/test_utils.py

@@ -64,7 +64,7 @@ def test_validate_og_title_invalid(self):
         try:
             validate_og_description(title)
         except ValueError as e:
-            self.assertEqual(e.message, MSG_INVALID_OG_TITLE)
+            self.assertEqual(str(e), MSG_INVALID_OG_TITLE)
 
     def test_validate_og_description_valid(self):
         self.assertTrue(validate_og_description(None))
@@ -83,7 +83,7 @@ def test_validate_og_description_invalid(self):
         try:
             validate_og_description(description)
         except ValueError as e:
-            self.assertEqual(e.message, MSG_INVALID_OG_DESCRIPTION)
+            self.assertEqual(str(e), MSG_INVALID_OG_DESCRIPTION)
 
     def test_validate_og_lead_image_no_image(self):
         self.assertTrue(validate_og_lead_image(None))
@@ -105,7 +105,7 @@ def test_validate_og_lead_image_invalid_mime_type(self):
         try:
             validate_og_lead_image(image)
         except ValueError as e:
-            self.assertEqual(e.message, MSG_INVALID_OG_LEAD_IMAGE_MIME_TYPE)
+            self.assertEqual(str(e), MSG_INVALID_OG_LEAD_IMAGE_MIME_TYPE)
 
     def test_validate_og_lead_image_invalid_size(self):
         from sc.social.like.config import OG_LEAD_IMAGE_MAX_SIZE
@@ -121,7 +121,7 @@ def test_validate_og_lead_image_invalid_size(self):
         try:
             validate_og_lead_image(image)
         except ValueError as e:
-            self.assertEqual(e.message, MSG_INVALID_OG_LEAD_IMAGE_SIZE)
+            self.assertEqual(str(e), MSG_INVALID_OG_LEAD_IMAGE_SIZE)
 
     def test_validate_og_lead_image_invalid_dimensions(self):
         from sc.social.like.utils import MSG_INVALID_OG_LEAD_IMAGE_DIMENSIONS
@@ -135,7 +135,7 @@ def test_validate_og_lead_image_invalid_dimensions(self):
         try:
             validate_og_lead_image(image)
         except ValueError as e:
-            self.assertEqual(e.message, MSG_INVALID_OG_LEAD_IMAGE_DIMENSIONS)
+            self.assertEqual(str(e), MSG_INVALID_OG_LEAD_IMAGE_DIMENSIONS)
 
     def test_validate_og_lead_image_invalid_aspect_ratio(self):
         from sc.social.like.utils import MSG_INVALID_OG_LEAD_IMAGE_ASPECT_RATIO
@@ -149,7 +149,7 @@ def test_validate_og_lead_image_invalid_aspect_ratio(self):
         try:
             validate_og_lead_image(image)
         except ValueError as e:
-            self.assertEqual(e.message, MSG_INVALID_OG_LEAD_IMAGE_ASPECT_RATIO)
+            self.assertEqual(str(e), MSG_INVALID_OG_LEAD_IMAGE_ASPECT_RATIO)
 
 
 def load_tests(loader, tests, pattern):

sc/social/like/tests/test_viewlets.py

@@ -1,4 +1,5 @@
 # -*- coding: utf-8 -*-
+from six.moves import range  # noqa: I001
 from plone import api
 from profilehooks import profile
 from profilehooks import timecall
@@ -27,10 +28,10 @@ def capture():
     http://stackoverflow.com/a/10743550/644075
     """
     import sys
-    from cStringIO import StringIO
+    from io import BytesIO
     oldout, olderr = sys.stdout, sys.stderr
     try:
-        out = [StringIO(), StringIO()]
+        out = [BytesIO(), BytesIO()]
         sys.stdout, sys.stderr = out
         yield out
     finally:
@@ -131,7 +132,7 @@ def test_metadata_viewlet_rendering_performance(self):
 
         @timecall(immediate=True)
         def render(times):
-            for i in xrange(0, times):
+            for i in range(0, times):
                 viewlet.render()
 
         with capture() as out:
@@ -143,7 +144,7 @@ def render(times):
         # show rendering profile
         @profile
         def render(times):
-            for i in xrange(0, times):
+            for i in range(0, times):
                 viewlet.render()
 
         render(times)
@@ -211,7 +212,7 @@ def test_social_viewlet_rendering_performance(self):
 
         @timecall(immediate=True)
         def render(times):
-            for i in xrange(0, times):
+            for i in range(0, times):
                 viewlet.render()
 
         with capture() as out:
@@ -223,7 +224,7 @@ def render(times):
         # show rendering profile
         @profile
         def render(times):
-            for i in xrange(0, times):
+            for i in range(0, times):
                 viewlet.render()
 
         render(times)

sc/social/like/tests/utils.py

@@ -1,4 +1,5 @@
 # -*- coding: utf-8 -*-
+from six.moves import range  # noqa: I001
 from plone.dexterity.interfaces import IDexterityFTI
 from plone.dexterity.schema import SchemaInvalidatedEvent
 from sc.social.like.behaviors import ISocialMedia
@@ -18,7 +19,7 @@ def enable_social_media_behavior():
 def get_random_string(length):
     from random import choice
     from string import printable
-    return ''.join(choice(printable) for i in xrange(0, length))
+    return ''.join(choice(printable) for i in range(0, length))
 
 
 def get_file(filename):

sc/social/like/tiles/facebook.py

@@ -4,6 +4,7 @@
 For additional implementation detail see:
 https://developers.facebook.com/docs/plugins/page-plugin
 """
+from six.moves.urllib.parse import urlencode  # noqa: I001
 from collective.cover.tiles.base import IPersistentCoverTile
 from collective.cover.tiles.base import PersistentCoverTile
 from plone import api
@@ -12,7 +13,6 @@
 from Products.Five.browser.pagetemplatefile import ViewPageTemplateFile
 from sc.social.like import LikeMessageFactory as _
 from sc.social.like.interfaces import ISocialLikeSettings
-from urllib import urlencode
 # from z3c.form.browser.checkbox import CheckBoxFieldWidget
 from zope import schema
 from zope.interface import implementer