REST: Rename Filter -> FilterSet

FilterSets are to Forms as Filters are to Fields: the former is
made up of the latter. We have a FilterSet for each resource that we
wish to support filtering on (i.e. all of them).

Rename our "Filters" to the more appropriate FilterSets.
The old name was confusing and will conflict with some forthcoming changes.

Signed-off-by: Stephen Finucane <stephen@that.guru>
[dja: commit message]
Signed-off-by: Daniel Axtens <dja@axtens.net>

diff --git a/patchwork/api/bundle.py b/patchwork/api/bundle.py
index 0278592a9e34c26dd1b615bc74875cc1331c4b9e..733e4881dc1735900203603e147571af21245fd4 100644 (file)
--- a/patchwork/api/bundle.py
+++ b/patchwork/api/bundle.py
@@ -24,7 +24,7 @@ from rest_framework.serializers import HyperlinkedModelSerializer
 from rest_framework.serializers import SerializerMethodField
 
 from patchwork.api.base import PatchworkPermission
-from patchwork.api.filters import BundleFilter
+from patchwork.api.filters import BundleFilterSet
 from patchwork.api.embedded import PatchSerializer
 from patchwork.api.embedded import ProjectSerializer
 from patchwork.api.embedded import UserSerializer
@@ -73,7 +73,7 @@ class BundleMixin(object):
 class BundleList(BundleMixin, ListAPIView):
     """List bundles."""
 
-    filter_class = BundleFilter
+    filter_class = BundleFilterSet
     search_fields = ('name',)
     ordering_fields = ('id', 'name', 'owner')
     ordering = 'id'

diff --git a/patchwork/api/check.py b/patchwork/api/check.py
index b37d6e01677017b89304a7a79d4ed33f4151fe35..8753c7de4e6c9c46485784649a35b4de2b378d15 100644 (file)
--- a/patchwork/api/check.py
+++ b/patchwork/api/check.py
@@ -27,7 +27,7 @@ from rest_framework.serializers import HyperlinkedModelSerializer
 from patchwork.api.base import CheckHyperlinkedIdentityField
 from patchwork.api.base import MultipleFieldLookupMixin
 from patchwork.api.embedded import UserSerializer
-from patchwork.api.filters import CheckFilter
+from patchwork.api.filters import CheckFilterSet
 from patchwork.models import Check
 from patchwork.models import Patch
 
@@ -80,7 +80,7 @@ class CheckSerializer(HyperlinkedModelSerializer):
 class CheckMixin(object):
 
     serializer_class = CheckSerializer
-    filter_class = CheckFilter
+    filter_class = CheckFilterSet
 
     def get_queryset(self):
         return Check.objects.prefetch_related('patch', 'user')

diff --git a/patchwork/api/cover.py b/patchwork/api/cover.py
index 99cf9e68e09373accb0300317c74cc7ff4172e8b..246b7cb96da664d782079797a96b001ff974504d 100644 (file)
--- a/patchwork/api/cover.py
+++ b/patchwork/api/cover.py
@@ -25,7 +25,7 @@ from rest_framework.reverse import reverse
 from rest_framework.serializers import SerializerMethodField
 
 from patchwork.api.base import BaseHyperlinkedModelSerializer
-from patchwork.api.filters import CoverLetterFilter
+from patchwork.api.filters import CoverLetterFilterSet
 from patchwork.api.embedded import PersonSerializer
 from patchwork.api.embedded import ProjectSerializer
 from patchwork.api.embedded import SeriesSerializer
@@ -92,7 +92,7 @@ class CoverLetterList(ListAPIView):
     """List cover letters."""
 
     serializer_class = CoverLetterListSerializer
-    filter_class = CoverLetterFilter
+    filter_class = CoverLetterFilterSet
     search_fields = ('name',)
     ordering_fields = ('id', 'name', 'date', 'submitter')
     ordering = 'id'

diff --git a/patchwork/api/event.py b/patchwork/api/event.py
index 9879a9f670a847ad6c294376a5f05819e52ccac9..b6626ec724735749edad4cfa836fc16230493827 100644 (file)
--- a/patchwork/api/event.py
+++ b/patchwork/api/event.py
@@ -32,7 +32,7 @@ from patchwork.api.embedded import PatchSerializer
 from patchwork.api.embedded import ProjectSerializer
 from patchwork.api.embedded import SeriesSerializer
 from patchwork.api.embedded import UserSerializer
-from patchwork.api.filters import EventFilter
+from patchwork.api.filters import EventFilterSet
 from patchwork.api.patch import StateField
 from patchwork.models import Event
 
@@ -104,7 +104,7 @@ class EventList(ListAPIView):
     renderer_classes = (JSONRenderer, JSONListHTMLRenderer)
     template_name = 'patchwork/event-list.html'
     serializer_class = EventSerializer
-    filter_class = EventFilter
+    filter_class = EventFilterSet
     page_size_query_param = None  # fixed page size
     ordering_fields = ()
     ordering = '-date'

