Merge pull request #10 from ekohl/master

Update code with better support for newer Django.

This merge also has lots of cleanups and improvements to the tests which now uses tox. Thanks to Ewoud Kohl van Wijngaarden (@ekohl) for giving this project some much needed love :-)

.gitignore

@@ -1 +1,6 @@
 *.pyc
+.tox/
+MANIFEST
+build/
+dist/
+*.egg-info/

MANIFEST.in

@@ -0,0 +1 @@
+include README.rst

manage.py

@@ -0,0 +1,10 @@
+#!/usr/bin/env python
+import os
+import sys
+
+if __name__ == "__main__":
+    os.environ.setdefault("DJANGO_SETTINGS_MODULE", "testsettings")
+
+    from django.core.management import execute_from_command_line
+
+    execute_from_command_line(sys.argv)

netfields/__init__.py

@@ -1,3 +1,3 @@
 from netfields.managers import NetManager
 from netfields.fields import (InetAddressField, CidrAddressField,
-        MACAddressField)
+                              MACAddressField)

netfields/fields.py

@@ -5,6 +5,7 @@ from django.db import models
 from netfields.managers import NET_OPERATORS, NET_TEXT_OPERATORS
 from netfields.forms import NetAddressFormField, MACAddressFormField
 
+
 class _NetAddressField(models.Field):
     empty_strings_allowed = False
 
@@ -14,41 +15,38 @@ class _NetAddressField(models.Field):
 
     def to_python(self, value):
         if not value:
-            value = None
-
-        if value is None:
             return value
 
         return IP(value)
 
     def get_prep_lookup(self, lookup_type, value):
-        if value is None:
-            return value
+        if not value:
+            return None
 
         if (lookup_type in NET_OPERATORS and
                 NET_OPERATORS[lookup_type] not in NET_TEXT_OPERATORS):
-            return self.get_db_prep_value(value)
+            return self.get_prep_value(value)
 
         return super(_NetAddressField, self).get_prep_lookup(
             lookup_type, value)
 
-
-    def get_db_prep_value(self, value):
-        if value is None:
-            return value
+    def get_prep_value(self, value):
+        if not value:
+            return None
 
         return unicode(self.to_python(value))
 
-    def get_db_prep_lookup(self, lookup_type, value):
-        if value is None:
-            return value
+    def get_db_prep_lookup(self, lookup_type, value, connection,
+            prepared=False):
+        if not value:
+            return []
 
         if (lookup_type in NET_OPERATORS and
                 NET_OPERATORS[lookup_type] not in NET_TEXT_OPERATORS):
-            return [self.get_db_prep_value(value)]
+            return [value] if prepared else [self.get_prep_value(value)]
 
         return super(_NetAddressField, self).get_db_prep_lookup(
-            lookup_type, value)
+            lookup_type, value, connection=connection, prepared=prepared)
 
     def formfield(self, **kwargs):
         defaults = {'form_class': NetAddressFormField}
@@ -61,7 +59,7 @@ class InetAddressField(_NetAddressField):
     max_length = 39
     __metaclass__ = models.SubfieldBase
 
-    def db_type(self):
+    def db_type(self, connection):
         return 'inet'
 
 
@@ -70,7 +68,7 @@ class CidrAddressField(_NetAddressField):
     max_length = 43
     __metaclass__ = models.SubfieldBase
 
-    def db_type(self):
+    def db_type(self, connection):
         return 'cidr'
 
 
@@ -81,7 +79,7 @@ class MACAddressField(models.Field):
         kwargs['max_length'] = 17
         super(MACAddressField, self).__init__(*args, **kwargs)
 
-    def db_type(self):
+    def db_type(self, connection):
         return 'macaddr'
 
     def formfield(self, **kwargs):

netfields/forms.py

@@ -5,12 +5,14 @@ from django import forms
 from django.utils.encoding import force_unicode
 from django.utils.safestring import mark_safe
 
+
 class NetInput(forms.Widget):
     input_type = 'text'
 
     def render(self, name, value, attrs=None):
         # Default forms.Widget compares value != '' which breaks IP...
-        if value is None: value = ''
+        if value is None:
+            value = ''
         final_attrs = self.build_attrs(attrs, type=self.input_type, name=name)
         if value:
             final_attrs['value'] = force_unicode(value)
@@ -26,20 +28,18 @@ class NetAddressFormField(forms.Field):
     def __init__(self, *args, **kwargs):
         super(NetAddressFormField, self).__init__(*args, **kwargs)
 
-    def clean(self, value):
-        super(NetAddressFormField, self).clean(value)
-
-        if value in (None, ''):
+    def to_python(self, value):
+        if not value:
             return None
+
         if isinstance(value, IP):
             return value
-        try:
-            return IP(value)
-        except ValueError, e:
-            raise forms.ValidationError(e)
 
