Add a templatetag to generate querystrings

[Ben Spaulding]

Working with pagination and query strings within a template can be painful. Personally, I have never had a situation when I was paginating using a GET parameter where there were not other parameters that needed to be preserved through out the various pages.

Take search, for example. There may be parameters for searching within one or more models, for a particular author and sorting by date. Maintaining all of these parameters within the pagination links takes some serious template logic.

{# Linebreaks added for readability. In real life this would need to be one, long line. #}
<a href="?{% for key, values in request.GET.iterlists %}
  {% ifnotequal key "page" %}
    {% for value in values %}
      {{ key }}={{ value }}&amp;
    {% endfor %}
  {% endifnotequal %}
{% endfor %}page={{ page.next_page_number }}">Next page</a>

That kind of logic shouldn’t be in a template. I have created a patch that would allow for something much simpler, like so:

<a href="?{{ page.next_page_querystring }}">Next page</a>

Though there has been much talk of creating template tags which would produce all-out pagination bars, I believe this particular functionality should be an actual method on the page object for two reasons:

1. This is basic functionality whose end result is hard to dispute (as opposed to a full pagination bar where markup and features could be disputed eternally),
2. This does not require the request context processor to be installed.

Note that this patch includes documentation. Tests are still needed. I am not married to the exact implementation, but I and others I have discussed this and feel that this simplicity and fuctionality belong in Django’s pagination.

[Ben Spaulding]

Methods for handling pagination query strings, documentation.

[Greg Brown]

I'm in favour of this proposal

[daybreaker]

See two different approaches:

• ​http://www.djangosnippets.org/snippets/1627/
• ​http://www.djangosnippets.org/snippets/1592/

I also vote for this. :)

[Chris Beaven]

Patch seems like a good idea - should be brought up in the django-dev google group.

[Ben Spaulding]

Replying to SmileyChris:

Patch seems like a good idea - should be brought up in the django-dev google group.

Thanks for the advice. I have started a discussion on django-dev: ​Add querystring helper methods to Page class.

[Aymeric Augustin]

Change UI/UX from NULL to False.

[Aymeric Augustin]

Change Easy pickings from NULL to False.

[Florian Apolloner]

Oh yeah, I run into this all the time. I think that we should allow customization of the querystring name, eg 'p' instead of 'page'. To that end a simple filter and/or tag might be better.

[Ben Spaulding]

Replying to apollo13:

Oh yeah, I run into this all the time. I think that we should allow customization of the querystring name, eg 'p' instead of 'page'. To that end a simple filter and/or tag might be better.

Just to be clear, drop the helper methods and go with a filter or tag, requiring use of the django.core.context_processors.request? (Sounds fine to me, I just want to be clear on the recommended route so this doesn’t bog down in implementation.) What template tag library would that live in? There doesn’t seem to be a current contrib app it would fit in, and I am not sure it belongs in built-ins if it depends on a context processor that is not installed by default.

[Florian Demmer]

i really miss this functionality and like the proposed solution. what is missing from the patch to get his merged?

[Tim Graham]

As indicated by the flags on this ticket "Needs tests".

[Florian Demmer]

sorry, i should have seen that. there is too much nice green in the theme ;)

i have created a pr based on the old patch, but slightly changed the implementation, updated MultipleObjectMixin to use the new feature, added a test, updated two existing tests and the documentation.

rfc: ​https://github.com/django/django/pull/4581

[Florian Demmer]

fixed documentation and added another test; please review updated pr...

[Tim Graham]

After thinking about this some more, I wonder if something like ​https://djangosnippets.org/snippets/2428/ would be a more flexible, generic solution (allowing query strings to be generated in other areas besides pagination, for example). I'm not in love with adding request details to the paginator (seems like a poor separation of concerns).

[Florian Demmer]

Two years ago apollo13 set this approach from "design decision needed" to "accepted", then Ben and I worked on getting the old patch up to date and came back fixing all kinds of details and now you think the alternative approach with a template tag is better.

This is your right of course, but please make a final decision and close this issue regarding "Add querystring helper methods to Page class" as wontfix if you decide in favour of a template tag solution, so that nobody else's time is wasted.

I am out.

[Tim Graham]

We got rid of the "design decision needed" triage stage, so many "accepted" tickets need discussion about implementation details. Often it's difficult to make such decisions without seeing an actual patch. I hoped to start a discussion about the best approach with that comment, not offend you. Of course, I am not trying to waste anyone's time; just trying to craft the best possible APIs for Django.

[Tim Graham]

From apollo13 on IRC: "for me a tag ala {% query_string page=3 %} which would take the existing qs and rewrite it would be perfect".

[Luke Plant]

I think this whole area is solved by django-spurl - ​https://github.com/j4mie/django-spurl

It builds on urlobject which can be used for Python code: ​https://github.com/zacharyvoase/urlobject/

There is also furl for Python code: ​https://github.com/gruns/furl

I don't think we need to duplicate any of these within Django. Having a template tag to do 1/10 of what spurl does is just an invitation to include more and more of spurl's functionality. It might be useful to have some links to spurl in the documentation.

[Curtis Maloney]

Personally I think it wouldn't hurt to have a helper for the specific case of altering the page number _only_.

