Summary

Add constructor-level customization of columns and sorting in datagrids.

Review Request #14818 — Created Feb. 16, 2026 and submitted March 9, 2026, 5:08 p.m.

Information

Owner

chipx86

Repository

Djblets

Branch

release-5.x

Bugs

Depends On

Reviewers

Groups

djblets

People

Description

This change introduces new columns and sort arguments to the
DataGrid constructor. These both take lists of strings, and behave the
same way that the query string versions do. They can also take None,
which will force usage of the datagrid defaults.

This not only overrides (and disables) anything in the querystring, but
also prevents both loading from and saving to the user profile.

Testing Done

Unit tests pass.

Tested with some in-progress code using specially-constructed datagrids,
and verified I could define the columns and sort order.

Commits

Summary	ID
Add constructor-level customization of columns and sorting in datagrids. Datagrids have historically allowed for custom column selection/ordering and sorting via HTTP GET query strings. This works great in the case where you want to display a standard datagrid page with user choices, but less so when you want to handle providing these options through other means. This change introduces new `columns` and `sort` arguments to the `DataGrid` constructor. These both take lists of strings, and behave the same way that the query string versions do. They can also take `None`, which will force usage of the datagrid defaults. This not only overrides (and disables) anything in the querystring, but also prevents both loading from and saving to the user profile.	b60b8f39ff477c8b6cc122ce62163fdf63aa25c1

Summary

Add constructor-level customization of columns and sorting in datagrids.

Datagrids have historically allowed for custom column selection/ordering and sorting via HTTP GET query strings. This works great in the case where you want to display a standard datagrid page with user choices, but less so when you want to handle providing these options through other means. This change introduces new `columns` and `sort` arguments to the `DataGrid` constructor. These both take lists of strings, and behave the same way that the query string versions do. They can also take `None`, which will force usage of the datagrid defaults. This not only overrides (and disables) anything in the querystring, but also prevents both loading from and saving to the user profile.

b60b8f39ff477c8b6cc122ce62163fdf63aa25c1

Issues

Description	From	Last Updated
In the change description, you say a None value forces usage of the datagrid defaults. Can we add unit tests …	david	March 2, 2026, 11:40 p.m.
These were wrong previously, but both should be typed as str \| None.	david	March 2, 2026, 11:32 p.m.
Since you removed the part of the docstring about returning bool, can we update this to just return list[str]?	david	March 2, 2026, 11:33 p.m.
We could take all of this out of the if sort_column_names block. If sort_column_names is an empty list, then the …	maubin	March 3, 2026, 11:49 a.m.

flake8 passed.

JSHint passed.

The issue has been resolved. Show all issues

In the change description, you say a None value forces usage of the datagrid defaults. Can we add unit tests for this?

djblets/datagrid/grids.py (Diff revision 1)
The issue has been resolved. Show all issues
```
These were wrong previously, but both should be typed as str | None.
```

djblets/datagrid/grids.py (Diff revision 1)

The issue has been resolved. Show all issues

Since you removed the part of the docstring about returning bool, can we update this to just return list[str]?

Change Summary:


Added unit tests for the columns=None and sort=None cases.
Fixed some incorrect and deprecated typing.

Commits:

	Summary	ID
	Add constructor-level customization of columns and sorting in datagrids. Datagrids have historically allowed for custom column selection/ordering and sorting via HTTP GET query strings. This works great in the case where you want to display a standard datagrid page with user choices, but less so when you want to handle providing these options through other means. This change introduces new `columns` and `sort` arguments to the `DataGrid` constructor. These both take lists of strings, and behave the same way that the query string versions do. They can also take `None`, which will force usage of the datagrid defaults. This not only overrides (and disables) anything in the querystring, but also prevents both loading from and saving to the user profile.	a077d3ae3d5ccae704ea497cbb461dca45cb540e
	Add constructor-level customization of columns and sorting in datagrids. Datagrids have historically allowed for custom column selection/ordering and sorting via HTTP GET query strings. This works great in the case where you want to display a standard datagrid page with user choices, but less so when you want to handle providing these options through other means. This change introduces new `columns` and `sort` arguments to the `DataGrid` constructor. These both take lists of strings, and behave the same way that the query string versions do. They can also take `None`, which will force usage of the datagrid defaults. This not only overrides (and disables) anything in the querystring, but also prevents both loading from and saving to the user profile.	f6c5d3dbd37ba9d90a1a539942671dba6ae6829f

Diff:

Revision 2 (+840 -206)

Show changes

	djblets/datagrid/grids.py
	djblets/datagrid/tests.py

Checks run (2 succeeded)

flake8 passed.

JSHint passed.

djblets/datagrid/grids.py (Diff revision 2)

The issue has been resolved. Show all issues

We could take all of this out of the if sort_column_names block. If sort_column_names is an empty list, then the for loop won't run anyways.

Change Summary:

Moved some code out of an unnecessary conditional.

Commits:

	Summary	ID
	Add constructor-level customization of columns and sorting in datagrids. Datagrids have historically allowed for custom column selection/ordering and sorting via HTTP GET query strings. This works great in the case where you want to display a standard datagrid page with user choices, but less so when you want to handle providing these options through other means. This change introduces new `columns` and `sort` arguments to the `DataGrid` constructor. These both take lists of strings, and behave the same way that the query string versions do. They can also take `None`, which will force usage of the datagrid defaults. This not only overrides (and disables) anything in the querystring, but also prevents both loading from and saving to the user profile.	f6c5d3dbd37ba9d90a1a539942671dba6ae6829f
	Add constructor-level customization of columns and sorting in datagrids. Datagrids have historically allowed for custom column selection/ordering and sorting via HTTP GET query strings. This works great in the case where you want to display a standard datagrid page with user choices, but less so when you want to handle providing these options through other means. This change introduces new `columns` and `sort` arguments to the `DataGrid` constructor. These both take lists of strings, and behave the same way that the query string versions do. They can also take `None`, which will force usage of the datagrid defaults. This not only overrides (and disables) anything in the querystring, but also prevents both loading from and saving to the user profile.	b60b8f39ff477c8b6cc122ce62163fdf63aa25c1

Diff:

Revision 3 (+854 -224)

Show changes

	djblets/datagrid/grids.py
	djblets/datagrid/tests.py

Checks run (2 succeeded)

flake8 passed.

JSHint passed.

Ship it!

```
Ship It!
```

Ship it!

```
Ship It!
```

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