Port to Python 3

.travis.yml

@@ -2,6 +2,7 @@ language: python
 python:
     - 2.7
     - 3.4
+    - 3.5
     - 3.6
 install:
     - python bootstrap.py

README.txt

@@ -10,7 +10,7 @@ To get started do::
 The server will come up on port 8080. You can create a new key encrypting key
 using::
 
-  $ wget https://localhost:8080/new -O kek.dat --ca-certificate sample.pem \
+  $ wget https://localhost:8080/new -O kek.dat --ca-certificate sample.crt \
          --post-data=""
 
 or, if you want a more convenient tool::
@@ -21,7 +21,7 @@ The data encryption key can now be retrieved by posting the KEK to another
 URL::
 
   $ wget https://localhost:8080/key --header 'Content-Type: text/plain' \
-         --post-file kek.dat -O datakey.dat --ca-certificate sample.pem
+         --post-file kek.dat -O datakey.dat --ca-certificate sample.crt
 
 or ::
 

generate-sample-cert.sh

@@ -1,4 +1,3 @@
 #!/bin/sh
 openssl genrsa 1024 > sample.key
-openssl req -new -x509 -nodes -sha1 -days 3650 -key sample.key > sample.crt
-cat sample.crt sample.key > sample.pem
+openssl req -new -x509 -nodes -sha256 -days 3650 -key sample.key > sample.crt

setup.py

@@ -43,6 +43,13 @@ def read(*rnames):
         'Intended Audience :: Developers',
         'License :: OSI Approved :: Zope Public License',
         'Programming Language :: Python',
+        'Programming Language :: Python :: 2',
+        'Programming Language :: Python :: 2.7',
+        'Programming Language :: Python :: 3',
+        'Programming Language :: Python :: 3.4',
+        'Programming Language :: Python :: 3.5',
+        'Programming Language :: Python :: 3.6',
+        'Programming Language :: Python :: Implementation :: CPython',
         'Natural Language :: English',
         'Operating System :: OS Independent',
         'Topic :: Internet :: WWW/HTTP'],
@@ -62,6 +69,7 @@ def read(*rnames):
         'pyramid',
         'pyramid_zcml',
         'setuptools',
+        'six',
         'transaction',
         'zope.interface',
         'zope.schema',

src/keas/kmi/README.txt

@@ -93,7 +93,7 @@ We can also encrypt data given by a file descriptor
 
   >>> import tempfile
   >>> tmp_file = tempfile.TemporaryFile()
-  >>> data=b"encryptioniscool"*24*1024
+  >>> data = b"encryptioniscool"*24*1024
   >>> pos = tmp_file.write(data)
   >>> pos = tmp_file.seek(0)
   >>> encrypted_file = tempfile.TemporaryFile()
@@ -103,7 +103,7 @@ We can also encrypt data given by a file descriptor
 And decrypt the file
 
   >>> decrypted_file = tempfile.TemporaryFile()
-  >>> pos =encrypted_file.seek(0)
+  >>> pos = encrypted_file.seek(0)
   >>> keys.decrypt_file(key, encrypted_file, decrypted_file)
   >>> encrypted_file.close()
 

src/keas/kmi/_compat.py

@@ -0,0 +1,59 @@
+##############################################################################
+#
+# Copyright (c) 2013 Zope Foundation and Contributors.
+# All Rights Reserved.
+#
+# This software is subject to the provisions of the Zope Public License,
+# Version 2.1 (ZPL).  A copy of the ZPL should accompany this distribution.
+# THIS SOFTWARE IS PROVIDED "AS IS" AND ANY AND ALL EXPRESS OR IMPLIED
+# WARRANTIES ARE DISCLAIMED, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
+# WARRANTIES OF TITLE, MERCHANTABILITY, AGAINST INFRINGEMENT, AND FITNESS
+# FOR A PARTICULAR PURPOSE
+#
+##############################################################################
+import sys
+from six import PY3
+
+# This code was copied from ZODB/_compat.py
+
+if not PY3:
+    # Python 2.x
+    # PyPy's cPickle doesn't have noload, and noload is broken in Python 2.7,
+    # so we need zodbpickle.
+    # Get the fastest working version we can (PyPy has no fastpickle)
+    try:
+        import zodbpickle.fastpickle as cPickle
+    except ImportError:
+        import zodbpickle.pickle as cPickle
+    Pickler = cPickle.Pickler
+    Unpickler = cPickle.Unpickler
+else:
+    # Python 3.x: can't use stdlib's pickle because
+    # http://bugs.python.org/issue6784
+    import zodbpickle.pickle
+
+    class Pickler(zodbpickle.pickle.Pickler):
+        def __init__(self, f, protocol=None):
+            super(Pickler, self).__init__(f, protocol)
+
+    class Unpickler(zodbpickle.pickle.Unpickler):
+        def __init__(self, f):
+            super(Unpickler, self).__init__(f)
+
+        # Py3: Python 3 doesn't allow assignments to find_global,
+        # instead, find_class can be overridden
+
+        find_global = None
+
+        def find_class(self, modulename, name):
+            if self.find_global is None:
+                return super(Unpickler, self).find_class(modulename, name)
+            return self.find_global(modulename, name)
+
+
+try:
+    # XXX: why not just import BytesIO from io?
+    from cStringIO import StringIO as BytesIO
+except ImportError:
+    # Python 3.x
+    from io import BytesIO