+        return self.python_type(value)
+
+
+MAC_RE = re.compile(r'^(([A-F0-9]{2}:){5}[A-F0-9]{2})$')
 
-mac_re = re.compile(r'^(([A-F0-9]{2}:){5}[A-F0-9]{2})$')
 
 class MACAddressFormField(forms.RegexField):
     default_error_messages = {
@@ -47,4 +47,4 @@ class MACAddressFormField(forms.RegexField):
     }
 
     def __init__(self, *args, **kwargs):
-        super(MACAddressFormField, self).__init__(mac_re, *args, **kwargs)
+        super(MACAddressFormField, self).__init__(MAC_RE, *args, **kwargs)

netfields/managers.py

@@ -25,13 +25,6 @@ class NetQuery(sql.Query):
     query_terms = sql.Query.query_terms.copy()
     query_terms.update(NET_OPERATORS)
 
-    def add_filter(self, (filter_string, value), *args, **kwargs):
-        # IP(...) == '' fails so make sure to force to string while we can
-        if isinstance(value, IP):
-            value = unicode(value)
-        return super(NetQuery, self).add_filter(
-            (filter_string, value), *args, **kwargs)
-
 
 class NetWhere(sql.where.WhereNode):
     def make_atom(self, child, qn, conn):
@@ -39,9 +32,10 @@ class NetWhere(sql.where.WhereNode):
 
         if hasattr(lvalue, 'process'):
             try:
-                lvalue, params = lvalue.process(lookup_type, params_or_value, connection)
-            except EmptyShortCircuit:
-                raise EmptyResultSet
+                lvalue, params = lvalue.process(lookup_type, params_or_value,
+                                                connection)
+            except sql.where.EmptyShortCircuit:
+                raise query.EmptyResultSet
         else:
             return super(NetWhere, self).make_atom(child, qn, conn)
 
@@ -57,9 +51,9 @@ class NetWhere(sql.where.WhereNode):
 
         if NET_OPERATORS.get(lookup_type, '') in NET_TEXT_OPERATORS:
             if db_type == 'inet':
-                field_sql  = 'HOST(%s)' % field_sql
+                field_sql = 'HOST(%s)' % field_sql
             else:
-                field_sql  = 'TEXT(%s)' % field_sql
+                field_sql = 'TEXT(%s)' % field_sql
 
         if isinstance(params, QueryWrapper):
             extra, params = params.data
@@ -70,17 +64,20 @@ class NetWhere(sql.where.WhereNode):
             params = (params,)
 
         if lookup_type in NET_OPERATORS:
-            return (' '.join([field_sql, NET_OPERATORS[lookup_type], extra]), params)
+            return (' '.join([field_sql, NET_OPERATORS[lookup_type], extra]),
+                    params)
         elif lookup_type == 'in':
             if not value_annot:
                 raise sql.datastructures.EmptyResultSet
             if extra:
                 return ('%s IN %s' % (field_sql, extra), params)
-            return ('%s IN (%s)' % (field_sql, ', '.join(['%s'] * len(params))), params)
+            return ('%s IN (%s)' % (field_sql, ', '.join(['%s'] *
+                    len(params))), params)
         elif lookup_type == 'range':
             return ('%s BETWEEN %%s and %%s' % field_sql, params)
         elif lookup_type == 'isnull':
-            return ('%s IS %sNULL' % (field_sql, (not value_annot and 'NOT ' or '')), params)
+            return ('%s IS %sNULL' % (field_sql, (not value_annot and 'NOT ' or
+                    '')), params)
 
         raise ValueError('Invalid lookup type "%s"' % lookup_type)
 

tests/models.py

@@ -1,41 +1,44 @@
-from IPy import IP
+from django.db.models import Model
 
-from django.db import models, connection, DEFAULT_DB_ALIAS
+from netfields import InetAddressField, CidrAddressField, MACAddressField, \
+        NetManager
 
-from netfields import *
 
-class InetTestModel(models.Model):
+class InetTestModel(Model):
     field = InetAddressField()
     objects = NetManager()
 
     class Meta:
         db_table = 'inet'
 
-class NullInetTestModel(models.Model):
+
+class NullInetTestModel(Model):
     field = InetAddressField(null=True)
     objects = NetManager()
 
     class Meta:
         db_table = 'nullinet'
 
-class CidrTestModel(models.Model):
+
+class CidrTestModel(Model):
     field = CidrAddressField()
     objects = NetManager()
 
     class Meta:
         db_table = 'cidr'
 
-class NullCidrTestModel(models.Model):
+
+class NullCidrTestModel(Model):
     field = CidrAddressField(null=True)
     objects = NetManager()
 
     class Meta:
         db_table = 'nullcidr'
 
-class MACTestModel(models.Model):
+
+class MACTestModel(Model):
     mac = MACAddressField(null=True)
     objects = NetManager()
 
     class Meta:
         db_table = 'mac'
-

tests/tests.py

