django-searchkit 0.1__py3-none-any.whl

searchkit/forms/fields.py

@@ -0,0 +1,55 @@
+from django import forms
+from django.utils.translation import gettext_lazy as _
+
+
+class RangeWidget(forms.MultiWidget):
+    def decompress(self, value):
+        """The value should be already a list."""
+        if value:
+            return value
+        else:
+            return [None, None]
+
+
+class BaseRangeField(forms.MultiValueField):
+    incomplete_message = None
+    field_type = None
+    widget_type = None
+    field_kwargs = dict()
+
+    def __init__(self, **kwargs):
+        error_messages = dict(incomplete=self.incomplete_message)
+        widget = RangeWidget(widgets=[self.widget_type, self.widget_type])
+        fields = (
+            self.field_type(label=_('From'), **self.field_kwargs),
+            self.field_type(label=_('To'), **self.field_kwargs),
+        )
+        super().__init__(
+            fields=fields,
+            widget=widget,
+            error_messages=error_messages,
+            require_all_fields=True,
+            **kwargs
+        )
+
+    def compress(self, data_list):
+        """We want the data list as data list."""
+        return data_list
+
+
+class IntegerRangeField(BaseRangeField):
+    incomplete_message = _("Enter the first and the last number.")
+    field_type = forms.IntegerField
+    widget_type = forms.NumberInput
+
+
+class DateRangeField(BaseRangeField):
+    incomplete_message = _("Enter the first and the last date.")
+    field_type = forms.DateField
+    widget_type = forms.DateInput
+
+
+class DateTimeRangeField(BaseRangeField):
+    incomplete_message = _("Enter the first and the last datetime.")
+    field_type = forms.DateTimeField
+    widget_type = forms.DateTimeInput

searchkit/forms/search.py

@@ -0,0 +1,45 @@
+from django import forms
+from django.utils.functional import cached_property
+from ..models import SearchkitSearch
+from .searchkit import SearchkitFormSet
+
+
+class SearchkitSearchForm(forms.ModelForm):
+    """
+    Represents a SearchkitSearch model. Using a SearchkitFormSet for the data
+    json field.
+    """
+    class Meta:
+        model = SearchkitSearch
+        fields = ['name']
+
+    def __init__(self, *args, **kwargs):
+        super().__init__(*args, **kwargs)
+
+    @property
+    def media(self):
+        # TODO: Check if child classes inherit those media files.
+        return self.formset.media
+
+    @cached_property
+    def formset(self):
+        """
+        A searchkit formset for the model.
+        """
+        kwargs = dict()
+        kwargs['data'] = self.data or None
+        kwargs['prefix'] = self.prefix
+        if self.instance.pk:
+            kwargs['model'] = self.instance.contenttype.model_class()
+            kwargs['initial'] = self.instance.data
+        return SearchkitFormSet(**kwargs)
+
+    def is_valid(self):
+        return self.formset.is_valid() and super().is_valid()
+
+    def clean(self):
+        if self.formset.contenttype_form.is_valid():
+            self.instance.contenttype = self.formset.contenttype_form.cleaned_data['contenttype']
+        if self.formset.is_valid():
+            self.instance.data = self.formset.cleaned_data
+        return super().clean()

searchkit/forms/searchkit.py

