MultiChoiceExt without linked db field (#8)

Author: vb64

README.md

@@ -154,6 +154,8 @@ Each element of the list consists of three values.
 -   checkbox label
 -   filtering expression applied to the DB model in the form of [Django Q-objects](https://docs.djangoproject.com/en/dev/topics/db/queries/#complex-lookups-with-q-objects)
 
+In the `parameter_name` attribute, you need to specify the name of the GET request parameter for sending filter data.
+
 For our example, the code will look like this.
 
 ```python
@@ -163,6 +165,7 @@ from django_admin_filters import MultiChoiceExt
 
 class ColorFilter(MultiChoiceExt):
     FILTER_LABEL = "By color"
+    parameter_name = "color"
     options = [
       ('red', 'Red', Q(is_online=False)),
       ('yellow', 'Yellow', Q(is_online=True) & (Q(is_trouble1=True) | Q(is_trouble2=True))),
@@ -176,10 +179,6 @@ class Admin(admin.ModelAdmin):
 admin.site.register(Log, Admin)
 ```
 
-When specifying the field to which the filter is applied, you must specify the name of an existing model field (for example, 'is_online' in the example above),
-and not the name of the virtual property ('color').
-You can specify the name of any field in the model. This is necessary so that Django will recognize it as valid when creating an instance of the filter.
-
 Otherwise, the behavior and settings of the `MultiChoiceExt` filter are similar to the `MultiChoice` filter described earlier.
 
 ## DateRange and DateRangePicker filters

READMEru.md

@@ -149,6 +149,8 @@ admin.site.register(Log, Admin)
 -   текст у чекбокса
 -   применяемое к таблице модели в БД выражение фильтрации в виде [Q-объектов Django](https://docs.djangoproject.com/en/dev/topics/db/queries/#complex-lookups-with-q-objects)
 
+В атрибуте `parameter_name` нужно указать имя параметра GET-запроса, в котором будут передаваться данные фильтра.
+
 Для нашего примера код будет таким.
 
 ```python
@@ -158,6 +160,7 @@ from django_admin_filters import MultiChoiceExt
 
 class ColorFilter(MultiChoiceExt):
     FILTER_LABEL = "По цвету"
+    parameter_name = "color"
     options = [
       ('red', 'Red', Q(is_online=False)),
       ('yellow', 'Yellow', Q(is_online=True) & (Q(is_trouble1=True) | Q(is_trouble2=True))),
@@ -171,10 +174,6 @@ class Admin(admin.ModelAdmin):
 admin.site.register(Log, Admin)
 ```
 
-При указании поля, к которому применяется фильтр, нужно указывать имя существующего поля модели (например, 'is_online' в примере выше),
-а не имя виртуального свойства ('color').
-Можно указывать имя любого поля модели. Это необходимо, чтобы Django при создании экземпляра фильтра признала его валидным.
-
 В остальном поведение и настройки фильтра `MultiChoiceExt` аналогичны описанному ранее фильтру `MultiChoice`.
 
 ## Фильтры DateRange и DateRangePicker

django_admin_filters/base.py

@@ -2,20 +2,18 @@
 from django.contrib import admin
 
 
-class Filter(admin.FieldListFilter):
-    """Base class for filters with title, apply button and collapsed state."""
+class Collapsed:
+    """Mixin class for filters with title, apply button and collapsed state."""
 
     is_collapsed = False
-    parameter_name_mask = 'adminfilter_'
+    parameter_name = 'filter'
+    title = None
 
     FILTER_LABEL = "Admin filter"
     BUTTON_LABEL = "Apply"
 
-    def __init__(self, field, request, params, model, model_admin, field_path):
-        """Customize FieldListFilter functionality."""
-        self.parameter_name = self.parameter_name_mask + field_path
-        super().__init__(field, request, params, model, model_admin, field_path)
-
+    def set_title(self):
+        """Init title values."""
         self.title = {
           'parameter_name': self.parameter_name,
           'filter_name': self.FILTER_LABEL,
@@ -28,6 +26,18 @@ def collapsed_state(self):
         """Return string for CSS stype."""
         return '' if self.is_collapsed else 'open'
 
+
+class Filter(admin.FieldListFilter, Collapsed):
+    """Base class for filters applied to field with title, apply button and collapsed state."""
+
+    parameter_name_mask = 'adminfilter_'
+
+    def __init__(self, field, request, params, model, model_admin, field_path):
+        """Customize FieldListFilter functionality."""
+        self.parameter_name = self.parameter_name_mask + field_path
+        super().__init__(field, request, params, model, model_admin, field_path)
+        self.set_title()
+
     def value(self):
         """Return the string provided in the request's query string.
 
@@ -42,3 +52,23 @@ def expected_parameters(self):
     def choices(self, changelist):
         """Must be implemented in childs."""
         raise NotImplementedError('Method choices')
+
+
+class FilterSimple(admin.SimpleListFilter, Collapsed):
+    """Base class for filters without field with title, apply button and collapsed state."""
+
+    parameter_name = 'adminfilter'
+    title = 'Filter'
+
+    def __init__(self, request, params, model, model_admin):
+        """Combine parents init."""
+        super().__init__(request, params, model, model_admin)
+        self.set_title()
+
+    def lookups(self, request, model_admin):
+        """Must be implemented in childs."""
+        raise NotImplementedError('Method lookups')
+
+    def queryset(self, request, queryset):
+        """Must be implemented in childs."""
+        raise NotImplementedError('Method queryset')

django_admin_filters/multi_choice.py

@@ -1,8 +1,36 @@
 """Django admin multi choice filter with checkboxes for db fields with choices option."""
-from .base import Filter as BaseFilter
+from .base import Filter as BaseFilter, FilterSimple as BaseFilterSimple
 
 
-class Filter(BaseFilter):
+class Choices:
+    """Multi choice options filter."""
+
+    template = None
+    selected = []
+    lookup_choices = []
+
+    FILTER_LABEL = "By choices"
+    CHOICES_SEPARATOR = ','
+
+    def set_selected(self, val, title):
+        """Init choices according request parameter string."""
+        self.template = 'multi_choice.html'
+        title.update({
+          'choices_separator': self.CHOICES_SEPARATOR,
+        })
+        self.selected = val.split(self.CHOICES_SEPARATOR) if val else []
+
+    def choices(self, _changelist):
+        """Define filter checkboxes."""
+        for lookup, title in self.lookup_choices:
+            yield {
+              'selected': lookup in self.selected,
+              'value': lookup,
+              'display': title,
+            }
+
+
+class Filter(BaseFilter, Choices):
     """Multi choice options filter.
 
     For CharField and IntegerField fields with 'choices' option.
@@ -13,37 +41,19 @@ class Filter(BaseFilter):
     https://github.com/modlinltd/django-advanced-filters
     """
 
-    template = 'multi_choice.html'
     parameter_name_mask = 'mchoice_'
 
-    FILTER_LABEL = "By choices"
-    CHOICES_SEPARATOR = ','
-
     def __init__(self, field, request, params, model, model_admin, field_path):
         """Extend base functionality."""
         super().__init__(field, request, params, model, model_admin, field_path)
-
-        self.title.update({
-          'choices_separator': self.CHOICES_SEPARATOR,
-        })
-        val = self.value()
-        self.selected = val.split(self.CHOICES_SEPARATOR) if val else []
-        self.lookup_choices = self.get_lookup_choices()
-
-    def get_lookup_choices(self):
-        """Return filter choices."""
+        self.set_selected(self.value(), self.title)
         if self.field.get_internal_type() in ['IntegerField']:
             self.selected = [int(i) for i in self.selected]
-        return self.field.flatchoices
+        self.lookup_choices = self.field.flatchoices
 
     def choices(self, changelist):
-        """Define filter checkboxes."""
-        for lookup, title in self.lookup_choices:
-            yield {
-              'selected': lookup in self.selected,
-              'value': lookup,
-              'display': title,
-            }
+        """Call shared implementation."""
+        return Choices.choices(self, changelist)
 
     def queryset(self, request, queryset):
         """Return the filtered by selected options queryset."""
@@ -56,12 +66,21 @@ def queryset(self, request, queryset):
         return queryset
 
 
-class FilterExt(Filter):
-    """Extended variant of previous filter, that allows filtering by custom defined properties."""
+class FilterExt(BaseFilterSimple, Choices):
+    """Allows filtering by custom defined properties."""
 
     options = []
 
-    def get_lookup_choices(self):
+    def __init__(self, request, params, model, model_admin):
+        """Combine parents init."""
+        super().__init__(request, params, model, model_admin)
+        self.set_selected(self.value(), self.title)
+
+    def choices(self, changelist):
+        """Call shared implementation."""
+        return Choices.choices(self, changelist)
+
+    def lookups(self, request, model_admin):
         """Return filter choices."""
         return [i[:2] for i in self.options]
 

example/admin.py

@@ -22,6 +22,7 @@ class NumberFilter(MultiChoice):
 class ColorFilter(MultiChoiceExt):
     """Property color filter."""
 
+    parameter_name = "color"
     FILTER_LABEL = "By color"
     is_collapsed = True
 
@@ -61,7 +62,7 @@ class Admin(admin.ModelAdmin):
       ('timestamp1', Timestamp1Filter),
       ('timestamp2', Timestamp2Filter),
       ('number', NumberFilter),
-      ('is_online', ColorFilter),
+      ColorFilter
     )
 
 

tests/test/test_base.py

@@ -16,3 +16,19 @@ def test_choices(self):
         with pytest.raises(NotImplementedError) as err:
             Filter.choices(None, None)
         assert 'choices' in str(err.value)
+
+    def test_lookups(self):
+        """Check 'lookups' method."""
+        from django_admin_filters.base import FilterSimple
+
+        with pytest.raises(NotImplementedError) as err:
+            FilterSimple.lookups(None, None, None)
+        assert 'lookups' in str(err.value)
+
+    def test_queryset(self):
+        """Check 'queryset' method."""
+        from django_admin_filters.base import FilterSimple
+
+        with pytest.raises(NotImplementedError) as err:
+            FilterSimple.queryset(None, None, None)
+        assert 'queryset' in str(err.value)

tests/test/test_multi_choice.py

@@ -33,7 +33,7 @@ def test_queryset_ext(self):
         """Filter queryset with MultiChoiceExt."""
         from example.admin import ColorFilter
 
-        pname = ColorFilter.parameter_name_mask + 'is_online'
+        pname = ColorFilter.parameter_name
         request = self.admin_get({pname: 'green' + ColorFilter.CHOICES_SEPARATOR + 'red'})
 
         changelist = self.modeladmin.get_changelist_instance(request)