[Django] #36941: Enhancement Proposal for querystring template tag: Support for dynamic context-based keys

[Django]

#36941: Enhancement Proposal for querystring template tag: Support for dynamic
context-based keys
-------------------------------------+-------------------------------------
Reporter: Hristo Trendafilov | Type:
| Cleanup/optimization
Status: new | Component: Template
| system
Version: 5.2 | Severity: Normal
Keywords: | Triage Stage:
| Unreviewed
Has patch: 1 | Needs documentation: 0
Needs tests: 0 | Patch needs improvement: 0
Easy pickings: 1 | UI/UX: 0
-------------------------------------+-------------------------------------
**Problem Statement**

Currently, the `{% querystring %}` template tag treats the keys in kwargs
as static strings. While this works for simple use cases, it severely
limits the reusability of templates in component-based architectures.

When using `{% include %}` to render a reusable component (like a generic
filter, a sortable table header, or a pagination widget), the parameter
name (the key) often needs to be dynamic, just like the value.

**The Use Case**

Imagine a reusable include for a sortable column: `sort_link.html`


{{{
<a href="{% querystring sort_param=field_name %}">
Sort by {{ field_label }}
</a>
}}}


If we include it like this:

`{% include 'sort_link.html' with sort_param='order_by' field_name='price'
%}`

Current Behaviour: It produces `?sort_param=price`.
Expected/Desired Behaviour: It should produce `?order_by=price`.

**Proposed Solution**

Add an optional boolean parameter `resolve_keys` (or similar) to the
querystring tag. When set to `True`, the tag will look up the key names in
the current context before processing the query dict.

Alternatively, there could be a dedicated template tag that reuses the
current `querystring`

{{{
@register.simple_tag(takes_context=True)
def querystring(context, query_dict=None, resolve_keys=False, **kwargs):
# ... existing logic ...

for _key, value in kwargs.items():
# Look up the key name in context if the flag is True
key = context.get(_key, key) if resolve_keys else _key

if key is None:
# suggested behaviour - remove this key if in parameters, like
if passed `key=None`

# ... correct logic continues ...

}}}

**Benefits**

Decoupling: Templates don't need to know the specific backend parameter
names.
DRY: One include can handle different filtering/sorting logic across
different views.
Consistency: Aligns with how Django handles dynamic values, extending that
logic to keys.
--
Ticket URL: <https://code.djangoproject.com/ticket/36941>
Django <https://code.djangoproject.com/>
The Web framework for perfectionists with deadlines.

[Django]

#36941: Enhancement Proposal for querystring template tag: Support for dynamic
context-based keys
-------------------------------------+-------------------------------------

Reporter: Hristo Trendafilov | Owner: (none)
Type: | Status: new
Cleanup/optimization |

Component: Template system | Version: 5.2

Severity: Normal | Resolution:

Keywords: | Triage Stage:
| Unreviewed
Has patch: 1 | Needs documentation: 0
Needs tests: 0 | Patch needs improvement: 0
Easy pickings: 1 | UI/UX: 0
-------------------------------------+-------------------------------------

Description changed by Hristo Trendafilov:

Old description:

New description:

**Problem Statement**

Currently, the `{% querystring %}` template tag treats the keys in kwargs
as static strings. While this works for simple use cases, it severely
limits the reusability of templates in component-based architectures.

When using `{% include %}` to render a reusable component (like a generic
filter, a sortable table header, or a pagination widget), the parameter
name (the key) often needs to be dynamic, just like the value.

**The Use Case**

Imagine a reusable include for a sortable column: `sort_link.html`


{{{
<a href="{% querystring sort_param=field_name %}">
Sort by {{ field_label }}
</a>
}}}


If we include it like this:

`{% include 'sort_link.html' with sort_param='order_by' field_name='price'

field_label='By Price' %}`

--
Ticket URL: <https://code.djangoproject.com/ticket/36941#comment:1>

[Django]

key = context.get(_key) if resolve_keys else _key

if key is None:
# suggested behaviour - remove this key if in parameters, like
if passed `key=None`

# ... correct logic continues ...

}}}

**Benefits**

Decoupling: Templates don't need to know the specific backend parameter
names.
DRY: One include can handle different filtering/sorting logic across
different views.
Consistency: Aligns with how Django handles dynamic values, extending that
logic to keys.

--
--

Ticket URL: <https://code.djangoproject.com/ticket/36941#comment:2>

[Django]

#36941: Enhancement Proposal for querystring template tag: Support for dynamic
context-based keys
-------------------------------------+-------------------------------------
Reporter: Hristo Trendafilov | Owner: (none)
Type: | Status: new
Cleanup/optimization |
Component: Template system | Version: 5.2
Severity: Normal | Resolution:
Keywords: | Triage Stage:
| Unreviewed
Has patch: 1 | Needs documentation: 0
Needs tests: 0 | Patch needs improvement: 0
Easy pickings: 1 | UI/UX: 0
-------------------------------------+-------------------------------------

Changes (by Yogya Chugh ):

* cc: Yogya Chugh (added)

