BACKWARDS INCOMPATIBLE CHANGE: Renamed the module from filter to django_filters, now it doesn't contend with the Python builtin filter.

Author: alex

MANIFEST.in

@@ -2,5 +2,5 @@ include AUTHORS.txt
 include COPYRIGHT
 include README.txt
 recursive-include docs *
-recursive-include filter/fixtures *
-recursive-include filter/tests/templates/filter *
+recursive-include django_filters/fixtures *
+recursive-include django_filters/tests/templates/django_filters *

README.txt

@@ -7,9 +7,9 @@ admin's ``list_filter`` interface.  It has an API very similar to Django's
 ``ModelForms``.  For example if you had a Product model you could have a
 filterset for it with the code::
 
-    import filter
+    import django_filters
 
-    class ProductFilterSet(filter.FilterSet):
+    class ProductFilterSet(django_filters.FilterSet):
         class Meta:
             model = Product
             fields = ['name', 'price', 'manufacturer']

django_filters/__init__.py

@@ -0,0 +1,2 @@
+from django_filters.filterset import FilterSet
+from django_filters.filters import *

filter/fields.py renamed to django_filters/fields.py

@@ -1,17 +1,17 @@
 from django import forms
 
-from filter.widgets import RangeWidget, LookupTypeWidget
+from django_filters.widgets import RangeWidget, LookupTypeWidget
 
 class RangeField(forms.MultiValueField):
     widget = RangeWidget
-    
+
     def __init__(self, *args, **kwargs):
         fields = (
             forms.DecimalField(),
             forms.DecimalField(),
         )
         super(RangeField, self).__init__(fields, *args, **kwargs)
-    
+
     def compress(self, data_list):
         if data_list:
             return slice(*data_list)
@@ -29,6 +29,6 @@ def __init__(self, field, lookup_choices, *args, **kwargs):
         widget = LookupTypeWidget(**defaults)
         kwargs['widget'] = widget
         super(LookupTypeField, self).__init__(fields, *args, **kwargs)
-    
+
     def compress(self, data_list):
         return data_list

filter/filters.py renamed to django_filters/filters.py

@@ -5,7 +5,7 @@
 from django.db.models.sql.constants import QUERY_TERMS
 from django.utils.translation import ugettext_lazy as _
 
