Add python3 compatibility with working tests.

pgcrypto/base.py

@@ -2,10 +2,10 @@
 __version__ = '.'.join(str(i) for i in __version_info__)
 
 import base64
-import datetime
-import decimal
 import struct
 
+from django.utils import six
+
 CRC24_INIT = 0xB704CE
 CRC24_POLY = 0x1864CFB
 
@@ -110,7 +110,7 @@ def pad(text, block_size, zero=False):
     by pgcrypto. See http://www.di-mgt.com.au/cryptopad.html for more information.
     """
     num = block_size - (len(text) % block_size)
-    ch = '\0' if zero else chr(num)
+    ch = b'\0' if zero else six.b(chr(num))
     return text + (ch * num)
 
 def aes_pad_key(key):

pgcrypto/fields.py

@@ -3,7 +3,7 @@
 from django.conf import settings
 from django.core import validators
 from django.db import models
-from django.utils import timezone
+from django.utils import timezone, six
 from django.utils.translation import ugettext_lazy as _
 from .base import armor, dearmor, pad, unpad, aes_pad_key
 import datetime
@@ -21,8 +21,8 @@ def __init__(self, *args, **kwargs):
         self.cipher_key = kwargs.pop('key', getattr(settings, 'PGCRYPTO_DEFAULT_KEY', ''))
         self.charset = 'utf-8'
         if self.cipher_name == 'AES':
-            self.cipher_key = aes_pad_key(self.cipher_key)
-        mod = __import__('Crypto.Cipher', globals(), locals(), [self.cipher_name], -1)
+            self.cipher_key = aes_pad_key(self.cipher_key.encode(self.charset))
+        mod = __import__('Crypto.Cipher', globals(), locals(), [self.cipher_name], 0)
         self.cipher_class = getattr(mod, self.cipher_name)
         self.check_armor = kwargs.pop('check_armor', True)
         super(BaseEncryptedField, self).__init__(*args, **kwargs)
@@ -36,7 +36,7 @@ def south_field_triple(self):
         """
         from south.modelsinspector import introspector
         args, kwargs = introspector(self)
