Merge pull request #75 from plone/python3

Python 3 support

.travis.yml

@@ -1,5 +1,7 @@
 language: python
-python: 2.7.15
+python:
+  - 2.7
+  - 3.6
 cache:
   pip: true
   directories:
@@ -8,6 +10,12 @@ env:
   - PLONE_VERSION=4.3.x
   - PLONE_VERSION=5.0.x
   - PLONE_VERSION=5.1.x
+matrix:
+  exclude:
+    - python: 3.6
+      env: PLONE_VERSION=4.3.x
+    - python: 3.6
+      env: PLONE_VERSION=5.0.x
 before_install:
   - mkdir -p $HOME/buildout-cache/{eggs,downloads}
   - virtualenv .

CHANGES.rst

@@ -4,7 +4,8 @@ Changelog
 1.3.1 (unreleased)
 ------------------
 
-- Nothing changed yet.
+- Prepare for Python 2 / 3 compatibility
+  [tschorr,pbauer,frapell]
 
 
 1.3.0 (2018-09-11)

plone-5.1.x.cfg

@@ -7,3 +7,4 @@ extends =
 [versions]
 plone.namedfile = 4.2.3
 plone.app.event = 3.0.6
+plone.protect   = 4.0.1

setup.py

@@ -5,6 +5,7 @@
 def read(*rnames):
     return open(os.path.join(os.path.dirname(__file__), *rnames)).read()
 
+
 version = '1.3.1-dev.0'
 
 long_description = (
@@ -32,6 +33,8 @@ def read(*rnames):
           "Operating System :: OS Independent",
           "Programming Language :: Python",
           "Programming Language :: Python :: 2.7",
+          "Programming Language :: Python :: 3.6",
+          "Programming Language :: Python :: 3.7",
       ],
       keywords='',
       author='Plone Foundation',
@@ -61,6 +64,7 @@ def read(*rnames):
           'zope.traversing',
           'Products.CMFCore',
           'Zope2',
