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

build/lib/build/lib/build/lib/example/example/settings.py

@@ -0,0 +1,125 @@
+"""
+Django settings for example project.
+
+Generated by 'django-admin startproject' using Django 4.1.6.
+
+For more information on this file, see
+https://docs.djangoproject.com/en/4.1/topics/settings/
+
+For the full list of settings and their values, see
+https://docs.djangoproject.com/en/4.1/ref/settings/
+"""
+
+from pathlib import Path
+
+# Build paths inside the project like this: BASE_DIR / 'subdir'.
+BASE_DIR = Path(__file__).resolve().parent.parent
+
+
+# Quick-start development settings - unsuitable for production
+# See https://docs.djangoproject.com/en/4.1/howto/deployment/checklist/
+
+# SECURITY WARNING: keep the secret key used in production secret!
+SECRET_KEY = 'django-insecure-^@et7v8l)mu@#@tooytj77v&jtkqy&i^wgp9+ro&v!rb6f1y__'
+
+# SECURITY WARNING: don't run with debug turned on in production!
+DEBUG = True
+
+ALLOWED_HOSTS = []
+
+
+# Application definition
+
+INSTALLED_APPS = [
+    'example',
+    'searchkit',
+    'django.contrib.admin',
+    'django.contrib.auth',
+    'django.contrib.contenttypes',
+    'django.contrib.sessions',
+    'django.contrib.messages',
+    'django.contrib.staticfiles',
+]
+
+MIDDLEWARE = [
+    'django.middleware.security.SecurityMiddleware',
+    'django.contrib.sessions.middleware.SessionMiddleware',
+    'django.middleware.common.CommonMiddleware',
+    'django.middleware.csrf.CsrfViewMiddleware',
+    'django.contrib.auth.middleware.AuthenticationMiddleware',
+    'django.contrib.messages.middleware.MessageMiddleware',
+    'django.middleware.clickjacking.XFrameOptionsMiddleware',
+]
+
+ROOT_URLCONF = 'example.urls'
+
+TEMPLATES = [
+    {
+        'BACKEND': 'django.template.backends.django.DjangoTemplates',
+        'DIRS': [],
+        'APP_DIRS': True,
+        'OPTIONS': {
+            'context_processors': [
+                'django.template.context_processors.debug',
+                'django.template.context_processors.request',
+                'django.contrib.auth.context_processors.auth',
+                'django.contrib.messages.context_processors.messages',
+            ],
+        },
+    },
+]
+
+WSGI_APPLICATION = 'example.wsgi.application'
+
+
+# Database
+# https://docs.djangoproject.com/en/4.1/ref/settings/#databases
+
+DATABASES = {
+    'default': {
+        'ENGINE': 'django.db.backends.sqlite3',
+        'NAME': BASE_DIR / 'db.sqlite3',
+    }
+}
+
+
+# Password validation
+# https://docs.djangoproject.com/en/4.1/ref/settings/#auth-password-validators
+
+AUTH_PASSWORD_VALIDATORS = [
+    {
+        'NAME': 'django.contrib.auth.password_validation.UserAttributeSimilarityValidator',
+    },
+    {
+        'NAME': 'django.contrib.auth.password_validation.MinimumLengthValidator',
+    },
+    {
+        'NAME': 'django.contrib.auth.password_validation.CommonPasswordValidator',
+    },
+    {
+        'NAME': 'django.contrib.auth.password_validation.NumericPasswordValidator',
+    },
+]
+
+
+# Internationalization
+# https://docs.djangoproject.com/en/4.1/topics/i18n/
+
+LANGUAGE_CODE = 'en-us'
+
+TIME_ZONE = 'UTC'
+
+USE_I18N = True
+
+USE_TZ = True
+
+
+# Static files (CSS, JavaScript, Images)
+# https://docs.djangoproject.com/en/4.1/howto/static-files/
+
+STATIC_URL = 'static/'
+
+# Default primary key field type
+# https://docs.djangoproject.com/en/4.1/ref/settings/#default-auto-field
+
+DEFAULT_AUTO_FIELD = 'django.db.models.BigAutoField'

build/lib/build/lib/build/lib/example/example/urls.py

