django-searchkit 1.1__py3-none-any.whl → 1.3__py3-none-any.whl

build/lib/build/lib/build/lib/searchkit/views.py

@@ -0,0 +1,23 @@
+from django.utils.translation import gettext_lazy as _
+from django.http import HttpResponse
+from django.http import Http404, HttpResponseBadRequest
+from django.apps import apps
+from django.contrib.contenttypes.models import ContentType
+from django.views.generic import View
+from .forms import SearchkitModelForm
+from .forms import searchkit_formset_factory
+
+
+# FIXME: Check permissions and authentication.
+class SearchkitAjaxView(View):
+    """
+    Reload the formset via ajax.
+    """
+    def get(self, request, **kwargs):
+        model_form = SearchkitModelForm(data=self.request.GET)
+        if model_form.is_valid():
+            model = model_form.cleaned_data['searchkit_model'].model_class()
+            formset = searchkit_formset_factory(model=model)(data=request.GET)
+            return HttpResponse(formset.render())
+        else:
+            return HttpResponseBadRequest(_('Invalid searchkit-model-form.'))

build/lib/build/lib/example/example/admin.py

@@ -7,7 +7,7 @@ from .models import ModelB
 @admin.register(ModelA)
 class ModelAAdmin(admin.ModelAdmin):
     list_display = [f.name for f in ModelA._meta.fields]
-    list_filter = [SearchkitFilter, 'chars_choices']
+    list_filter = [SearchkitFilter]
 
 
 @admin.register(ModelB)

build/lib/build/lib/searchkit/__version__.py