@@ -0,0 +1,192 @@
+from collections import OrderedDict
+from django import forms
+from django.utils.translation import gettext_lazy as _
+from django.utils.functional import cached_property
+from django.contrib.contenttypes.models import ContentType
+from .utils import CSS_CLASSES, FIELD_PLAN, OPERATOR_DESCRIPTION
+from .utils import SUPPORTED_FIELDS, SUPPORTED_RELATIONS
+
+
+# FIXME: Make this a setting
+RELATION_DEPTH = 3
+
+
+class SearchkitForm(CSS_CLASSES, forms.Form):
+    """
+    Searchkit form representing a model field lookup based on the field name,
+    the operator and one or two values.
+
+    The unbound form is composed of an index field (the count of the searchkit
+    form) and a choice field offering the names of the model fields.
+
+    The bound form is dynamically extended by the operator field or the operator and
+    the value field depending on the provided data
+
+    See the FIELD_PLAN variable for the logic of building the form.
+    """
+    def __init__(self, model, *args, **kwargs):
+        super().__init__(*args, **kwargs)
+        self.model = model
+        self.model_field = None
+        self.field_plan = None
+        self.operator = None
+        self._add_field_name_field()
+        lookup = self._preload_clean_data('field')
+        self.model_field = self._get_model_field(lookup)
+        self.field_plan = next(iter([p for t, p in FIELD_PLAN.items() if t(self.model_field)]))
+        self._add_operator_field()
+        self.operator = self._preload_clean_data('operator')
+        self._add_value_field()
+
+    @cached_property
+    def unprefixed_data(self):
+        data = dict()
+        for key, value in self.data.items():
+            if key.startswith(self.prefix):
+                data[key[len(self.prefix) + 1:]] = value
+        return data
+
+    def _preload_clean_data(self, field_name):
+        # Try the initial value first since it is already cleaned.
+        if self.initial and field_name in self.initial:
+            return self.initial[field_name]
+        # Otherwise look up the data dict.
+        elif field_name in self.unprefixed_data:
+            try:
+                # Do we have a valid value?
+                return self.fields[field_name].clean(self.unprefixed_data[field_name])
+            except forms.ValidationError:
+                pass
+        else:
+            # At last simply return the first option which will be the selected
+            # one.
+            return self.fields[field_name].choices[0][0]
+
+    def _get_model_field(self, lookup):
+        path = lookup.split('__')
+        model = self.model
+        for index, field_name in enumerate(path, 1):
+            field = model._meta.get_field(field_name)
+            if index < len(path):
+                model = field.remote_field.model
+        return field
+
+    def _get_model_field_choices(self, model, fields=[]):
+        choices = list()
+        for model_field in model._meta.fields:
+            if any(isinstance(model_field, f) for f in SUPPORTED_FIELDS):
+                lookup = '__'.join([f.name for f in [*fields, model_field]])
+                label = ' -> '.join(f.verbose_name for f in [*fields, model_field])
+                choices.append((lookup, label))
+        if len(fields) < RELATION_DEPTH:
+            for model_field in model._meta.fields:
+                if any(isinstance(model_field, f) for f in SUPPORTED_RELATIONS):
+                    related_model = model_field.remote_field.model
+                    fields = [*fields, model_field]
+                    choices += self._get_model_field_choices(related_model, fields)
+        return choices
+
+    def _add_field_name_field(self):
+        initial = self.initial.get('field')
+        choices = self._get_model_field_choices(self.model)
+        field = forms.ChoiceField(label=_('Model field'), choices=choices, initial=initial)
+        field.widget.attrs.update({"class": CSS_CLASSES.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.widget.attrs.update({"class": CSS_CLASSES.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
+
+
+class ContentTypeForm(CSS_CLASSES, forms.Form):
+    """
+    Form to select a content type.
+    """
+    contenttype = forms.ModelChoiceField(
+        queryset=ContentType.objects.all(),
+        label=_('Model'),
+        empty_label=_('Select a Model'),
+        widget=forms.Select(attrs={"class": CSS_CLASSES.reload_on_change_css_class}),
+    )
+
+    class Media:
+        js = [
+            'admin/js/vendor/jquery/jquery.min.js',
+            'admin/js/jquery.init.js',
+            "searchkit/searchkit.js"
+        ]
+
+
+class BaseSearchkitFormset(CSS_CLASSES, forms.BaseFormSet):
+    """
+    Formset holding all searchkit forms.
+    """
+    template_name = "searchkit/searchkit.html"
+    template_name_div = "searchkit/searchkit.html"
+    default_prefix = 'searchkit'
+    form = SearchkitForm
+    contenttype_form_class = ContentTypeForm
+
+    def __init__(self, *args, **kwargs):
+        self.contenttype_form = self.get_conttenttype_form(kwargs)
+        self.model = self.get_model(kwargs)
+        super().__init__(*args, **kwargs)
+        if self.initial:
+            self.extra = 0
+
+    def get_conttenttype_form(self, kwargs):
+        ct_kwargs = dict()
+        ct_kwargs['data'] = kwargs.get('data')
+        ct_kwargs['prefix'] = kwargs.get('prefix')
+        if model := kwargs.pop('model', None):
+            ct_kwargs['initial'] = dict(contenttype=ContentType.objects.get_for_model(model))
+        return self.contenttype_form_class(**ct_kwargs)
+
+    def get_model(self, kwargs):
+        if self.contenttype_form.initial:
+            return self.contenttype_form.initial['contenttype'].model_class()
+        elif self.contenttype_form.is_valid():
+            return self.contenttype_form.cleaned_data['contenttype'].model_class()
+
+    def get_form_kwargs(self, index):
+        kwargs = self.form_kwargs.copy()
+        kwargs['model'] = self.model
+        return kwargs
+
+    def add_prefix(self, index):
+        if self.model:
+            return "%s-%s-%s" % (self.prefix, self.model._meta.model_name, index)
+
+    @classmethod
+    def get_default_prefix(cls):
+        return cls.default_prefix
+
+    @cached_property
+    def forms(self):
+        # We won't render any forms if we got no model.
+        return super().forms if self.model else []
+
+    @property
+    def media(self):
+        return self.contenttype_form.media
+
+    def is_valid(self):
+        return self.contenttype_form.is_valid() and self.forms and super().is_valid()
+
+
+SearchkitFormSet = forms.formset_factory(
+        form=SearchkitForm,
+        formset=BaseSearchkitFormset,
+    )

searchkit/forms/utils.py

@@ -0,0 +1,149 @@
+from django.db import models
+from django import forms
+from django.utils.translation import gettext_lazy as _
+from collections import OrderedDict
+from searchkit.forms import fields as searchkit_fields
+
+
+OPERATOR_DESCRIPTION = {
+    'exact': _('is exact'),
+    'contains': _('contains'),
+    'startswith': _('starts with'),
+    'endswith': _('ends with'),
+    'regex': _('matches regular expression'),
+    'gt': _('is greater than'),
+    'gte': _('is greater than or equal'),
+    'lt': _('is lower than'),
+    'lte': _('is lower than or equal'),
+    'range': _('is between'),
+    'in': _('is one of'),
+}
+
+
+SUPPORTED_FIELDS = [
+    models.BooleanField,
+    models.CharField,
+    models.IntegerField,
+    models.FloatField,
+    models.DecimalField,
+    models.DateField,
+    models.DateTimeField,
+]
+SUPPORTED_RELATIONS = [
+    models.ForeignKey,
+    models.OneToOneField,
+]
+
+
+FIELD_PLAN = OrderedDict((
+    (
+        lambda f: isinstance(f, models.BooleanField),
+        {
+            'exact': (forms.NullBooleanField,),
+        }
+    ),
+    (
+        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,),
+        }
+    ),
+    (
+        lambda f: isinstance(f, models.CharField),
+        {
+            'exact': (forms.CharField,),
+            'contains': (forms.CharField,),
+            'startswith': (forms.CharField,),
+            'endswith': (forms.CharField,),
+            'regex': (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,),
+        }
+    ),
+    (
+        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,),
+        }
+    ),
+    (
+        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,),
+        }
+    ),
+    (
+        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,),
+        }
+    ),
+    (
+        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,),
+        }
+    ),
+    (
+        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,),
+        }
+    ),
+))
+
+
+class CSS_CLASSES:
+    reload_on_change_css_class = "searchkit-reload-on-change"
+    reload_on_click_css_class = "searchkit-reload-on-click"
+
+
+def get_filter_rules(formset):
+    """
+    Build filter rules out of the cleaned data of the formset.
+    :param formset: Formset to extract filter rules from.
+    :return: OrderedDict with filter rule pairs: field__operator: value
+    """
+    lookups = OrderedDict()
+    for data in formset.cleaned_data:
+        lookups[f'{data["field"]}__{data["operator"]}'] = data['value']
+    return lookups

