Skip to content

Querystrings

hypha.core.templatetags.querystrings

register module-attribute 

register = Library()

get_query 

get_query(context, param)
Source code in hypha/core/templatetags/querystrings.py 
 9
10
11
12
13
14
15
16
17
@register.simple_tag(takes_context=True)
def get_query(context, param):
    url = context.get("request").get_full_path()
    parsed_url = urlparse(url)
    captured_value = parse_qs(parsed_url.query)

    if captured_value and param in captured_value.keys():
        return captured_value[param][0]
    return None

construct_query_string 

construct_query_string(context, query_params, only_query_string=False)
Source code in hypha/core/templatetags/querystrings.py 
20
21
22
23
24
25
26
27
28
29
30
31
def construct_query_string(context, query_params, only_query_string=False):
    # empty values will be removed
    query_string = "" if only_query_string else context["request"].path
    if len(query_params):
        query_params = sorted(
            query_params, key=lambda elem: "|".join([str(elem[0]), str(elem[1])])
        )
        encoded_params = urlencode(
            [(key, str(value)) for (key, value) in query_params if value]
        ).replace("&", "&")
        query_string += "?{encoded_params}".format(encoded_params=encoded_params)
    return mark_safe(query_string)

modify_query 

modify_query(context, *params_to_remove, **params_to_change)

Renders a link with modified current query parameters

Source code in hypha/core/templatetags/querystrings.py 
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
@register.simple_tag(takes_context=True)
def modify_query(context, *params_to_remove, **params_to_change):
    """Renders a link with modified current query parameters"""
    only_query_string = False
    if "only_query_string" in params_to_remove:
        params_to_remove = [
            param for param in params_to_remove if param != "only_query_string"
        ]
        only_query_string = True
    query_params = []
    for key, value_list in context["request"].GET.lists():
        if key not in params_to_remove:
            # don't add key-value pairs for params_to_remove
            if key in params_to_change:
                # update values for keys in params_to_change
                query_params.append((key, params_to_change[key]))
                params_to_change.pop(key)
            else:
                # leave existing parameters as they were
                # if not mentioned in the params_to_change
                for value in value_list:
                    query_params.append((key, value))
                    # attach new params
    for key, value in params_to_change.items():
        query_params.append((key, value))
    return construct_query_string(
        context=context, query_params=query_params, only_query_string=only_query_string
    )

add_to_query 

add_to_query(context, *params_to_remove, **params_to_add)

Renders a link with modified current query parameters

Source code in hypha/core/templatetags/querystrings.py 
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
@register.simple_tag(takes_context=True)
def add_to_query(context, *params_to_remove, **params_to_add):
    """Renders a link with modified current query parameters"""
    only_query_string = False
    if "only_query_string" in params_to_remove:
        params_to_remove = [
            param for param in params_to_remove if param != "only_query_string"
        ]
        only_query_string = True
    query_params = []
    # go through current query params..
    for key, value_list in context["request"].GET.lists():
        if key not in params_to_remove:
            # don't add key-value pairs which already
            # exist in the query
            if key in params_to_add and params_to_add[key] in value_list:
                params_to_add.pop(key)
            for value in value_list:
                query_params.append((key, value))
    # add the rest key-value pairs
    for key, value in params_to_add.items():
        query_params.append((key, value))
    return construct_query_string(
        context=context, query_params=query_params, only_query_string=only_query_string
    )

remove_from_query 

remove_from_query(context, *args, **kwargs)

Renders a link with modified current query parameters

Source code in hypha/core/templatetags/querystrings.py 
 91
 92
 93
 94
 95
 96
 97
 98
 99
100
101
102
103
104
105
106
107
108
109
@register.simple_tag(takes_context=True)
def remove_from_query(context, *args, **kwargs):
    """Renders a link with modified current query parameters"""
    only_query_string = False
    if "only_query_string" in args:
        args = [param for param in args if param != "only_query_string"]
        only_query_string = True
    query_params = []
    # go through current query params..
    for key, value_list in context["request"].GET.lists():
        # skip keys mentioned in the args
        if key not in args:
            for value in value_list:
                # skip key-value pairs mentioned in kwargs
                if not (key in kwargs and str(value) == str(kwargs[key])):
                    query_params.append((key, value))
    return construct_query_string(
        context=context, query_params=query_params, only_query_string=only_query_string
    )