+          'six',
       ],
       entry_points="""
       # -*- Entry points: -*-

src/plone/rest/cors.py

@@ -1,6 +1,6 @@
 # -*- coding: utf-8 -*-
 from plone.rest.interfaces import ICORSPolicy
-from zope.interface import implements
+from zope.interface import implementer
 
 # CORS preflight service registry
 # A mapping of method -> service_id
@@ -18,8 +18,8 @@ def lookup_preflight_service_id(method):
         return _services[method]
 
 
+@implementer(ICORSPolicy)
 class CORSPolicy(object):
-    implements(ICORSPolicy)
 
     def __init__(self, context, request):
         self.context = context

src/plone/rest/errors.py

@@ -8,11 +8,17 @@
 from six.moves.urllib.parse import quote
 from six.moves.urllib.parse import unquote
 from zExceptions import NotFound
+try:
+    from ZPublisher.HTTPRequest import WSGIRequest
+    HAS_WSGI = True
+except ImportError:
+    HAS_WSGI = False
 from zope.component import adapter
 from zope.component import queryUtility
 from zope.component.hooks import getSite
 
 import json
+import six
 import sys
 import traceback
 
@@ -42,8 +48,12 @@ def __call__(self):
         return
 
     def render_exception(self, exception):
-        result = {u'type': type(exception).__name__.decode('utf-8'),
-                  u'message': str(exception).decode('utf-8')}
+        name = type(exception).__name__
+        message = str(exception)
+        if six.PY2:
+            name = name.decode('utf-8')
+            message = message.decode('utf-8')
+        result = {u'type': name, u'message': message}
 
         if isinstance(exception, NotFound):
             # First check if a redirect from p.a.redirector exists
@@ -65,8 +75,19 @@ def render_exception(self, exception):
     def render_traceback(self, exception):
         _, exc_obj, exc_traceback = sys.exc_info()
         if exception is not exc_obj:
-            return (u'ERROR: Another exception happened before we could '
-                    u'render the traceback.')
+            if HAS_WSGI and \
+               isinstance(self.request, WSGIRequest) and \
+               str(exception) == str(exc_obj):
+                # WSGIRequest may "upgrade" the exception,
+                # resulting in a new exception which has
+                # the same string representation as the
+                # original exception.
+                # https://github.com/plone/Products.CMFPlone/issues/2474
+                # https://github.com/plone/plone.rest/commit/96599cc3bb3ef5a23b10eb585781d88274fbcaf5#comments
+                pass
+            else:
+                return (u'ERROR: Another exception happened before we could '
+                        u'render the traceback.')
 
         raw = '\n'.join(traceback.format_tb(exc_traceback))
         return raw.strip().split('\n')

src/plone/rest/service.py

@@ -2,11 +2,11 @@
 from plone.rest.interfaces import ICORSPolicy
 from plone.rest.interfaces import IService
 from zope.component import queryMultiAdapter
-from zope.interface import implements
+from zope.interface import implementer
 
 
+@implementer(IService)
 class Service(object):
-    implements(IService)
 
     def __call__(self):
         policy = queryMultiAdapter((self.context, self.request), ICORSPolicy)

src/plone/rest/testing.py

@@ -41,7 +41,7 @@ def setUpZope(self, app, configurationContext):
 class InternalServerErrorService(Service):
 
     def __call__(self):
-        from urllib2 import HTTPError
+        from six.moves.urllib.error import HTTPError
         raise HTTPError(
             'http://nohost/plone/500-internal-server-error',
             500,

src/plone/rest/tests/test_dexterity.py

@@ -116,11 +116,13 @@ def test_dexterity_news_item_get(self):
             'text/html'
         )
         image_file = os.path.join(os.path.dirname(__file__), u'image.png')
+        fd = open(image_file, 'rb')
         self.portal.newsitem.image = NamedBlobImage(
-            data=open(image_file, 'r').read(),
+            data=fd.read(),
             contentType='image/png',
             filename=u'image.png'
         )
+        fd.close()
         self.portal.newsitem.image_caption = u'This is an image caption.'
         import transaction
         transaction.commit()
@@ -176,11 +178,13 @@ def test_dexterity_file_get(self):
         pdf_file = os.path.join(
             os.path.dirname(__file__), u'file.pdf'
         )
+        fd = open(pdf_file, 'rb')
         self.portal.file.file = NamedBlobFile(
-            data=open(pdf_file, 'r').read(),
+            data=fd.read(),
             contentType='application/pdf',
             filename=u'file.pdf'
         )
+        fd.close()
         intids = getUtility(IIntIds)
         file_id = intids.getId(self.portal.file)
         self.portal.file.file = RelationValue(file_id)
@@ -202,11 +206,13 @@ def test_dexterity_image_get(self):
         self.portal.image.title = 'My Image'
         self.portal.image.description = u'This is an image'
         image_file = os.path.join(os.path.dirname(__file__), u'image.png')
+        fd = open(image_file, 'rb')
         self.portal.image.image = NamedBlobImage(
-            data=open(image_file, 'r').read(),
+            data=fd.read(),
             contentType='image/png',
             filename=u'image.png'
         )
+        fd.close()
         import transaction
         transaction.commit()
 

src/plone/rest/tests/test_error_handling.py

@@ -118,4 +118,4 @@ def test_500_traceback_only_for_manager_users(self):
         self.assertIsInstance(traceback, list)
         self.assertRegexpMatches(
             traceback[0],
-            r'^File "[^"]*", line \d*, in publish')
+            r'^File "[^"]*", line \d*, in (publish|transaction_pubevents)')

src/plone/rest/tests/test_permissions.py

@@ -41,8 +41,9 @@ def traverse(self, path='/plone', accept='application/json', method='GET'):
         request.environ['PATH_TRANSLATED'] = path
         request.environ['HTTP_ACCEPT'] = accept
         request.environ['REQUEST_METHOD'] = method
-        request._auth = 'Basic %s' % b64encode(
-            '%s:%s' % (TEST_USER_NAME, TEST_USER_PASSWORD))
+        auth = '%s:%s' % (TEST_USER_NAME, TEST_USER_PASSWORD)
+        b64auth = b64encode(auth.encode('utf8'))
+        request._auth = 'Basic %s' % b64auth.decode('utf8')
         notify(PubStart(request))
         return request.traverse(path)
 

src/plone/rest/tests/test_redirects.py

@@ -38,7 +38,7 @@ def test_get_to_moved_item_causes_301_redirect(self):
         self.assertEqual(301, response.status_code)
         self.assertEqual(self.portal_url + '/folder-new',
                          response.headers['Location'])
-        self.assertEqual(u'', response.text)
+        self.assertEqual(b'', response.raw.read())
 
     def test_post_to_moved_item_causes_308_redirect(self):
         response = requests.post(
@@ -50,7 +50,7 @@ def test_post_to_moved_item_causes_308_redirect(self):
         self.assertEqual(308, response.status_code)
         self.assertEqual(self.portal_url + '/folder-new',
                          response.headers['Location'])
-        self.assertEqual(u'', response.text)
+        self.assertEqual(b'', response.raw.read())
 
     def test_unauthorized_request_to_item_still_redirects_first(self):
         response = requests.get(
@@ -65,7 +65,7 @@ def test_unauthorized_request_to_item_still_redirects_first(self):
         self.assertEqual(301, response.status_code)
         self.assertEqual(self.portal_url + '/folder-new',
                          response.headers['Location'])
-        self.assertEqual(u'', response.text)
+        self.assertEqual(b'', response.raw.read())
 
         # Following the redirect then leads to an item that will produce a 401
         response = requests.get(
@@ -86,7 +86,7 @@ def test_query_string_gets_preserved(self):
         self.assertEqual(301, response.status_code)
         self.assertEqual(self.portal_url + '/folder-new?key=value',
                          response.headers['Location'])
-        self.assertEqual(u'', response.text)
+        self.assertEqual(b'', response.raw.read())
 
     def test_named_service_on_moved_item_causes_301_redirect(self):
         response = requests.get(
@@ -98,7 +98,7 @@ def test_named_service_on_moved_item_causes_301_redirect(self):
         self.assertEqual(301, response.status_code)
         self.assertEqual(self.portal_url + '/folder-new/namedservice',
                          response.headers['Location'])
-        self.assertEqual(u'', response.text)
+        self.assertEqual(b'', response.raw.read())
 
     def test_named_service_plus_path_parameter_works(self):
         response = requests.get(
@@ -110,7 +110,7 @@ def test_named_service_plus_path_parameter_works(self):
         self.assertEqual(301, response.status_code)
         self.assertEqual(self.portal_url + '/folder-new/namedservice/param',
                          response.headers['Location'])
-        self.assertEqual(u'', response.text)
+        self.assertEqual(b'', response.raw.read())
 
     def test_redirects_for_regular_views_still_work(self):
         response = requests.get(
@@ -122,7 +122,7 @@ def test_redirects_for_regular_views_still_work(self):
         self.assertEqual(301, response.status_code)
         self.assertEqual(self.portal_url + '/folder-new/@@some-view',
                          response.headers['Location'])
-        self.assertEqual(u'', response.text)
+        self.assertEqual(b'', response.raw.read())
 
     def test_redirects_for_views_plus_params_plus_querystring_works(self):
         response = requests.get(
@@ -134,7 +134,7 @@ def test_redirects_for_views_plus_params_plus_querystring_works(self):
         self.assertEqual(301, response.status_code)
         self.assertEqual(self.portal_url + '/folder-new/@@some-view/param?k=v',
                          response.headers['Location'])
-        self.assertEqual(u'', response.text)
+        self.assertEqual(b'', response.raw.read())
 
     def test_doesnt_cause_redirect_loop_on_bogus_storage_entries(self):
         storage = queryUtility(IRedirectionStorage)
@@ -164,7 +164,7 @@ def test_handles_redirects_that_include_querystring_in_old_path(self):
         self.assertEqual(301, response.status_code)
         self.assertEqual(self.portal_url + '/new-item',
                          response.headers['Location'])
-        self.assertEqual(u'', response.text)
+        self.assertEqual(b'', response.raw.read())
 
     def test_aborts_redirect_checks_early_for_app_root(self):
         error_view = ErrorHandling(self.portal, self.portal.REQUEST)

src/plone/rest/tests/test_traversal.py

@@ -32,8 +32,9 @@ def traverse(self, path='/plone', accept='application/json', method='GET'):
         request.environ['PATH_TRANSLATED'] = path
         request.environ['HTTP_ACCEPT'] = accept
         request.environ['REQUEST_METHOD'] = method
-        request._auth = 'Basic %s' % b64encode(
-            '%s:%s' % (SITE_OWNER_NAME, SITE_OWNER_PASSWORD))
+        auth = '%s:%s' % (SITE_OWNER_NAME, SITE_OWNER_PASSWORD)
+        b64auth = b64encode(auth.encode('utf8'))
+        request._auth = 'Basic %s' % b64auth.decode('utf8')
         notify(PubStart(request))
         return request.traverse(path)
 

src/plone/rest/traverse.py

@@ -1,18 +1,18 @@
 # -*- coding: utf-8 -*-
+from Products.CMFPlone.interfaces.siteroot import IPloneSiteRoot
 from Products.SiteAccess.VirtualHostMonster import VirtualHostMonster
 from ZPublisher.BaseRequest import DefaultPublishTraverse
 from plone.rest.interfaces import IAPIRequest
 from plone.rest.interfaces import IService
-from zope.component import adapts
+from zope.component import adapter
 from zope.component import queryMultiAdapter
-from zope.interface import implements
+from zope.interface import implementer
 from zope.publisher.interfaces.browser import IBrowserPublisher
 from Products.CMFCore.interfaces import IContentish
-from Products.CMFCore.interfaces import ISiteRoot
 
 
+@adapter(IPloneSiteRoot, IAPIRequest)
 class RESTTraverse(DefaultPublishTraverse):
-    adapts(ISiteRoot, IAPIRequest)
 
     def publishTraverse(self, request, name):
         try:
@@ -51,10 +51,10 @@ def browserDefault(self, request):
         return self.context, (request._rest_service_id,)
 
 
+@implementer(IBrowserPublisher)
 class RESTWrapper(object):
     """A wrapper for objects traversed during a REST request.
     """
-    implements(IBrowserPublisher)
 
     def __init__(self, context, request):
         self.context = context