Skip to content

filter_tools

django_spire.contrib.queryset.filter_tools

filter_by_lookup_map

Filters a given queryset based on a lookup map and provided data. Additional filters can also be applied if provided.

Parameters:

  • (QuerySet) (queryset) –

    The queryset to be filtered.

  • (dict) (lookup_map) –

    A dictionary mapping input data keys to filtering fields in the queryset.

  • None) –

    Optional. A list of extra positional filter arguments to be applied. Defaults to None.

Returns:

  • –

    QuerySet: The filtered queryset.

Source code in django_spire/contrib/queryset/filter_tools.py 
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
def filter_by_lookup_map(
    queryset: QuerySet,
    lookup_map: dict,
    data: dict,
    extra_filters: dict | None = None
):
    """
    Filters a given queryset based on a lookup map and provided data. Additional filters
    can also be applied if provided.

    :param queryset (QuerySet): The queryset to be filtered.
    :param lookup_map (dict): A dictionary mapping input data keys to filtering fields in
        the queryset.
    :param data (dict): A dictionary containing key-value pairs to filter the queryset.
    :param extra_filters (list | None): Optional. A list of extra positional filter
        arguments to be applied. Defaults to None.

    :returns: QuerySet: The filtered queryset.
    """
    if extra_filters is None:
        extra_filters = {}

    lookup_kwargs = {
        lookup_map[k]: v
        for k, v in data.items()
        if k in lookup_map and v not in (None, "", [])
    } | extra_filters

    return queryset.filter(**lookup_kwargs)

filter_by_model_fields

Filters a given queryset based on the queryset's model fields and provided data.

Parameters:

  • (QuerySet) (queryset) –

    The queryset to be filtered.

  • (dict) (data) –

    A dictionary containing key-value pairs to filter the queryset.

Returns:

  • QuerySet –

    QuerySet: The filtered queryset.

Source code in django_spire/contrib/queryset/filter_tools.py 
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
def filter_by_model_fields(queryset: QuerySet, data: dict) -> QuerySet:
    """
    Filters a given queryset based on the queryset's model fields and provided data.

    :param queryset (QuerySet): The queryset to be filtered.
    :param data (dict): A dictionary containing key-value pairs to filter the queryset.

    :returns: QuerySet: The filtered queryset.
    """
    model_fields = [f for f in queryset.model._meta.get_fields()]

    lookup_kwargs = {
        _get_kwarg_name_for_filter_field(
            field=model_field,
            val=data[model_field.name]
        ): data[model_field.name]
        for model_field in model_fields
        if model_field.name in data and data[model_field.name] not in (None, "", [])
    }

    return queryset.filter(**lookup_kwargs)