diff --git a/patchwork/api/filters.py b/patchwork/api/filters.py
index 7d94d5eda416367bd748b57b8a9f8739e3d50762..afef10f4921383c1e5ad19e8d8d81defb26c6d12 100644 (file)
--- a/patchwork/api/filters.py
+++ b/patchwork/api/filters.py
@@ -141,7 +141,7 @@ class TimestampMixin(FilterSet):
     since = IsoDateTimeFilter(name='date', lookup_expr='gte')
 
 
-class SeriesFilter(TimestampMixin, FilterSet):
+class SeriesFilterSet(TimestampMixin, FilterSet):
 
     submitter = PersonFilter(queryset=Person.objects.all())
     project = ProjectFilter(queryset=Project.objects.all())
@@ -151,7 +151,7 @@ class SeriesFilter(TimestampMixin, FilterSet):
         fields = ('submitter', 'project')
 
 
-class CoverLetterFilter(TimestampMixin, FilterSet):
+class CoverLetterFilterSet(TimestampMixin, FilterSet):
 
     project = ProjectFilter(queryset=Project.objects.all())
     submitter = PersonFilter(queryset=Person.objects.all())
@@ -161,7 +161,7 @@ class CoverLetterFilter(TimestampMixin, FilterSet):
         fields = ('project', 'series', 'submitter')
 
 
-class PatchFilter(TimestampMixin, FilterSet):
+class PatchFilterSet(TimestampMixin, FilterSet):
 
     project = ProjectFilter(queryset=Project.objects.all())
     submitter = PersonFilter(queryset=Person.objects.all())
@@ -174,7 +174,7 @@ class PatchFilter(TimestampMixin, FilterSet):
                   'state', 'archived')
 
 
-class CheckFilter(TimestampMixin, FilterSet):
+class CheckFilterSet(TimestampMixin, FilterSet):
 
     user = UserFilter(queryset=User.objects.all())
 
@@ -183,7 +183,7 @@ class CheckFilter(TimestampMixin, FilterSet):
         fields = ('user', 'state', 'context')
 
 
-class EventFilter(TimestampMixin, FilterSet):
+class EventFilterSet(TimestampMixin, FilterSet):
 
     project = ProjectFilter(queryset=Project.objects.all())
 
@@ -192,7 +192,7 @@ class EventFilter(TimestampMixin, FilterSet):
         fields = ('project', 'category', 'series', 'patch', 'cover')
 
 
-class BundleFilter(FilterSet):
+class BundleFilterSet(FilterSet):
 
     project = ProjectFilter(queryset=Project.objects.all())
     owner = UserFilter(queryset=User.objects.all())

diff --git a/patchwork/api/patch.py b/patchwork/api/patch.py
index 028d68544ea661070ec374196154ee7a6afd4a07..c807e98a0be1bcc13cf0a1680a2ef0cf97df3353 100644 (file)
--- a/patchwork/api/patch.py
+++ b/patchwork/api/patch.py
@@ -28,7 +28,7 @@ from rest_framework.serializers import SerializerMethodField
 
 from patchwork.api.base import BaseHyperlinkedModelSerializer
 from patchwork.api.base import PatchworkPermission
-from patchwork.api.filters import PatchFilter
+from patchwork.api.filters import PatchFilterSet
 from patchwork.api.embedded import PersonSerializer
 from patchwork.api.embedded import ProjectSerializer
 from patchwork.api.embedded import SeriesSerializer
@@ -162,7 +162,7 @@ class PatchList(ListAPIView):
 
     permission_classes = (PatchworkPermission,)
     serializer_class = PatchListSerializer
-    filter_class = PatchFilter
+    filter_class = PatchFilterSet
     search_fields = ('name',)
     ordering_fields = ('id', 'name', 'project', 'date', 'state', 'archived',
                        'submitter', 'check')

diff --git a/patchwork/api/series.py b/patchwork/api/series.py
index b5f4450a71b00cf4c914b795162247ff273fc368..ab1b6adb7b89a47d0e7718ebbd47e261b4ef15ab 100644 (file)
--- a/patchwork/api/series.py
+++ b/patchwork/api/series.py
@@ -23,7 +23,7 @@ from rest_framework.serializers import HyperlinkedModelSerializer
 from rest_framework.serializers import SerializerMethodField
 
 from patchwork.api.base import PatchworkPermission
-from patchwork.api.filters import SeriesFilter
+from patchwork.api.filters import SeriesFilterSet
 from patchwork.api.embedded import CoverLetterSerializer
 from patchwork.api.embedded import PatchSerializer
 from patchwork.api.embedded import PersonSerializer
@@ -68,7 +68,7 @@ class SeriesMixin(object):
 class SeriesList(SeriesMixin, ListAPIView):
     """List series."""
 
-    filter_class = SeriesFilter
+    filter_class = SeriesFilterSet
     search_fields = ('name',)
     ordering_fields = ('id', 'name', 'date', 'submitter', 'received_all')
     ordering = 'id'