Skip to content

Filters

hypha.apply.search.filters

apply_date_filter 

apply_date_filter(qs, field, values)

Given a queryset, a field name, and a list of date strings, filter the queryset.

Returns:

  • tuple ( Tuple[QuerySet, str] ) –

    the filtered queryset and the parsed date range in the format of [YYYY-MM-DD start date]/[YYYY-MM-DD end date]

Source code in hypha/apply/search/filters.py 
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
def apply_date_filter(qs, field, values) -> Tuple[QuerySet, str]:
    """Given a queryset, a field name, and a list of date strings, filter the queryset.

    Returns:
        tuple: the filtered queryset and the parsed date range in the format of `[YYYY-MM-DD start date]/[YYYY-MM-DD end date]`

    """
    q_obj = Q()

    date_range = []

    for date_str in values:
        tokens = tokenize_date_filter_value(date_str)
        date_range.append(f"{tokens[-3]}-{tokens[-2]:02}-{tokens[-1]:02}")

        if q := date_filter_tokens_to_q_obj(tokens=tokens, field=field):
            q_obj &= q
        else:
            return qs.none()

    return (qs.filter(q_obj), "/".join(date_range))

date_filter_tokens_to_q_obj 

date_filter_tokens_to_q_obj(tokens, field)

Convert a date tokens parsed using tokenize_date_filter_value into a Q object that can be used to filter a queryset.

Args: - tokens: A list of tokens parsed using tokenize_date_filter_value. - field: This should be the name of a DateTimeField.

Source code in hypha/apply/search/filters.py 
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
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
def date_filter_tokens_to_q_obj(tokens: list, field: str) -> Q:
    """Convert a date tokens parsed using `tokenize_date_filter_value` into a
    Q object that can be used to filter a queryset.

    Args:
    - tokens: A list of tokens parsed using `tokenize_date_filter_value`.
    - field: This should be the name of a DateTimeField.
    """
    match tokens:
        case [operator, year, month, day]:
            if operator == ">=":
                return Q(**{f"{field}__date__gte": dt.date(year, month, day)})
            elif operator == "<=":
                return Q(**{f"{field}__date__lte": dt.date(year, month, day)})
            elif operator == ">":
                return Q(**{f"{field}__date__gt": dt.date(year, month, day)})
            elif operator == "<":
                return Q(**{f"{field}__date__lt": dt.date(year, month, day)})
            elif operator == "=":
                return Q(**{f"{field}__date": dt.date(year, month, day)})
            else:
                return Q(**{f"{field}__date": dt.date(year, month, day)})
        case [operator, year, month]:
            if operator == ">=":
                return Q(**{f"{field}__year__gte": year, f"{field}__month__gte": month})
            elif operator == "<=":
                return Q(**{f"{field}__year__lte": year, f"{field}__month__lte": month})
            elif operator == ">":
                return Q(**{f"{field}__year__gt": year, f"{field}__month__gt": month})
            elif operator == "<":
                return Q(**{f"{field}__year__lt": year, f"{field}__month__lt": month})
            elif operator == "=":
                return Q(**{f"{field}__year": year, f"{field}__month": month})
            else:
                return Q(**{f"{field}__year": year, f"{field}__month": month})
        case [operator, year]:
            if operator == ">=":
                return Q(**{f"{field}__year__gte": year})
            elif operator == "<=":
                return Q(**{f"{field}__year__lte": year})
            elif operator == ">":
                return Q(**{f"{field}__year__gt": year})
            elif operator == "<":
                return Q(**{f"{field}__year__lt": year})
            elif operator == "=":
                return Q(**{f"{field}__year": year})
            else:
                return Q(**{f"{field}__year": year})
    return None