src/keas/kmi/facility.py

@@ -37,7 +37,6 @@
 
 from hashlib import md5
 
-__docformat__ = "reStructuredText"
 
 logger = logging.getLogger('kmi')
 

src/keas/kmi/interfaces.py

@@ -18,9 +18,6 @@
 from zope.interface.common import mapping
 
 
-__docformat__ = "reStructuredText"
-
-
 class IEncryptionService(zope.interface.Interface):
     """Utility providing encryption mechanism"""
 

src/keas/kmi/keyholder.py

@@ -13,7 +13,6 @@
 ##############################################################################
 """Simple Key Holder
 """
-__docformat__ = "reStructuredText"
 from zope.interface import implementer
 from keas.kmi.interfaces import IKeyHolder
 

src/keas/kmi/persistent.py

@@ -14,7 +14,7 @@
 """Encrypted persistent objects
 """
 from __future__ import absolute_import
-from ZODB._compat import BytesIO, Pickler, Unpickler
+from keas.kmi._compat import BytesIO, Pickler, Unpickler
 import persistent
 import persistent.wref
 from zope.component import getUtility

src/keas/kmi/persistent.txt

@@ -152,7 +152,7 @@ error:
     >>> pwd.password
     Traceback (most recent call last):
       ...
-    ValueError: need more than 1 value to unpack
+    ValueError: not enough values to unpack (expected 2, got 1)
 
 But we can apply the conversion step:
 

src/keas/kmi/testclient.py

@@ -1,4 +1,3 @@
-from __future__ import print_function
 ##############################################################################
 #
 # Copyright (c) 2008 Zope Foundation and Contributors.
@@ -14,7 +13,7 @@
 ##############################################################################
 """Test client to access the KMI server API.
 """
-__docformat__ = "reStructuredText"
+from __future__ import print_function
 
 import os
 import sys
@@ -45,7 +44,8 @@ def new_key(kmf):
 
 def read_kek(kekfile):
     try:
-        return open(kekfile, 'rb').read()
+        with open(kekfile, 'rb') as fp:
+            return fp.read()
     except IOError as e:
         print("Could not read key encrypting key from %s" % kekfile, file=sys.stderr)
         print(e, file=sys.stderr)
@@ -57,7 +57,8 @@ def read_data(filename=None):
         return sys.stdin.read()
     else:
         try:
-            return open(filename, 'rb').read()
+            with open(filename, 'rb') as fp:
+                return fp.read()
         except IOError as e:
             print("Could not read %s" % filename, file=sys.stderr)
             print(e, file=sys.stderr)

src/keas/kmi/tests.py

@@ -14,12 +14,14 @@
 """Test Setup
 """
 import doctest
+import re
 import tempfile
 import transaction
 import unittest
 
 from zope.app.testing import setup
 from zope.component import provideUtility
+from zope.testing.renormalizing import RENormalizing
 
 from keas.kmi.testing import TestingKeyManagementFacility
 from keas.kmi.interfaces import IKeyManagementFacility
@@ -39,6 +41,11 @@ def tearDownPersistent(test):
 
 
 def test_suite():
+    checker = RENormalizing([
+        # fix doctest for ValueError exception on Python < 3.6
+        (re.compile(r"ValueError: need more than 1 value to unpack"),
+         "ValueError: not enough values to unpack (expected 2, got 1)")
+    ])
     return unittest.TestSuite([
         doctest.DocFileSuite(
             'README.txt',
@@ -49,5 +56,6 @@ def test_suite():
         doctest.DocFileSuite(
             'persistent.txt',
             setUp=setUpPersistent, tearDown=tearDownPersistent,
-            optionflags=doctest.NORMALIZE_WHITESPACE|doctest.ELLIPSIS),
+            optionflags=doctest.NORMALIZE_WHITESPACE|doctest.ELLIPSIS,
+            checker=checker),
     ])