searchkit/migrations/0001_initial.py

@@ -0,0 +1,30 @@
+# Generated by Django 5.1.3 on 2025-05-22 19:04
+
+import django.db.models.deletion
+import picklefield.fields
+from django.db import migrations, models
+
+
+class Migration(migrations.Migration):
+
+    initial = True
+
+    dependencies = [
+        ('contenttypes', '0002_remove_content_type_name'),
+    ]
+
+    operations = [
+        migrations.CreateModel(
+            name='SearchkitSearch',
+            fields=[
+                ('id', models.BigAutoField(auto_created=True, primary_key=True, serialize=False, verbose_name='ID')),
+                ('name', models.CharField(max_length=255, verbose_name='Search name')),
+                ('data', picklefield.fields.PickledObjectField(editable=False, verbose_name='Serialized filter rule data')),
+                ('created_date', models.DateTimeField(auto_now_add=True)),
+                ('contenttype', models.ForeignKey(on_delete=django.db.models.deletion.CASCADE, to='contenttypes.contenttype', verbose_name='Model')),
+            ],
+            options={
+                'unique_together': {('name', 'contenttype')},
+            },
+        ),
+    ]

searchkit/models.py

@@ -0,0 +1,23 @@
+from collections import OrderedDict
+from picklefield.fields import PickledObjectField
+from django.db import models
+from django.contrib.contenttypes.models import ContentType
+from django.utils.translation import gettext_lazy as _
+
+
+# Create your models here.
+# TODO: Use pickled cleaned data with a char field.
+class SearchkitSearch(models.Model):
+    name = models.CharField(_('Search name'), max_length=255)
+    contenttype = models.ForeignKey(ContentType, on_delete=models.CASCADE, verbose_name=_('Model'))
+    data = PickledObjectField(_('Serialized filter rule data'))
+    created_date = models.DateTimeField(auto_now_add=True)
+
+    class Meta:
+        unique_together = ('name', 'contenttype')
+
+    def get_filter_rules(self):
+        lookups = OrderedDict()
+        for data in self.data:
+            lookups[f'{data["field"]}__{data["operator"]}'] = data['value']
+        return lookups