-        return ("django.db.models.fields.TextField", args, kwargs)
+        return "django.db.models.fields.TextField", args, kwargs
 
     def deconstruct(self):
         """
@@ -62,7 +62,7 @@ def is_encrypted(self, value):
         """
         Returns whether the given value is encrypted (and armored) or not.
         """
-        return isinstance(value, basestring) and value.startswith('-----BEGIN')
+        return isinstance(value, six.string_types) and value.startswith('-----BEGIN')
 
     def to_python(self, value):
         if self.is_encrypted(value):
@@ -71,7 +71,8 @@ def to_python(self, value):
             #    2. Decrypt the bytestring using the specified cipher.
             #    3. Unpad the bytestring using the cipher's block size.
             #    4. Decode the bytestring to a unicode string using the specified charset.
-            return unpad(self.get_cipher().decrypt(dearmor(value, verify=self.check_armor)), self.cipher_class.block_size).decode(self.charset)
+            return unpad(self.get_cipher().decrypt(dearmor(value, verify=self.check_armor)),
+                         self.cipher_class.block_size).decode(self.charset)
         return value or ''
 
     def get_db_prep_save(self, value, connection):
@@ -82,12 +83,12 @@ def get_db_prep_save(self, value, connection):
             #    3. Pad the bytestring for encryption, using the cipher's block size.
             #    4. Encrypt the padded bytestring using the specified cipher.
             #    5. Armor the encrypted bytestring for storage in the text field.
-            return armor(self.get_cipher().encrypt(pad(unicode(value).encode(self.charset), self.cipher_class.block_size)))
+            return armor(self.get_cipher().encrypt(pad(six.text_type(value).encode(self.charset),
+                                                       self.cipher_class.block_size)))
         return value or ''
 
 
-class EncryptedTextField (BaseEncryptedField):
-    __metaclass__ = models.SubfieldBase
+class EncryptedTextField (six.with_metaclass(models.SubfieldBase, BaseEncryptedField)):
     description = _('Text')
 
     def formfield(self, **kwargs):
@@ -96,8 +97,7 @@ def formfield(self, **kwargs):
         return super(EncryptedTextField, self).formfield(**defaults)
 
 
-class EncryptedCharField (BaseEncryptedField):
-    __metaclass__ = models.SubfieldBase
+class EncryptedCharField (six.with_metaclass(models.SubfieldBase, BaseEncryptedField)):
     description = _('String')
 
     def __init__(self, **kwargs):
@@ -113,8 +113,7 @@ def formfield(self, **kwargs):
         return super(EncryptedCharField, self).formfield(**defaults)
 
 
-class EncryptedIntegerField (BaseEncryptedField):
-    __metaclass__ = models.SubfieldBase
+class EncryptedIntegerField (six.with_metaclass(models.SubfieldBase, BaseEncryptedField)):
     description = _('Integer')
     field_cast = '::integer'
 
@@ -129,8 +128,7 @@ def to_python(self, value):
         return value
 
 
-class EncryptedDecimalField (BaseEncryptedField):
-    __metaclass__ = models.SubfieldBase
+class EncryptedDecimalField (six.with_metaclass(models.SubfieldBase, BaseEncryptedField)):
     description = _('Decimal number')
     field_cast = '::numeric'
 
@@ -145,8 +143,7 @@ def to_python(self, value):
         return value
 
 
-class EncryptedDateField (BaseEncryptedField):
-    __metaclass__ = models.SubfieldBase
+class EncryptedDateField (six.with_metaclass(models.SubfieldBase, BaseEncryptedField)):
     description = _('Date (without time)')
     field_cast = '::date'
 
@@ -187,8 +184,7 @@ def _get_auto_now_value(self):
         return datetime.date.today()
 
 
-class EncryptedDateTimeField (EncryptedDateField):
-    __metaclass__ = models.SubfieldBase
+class EncryptedDateTimeField (six.with_metaclass(models.SubfieldBase, EncryptedDateField)):
     description = _('Date (with time)')
     field_cast = 'timestamp with time zone'
 
@@ -204,15 +200,14 @@ def _get_auto_now_value(self):
         return timezone.now()
 
 
-class EncryptedEmailField (BaseEncryptedField):
-    __metaclass__ = models.SubfieldBase
+class EncryptedEmailField (six.with_metaclass(models.SubfieldBase, BaseEncryptedField)):
     default_validators = [validators.validate_email]
     description = _('Email address')
 
     def formfield(self, **kwargs):
         defaults = {'form_class': forms.EmailField}
         defaults.update(kwargs)
-        return super(EncryptedCharField, self).formfield(**defaults)
+        return super(EncryptedEmailField, self).formfield(**defaults)
 
 
 if django.VERSION >= (1, 7):

setup.py

@@ -12,13 +12,15 @@
     packages=find_packages(),
     install_requires=[
         'pycrypto>=2.6',
+        'Django>=1.6',
     ],
     classifiers=[
         'Development Status :: 5 - Production/Stable',
         'Framework :: Django',
         'Intended Audience :: Developers',
         'License :: OSI Approved :: BSD License',
-        'Programming Language :: Python',
+        'Programming Language :: Python :: 2',
+        'Programming Language :: Python :: 3',
         'Topic :: Database',
     ]
 )

tests/core/models.py

@@ -1,11 +1,15 @@
 from django.db import models
+from django.utils.encoding import python_2_unicode_compatible
+
 import pgcrypto
 
+
+@python_2_unicode_compatible
 class Employee (models.Model):
     name = models.CharField(max_length=200)
     ssn = pgcrypto.EncryptedCharField()
     salary = pgcrypto.EncryptedDecimalField()
     date_hired = pgcrypto.EncryptedDateField(cipher='Blowfish', key='datekey')
 
-    def __unicode__(self):
+    def __str__(self):
         return self.name

tests/core/tests.py

@@ -28,7 +28,7 @@ def setUp(self):
 
     def test_encrypt(self):
         c = Blowfish.new('pass', Blowfish.MODE_CBC, self.iv_blowfish)
-        self.assertEqual(c.encrypt(pad('sensitive information', c.block_size)), self.encrypt_bf)
+        self.assertEqual(c.encrypt(pad(b'sensitive information', c.block_size)), self.encrypt_bf)
 
     def test_decrypt(self):
         c = Blowfish.new('pass', Blowfish.MODE_CBC, self.iv_blowfish)
@@ -39,11 +39,11 @@ def test_armor_dearmor(self):
         self.assertEqual(dearmor(a), self.encrypt_bf)
 
     def test_aes(self):
-        c = AES.new(aes_pad_key('pass'), AES.MODE_CBC, self.iv_aes)
-        self.assertEqual(c.encrypt(pad('sensitive information', c.block_size)), self.encrypt_aes)
+        c = AES.new(aes_pad_key(b'pass'), AES.MODE_CBC, self.iv_aes)
+        self.assertEqual(c.encrypt(pad(b'sensitive information', c.block_size)), self.encrypt_aes)
 
     def test_aes_pad(self):
-        c = AES.new(aes_pad_key('secret'), AES.MODE_CBC, self.iv_aes)
+        c = AES.new(aes_pad_key(b'secret'), AES.MODE_CBC, self.iv_aes)
         self.assertEqual(unpad(c.decrypt(self.encrypt_aes_padded), c.block_size), b'xxxxxxxxxxxxxxxx')
 
 class FieldTests (TestCase):
@@ -56,7 +56,7 @@ def setUp(self):
 
     def test_query(self):
         fixture_path = os.path.join(os.path.dirname(__file__), 'fixtures', 'employees.json')
-        for obj in json.load(open(fixture_path, 'rb')):
+        for obj in json.load(open(fixture_path, 'r')):
             if obj['model'] == 'core.employee':
                 e = Employee.objects.get(ssn=obj['fields']['ssn'])
                 self.assertEqual(e.pk, int(obj['pk']))