Summary

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

Review Request #14698 — Created Nov. 18, 2025 and submitted Dec. 9, 2025, 11:27 p.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.	da691fa6551cc7af6020df8536c503ad461fc4ef

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.

da691fa6551cc7af6020df8536c503ad461fc4ef

Issues

Description	From	Last Updated
The end sounds a bit weird, maybe say "... before use."	maubin	Nov. 28, 2025, 8:27 p.m.
Shouldn't here and the "Version Added"s below all be "Version Changed" instead?	maubin	Nov. 28, 2025, 8:30 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. 28, 2025, 8:34 p.m.
Perhaps we should raise TemplateSyntaxError if 'spaceless', 'strip', or 'unsafe' are provided but we're casting to bool or int?	david	Nov. 28, 2025, 8:41 p.m.
You're stripping twice here.	david	Nov. 28, 2025, 8:41 p.m.
Can we add tests for "1", "TRUE", "0", "false", as well as a few including whitespace (" true", " 1 …	david	Nov. 28, 2025, 8:42 p.m.
Can we add tests with whitespace, 0, and negative numbers?	david	Nov. 28, 2025, 8:57 p.m.
'typing.Any' imported but unused Column: 5 Error code: F401	reviewbot	Nov. 28, 2025, 9:15 p.m.

flake8 passed.

JSHint passed.

djblets/util/templatetags/djblets_utils.py (Diff revision 1)
The issue has been resolved. Show all issues
```
The end sounds a bit weird, maybe say "... before use."
```
1. chipx86 Nov. 28, 2025, 9:04 p.m.
  Good catch. Definitely a typo. Fixed.

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

The issue has been resolved. Show all issues

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

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

The issue has been resolved. 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

chipx86 Nov. 28, 2025, 9:04 p.m.

That call is str, but I was aiming to keep this flexible with types since the stored result actually could be anything (I flirted with JSON-compatible types as a result as well). But yeah, I can go for explicit here.

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

The issue has been resolved. 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)
The issue has been resolved. Show all issues
```
You're stripping twice here.
```

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

The issue has been resolved. 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)
The issue has been resolved. Show all issues
```
Can we add tests with whitespace, 0, and negative numbers?
```

Change Summary:


Added valid option checking for all types.
Improved typing.
Removed an extra strip() call.
Added more thorough unit testing.

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
	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.	da691fa6551cc7af6020df8536c503ad461fc4ef

Diff:

Revision 2 (+556 -40)

Show changes

	djblets/util/templatetags/djblets_utils.py
	djblets/util/tests/test_djblets_utils_tags.py

Checks run (1 failed, 1 succeeded)

flake8 failed.

JSHint passed.

flake8

djblets/util/templatetags/djblets_utils.py (Diff revision 2)
The issue has been resolved. Show all issues
```
'typing.Any' imported but unused

Column: 5
Error code: F401
```

Ship it!

```
Ship It!
```

Ship it!

```
Ship It!
```

Status:: Completed
Change Summary:: Pushed to release-5.x (f6b636f)