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. lookup_map (dict): A dictionary mapping input data keys to filtering fields in the queryset. data (dict): A dictionary containing key-value pairs to filter the queryset. extra_filters (list | 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 
 9
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
39
40
41
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.

    Parameters:
        queryset (QuerySet): The queryset to be filtered.
        lookup_map (dict): A dictionary mapping input data keys to filtering fields in
            the queryset.
        data (dict): A dictionary containing key-value pairs to filter the queryset.
        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)