Skip to content

mixins

django_spire.contrib.queryset.mixins

SessionFilterQuerySetMixin

Bases: QuerySet

process_session_filter

Source code in django_spire/contrib/queryset/mixins.py 
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
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
def process_session_filter(
    self,
    request: WSGIRequest,
    session_key: str,
    form_class: type[Form],
    is_from_body: bool = False
) -> QuerySet:
    # Session keys must match to process new queryset data

    data = json.loads(request.body.decode('utf-8')) if is_from_body else request.GET

    try:
        action = SessionFilterActionEnum(data.get('action'))
    except ValueError:
        action = None

    form = form_class(data)

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

        if action == SessionFilterActionEnum.CLEAR:
            session.purge()
            return self

        # Apply filters when the user submits the filter form
        if (
            action == SessionFilterActionEnum.FILTER
            and session_key == data.get('session_filter_key')
        ):
            # Update session data
            for key, value in form.cleaned_data.items():
                session.add_data(key, value)

        # If the session is expired, return the unfiltered queryset
        if session.is_expired:
            return self

        # When no new filter data is applied and session is NOT yet expired,
        # return the original queryset
        return self.bulk_filter(session.data)

    show_form_errors(request, form)
    return self

bulk_filter abstractmethod

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

SearchQuerySetMixin

Bases: QuerySet

search

Source code in django_spire/contrib/queryset/mixins.py 
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
def search(self, value: str | None) -> QuerySet:
    words = value.split(' ')

    filtered_query = self

    char_fields = [
        field.name for field in self.model._meta.fields
        if field.get_internal_type() == 'CharField'
    ]

    for word in words:
        or_conditions = Q()
        for field in char_fields:
            or_conditions |= Q(**{f"{field}__icontains": word})
        filtered_query = filtered_query.filter(or_conditions)

    return filtered_query

ChoicesQueryMixin

Bases: QuerySet

to_choices

Source code in django_spire/contrib/queryset/mixins.py 
90
91
92
93
def to_choices(self):
    return [
        (obj.pk, str(obj)) for obj in self
    ]