Summary

Add a as_type= argument for {% definevar %} for casting to types.

Review Request #14698 — Created Nov. 18, 2025 and updated Nov. 19, 2025, 10:05 a.m.

Information

Owner

chipx86

Repository

Djblets

Branch

release-5.x

Bugs

Depends On

Reviewers

Groups

djblets

People

Description

{% definevar %} can now store a value as a boolean or integer through
the as_type= argument. By default, this stored as a string
(equivalent to str).

When passing as_type=bool, a true (lowercased) or 1 will
result in a stored True. Anything else will be False.

When passing as_type=int, the value will be converted to an integer.
If the value can't be parsed as an integer, a TemplateSyntaxError will
be raised.

There's also an optimization around the options. We now convert to a
set so we don't repeatedly iterate through the list for each option.

Testing Done

Unit tests pass.

Made use of this in some in-progress code in Review Board for setting
options.

Commits

Summary	ID
Add a as_type= argument for {% definevar %} for casting to types. `{% definevar %}` can now store a value as a boolean or integer through the `as_type=` argument. By default, this stored as a string (equivalent to `str`). When passing `as_type=bool`, a `true` (lowercased) or `1` will result in a stored `True`. Anything else will be `False`. When passing `as_type=int`, the value will be converted to an integer. If the value can't be parsed as an integer, a `TemplateSyntaxError` will be raised. There's also an optimization around the options. We now convert to a `set` so we don't repeatedly iterate through the list for each option.	b07678ceb1eb5292b075300623226a4663108dc6

Summary

Add a as_type= argument for {% definevar %} for casting to types.

`{% definevar %}` can now store a value as a boolean or integer through the `as_type=` argument. By default, this stored as a string (equivalent to `str`). When passing `as_type=bool`, a `true` (lowercased) or `1` will result in a stored `True`. Anything else will be `False`. When passing `as_type=int`, the value will be converted to an integer. If the value can't be parsed as an integer, a `TemplateSyntaxError` will be raised. There's also an optimization around the options. We now convert to a `set` so we don't repeatedly iterate through the list for each option.

b07678ceb1eb5292b075300623226a4663108dc6

Issues

Description	From	Last Updated
The end sounds a bit weird, maybe say "... before use."	maubin	Nov. 18, 2025, 9:45 p.m.
Shouldn't here and the "Version Added"s below all be "Version Changed" instead?	maubin	Nov. 18, 2025, 9:45 p.m.
Shouldn't the result of this always be str, not Any? Given that this is essentially a parse step, it would …	david	Nov. 19, 2025, 10:05 a.m.
Perhaps we should raise TemplateSyntaxError if 'spaceless', 'strip', or 'unsafe' are provided but we're casting to bool or int?	david	Nov. 19, 2025, 10:05 a.m.
You're stripping twice here.	david	Nov. 19, 2025, 10:05 a.m.
Can we add tests for "1", "TRUE", "0", "false", as well as a few including whitespace (" true", " 1 …	david	Nov. 19, 2025, 10:05 a.m.
Can we add tests with whitespace, 0, and negative numbers?	david	Nov. 19, 2025, 10:05 a.m.

flake8 passed.

JSHint passed.

Fix it!

djblets/util/templatetags/djblets_utils.py (Diff revision 1)
An issue was opened. Show all issues
```
The end sounds a bit weird, maybe say "... before use."
```

djblets/util/templatetags/djblets_utils.py (Diff revision 1)

An issue was opened. Show all issues

Shouldn't here and the "Version Added"s below all be "Version Changed" instead?

Fix it!

djblets/util/templatetags/djblets_utils.py (Diff revision 1)

An issue was opened. Show all issues

Shouldn't the result of this always be str, not Any?

Given that this is essentially a parse step, it would be nice to assign the result after the parse to a separate variable which is explicitly typed as str | SafeString | int | bool instead of reassigning to result

djblets/util/templatetags/djblets_utils.py (Diff revision 1)

An issue was opened. Show all issues

Perhaps we should raise TemplateSyntaxError if 'spaceless', 'strip', or 'unsafe' are provided but we're casting to bool or int?

djblets/util/templatetags/djblets_utils.py (Diff revision 1)
An issue was opened. Show all issues
```
You're stripping twice here.
```

djblets/util/tests/test_djblets_utils_tags.py (Diff revision 1)

An issue was opened. Show all issues

Can we add tests for "1", "TRUE", "0", "false", as well as a few including whitespace (" true", " 1 ")?

djblets/util/tests/test_djblets_utils_tags.py (Diff revision 1)
An issue was opened. Show all issues
```
Can we add tests with whitespace, 0, and negative numbers?
```