@@ -13,4 +13,4 @@ Version 0.x should be considered a development version with an unstable API,
 and backwards compatibility is not guaranteed for minor versions.
 """
 
-__version__ = "1.1"
+__version__ = "1.3"

build/lib/build/lib/searchkit/admin.py

@@ -1,15 +1,18 @@
 from django.contrib import admin
 from django.http import HttpResponseRedirect
 from django.urls import reverse
+from django.utils.html import format_html
 from .models import Search
 from .forms import SearchForm
 from .filters import SearchkitFilter
+from .filters import SearchableModelFilter
 
 
 @admin.register(Search)
 class SearchkitSearchAdmin(admin.ModelAdmin):
     form = SearchForm
-    list_display = ('name', 'contenttype', 'created_date')
+    list_display = ('name', 'contenttype', 'created_date', 'apply_search_view')
+    list_filter = (('contenttype', SearchableModelFilter),)
 
     def get_url_for_applied_search(self, obj):
         app_label = obj.contenttype.app_label
@@ -28,3 +31,14 @@ class SearchkitSearchAdmin(admin.ModelAdmin):
             return HttpResponseRedirect(self.get_url_for_applied_search(obj))
         else:
             return super().response_change(request, obj, *args, **kwargs)
+
+    def apply_search_view(self, obj):
+        """
+        Returns a link to apply the search.
+        """
+        return format_html(
+            '<a href="{}" >Apply search "{}"</a>',
+            self.get_url_for_applied_search(obj),
+            obj.name
+        )
+    apply_search_view.short_description = 'Apply Search'

build/lib/build/lib/searchkit/filters.py

@@ -1,9 +1,10 @@
-from django.contrib.admin import SimpleListFilter
+from django.contrib import admin
 from django.contrib.contenttypes.models import ContentType
 from .models import Search
+from .utils import is_searchable_model
 
 
-class SearchkitFilter(SimpleListFilter):
+class SearchkitFilter(admin.SimpleListFilter):
     title = 'Searchkit Filter'
     parameter_name = 'search'
     template = 'searchkit/searchkit_filter.html'
@@ -14,14 +15,22 @@ class SearchkitFilter(SimpleListFilter):
         self.searchkit_model = ContentType.objects.get_for_model(model)
         super().__init__(request, params, model, model_admin)
 
+    def has_output(self):
+        return True
+
     def lookups(self, request, model_admin):
-        # Fetch the last three objects from SearchkitSearch and return them as
-        # choices.
-        searches = Search.objects.filter(contenttype=self.searchkit_model).order_by('-created_date')[:3]
+        searches = Search.objects.filter(contenttype=self.searchkit_model).order_by('-created_date')
         return [(str(obj.id), obj.name) for obj in searches]
 
     def queryset(self, request, queryset):
         # Filter the queryset based on the selected SearchkitSearch object
         if self.value():
             search = Search.objects.get(id=int(self.value()))
-            return search.as_queryset()
+            return queryset.filter(**search.as_lookups())
+
+
+class SearchableModelFilter(admin.filters.RelatedFieldListFilter):
+    def __init__(self, *args, **kwargs):
+        super().__init__(*args, **kwargs)
+        contenttypes = ContentType.objects.order_by('app_label', 'model')
+        self.lookup_choices = [(m.id, m) for m in contenttypes if is_searchable_model(m.model_class())]

build/lib/build/lib/searchkit/forms/fields.py

@@ -1,4 +1,5 @@
 from django import forms
+from django.contrib.admin import widgets
 from django.utils.translation import gettext_lazy as _
 
 
@@ -46,10 +47,10 @@ class IntegerRangeField(BaseRangeField):
 class DateRangeField(BaseRangeField):
     incomplete_message = _("Enter the first and the last date.")
     field_type = forms.DateField
-    widget_type = forms.DateInput
+    widget_type = widgets.AdminDateWidget
 
 
-class DateTimeRangeField(BaseRangeField):
+class DateTimeRangeField(DateRangeField):
     incomplete_message = _("Enter the first and the last datetime.")
-    field_type = forms.DateTimeField
-    widget_type = forms.DateTimeInput
+    field_type = forms.SplitDateTimeField
+    widget_type = widgets.AdminSplitDateTime

build/lib/build/lib/searchkit/forms/search.py

@@ -1,6 +1,5 @@
 from django import forms
 from django.utils.functional import cached_property
-from django.contrib.contenttypes.models import ContentType
 from ..models import Search
 from .searchkit import SearchkitModelForm
 from .searchkit import searchkit_formset_factory

build/lib/build/lib/searchkit/forms/searchkit.py

@@ -1,19 +1,30 @@
 from django import forms
+from django.apps import apps
+from django.contrib.admin import widgets
+from django.contrib.contenttypes.models import ContentType
 from django.utils.translation import gettext_lazy as _
 from django.utils.functional import cached_property
 from .utils import CssClassMixin, FIELD_PLAN, OPERATOR_DESCRIPTION
 from .utils import SUPPORTED_FIELDS
 from .utils import ModelTree
 from .utils import MediaMixin
-from .utils import get_searchable_models
+from .fields import DateRangeField
+from ..utils import is_searchable_model
 
 
 class SearchkitModelForm(forms.Form):
     """
     Form to select a content type.
     """
+    def __init__(self, *args, **kwargs):
+        super().__init__(*args, **kwargs)
+        models = [m for m in apps.get_models() if is_searchable_model(m)]
+        ids = [ContentType.objects.get_for_model(m).id for m in models]
+        queryset = self.fields['searchkit_model'].queryset.filter(pk__in=ids)
+        self.fields['searchkit_model'].queryset = queryset
+
     searchkit_model = forms.ModelChoiceField(
-        queryset=get_searchable_models(),
+        queryset=ContentType.objects.all().order_by('app_label', 'model'),
         label=_('Model'),
         empty_label=_('Select a Model'),
         widget=forms.Select(attrs={
@@ -105,27 +116,19 @@ class BaseSearchkitForm(MediaMixin, CssClassMixin, forms.Form):
         return choices
 
     def _add_field_name_field(self):
-        initial = self.initial.get('field')
         choices = self._get_model_field_choices()
-        field = forms.ChoiceField(label=_('Model field'), choices=choices, initial=initial)
+        field = forms.ChoiceField(label=_('Model field'), choices=choices)
         field.widget.attrs.update({"class": self.reload_on_change_css_class})
         self.fields['field'] = field
 
     def _add_operator_field(self):
-        initial = self.initial.get('operator')
         choices = [(o, OPERATOR_DESCRIPTION[o]) for o in self.field_plan.keys()]
-        field = forms.ChoiceField(label=_('Operator'), choices=choices, initial=initial)
+        field = forms.ChoiceField(label=_('Operator'), choices=choices)
         field.widget.attrs.update({"class": self.reload_on_change_css_class})
         self.fields['operator'] = field
 
     def _add_value_field(self):
-        initial = self.initial.get('value')
-        field_class = self.field_plan[self.operator][0]
-        if getattr(field_class, 'choices', None) and getattr(self.model_field, 'choices', None):
-            field = field_class(choices=self.model_field.choices, initial=initial)
-        else:
-            field = field_class()
-        self.fields['value'] = field
+        self.fields['value'] = self.field_plan[self.operator](self.model_field)
 
 
 class BaseSearchkitFormSet(CssClassMixin, forms.BaseFormSet):
@@ -143,6 +146,26 @@ class BaseSearchkitFormSet(CssClassMixin, forms.BaseFormSet):
     def get_default_prefix(self):
         return "searchkit"
 
+    @cached_property
+    def uses_date_widget(self):
+        """
+        Check if the form uses a date widget.
+        """
+        for form in self.forms:
+            for field in form.fields.values():
+                if isinstance(field.widget, (widgets.AdminDateWidget, widgets.AdminSplitDateTime)):
+                    return True
+                elif isinstance(field, DateRangeField):
+                    return True
+        return False
+
+    @cached_property
+    def forms(self):
+        if self.model:
+            return super().forms
+        else:
+            return []
+
 
 def searchkit_formset_factory(model, **kwargs):
     form = type('SearchkitForm', (BaseSearchkitForm,), dict(model=model))

build/lib/build/lib/searchkit/forms/utils.py

@@ -1,13 +1,9 @@
 from modeltree import ModelTree as BaseModelTree
 from collections import OrderedDict
-from django.apps import apps
-from django.contrib import admin
-from django.contrib.contenttypes.models import ContentType
+from django.contrib.admin.widgets import AdminDateWidget, AdminSplitDateTime
 from django.db import models
-from django.db.utils import OperationalError
 from django import forms
 from django.utils.translation import gettext_lazy as _
-from ..filters import SearchkitFilter
 from . import fields as  searchkit_fields
 
 
@@ -50,94 +46,95 @@ FIELD_PLAN = OrderedDict((
     (
         lambda f: isinstance(f, models.BooleanField),
         {
-            'exact': (forms.NullBooleanField,),
+            'exact': lambda f: forms.NullBooleanField() if f.null else forms.BooleanField(),
         }
     ),
     (
         lambda f: isinstance(f, models.CharField) and f.choices,
         {
-            'exact': (forms.ChoiceField,),
-            'contains': (forms.CharField,),
-            'startswith': (forms.CharField,),
-            'endswith': (forms.CharField,),
-            'regex': (forms.CharField,),
-            'in': (forms.MultipleChoiceField,),
+            'exact': lambda f: forms.ChoiceField(choices=f.choices),
+            'contains': lambda f: forms.CharField(),
+            'startswith': lambda f: forms.CharField(),
+            'endswith': lambda f: forms.CharField(),
+            'regex': lambda f: forms.CharField(),
+            'in': lambda f: forms.MultipleChoiceField(choices=f.choices),
         }
     ),
     (
         lambda f: isinstance(f, models.CharField),
         {
-            'exact': (forms.CharField,),
-            'contains': (forms.CharField,),
-            'startswith': (forms.CharField,),
-            'endswith': (forms.CharField,),
-            'regex': (forms.CharField,),
+            'exact': lambda f: forms.CharField(),
+            'contains': lambda f: forms.CharField(),
+            'startswith': lambda f: forms.CharField(),
+            'endswith': lambda f: forms.CharField(),
+            'regex': lambda f: forms.CharField(),
         }
     ),
     (
         lambda f: isinstance(f, models.IntegerField) and f.choices,
         {
-            'exact': (forms.ChoiceField,),
-            'contains': (forms.IntegerField,),
-            'startswith': (forms.IntegerField,),
-            'endswith': (forms.IntegerField,),
-            'regex': (forms.IntegerField,),
-            'in': (forms.MultipleChoiceField,),
+            'exact': lambda f: forms.ChoiceField(choices=f.choices),
+            'gt': lambda f: forms.IntegerField(),
+            'gte': lambda f: forms.IntegerField(),
+            'lt': lambda f: forms.IntegerField(),
+            'lte': lambda f: forms.IntegerField(),
+            'range': lambda f: searchkit_fields.IntegerRangeField(),
+            'in': lambda f: forms.MultipleChoiceField(choices=f.choices),
         }
     ),
     (
         lambda f: isinstance(f, models.IntegerField),
         {
-            'exact': (forms.IntegerField,),
-            'gt': (forms.IntegerField,),
-            'gte': (forms.IntegerField,),
-            'lt': (forms.IntegerField,),
-            'lte': (forms.IntegerField,),
-            'range': (searchkit_fields.IntegerRangeField,),
+            'exact': lambda f: forms.IntegerField(),
+            'gt': lambda f: forms.IntegerField(),
+            'gte': lambda f: forms.IntegerField(),
+            'lt': lambda f: forms.IntegerField(),
+            'lte': lambda f: forms.IntegerField(),
+            'range': lambda f: searchkit_fields.IntegerRangeField(),
         }
     ),
     (
         lambda f: isinstance(f, models.FloatField),
         {
-            'exact': (forms.FloatField,),
-            'gt': (forms.FloatField,),
-            'gte': (forms.FloatField,),
-            'lt': (forms.FloatField,),
-            'lte': (forms.FloatField,),
-            'range': (searchkit_fields.IntegerRangeField,),
+            'exact': lambda f: forms.FloatField(),
+            'gt': lambda f: forms.FloatField(),
+            'gte': lambda f: forms.FloatField(),
+            'lt': lambda f: forms.FloatField(),
+            'lte': lambda f: forms.FloatField(),
+            'range': lambda f: searchkit_fields.IntegerRangeField(),
         }
     ),
     (
         lambda f: isinstance(f, models.DecimalField),
         {
-            'exact': (forms.DecimalField,),
-            'gt': (forms.DecimalField,),
-            'gte': (forms.DecimalField,),
-            'lt': (forms.DecimalField,),
-            'lte': (forms.DecimalField,),
-            'range': (searchkit_fields.IntegerRangeField,),
+            'exact': lambda f: forms.DecimalField(),
+            'gt': lambda f: forms.DecimalField(),
+            'gte': lambda f: forms.DecimalField(),
+            'lt': lambda f: forms.DecimalField(),
+            'lte': lambda f: forms.DecimalField(),
+            'range': lambda f: searchkit_fields.IntegerRangeField(),
         }
     ),
     (
         lambda f: isinstance(f, models.DateTimeField),
         {
-            'exact': (forms.DateTimeField,),
-            'gt': (forms.DateTimeField,),
-            'gte': (forms.DateTimeField,),
-            'lt': (forms.DateTimeField,),
-            'lte': (forms.DateTimeField,),
-            'range': (searchkit_fields.DateTimeRangeField,),
+            'exact': lambda f: forms.SplitDateTimeField(widget=AdminSplitDateTime()),
+            'gt': lambda f: forms.SplitDateTimeField(widget=AdminSplitDateTime()),
+            'gte': lambda f: forms.SplitDateTimeField(widget=AdminSplitDateTime()),
+            'lt': lambda f: forms.SplitDateTimeField(widget=AdminSplitDateTime()),
+            'lte': lambda f: forms.SplitDateTimeField(widget=AdminSplitDateTime()),
+            'range': lambda f: searchkit_fields.DateTimeRangeField(),
         }
     ),
     (
         lambda f: isinstance(f, models.DateField),
         {
-            'exact': (forms.DateField,),
-            'gt': (forms.DateField,),
-            'gte': (forms.DateField,),
-            'lt': (forms.DateField,),
-            'lte': (forms.DateField,),
-            'range': (searchkit_fields.DateRangeField,),
+            'exact': lambda f: forms.DateField(widget=AdminDateWidget()),
+            'gt': lambda f: forms.DateField(widget=AdminDateWidget()),
+            'gte': lambda f: forms.DateField(widget=AdminDateWidget()),
+            'lt': lambda f: forms.DateField(widget=AdminDateWidget()),
+            'lte': lambda f: forms.DateField(widget=AdminDateWidget()),
+            'range': lambda f: searchkit_fields.DateRangeField(),
         }
     ),
 ))
@@ -155,24 +152,3 @@ class MediaMixin:
             'admin/js/jquery.init.js',
             "searchkit/searchkit.js"
         ]
-
-
-def is_searchable_model(model):
-    """
-    Check if the model is searchable by Searchkit.
-    """
-    return admin.site.is_registered(model) and SearchkitFilter in admin.site._registry[model].list_filter
-
-
-def get_searchable_models():
-    """
-    Return a queryset of searchable models.
-    """
-    # Before mirating the database we get an OperationalError when trying to
-    # access ContentType database table.
-    try:
-        models = [m for m in apps.get_models() if is_searchable_model(m)]
-        ids = [ContentType.objects.get_for_model(m).id for m in models]
-        return ContentType.objects.filter(pk__in=ids).order_by('app_label', 'model')
-    except OperationalError:
-        return ContentType.objects.all()

build/lib/build/lib/searchkit/models.py

@@ -19,9 +19,3 @@ class Search(models.Model):
         for data in self.data:
             lookups[f'{data["field"]}__{data["operator"]}'] = data['value']
         return lookups
-
-    def as_queryset(self):
-        """
-        Returns a filtered queryset for the model.
-        """
-        return self.contenttype.model_class().objects.filter(**self.as_lookups())

build/lib/build/lib/searchkit/tests.py

@@ -49,7 +49,7 @@ INITIAL_DATA = [
     dict(
         field='datetime',
         operator='exact',
-        value='2025-05-14 08:45',
+        value=['2025-05-14', '08:45'],
     )
 ]
 
@@ -263,8 +263,6 @@ class SearchkitSearchFormTestCase(TestCase):
         self.assertEqual(len(filter_rules), len(INITIAL_DATA))
         for data in INITIAL_DATA:
             self.assertIn(f"{data['field']}__{data['operator']}", filter_rules)
-        queryset = form.instance.as_queryset()
-        self.assertTrue(queryset.model == ModelA)
 
 
 class SearchkitModelFormTestCase(TestCase):

build/lib/build/lib/searchkit/utils.py

@@ -0,0 +1,13 @@
+from django.contrib import admin
+
+
+def is_searchable_model(model):
+    """
+    Check if the model is searchable by Searchkit.
+    """
+    # We do not import SearchkitFilter to avoid circular imports. So we check
+    # the filter by its name.
+    return (
+        admin.site.is_registered(model)
+        and 'SearchkitFilter' in [getattr(f, '__name__', '') for f in admin.site._registry[model].list_filter]
+    )

build/lib/build/lib/searchkit/views.py

@@ -14,9 +14,9 @@ class SearchkitAjaxView(View):
     Reload the formset via ajax.
     """
     def get(self, request, **kwargs):