In a prior project we ended up needing 4 different querystring manipulators [and I'm sure there could have been more].

One would output the original, less any listed keys, plus any specified keys _overridden_ in value.
One would just add new values.
One would return the original with only the listed keys.
A final just updated the page number.

This still doesn't cover, for instance, when you want to add a second value to an existing key... or.... well, given it's a multi-dict, the options are endless.

So, to reiterate: A _simple_ helper for helping with pagination, which is a problem almost everyone encounters, would be good.

A general purpose querystring manipulator? Leave that to 3rd parties.

[Jimmy Merrild Krag]

It's been some time since something happened on this one. i have just stumpled into needing to change query strings in templates, so I thought I'd add my findings.

I have created two rather simple filter which allows you ro edit the query string. django-spurl already does some of this, however not very elegantly. I think the following three filters would be a great addition to Django that will get you "there" much of the time:

​https://pastebin.com/vJ3feNvY

Usage is e.g. <a href="?{% set_query_values page=page.next_page_number %}">&raquo;</a> or <a href="?{% append_query_values selected=item.id %}">Select {{ item.name }}</a>
Note: They all support iterables as values.

I think the only ones probably missing is one for removing a key and one for removing a specific value from a key.

I'm also thinking of merging the set and append (also adding remove) by prepending each key with the action and letting None clear the list when using set_. I imagine something like {% modify_query set_level=7 set_nextlevel=None append_consumedlevels=processed_levels_list remove_availablelevels=7 %}.

What do you think? Any thoughts?

[Jimmy Merrild Krag]

I made an implementation of the above mentioned modify_query.

​https://pastebin.com/nGmVdeks

Thoughts and comments are most welcome.

[Federico Jaramillo Martínez]

Is this ticket still valid?

Would a PR with a templatetag be accepted?
If so, I could be working on this.

If anyone can confirm I would appreciate.

Thanks

[Claude Paroz]

Sure, it's still valid. Read attentively the existing comments.

Maybe the greatest challenge of this ticket is to find a compromise between functionality and simplicity, addressing the more common use cases while accepting it won't address all possible needs.

[Carsten Fuchs]

I too had reinvented this wheel a couple of years ago, unaware of this ticket. Other implementations above are more powerful, but this one is short:

@register.simple_tag
def query_string(*args, **kwargs):
    """
    Combines dictionaries of query parameters and individual query parameters
    and builds an encoded URL query string from the result.
    """
    query_dict = QueryDict(mutable=True)

    for a in args:
        query_dict.update(a)

    remove_keys = []

    for k, v in kwargs.items():
        if v is None:
            remove_keys.append(k)
        elif isinstance(v, list):
            query_dict.setlist(k, v)
        else:
            query_dict[k] = v

    for k in remove_keys:
        if k in query_dict:
            del query_dict[k]

    qs = query_dict.urlencode()
    if not qs:
        return ""
    return "?" + qs

It cannot do everything, but covers all my use cases: Keep most of the existing source parameters, but delete, add or change some. Examples:

{# Just repeat the parameters: #}
{% query_string request.GET %}

{# Add a parameter: #}
{% query_string request.GET format='pdf' %}

{# Change a parameter: #}
{% query_string request.GET page=next_page_number %}

{# Overwrite month and year with precomputed values, e.g. with next_month_year = {'month': 1, 'year': 2022}, and clear the day: #}
{% query_string request.GET next_month_year day=None %}

I'm aware that posting yet another implementation does not achieve true progress and that the more elaborate implementations above may be more appropriate for inclusion in Django.
Still, I wanted to mention this because in my opinion it keeps the balance between features and simplicity.

[Leonardo Cavallucci]

I would really love to have this: I could work on this, if it is decided how this should work

[Tom Carrick]

​PR

[Mariusz Felisiak <felisiak.mariusz@…>]

In e67d3580:

Fixed #10941 -- Added {% query_string %} template tag.

[GitHub <noreply@…>]

In 27043bd:

Refs #10941 -- Renamed query_string template tag to querystring.

[Natalia <124304+nessita@…>]

In 91a5b5a:

[5.1.x] Refs #10941 -- Renamed query_string template tag to querystring.

Backport of 27043bde5b795eb4a605aeca1d3bc4345d2ca478 from main.

[GitHub <noreply@…>]

In 5dc1717:

Refs #10941 -- Renamed test file test_query_string.py to test_querystring.py.

This follows previous renames made in 27043bde5b795eb4a605aeca1d3bc4345d2ca478.

[Natalia <124304+nessita@…>]

In df7ebb8:

[5.1.x] Refs #10941 -- Renamed test file test_query_string.py to test_querystring.py.

This follows previous renames made in 27043bde5b795eb4a605aeca1d3bc4345d2ca478.

Backport of 5dc17177c38662d6f4408258ee117cd80e0cb933 from main.

[GitHub <noreply@…>]

In cf03aa4e:

Refs #10941 -- Reorganized querystring template tag docs.

[Natalia <124304+nessita@…>]

In 39062e79:

[5.1.x] Refs #10941 -- Reorganized querystring template tag docs.

Backport of cf03aa4e94625971852a09e869f7ee7c328b573f from main.

[Natalia Bidart]

Further tests to this template tag: ​https://github.com/django/django/pull/18487

[Sarah Boyce <42296566+sarahboyce@…>]

In f2b44ef4:

Refs #10941 -- Added helper and refactored tests for querystring template tag.

Thank you Sarah Boyce for the review and suggestions.

[Sarah Boyce <42296566+sarahboyce@…>]

In 15ca7544:

Refs #10941 -- Added tests in querystring template tag.

These extra tests assert over the handling of empty params (None, empty
dict, empty QueryDict), and also for dicts having non-string keys.