-from filter.fields import RangeField, LookupTypeField
+from django_filters.fields import RangeField, LookupTypeField
 
 __all__ = [
     'Filter', 'CharFilter', 'BooleanFilter', 'ChoiceFilter',

filter/filterset.py renamed to django_filters/filterset.py

@@ -5,8 +5,8 @@
 from django.utils.datastructures import SortedDict
 from django.utils.text import capfirst
 
-from filter.filters import Filter, CharFilter, BooleanFilter, ChoiceFilter, \
-    DateFilter, DateTimeFilter, TimeFilter, ModelChoiceFilter, \
+from django_filters.filters import Filter, CharFilter, BooleanFilter, \
+    ChoiceFilter, DateFilter, DateTimeFilter, TimeFilter, ModelChoiceFilter, \
     ModelMultipleChoiceFilter, NumberFilter
 
 ORDER_BY_FIELD = 'o'

django_filters/fixtures/test_data.json

@@ -0,0 +1 @@
+[{"pk": 1, "model": "django_filters.user", "fields": {"username": "alex", "status": 1, "first_name": "", "last_name": "", "favorite_books": [1, 2], "is_active": false}}, {"pk": 2, "model": "django_filters.user", "fields": {"username": "aaron", "status": 0, "first_name": "", "last_name": "", "favorite_books": [1, 3], "is_active": false}}, {"pk": 3, "model": "django_filters.user", "fields": {"username": "jacob", "status": 0, "first_name": "", "last_name": "", "favorite_books": [], "is_active": true}}, {"pk": 1, "model": "django_filters.comment", "fields": {"date": "2009-01-30", "text": "super awesome!", "time": "03:04:05", "author": 1}}, {"pk": 2, "model": "django_filters.comment", "fields": {"date": "2009-01-27", "text": "psycadelic!", "time": "05:04:03", "author": 2}}, {"pk": 3, "model": "django_filters.comment", "fields": {"date": "2008-12-31", "text": "funky fresh!", "time": "12:55:00", "author": 3}}, {"pk": 1, "model": "django_filters.book", "fields": {"average_rating": 4.7999999999999998, "price": "10", "title": "Ender's Game"}}, {"pk": 2, "model": "django_filters.book", "fields": {"average_rating": 4.5999999999999996, "price": "15", "title": "Rainbox Six"}}, {"pk": 3, "model": "django_filters.book", "fields": {"average_rating": 4.2999999999999998, "price": "20", "title": "Snowcrash"}}]

filter/models.py renamed to django_filters/models.py

@@ -0,0 +1,7 @@
+from django.conf.urls.defaults import *
+
+from django_filters.models import Book
+
+urlpatterns = patterns('',
+    (r'^books/$', 'django_filters.views.object_filter', {'model': Book}),
+)

filter/tests/__init__.py renamed to django_filters/tests/__init__.py

@@ -4,12 +4,12 @@
 from django.conf import settings
 from django.test import TestCase
 
-import filter
-from filter.models import User, Comment, Book, Restaurant, Article, STATUS_CHOICES
+import django_filters
+from django_filters.models import User, Comment, Book, Restaurant, Article, STATUS_CHOICES
 
 
 class GenericViewTests(TestCase):
-    urls = 'filter.tests.test_urls'
+    urls = 'django_filters.tests.test_urls'
     fixtures = ['test_data']
     template_dirs = [
         os.path.join(os.path.dirname(__file__), 'templates'),
@@ -29,7 +29,7 @@ def test_generic_view(self):
 
 class InheritanceTest(TestCase):
     def test_inheritance(self):
-        class F(filter.FilterSet):
+        class F(django_filters.FilterSet):
             class Meta:
                 model = Book
 
@@ -39,13 +39,13 @@ class G(F):
 
 class ModelInheritanceTest(TestCase):
     def test_abstract(self):
-        class F(filter.FilterSet):
+        class F(django_filters.FilterSet):
             class Meta:
                 model = Restaurant
 
         self.assertEquals(set(F.base_filters), set(['name', 'serves_pizza']))
 
-        class F(filter.FilterSet):
+        class F(django_filters.FilterSet):
             class Meta:
                 model = Restaurant
                 fields = ['name', 'serves_pizza']
@@ -56,8 +56,8 @@ class Meta:
 class DateRangeFilterTest(TestCase):
     def test_filter(self):
         a = Article.objects.create(published=datetime.datetime.today())
-        class F(filter.FilterSet):
-            published = filter.DateRangeFilter()
+        class F(django_filters.FilterSet):
+            published = django_filters.DateRangeFilter()
             class Meta:
                 model = Article
         f = F({'published': '2'})
@@ -66,7 +66,7 @@ class Meta:
 
 class FilterSetForm(TestCase):
     def test_prefix(self):
-        class F(filter.FilterSet):
+        class F(django_filters.FilterSet):
             class Meta:
                 model = Restaurant
                 fields = ['name']
@@ -77,10 +77,10 @@ class Meta:
 >>> from datetime import datetime
 >>> from django import forms
 >>> from django.core.management import call_command
->>> import filter
->>> from filter import FilterSet
->>> from filter.widgets import LinkWidget
->>> from filter.models import User, Comment, Book, STATUS_CHOICES
+>>> import django_filters
+>>> from django_filters import FilterSet
+>>> from django_filters.widgets import LinkWidget
+>>> from django_filters.models import User, Comment, Book, STATUS_CHOICES
 
 >>> call_command('loaddata', 'test_data', verbosity=0)
 
@@ -114,7 +114,7 @@ class Meta:
 </select></td></tr>
 
 >>> class F(FilterSet):
-...     status = filter.ChoiceFilter(widget=forms.RadioSelect, choices=STATUS_CHOICES)
+...     status = django_filters.ChoiceFilter(widget=forms.RadioSelect, choices=STATUS_CHOICES)
 ...     class Meta:
 ...         model = User
 ...         fields = ['status']
@@ -145,7 +145,7 @@ class Meta:
 <tr><th><label for="id_username">Username:</label></th><td><input type="text" name="username" value="alex" id="id_username" /></td></tr>
 
 >>> class F(FilterSet):
-...     username = filter.CharFilter(action=lambda qs, value: qs.filter(**{'username__startswith': value}))
+...     username = django_filters.CharFilter(action=lambda qs, value: qs.filter(**{'username__startswith': value}))
 ...     class Meta:
 ...         model = User
 ...         fields = ['username']
@@ -155,7 +155,7 @@ class Meta:
 [<User: alex>, <User: aaron>]
 
 >>> class F(FilterSet):
-...     status = filter.MultipleChoiceFilter(choices=STATUS_CHOICES)
+...     status = django_filters.MultipleChoiceFilter(choices=STATUS_CHOICES)
 ...     class Meta:
 ...         model = User
 ...         fields = ['status']
@@ -248,7 +248,7 @@ class Meta:
 </select></td></tr>
 
 >>> class F(FilterSet):
-...     price = filter.NumberFilter(lookup_type='lt')
+...     price = django_filters.NumberFilter(lookup_type='lt')
 ...     class Meta:
 ...         model = Book
 ...         fields = ['price']
@@ -273,7 +273,7 @@ class Meta:
 >>> f.qs
 [<User: alex>, <User: aaron>, <User: jacob>]
 >>> class F(FilterSet):
-...     average_rating = filter.NumberFilter(lookup_type='gt')
+...     average_rating = django_filters.NumberFilter(lookup_type='gt')
 ...     class Meta:
 ...         model = Book
 ...         fields = ['average_rating']
@@ -292,7 +292,7 @@ class Meta:
 [<Comment: jacob said funky fresh!>]
 
 >>> class F(FilterSet):
-...     price = filter.RangeFilter()
+...     price = django_filters.RangeFilter()
 ...     class Meta:
 ...         model = Book
 ...         fields = ['price']
@@ -306,7 +306,7 @@ class Meta:
 [<Book: Ender's Game>, <Book: Rainbox Six>]
 
 >>> class F(FilterSet):
-...     price = filter.NumberFilter(lookup_type=None)
+...     price = django_filters.NumberFilter(lookup_type=None)
 ...     class Meta:
 ...         model = Book
 ...         fields = ['price']
@@ -337,7 +337,7 @@ class Meta:
 <option value="year">year</option>
 </select></td></tr>
 >>> class F(FilterSet):
-...     price = filter.NumberFilter(lookup_type=['lt', 'gt'])
+...     price = django_filters.NumberFilter(lookup_type=['lt', 'gt'])
 ...     class Meta:
 ...         model = Book
 ...         fields = ['price']
@@ -358,7 +358,7 @@ class Meta:
 [<Book: Ender's Game>, <Book: Rainbox Six>, <Book: Snowcrash>]
 
 >>> class F(FilterSet):
-...     status = filter.ChoiceFilter(widget=LinkWidget, choices=STATUS_CHOICES)
+...     status = django_filters.ChoiceFilter(widget=LinkWidget, choices=STATUS_CHOICES)
 ...     class Meta:
 ...         model = User
 ...         fields = ['status']
@@ -380,7 +380,7 @@ class Meta:
 </ul></td></tr>
 
 >>> class F(FilterSet):
-...     date = filter.DateRangeFilter(widget=LinkWidget)
+...     date = django_filters.DateRangeFilter(widget=LinkWidget)
 ...     class Meta:
 ...         model = Comment
 ...         fields = ['date']
@@ -468,7 +468,7 @@ class Meta:
 [<User: alex>, <User: aaron>, <User: jacob>]
 
 >>> class F(FilterSet):
-...     price = filter.NumberFilter(lookup_type=['lt', 'gt', 'exact'])
+...     price = django_filters.NumberFilter(lookup_type=['lt', 'gt', 'exact'])
 ...     class Meta:
 ...         model = Book
 ...         fields = ['price']

filter/tests/templates/filter/book_filter.html renamed to django_filters/tests/templates/django_filters/book_filter.html

@@ -1,7 +1,7 @@
 from django.shortcuts import render_to_response
 from django.template import RequestContext
 
-from filter.filterset import FilterSet
+from django_filters.filterset import FilterSet
 
 def object_filter(request, model=None, queryset=None, template_name=None, extra_context=None,
     context_processors=None, filter_class=None):

django_filters/tests/test_urls.py

@@ -1,5 +1,5 @@
 Installing django-filter
 ------------------------
 
-To install, simply place the ``filter`` directory somehwere on your ``PYTHONPATH``,
-and then add ``'filter'`` to your ``INSTALLED_APPS``.
+To install, simply place the ``django_filters`` directory somehwere on your
+``PYTHONPATH``, and then add ``'django_filters'`` to your ``INSTALLED_APPS``.

filter/tests/tests.py renamed to django_filters/tests/tests.py

@@ -95,9 +95,9 @@ argument.
 The django.form Widget class which will represent the ``Filter``.  In addition
 to the widgets that are included with Django that you can use there are
 additional ones that django-filte provides which may be useful:
-    * ``filter.widgets.LinkWidget`` -- this displays the options in a mannner
-      similar to the way the Django Admin does, as a series of links.  The
-      link for the selected option will have ``class="selected"``.
+    * ``django_filters.widgets.LinkWidget`` -- this displays the options in a
+      mannner similar to the way the Django Admin does, as a series of links.
+      The link for the selected option will have ``class="selected"``.
 
 ``action``
 ~~~~~~~~~~

filter/views.py renamed to django_filters/views.py

@@ -18,9 +18,9 @@ model::
 We have a number of fields and we want to let our users filter based on the
 price or the release_date.  We create a ``FilterSet`` for this::
 
-    import filter
+    import django_filters
 
-    class ProductFilter(filter.FilterSet):
+    class ProductFilter(django_filters.FilterSet):
         class Meta:
             model = Product
             fields = ['price', 'release_date']
@@ -30,10 +30,10 @@ As you can see this uses a very similar API to Django's ``ModelForm``.  Just
 like with a ``ModelForm`` we can also overide filters, or add new ones using a
 declarative syntax::
 
-    import filter
+    import django_filters
 
-    class ProductFilter(filter.FilterSet):
-        price = filter.NumberFilter(lookup_type='lt')
+    class ProductFilter(django_filters.FilterSet):
+        price = django_filters.NumberFilter(lookup_type='lt')
         class Meta:
             model = Product
             fields = ['price', 'release_date']
@@ -47,7 +47,7 @@ Filters also take any arbitrary keyword arguments which get passed onto the
 in ``Filter.extra``, so it's possible to overide the constructor of a
 ``FilterSet`` to add extra ones::
 
-    class ProductFilterSet(filter.FilterSet):
+    class ProductFilterSet(django_filters.FilterSet):
         class Meta:
             model = Product
             fields = ['manufacturer']
@@ -103,6 +103,6 @@ Generic View
 ============
 
 In addition to the above usage there is also a generic view included in
-django-filter, which lives at ``filter.view.object_filter``.  You must provide
-either a ``model`` or ``filter_class`` argument, similar to the
+django-filter, which lives at ``django_filters.view.object_filter``.  You must
+provide either a ``model`` or ``filter_class`` argument, similar to the
 ``create_update`` view in Django itself.

filter/widgets.py renamed to django_filters/widgets.py

@@ -23,11 +23,11 @@
         'Framework :: Django',
     ],
     package_data = {
-        'filter': [
+        'django_filters': [
             'fixtures/*.json',
         ],
-        'filter.tests': [
-            'templates/filter/*.html',
+        'django_filters.tests': [
+            'templates/django_filters/*.html',
         ]
     },
     zip_safe=False,