@@ -0,0 +1,23 @@
+"""example URL Configuration
+
+The `urlpatterns` list routes URLs to views. For more information please see:
+    https://docs.djangoproject.com/en/4.1/topics/http/urls/
+Examples:
+Function views
+    1. Add an import:  from my_app import views
+    2. Add a URL to urlpatterns:  path('', views.home, name='home')
+Class-based views
+    1. Add an import:  from other_app.views import Home
+    2. Add a URL to urlpatterns:  path('', Home.as_view(), name='home')
+Including another URLconf
+    1. Import the include() function: from django.urls import include, path
+    2. Add a URL to urlpatterns:  path('blog/', include('blog.urls'))
+"""
+from django.contrib import admin
+from django.urls import path, include
+
+
+urlpatterns = [
+    path('', include('searchkit.urls')),
+    path('admin/', admin.site.urls),
+]

build/lib/build/lib/build/lib/example/example/wsgi.py

@@ -0,0 +1,16 @@
+"""
+WSGI config for example project.
+
+It exposes the WSGI callable as a module-level variable named ``application``.
+
+For more information on this file, see
+https://docs.djangoproject.com/en/4.1/howto/deployment/wsgi/
+"""
+
+import os
+
+from django.core.wsgi import get_wsgi_application
+
+os.environ.setdefault('DJANGO_SETTINGS_MODULE', 'example.settings')
+
+application = get_wsgi_application()

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

@@ -0,0 +1,16 @@
+"""
+This project uses the Semantic Versioning scheme in conjunction with PEP 0440:
+    <http://semver.org/>
+    <https://www.python.org/dev/peps/pep-0440>
+
+Major versions introduce significant changes to the API, and backwards
+compatibility is not guaranteed. Minor versions are for new features and other
+backwards-compatible changes to the API. Patch versions are for bug fixes and
+internal code changes that do not affect the API. Development versions are
+incomplete states of a release .
+
+Version 0.x should be considered a development version with an unstable API,
+and backwards compatibility is not guaranteed for minor versions.
+"""
+
+__version__ = "1.3"

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

@@ -0,0 +1,44 @@
+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', 'apply_search_view')
+    list_filter = (('contenttype', SearchableModelFilter),)
+
+    def get_url_for_applied_search(self, obj):
+        app_label = obj.contenttype.app_label
+        model_name = obj.contenttype.model
+        base_url = reverse(f'admin:{app_label}_{model_name}_changelist')
+        return f'{base_url}?{SearchkitFilter.parameter_name}={obj.pk}'
+
+    def response_add(self, request, obj, *args, **kwargs):
+        if '_save_and_apply' in request.POST:
+            return HttpResponseRedirect(self.get_url_for_applied_search(obj))
+        else:
+            return super().response_add(request, obj, *args, **kwargs)
+
+    def response_change(self, request, obj, *args, **kwargs):
+        if '_save_and_apply' in request.POST:
+            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/build/lib/searchkit/apps.py

@@ -0,0 +1,6 @@
+from django.apps import AppConfig
+
+
+class SearchkitConfig(AppConfig):
+    default_auto_field = 'django.db.models.BigAutoField'
+    name = 'searchkit'

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

@@ -0,0 +1,36 @@
+from django.contrib import admin
+from django.contrib.contenttypes.models import ContentType
+from .models import Search
+from .utils import is_searchable_model
+
+
+class SearchkitFilter(admin.SimpleListFilter):
+    title = 'Searchkit Filter'
+    parameter_name = 'search'
+    template = 'searchkit/searchkit_filter.html'
+
+    def __init__(self, request, params, model, model_admin):
+        # We need the app_label and model as get parameter for the new search
+        # link.
+        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):
+        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 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/build/lib/searchkit/forms/__init__.py

@@ -0,0 +1,5 @@
+from .search import SearchForm
+from .searchkit import SearchkitModelForm
+from .searchkit import BaseSearchkitFormSet
+from .searchkit import BaseSearchkitForm
+from .searchkit import searchkit_formset_factory

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

@@ -0,0 +1,56 @@
+from django import forms
+from django.contrib.admin import widgets
+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 = widgets.AdminDateWidget
+
+
+class DateTimeRangeField(DateRangeField):
+    incomplete_message = _("Enter the first and the last datetime.")
+    field_type = forms.SplitDateTimeField
+    widget_type = widgets.AdminSplitDateTime

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

