refactor(filters): config ArrayField DRY

Move filter_overrides for ArrayField to Meta class of common parent for model-based FilterSets to reduce redundancy.
acdh-oeaw · Aug 19, 2024 · aed71d8 · aed71d8
1 parent 41adb9c
commit aed71d8
Showing 1 changed file with 15 additions and 33 deletions.
diff --git a/apis_ontology/filtersets.py b/apis_ontology/filtersets.py
@@ -107,6 +107,21 @@ class BaseEntityFilterSet(AbstractEntityFilterSet):
     """
     Parent class for all entity model classes.
     """
+
+    class Meta(AbstractEntityFilterSet.Meta):
+        filter_overrides = {
+            **AbstractEntityFilterSet.Meta.filter_overrides,
+            ArrayField: {
+                "filter_class": django_filters.MultipleChoiceFilter,
+                # "extra" attribute not working for fields with choices, see:
+                # https://github.com/carltongibson/django-filter/issues/1475
+                "extra": lambda f: {
+                    "lookup_expr": "icontains",
+                    "widget": forms.SelectMultiple,
+                },
+            },
+        }
+
     def __init__(self, *args, **kwargs):
         super().__init__(*args, **kwargs)
         if "custom_search" in self.filters:
@@ -182,17 +197,6 @@ class Meta(BaseEntityFilterSet.Meta):
         fields = {
             "new_fictionality": ["icontains"],
         }
-        filter_overrides = {
-            ArrayField: {
-                "filter_class": django_filters.MultipleChoiceFilter,
-                # "extra" attribute not working for fields with choices, see:
-                # https://github.com/carltongibson/django-filter/issues/1475
-                "extra": lambda f: {
-                    "lookup_expr": "icontains",
-                    "widget": forms.SelectMultiple,
-                },
-            },
-        }
 
 
 class VersionCharacterFilterSet(CharacterFilterSet):
@@ -261,17 +265,6 @@ class Meta(BaseEntityFilterSet.Meta):
         fields = {
             "temporal_order": ["icontains"],
         }
-        filter_overrides = {
-            ArrayField: {
-                "filter_class": django_filters.MultipleChoiceFilter,
-                # "extra" attribute not working for fields with choices, see:
-                # https://github.com/carltongibson/django-filter/issues/1475
-                "extra": lambda f: {
-                    "lookup_expr": "icontains",
-                    "widget": forms.SelectMultiple,
-                },
-            },
-        }
 
 
 class VersionWorkFilterSet(WorkFilterSet):
@@ -293,17 +286,6 @@ class Meta(BaseEntityFilterSet.Meta):
         fields = {
             "language": ["icontains"],
         }
-        filter_overrides = {
-            ArrayField: {
-                "filter_class": django_filters.MultipleChoiceFilter,
-                # "extra" attribute not working for fields with choices, see:
-                # https://github.com/carltongibson/django-filter/issues/1475
-                "extra": lambda f: {
-                    "lookup_expr": "icontains",
-                    "widget": forms.SelectMultiple,
-                },
-            },
-        }
 
 
 class VersionExpressionFilterSet(ExpressionFilterSet):