--
Ticket URL: <https://code.djangoproject.com/ticket/36941#comment:3>

[Django]

#36941: Enhancement Proposal for querystring template tag: Support for dynamic
context-based keys
-------------------------------------+-------------------------------------

Reporter: Hristo Trendafilov | Owner: Vishy
Type: | Algo
Cleanup/optimization | Status: assigned

Component: Template system | Version: 5.2
Severity: Normal | Resolution:
Keywords: | Triage Stage:
| Unreviewed
Has patch: 1 | Needs documentation: 0
Needs tests: 0 | Patch needs improvement: 0
Easy pickings: 1 | UI/UX: 0
-------------------------------------+-------------------------------------

Changes (by Vishy Algo):

* owner: (none) => Vishy Algo
* status: new => assigned

--
Ticket URL: <https://code.djangoproject.com/ticket/36941#comment:4>

[Django]

#36941: Enhancement Proposal for querystring template tag: Support for dynamic
context-based keys
-------------------------------------+-------------------------------------
Reporter: Hristo Trendafilov | Owner: Vishy
Type: | Algo
Cleanup/optimization | Status: assigned
Component: Template system | Version: 5.2
Severity: Normal | Resolution:
Keywords: | Triage Stage:
| Unreviewed
Has patch: 1 | Needs documentation: 0
Needs tests: 0 | Patch needs improvement: 0
Easy pickings: 1 | UI/UX: 0
-------------------------------------+-------------------------------------

Comment (by Hristo Trendafilov):

If needed, I could give a hand with that as well.
--
Ticket URL: <https://code.djangoproject.com/ticket/36941#comment:5>

[Django]

#36941: Enhancement Proposal for querystring template tag: Support for dynamic
context-based keys
-------------------------------------+-------------------------------------
Reporter: Hristo Trendafilov | Owner: Vishy
Type: | Algo
Cleanup/optimization | Status: assigned
Component: Template system | Version: 5.2
Severity: Normal | Resolution:
Keywords: | Triage Stage:
| Unreviewed
Has patch: 1 | Needs documentation: 0
Needs tests: 0 | Patch needs improvement: 0
Easy pickings: 1 | UI/UX: 0
-------------------------------------+-------------------------------------

Comment (by Vishy Algo):

Has this got consensus? It would be better to raise this on the Django
Forum first.
--
Ticket URL: <https://code.djangoproject.com/ticket/36941#comment:6>

[Django]

#36941: Enhancement Proposal for querystring template tag: Support for dynamic
context-based keys
-------------------------------------+-------------------------------------
Reporter: Hristo Trendafilov | Owner: Vishy
Type: | Algo
Cleanup/optimization | Status: assigned
Component: Template system | Version: 5.2
Severity: Normal | Resolution:
Keywords: | Triage Stage:
| Unreviewed
Has patch: 1 | Needs documentation: 0
Needs tests: 0 | Patch needs improvement: 0
Easy pickings: 1 | UI/UX: 0
-------------------------------------+-------------------------------------

Comment (by Hristo Trendafilov):

Replying to [comment:6 Vishy Algo]:

> Has this got consensus? It would be better to raise this on the Django
Forum first.

I think this is a needed update to make this template tag more dynamic,
reusable and comply better with the Django template inheritance.

But anyway - https://forum.djangoproject.com/t/enhancement-proposal-for-
querystring-template-tag-support-for-dynamic-context-based-keys/44281
--
Ticket URL: <https://code.djangoproject.com/ticket/36941#comment:7>

[Django]

#36941: Enhancement Proposal for querystring template tag: Support for dynamic
context-based keys
-------------------------------------+-------------------------------------
Reporter: Hristo Trendafilov | Owner: Vishy
Type: | Algo

Cleanup/optimization | Status: closed

Component: Template system | Version: 5.2

Severity: Normal | Resolution: invalid
Keywords: | Triage Stage:
| Unreviewed
Has patch: 0 | Needs documentation: 0

Needs tests: 0 | Patch needs improvement: 0

Easy pickings: 0 | UI/UX: 0
-------------------------------------+-------------------------------------
Changes (by Clifford Gama):

* easy: 1 => 0
* has_patch: 1 => 0
* resolution: => invalid
* status: assigned => closed

Comment:

Thanks for the ticket. Both `querystring` and the `{% with %}` tag are
working as expected, but they don’t support dynamic parameter names, so
they won’t produce the exact output you’re looking for.

You should be able to achieve what you want by writing a custom template
tag that takes a parameter name and value, builds the query string in
Python, and returns the correct URL. You'd then replace `querystring` in
your include template with that tag (which potentially might be a simple
wrapper around `querystring`.

Closing this ticket per
https://code.djangoproject.com/wiki/TicketClosingReasons/UseSupportChannels.
If you want to propose a change to the template language syntax itself,
you’d have to open a new feature proposal/suggestion
[https://docs.djangoproject.com/en/dev/internals/contributing/bugs-and-
features/#requesting-features per this documentation].
--
Ticket URL: <https://code.djangoproject.com/ticket/36941#comment:8>