searchkit/templatetags/searchkit.py

@@ -0,0 +1,47 @@
+from django.template import Library
+from django.urls import reverse
+from django.contrib.admin.helpers import Fieldset
+from ..forms.utils import CSS_CLASSES
+
+
+register = Library()
+
+
+@register.simple_tag
+def searchkit_url(formset):
+    """
+    Return url to reload the formset.
+    """
+    app_label = formset.model._meta.app_label
+    model_name = formset.model._meta.model_name
+    url = reverse('searchkit_form', args=[app_label, model_name])
+    return url
+
+@register.simple_tag
+def on_change_class():
+    """
+    Return css class for on change handler.
+    """
+    return CSS_CLASSES.reload_on_change_css_class
+
+@register.simple_tag
+def on_click_class():
+    """
+    Return css class for on click handler.
+    """
+    return CSS_CLASSES.reload_on_click_css_class
+
+@register.inclusion_tag("admin/includes/fieldset.html")
+def as_fieldset(form, heading_level=2, prefix='', id_prefix=0, id_suffix='', **fieldset_kwargs):
+    """
+    Create and render a fieldset for form.
+    """
+    fieldset = Fieldset(form, fields=form.fields, **fieldset_kwargs)
+    context = dict(
+        fieldset=fieldset,
+        heading_level=heading_level,
+        prefix=prefix,
+        id_prefix=id_prefix,
+        id_suffix=id_suffix,
+    )
+    return context