@@ -1,9 +1,11 @@
-import unittest
 from IPy import IP
 
 from django.db import IntegrityError
+from django.test import TestCase
+
+from netfields.models import (CidrTestModel, InetTestModel, NullCidrTestModel,
+                              NullInetTestModel)
 
-from models import *
 
 class BaseTestCase(object):
     select = 'SELECT "table"."id", "table"."field" FROM "table" '
@@ -152,7 +154,7 @@ class BaseCidrFieldTestCase(BaseTestCase):
             self.select + 'WHERE TEXT("table"."field") ~* %s ')
 
 
-class TestInetField(BaseInetFieldTestCase, unittest.TestCase):
+class TestInetField(BaseInetFieldTestCase, TestCase):
     def setUp(self):
         self.model = InetTestModel
         self.qs = self.model.objects.all()
@@ -168,7 +170,7 @@ class TestInetField(BaseInetFieldTestCase, unittest.TestCase):
         self.assertRaises(IntegrityError, self.model().save)
 
 
-class TestInetFieldNullable(BaseInetFieldTestCase, unittest.TestCase):
+class TestInetFieldNullable(BaseInetFieldTestCase, TestCase):
     def setUp(self):
         self.model = NullInetTestModel
         self.qs = self.model.objects.all()
@@ -184,7 +186,7 @@ class TestInetFieldNullable(BaseInetFieldTestCase, unittest.TestCase):
         self.model().save()
 
 
-class TestCidrField(BaseCidrFieldTestCase, unittest.TestCase):
+class TestCidrField(BaseCidrFieldTestCase, TestCase):
     def setUp(self):
         self.model = CidrTestModel
         self.qs = self.model.objects.all()
@@ -200,7 +202,7 @@ class TestCidrField(BaseCidrFieldTestCase, unittest.TestCase):
         self.assertRaises(IntegrityError, self.model().save)
 
 
-class TestCidrFieldNullable(BaseCidrFieldTestCase, unittest.TestCase):
+class TestCidrFieldNullable(BaseCidrFieldTestCase, TestCase):
     def setUp(self):
         self.model = NullCidrTestModel
         self.qs = self.model.objects.all()

requirements.txt

@@ -0,0 +1,3 @@
+IPy
+django>=1.3
+psycopg2

setup.py

@@ -0,0 +1,42 @@
+#!/usr/bin/env python
+# -*- coding: utf-8 -*-
+from distutils.core import setup
+from setuptools import find_packages
+
+import os
+
+def get_long_description():
+    path = os.path.join(os.path.dirname(__file__), 'README.rst')
+    with open(path) as f:
+        return f.read()
+
+setup(
+    name='django-postgresql-netfields',
+    version='0.1',
+    license='BSD',
+    description='Django PostgreSQL netfields implementation',
+    long_description=get_long_description(),
+    url='https://github.com/adamcik/django-postgresql-netfields',
+
+    author=u'Thomas Admacik',
+    author_email='adamcik@samfundet.no',
+
+    packages=find_packages(),
+    include_package_data=True,
+    zip_safe=False,
+    install_requires=[
+        'IPy',
+        'django>=1.3',
+    ],
+
+    classifiers=[
+        'Development Status :: 4 - Beta',
+        'Environment :: Web Environment',
+        'Framework :: Django',
+        'Intended Audience :: Developers',
+        'License :: OSI Approved :: BSD License',
+        'Operating System :: OS Independent',
+        'Programming Language :: Python',
+        'Topic :: Utilities',
+    ],
+)

tests/settings.py

@@ -1,8 +0,0 @@
-DATABASES = {
-    'default': {
-        'ENGINE': 'django.db.backends.sqlite3',
-        'NAME': 'netfields',
-    }
-}
-
-INSTALLED_APPS = ('tests',)

testsettings.py

@@ -0,0 +1,12 @@
+DATABASES = {
+    'default': {
+        'ENGINE': 'django.db.backends.postgresql_psycopg2',
+        'NAME': 'netfields',
+    }
+}
+
+INSTALLED_APPS = (
+    'netfields',
+)
+
+SECRET_KEY = "notimportant"

tox.ini

@@ -0,0 +1,40 @@
+[tox]
+envlist=
+    py26-django13,
+    py27-django13,
+    py26-django14,
+    py27-django14,
+
+[testenv]
+commands=
+    python manage.py test
+
+# Build configurations...
+
+[testenv:py26-django13]
+basepython=python2.6
+deps=
+    IPy
+    django==1.3
+    psycopg2==2.4.1
+
+[testenv:py27-django13]
+basepython=python2.7
+deps=
+    IPy
+    django==1.3
+    psycopg2==2.4.1
+
+[testenv:py26-django14]
+basepython=python2.6
+deps=
+    IPy
+    django==1.4
+    psycopg2
+
+[testenv:py27-django14]
+basepython=python2.7
+deps=
+    IPy
+    django==1.4
+    psycopg2