Update django-filter to v1.1 (#292)

* Update Filter.name => Filter.field_name
* Bump django-filter compat to v1.1
* Bump minor version, update changelog
* Ditch detox in favor of tox
* Pin Django<2 in perf tests
* Fix warnings
* Pin versions for warnings build in 0.11.x

Author: rpkilby

.travis.yml

@@ -9,9 +9,9 @@ python:
   - "3.6"
 
 install:
-  - travis_retry pip install detox tox-travis coverage
+  - travis_retry pip install tox tox-travis coverage
 script:
-  - detox -- -v 2
+  - tox -- -v 2
 after_success:
   - coverage report
   - bash <(curl -s https://codecov.io/bash)

CHANGELOG.rst

@@ -1,6 +1,12 @@
 Unreleased:
 -----------
 
+v0.11.0
+-------
+
+This is a minor release that upgrades django-filter compatibility from ``v1.0``
+to ``v1.1``. No new functionality has been introduced.
+
 v0.10.2.post0:
 --------------
 

rest_framework_filters/filters.py

@@ -40,7 +40,7 @@ def get_queryset(self, request):
         queryset = super(RelatedFilter, self).get_queryset(request)
         assert queryset is not None, \
             "Expected `.get_queryset()` for related filter '%s.%s' to return a `QuerySet`, but got `None`." \
-            % (self.parent.__class__.__name__, self.name)
+            % (self.parent.__class__.__name__, self.field_name)
         return queryset
 
 

rest_framework_filters/filterset.py

@@ -41,7 +41,7 @@ def __new__(cls, name, bases, attrs):
                 del declared_filters[param]
 
         for param, f in six.iteritems(auto_filters):
-            opts.fields = {f.name: f.lookups or []}
+            opts.fields = {f.field_name: f.lookups or []}
 
             # patch, generate auto filters
             new_class._meta, new_class.declared_filters = opts, declared_filters
@@ -50,7 +50,7 @@ def __new__(cls, name, bases, attrs):
             # get_filters() generates param names from the model field name
             # Replace the field name with the parameter name from the filerset
             new_class.base_filters.update(OrderedDict(
-                (gen_param.replace(f.name, param, 1), gen_f)
+                (gen_param.replace(f.field_name, param, 1), gen_f)
                 for gen_param, gen_f in six.iteritems(generated_filters)
             ))
 
@@ -132,7 +132,7 @@ def expand_filters(self):
                 # modify filter names to account for relationship
                 for related_name, related_f in six.iteritems(filterset.expand_filters()):
                     related_name = LOOKUP_SEP.join([filter_name, related_name])
-                    related_f.name = LOOKUP_SEP.join([f.name, related_f.name])
+                    related_f.field_name = LOOKUP_SEP.join([f.field_name, related_f.field_name])
                     requested_filters[related_name] = related_f
 
         return requested_filters

setup.py

@@ -36,7 +36,7 @@ def get_package_data(package):
 
 setup(
     name='djangorestframework-filters',
-    version='0.10.2.post0',
+    version='0.11.0',
     url='http://github.com/philipn/django-rest-framework-filters',
     license='MIT',
     long_description=README,
@@ -48,7 +48,7 @@ def get_package_data(package):
     zip_safe=False,
     install_requires=[
         'djangorestframework',
-        'django-filter~=1.0',
+        'django-filter~=1.1',
     ],
     classifiers=[
         'Development Status :: 5 - Production/Stable',

tests/test_filtering.py

@@ -349,8 +349,8 @@ def test_relatedfilter_queryset_required(self):
         # The default behavior should not expose information, which requires users to
         # explicitly set the `queryset` argument.
         class NoteFilter(FilterSet):
-            title = filters.CharFilter(name='title')
-            author = filters.RelatedFilter(UserFilter, name='author')
+            title = filters.CharFilter(field_name='title')
+            author = filters.RelatedFilter(UserFilter, field_name='author')
 
             class Meta:
                 model = Note
@@ -376,7 +376,7 @@ class Meta:
                 fields = ['username']
 
         class NoteFilter(FilterSet):
-            author = filters.RelatedFilter(RequestCheck, name='author', queryset=User.objects.all())
+            author = filters.RelatedFilter(RequestCheck, field_name='author', queryset=User.objects.all())
 
             class Meta:
                 model = Note
@@ -389,7 +389,7 @@ class Meta:
 
     def test_validation(self):
         class F(PostFilter):
-            pk = filters.NumberFilter(name='id')
+            pk = filters.NumberFilter(field_name='id')
 
         GET = {
             'note__author': 'foo',
@@ -411,7 +411,7 @@ def test_multiwidget_incompatibility(self):
 
         # test django-filter functionality
         class PersonFilter(DFFilterSet):
-            date_joined = filters.DateFromToRangeFilter(name='date_joined')
+            date_joined = filters.DateFromToRangeFilter(field_name='date_joined')
 
             class Meta:
                 model = Person
@@ -426,7 +426,7 @@ class Meta:
 
         # test drf-filters caveat
         class PersonFilter(FilterSet):
-            date_joined = filters.DateFromToRangeFilter(name='date_joined')
+            date_joined = filters.DateFromToRangeFilter(field_name='date_joined')
 
             class Meta:
                 model = Person

tests/test_filterset.py

@@ -86,14 +86,14 @@ class Meta:
     def test_alllookupsfilter_for_related_field(self):
         # See: https://github.com/philipn/django-rest-framework-filters/issues/127
         class F(FilterSet):
-            author = filters.AllLookupsFilter(name='author__last_name')
+            author = filters.AllLookupsFilter(field_name='author__last_name')
 
             class Meta:
                 model = Note
                 fields = []
 
         self.assertIsInstance(F.base_filters['author'], filters.CharFilter)
-        self.assertEqual(F.base_filters['author'].name, 'author__last_name')
+        self.assertEqual(F.base_filters['author'].field_name, 'author__last_name')
 
     def test_relatedfilter_combined_with__all__(self):
         # ensure that related filter is compatible with __all__ lookups.

tests/testapp/filters.py

@@ -11,62 +11,62 @@
 
 
 class DFUserFilter(django_filters.FilterSet):
-    email = filters.CharFilter(name='email')
+    email = filters.CharFilter(field_name='email')
 
     class Meta:
         model = User
         fields = '__all__'
 
 
 class NoteFilterWithAll(FilterSet):
-    title = AllLookupsFilter(name='title')
+    title = AllLookupsFilter(field_name='title')
 
     class Meta:
         model = Note
         fields = []
 
 
 class UserFilter(FilterSet):
-    username = filters.CharFilter(name='username')
-    email = filters.CharFilter(name='email')
+    username = filters.CharFilter(field_name='username')
+    email = filters.CharFilter(field_name='email')
     last_login = filters.AllLookupsFilter()
-    is_active = filters.BooleanFilter(name='is_active')
+    is_active = filters.BooleanFilter(field_name='is_active')
 
     class Meta:
         model = User
         fields = []
 
 
 class UserFilterWithAll(FilterSet):
-    username = AllLookupsFilter(name='username')
-    email = filters.CharFilter(name='email')
+    username = AllLookupsFilter(field_name='username')
+    email = filters.CharFilter(field_name='email')
 
     class Meta:
         model = User
         fields = []
 
 
 class NoteFilterWithRelated(FilterSet):
-    title = filters.CharFilter(name='title')
-    author = RelatedFilter(UserFilter, name='author', queryset=User.objects.all())
+    title = filters.CharFilter(field_name='title')
+    author = RelatedFilter(UserFilter, field_name='author', queryset=User.objects.all())
 
     class Meta:
         model = Note
         fields = []
 
 
 class NoteFilterWithRelatedAll(FilterSet):
-    title = filters.CharFilter(name='title')
-    author = RelatedFilter(UserFilterWithAll, name='author', queryset=User.objects.all())
+    title = filters.CharFilter(field_name='title')
+    author = RelatedFilter(UserFilterWithAll, field_name='author', queryset=User.objects.all())
 
     class Meta:
         model = Note
         fields = []
 
 
 class NoteFilterWithRelatedAllDifferentFilterName(FilterSet):
-    title = filters.CharFilter(name='title')
-    writer = RelatedFilter(UserFilterWithAll, name='author', queryset=User.objects.all())
+    title = filters.CharFilter(field_name='title')
+    writer = RelatedFilter(UserFilterWithAll, field_name='author', queryset=User.objects.all())
 
     class Meta:
         model = Note
@@ -75,9 +75,9 @@ class Meta:
 
 class PostFilter(FilterSet):
     # Used for Related filter and Filter.method regression tests
-    note = RelatedFilter(NoteFilterWithRelatedAll, name='note', queryset=Note.objects.all())
+    note = RelatedFilter(NoteFilterWithRelatedAll, field_name='note', queryset=Note.objects.all())
     date_published = filters.AllLookupsFilter()
-    is_published = filters.BooleanFilter(name='date_published', method='filter_is_published')
+    is_published = filters.BooleanFilter(field_name='date_published', method='filter_is_published')
 
     class Meta:
         model = Post
@@ -95,68 +95,68 @@ def filter_is_published(self, qs, name, value):
 
 
 class CoverFilterWithRelatedMethodFilter(FilterSet):
-    comment = filters.CharFilter(name='comment')
-    post = RelatedFilter(PostFilter, name='post', queryset=Post.objects.all())
+    comment = filters.CharFilter(field_name='comment')
+    post = RelatedFilter(PostFilter, field_name='post', queryset=Post.objects.all())
 
     class Meta:
         model = Cover
         fields = []
 
 
 class CoverFilterWithRelated(FilterSet):
-    comment = filters.CharFilter(name='comment')
-    post = RelatedFilter(PostFilter, name='post', queryset=Post.objects.all())
+    comment = filters.CharFilter(field_name='comment')
+    post = RelatedFilter(PostFilter, field_name='post', queryset=Post.objects.all())
 
     class Meta:
         model = Cover
         fields = []
 
 
 class PageFilterWithRelated(FilterSet):
-    title = filters.CharFilter(name='title')
-    previous_page = RelatedFilter(PostFilter, name='previous_page', queryset=Post.objects.all())
+    title = filters.CharFilter(field_name='title')
+    previous_page = RelatedFilter(PostFilter, field_name='previous_page', queryset=Post.objects.all())
 
     class Meta:
         model = Page
         fields = []
 
 
 class PageFilterWithAliasedNestedRelated(FilterSet):
-    title = filters.CharFilter(name='title')
-    two_pages_back = RelatedFilter(PostFilter, name='previous_page__previous_page', queryset=Page.objects.all())
+    title = filters.CharFilter(field_name='title')
+    two_pages_back = RelatedFilter(PostFilter, field_name='previous_page__previous_page', queryset=Page.objects.all())
 
     class Meta:
         model = Page
         fields = []
 
 
 class TagFilter(FilterSet):
-    name = AllLookupsFilter(name='name')
+    name = AllLookupsFilter(field_name='name')
 
     class Meta:
         model = Tag
         fields = []
 
 
 class BlogPostFilter(FilterSet):
-    title = filters.CharFilter(name='title')
-    tags = RelatedFilter(TagFilter, name='tags', queryset=Tag.objects.all())
+    title = filters.CharFilter(field_name='title')
+    tags = RelatedFilter(TagFilter, field_name='tags', queryset=Tag.objects.all())
 
     class Meta:
         model = BlogPost
         fields = []
 
 
 class UserFilterWithDifferentName(FilterSet):
-    name = filters.CharFilter(name='username')
+    name = filters.CharFilter(field_name='username')
 
     class Meta:
         model = User
         fields = []
 
 
 class NoteFilterWithRelatedDifferentName(FilterSet):
-    author = RelatedFilter(UserFilterWithDifferentName, name='author', queryset=User.objects.all())
+    author = RelatedFilter(UserFilterWithDifferentName, field_name='author', queryset=User.objects.all())
 
     class Meta:
         model = Note
@@ -167,35 +167,35 @@ class Meta:
 # Recursive filtersets
 #############################################################
 class AFilter(FilterSet):
-    title = filters.CharFilter(name='title')
-    b = RelatedFilter('tests.testapp.filters.BFilter', name='b', queryset=B.objects.all())
+    title = filters.CharFilter(field_name='title')
+    b = RelatedFilter('tests.testapp.filters.BFilter', field_name='b', queryset=B.objects.all())
 
     class Meta:
         model = A
         fields = []
 
 
 class CFilter(FilterSet):
-    title = filters.CharFilter(name='title')
-    a = RelatedFilter(AFilter, name='a', queryset=A.objects.all())
+    title = filters.CharFilter(field_name='title')
+    a = RelatedFilter(AFilter, field_name='a', queryset=A.objects.all())
 
     class Meta:
         model = C
         fields = []
 
 
 class BFilter(FilterSet):
-    name = AllLookupsFilter(name='name')
-    c = RelatedFilter(CFilter, name='c', queryset=C.objects.all())
+    name = AllLookupsFilter(field_name='name')
+    c = RelatedFilter(CFilter, field_name='c', queryset=C.objects.all())
 
     class Meta:
         model = B
         fields = []
 
 
 class PersonFilter(FilterSet):
-    name = AllLookupsFilter(name='name')
-    best_friend = RelatedFilter('tests.testapp.filters.PersonFilter', name='best_friend', queryset=Person.objects.all())
+    name = AllLookupsFilter(field_name='name')
+    best_friend = RelatedFilter('tests.testapp.filters.PersonFilter', field_name='best_friend', queryset=Person.objects.all())
 
     class Meta:
         model = Person
@@ -206,19 +206,19 @@ class Meta:
 # Extensions to django_filter fields for DRF.
 #############################################################
 class AllLookupsPersonDateFilter(FilterSet):
-    date_joined = AllLookupsFilter(name='date_joined')
-    time_joined = AllLookupsFilter(name='time_joined')
-    datetime_joined = AllLookupsFilter(name='datetime_joined')
+    date_joined = AllLookupsFilter(field_name='date_joined')
+    time_joined = AllLookupsFilter(field_name='time_joined')
+    datetime_joined = AllLookupsFilter(field_name='datetime_joined')
 
     class Meta:
         model = Person
         fields = []
 
 
 class ExplicitLookupsPersonDateFilter(FilterSet):
-    date_joined = AllLookupsFilter(name='date_joined')
-    time_joined = AllLookupsFilter(name='time_joined')
-    datetime_joined = AllLookupsFilter(name='datetime_joined')
+    date_joined = AllLookupsFilter(field_name='date_joined')
+    time_joined = AllLookupsFilter(field_name='time_joined')
+    datetime_joined = AllLookupsFilter(field_name='datetime_joined')
 
     class Meta:
         model = Person
@@ -242,8 +242,8 @@ class Meta:
 
 
 class BlogPostOverrideFilter(FilterSet):
-    declared_publish_date__isnull = filters.NumberFilter(name='publish_date', lookup_expr='isnull')
-    all_declared_publish_date = filters.AllLookupsFilter(name='publish_date')
+    declared_publish_date__isnull = filters.NumberFilter(field_name='publish_date', lookup_expr='isnull')
+    all_declared_publish_date = filters.AllLookupsFilter(field_name='publish_date')
 
     class Meta:
         model = BlogPost