-        contenttype_form = SearchkitModelForm(data=self.request.GET)
-        if contenttype_form.is_valid():
-            model = contenttype_form.cleaned_data['searchkit_model'].model_class()
+        model_form = SearchkitModelForm(data=self.request.GET)
+        if model_form.is_valid():
+            model = model_form.cleaned_data['searchkit_model'].model_class()
             formset = searchkit_formset_factory(model=model)(data=request.GET)
             return HttpResponse(formset.render())
         else:

build/lib/example/example/admin.py

@@ -7,7 +7,7 @@ from .models import ModelB
 @admin.register(ModelA)
 class ModelAAdmin(admin.ModelAdmin):
     list_display = [f.name for f in ModelA._meta.fields]
-    list_filter = [SearchkitFilter, 'chars_choices']
+    list_filter = [SearchkitFilter]
 
 
 @admin.register(ModelB)

build/lib/searchkit/__version__.py

@@ -13,4 +13,4 @@ Version 0.x should be considered a development version with an unstable API,
 and backwards compatibility is not guaranteed for minor versions.
 """
 
-__version__ = "1.1"
+__version__ = "1.3"

build/lib/searchkit/admin.py

@@ -1,15 +1,18 @@
 from django.contrib import admin
 from django.http import HttpResponseRedirect
 from django.urls import reverse
+from django.utils.html import format_html
 from .models import Search
 from .forms import SearchForm
 from .filters import SearchkitFilter
+from .filters import SearchableModelFilter
 
 
 @admin.register(Search)
 class SearchkitSearchAdmin(admin.ModelAdmin):
     form = SearchForm
-    list_display = ('name', 'contenttype', 'created_date')
+    list_display = ('name', 'contenttype', 'created_date', 'apply_search_view')
+    list_filter = (('contenttype', SearchableModelFilter),)
 
     def get_url_for_applied_search(self, obj):
         app_label = obj.contenttype.app_label
@@ -28,3 +31,14 @@ class SearchkitSearchAdmin(admin.ModelAdmin):
             return HttpResponseRedirect(self.get_url_for_applied_search(obj))
         else:
             return super().response_change(request, obj, *args, **kwargs)
+
+    def apply_search_view(self, obj):
+        """
+        Returns a link to apply the search.
+        """
+        return format_html(
+            '<a href="{}" >Apply search "{}"</a>',
+            self.get_url_for_applied_search(obj),
+            obj.name
+        )
+    apply_search_view.short_description = 'Apply Search'

build/lib/searchkit/filters.py

@@ -1,9 +1,10 @@
-from django.contrib.admin import SimpleListFilter
+from django.contrib import admin
 from django.contrib.contenttypes.models import ContentType
 from .models import Search
+from .utils import is_searchable_model
 
 
-class SearchkitFilter(SimpleListFilter):
+class SearchkitFilter(admin.SimpleListFilter):
     title = 'Searchkit Filter'
     parameter_name = 'search'
     template = 'searchkit/searchkit_filter.html'
@@ -14,14 +15,22 @@ class SearchkitFilter(SimpleListFilter):
         self.searchkit_model = ContentType.objects.get_for_model(model)
         super().__init__(request, params, model, model_admin)
 
+    def has_output(self):
+        return True
+
     def lookups(self, request, model_admin):
-        # Fetch the last three objects from SearchkitSearch and return them as
-        # choices.
-        searches = Search.objects.filter(contenttype=self.searchkit_model).order_by('-created_date')[:3]
+        searches = Search.objects.filter(contenttype=self.searchkit_model).order_by('-created_date')
         return [(str(obj.id), obj.name) for obj in searches]
 
     def queryset(self, request, queryset):
         # Filter the queryset based on the selected SearchkitSearch object
         if self.value():
             search = Search.objects.get(id=int(self.value()))
-            return search.as_queryset()
+            return queryset.filter(**search.as_lookups())
+
+
+class SearchableModelFilter(admin.filters.RelatedFieldListFilter):
+    def __init__(self, *args, **kwargs):
+        super().__init__(*args, **kwargs)
+        contenttypes = ContentType.objects.order_by('app_label', 'model')
+        self.lookup_choices = [(m.id, m) for m in contenttypes if is_searchable_model(m.model_class())]

build/lib/searchkit/forms/fields.py

@@ -1,4 +1,5 @@
 from django import forms
+from django.contrib.admin import widgets
 from django.utils.translation import gettext_lazy as _
 
 
@@ -46,10 +47,10 @@ class IntegerRangeField(BaseRangeField):
 class DateRangeField(BaseRangeField):
     incomplete_message = _("Enter the first and the last date.")
     field_type = forms.DateField
-    widget_type = forms.DateInput
+    widget_type = widgets.AdminDateWidget
 
 
-class DateTimeRangeField(BaseRangeField):
+class DateTimeRangeField(DateRangeField):
     incomplete_message = _("Enter the first and the last datetime.")
-    field_type = forms.DateTimeField
-    widget_type = forms.DateTimeInput
+    field_type = forms.SplitDateTimeField
+    widget_type = widgets.AdminSplitDateTime

build/lib/searchkit/forms/search.py

@@ -1,6 +1,5 @@
 from django import forms
 from django.utils.functional import cached_property
-from django.contrib.contenttypes.models import ContentType
 from ..models import Search
 from .searchkit import SearchkitModelForm
 from .searchkit import searchkit_formset_factory