Skip to content

mixins

django_spire.contrib.queryset.mixins

SessionFilterQuerySetMixin

Bases: QuerySet

process_session_filter

Source code in django_spire/contrib/queryset/mixins.py 
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
def process_session_filter(
        self,
        request: WSGIRequest,
        session_key: str,
        form_class: Type[Form]
) -> QuerySet:
    # Session keys must match to process new queryset data

    action = request.GET.get('action')
    form = form_class(request.GET)

    if form.is_valid():
        session = SessionController(request=request, session_key=session_key)

        # Todo: Change actions into an enum
        if action == SessionFilterActionEnum.CLEAR.value:
            session.purge()
            return self

        # The user has submitted the filter form
        if action == SessionFilterActionEnum.FILTER.value and session_key == request.GET.get('session_filter_key'):

            # Update session data
            for key, value in form.cleaned_data.items():
                session.add_data(key, value)

        return self.bulk_filter(session.data)
    else:
        show_form_errors(request, form)
        return self

bulk_filter abstractmethod

Source code in django_spire/contrib/queryset/mixins.py 
49
50
51
@abstractmethod
def bulk_filter(self, filter_data: dict) -> QuerySet:
    pass

SearchQuerySetMixin

Bases: QuerySet

search abstractmethod

Source code in django_spire/contrib/queryset/mixins.py 
56
57
58
@abstractmethod
def search(self, value: str | None) -> QuerySet:
    pass