@@ -0,0 +1,61 @@
+from django import forms
+from django.utils.functional import cached_property
+from ..models import Search
+from .searchkit import SearchkitModelForm
+from .searchkit import searchkit_formset_factory
+from .utils import MediaMixin
+
+
+class SearchForm(MediaMixin, forms.ModelForm):
+    """
+    Represents a SearchkitSearch model. Using a SearchkitFormSet for the data
+    json field.
+    """
+    class Meta:
+        model = Search
+        fields = ['name']
+
+    @cached_property
+    def searchkit_model(self):
+        if self.instance.pk:
+            return self.instance.contenttype.model_class()
+        elif self.searchkit_model_form.is_valid():
+            return self.searchkit_model_form.cleaned_data['searchkit_model'].model_class()
+        elif 'searchkit_model' in self.searchkit_model_form.initial:
+            value = self.searchkit_model_form.initial['searchkit_model']
+            try:
+                return self.searchkit_model_form.fields['searchkit_model'].clean(value).model_class()
+            except forms.ValidationError:
+                return None
+
+    @cached_property
+    def searchkit_model_form(self):
+        kwargs = dict(data=self.data or None, initial=self.initial or None)
+        if self.instance.pk:
+            kwargs['initial'] = dict(searchkit_model=self.instance.contenttype)
+        return SearchkitModelForm(**kwargs)
+
+    @cached_property
+    def formset(self):
+        """
+        A searchkit formset for the model.
+        """
+        kwargs = dict()
+        if self.searchkit_model and self.data:
+            kwargs = dict(data=self.data)
+        elif self.searchkit_model and self.instance.pk:
+            kwargs = dict(initial=self.instance.data)
+
+        extra = 0 if self.instance.pk else 1
+        formset = searchkit_formset_factory(model=self.searchkit_model, extra=extra)
+        return formset(**kwargs)
+
+    def is_valid(self):
+        return self.formset.is_valid() and self.searchkit_model_form.is_valid and super().is_valid()
+
+    def clean(self):
+        if self.searchkit_model_form.is_valid():
+            self.instance.contenttype = self.searchkit_model_form.cleaned_data['searchkit_model']
+        if self.formset.is_valid():
+            self.instance.data = self.formset.cleaned_data
+        return super().clean()

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

@@ -0,0 +1,177 @@
+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 .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=ContentType.objects.all().order_by('app_label', 'model'),
+        label=_('Model'),
+        empty_label=_('Select a Model'),
+        widget=forms.Select(attrs={
+            "class": CssClassMixin.reload_on_change_css_class,
+            "data-total-forms": 1,
+        }),
+    )
+
+
+class BaseSearchkitForm(MediaMixin, CssClassMixin, 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.
+    """
+    model = None  # Set by the formset factory.
+
+    def __init__(self, *args, **kwargs):
+        super().__init__(*args, **kwargs)
+        self.model_tree = ModelTree(self.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:
+                return self.fields[field_name].choices[0][0]
+        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('__')
+        field_name = path[-1]
+        if path[:-1]:
+            model = self.model_tree.get('__'.join(path[:-1])).model
+        else:
+            model = self.model
+        return model._meta.get_field(field_name)
+
+    def _get_model_field_choices(self):
+        choices = list()
+        label_path = list()
+        for node in self.model_tree.iterate():
+            label_path.append
+            for model_field in node.model._meta.fields:
+                if not any(isinstance(model_field, f) for f in SUPPORTED_FIELDS):
+                    continue
+                if node.is_root:
+                    lookup = model_field.name
+                    label = f'`{model_field.verbose_name}`'
+                else:
+                    lookup = f'{node.field_path}__{model_field.name}'
+                    get_field_name = lambda f: getattr(f, 'verbose_name', f.name)
+                    label_path = [f'`{get_field_name(n.field)}` => <{n.model._meta.verbose_name}>' for n in node.path[1:]]
+                    label = ".".join(label_path + [f'`{model_field.verbose_name}`'])
+                choices.append((lookup, label))
+        return choices
+
+    def _add_field_name_field(self):
+        choices = self._get_model_field_choices()
+        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):
+        choices = [(o, OPERATOR_DESCRIPTION[o]) for o in self.field_plan.keys()]
+        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):
+        self.fields['value'] = self.field_plan[self.operator](self.model_field)
+
+
+class BaseSearchkitFormSet(CssClassMixin, forms.BaseFormSet):
+    """
+    Formset holding all searchkit forms.
+    """
+    template_name = "searchkit/searchkit.html"
+    template_name_div = "searchkit/searchkit.html"
+    model = None  # Set by the formset factory.
+
+    def add_prefix(self, index):
+        return "%s-%s-%s-%s" % (self.prefix, self.model._meta.app_label, self.model._meta.model_name, index)
+
+    @classmethod
+    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))
+    formset = type('SearchkitFormSet', (BaseSearchkitFormSet,), dict(model=model))
+    return forms.formset_factory(
+        form=form,
+        formset=formset,
+        **kwargs
+    )