Summary

Add JSON serialization of datagrids.

Review Request #14819 — 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 can be used to provide datagrid functionality in other contexts.
The primary purpose at this time is to enable API access to datagrids.
The information can be returned as-is or further processed to provide
a more integrated response into an API response format.

Columns can provide an explicit JSON value alongside rendered HTML. Both
now default to making use of a new get_raw_object_value(), which can
provide a suitable value from an object. This is intended for column
implementations to override and use as necessary, and to simplify common
code used for render_data() and to_json().

Testing Done

Unit tests pass.

Commits

Summary	ID
Add JSON serialization of datagrids. Datagrids can now be serialized to JSON, providing information on active and available columns, pagination, sorting information, rows, and each cell within. The cells contain both rendered HTML (the `<td>` and everything inside) and a JSON value for processing. This can be used to provide datagrid functionality in other contexts. The primary purpose at this time is to enable API access to datagrids. The information can be returned as-is or further processed to provide a more integrated response into an API response format. Columns can provide an explicit JSON value alongside rendered HTML. Both now default to making use of a new `get_raw_object_value()`, which can provide a suitable value from an object. This is intended for column implementations to override and use as necessary, and to simplify common code used for `render_data()` and `to_json()`.	11740c0c81165439a08fa74dd2a505c34a7efab0

Summary

Add JSON serialization of datagrids.

Datagrids can now be serialized to JSON, providing information on active and available columns, pagination, sorting information, rows, and each cell within. The cells contain both rendered HTML (the `<td>` and everything inside) and a JSON value for processing. This can be used to provide datagrid functionality in other contexts. The primary purpose at this time is to enable API access to datagrids. The information can be returned as-is or further processed to provide a more integrated response into an API response format. Columns can provide an explicit JSON value alongside rendered HTML. Both now default to making use of a new `get_raw_object_value()`, which can provide a suitable value from an object. This is intended for column implementations to override and use as necessary, and to simplify common code used for `render_data()` and `to_json()`.

11740c0c81165439a08fa74dd2a505c34a7efab0

Issues

Description	From	Last Updated
Should probably be "... in a datagrid." instead of "... in a datagrid row."	david	March 2, 2026, 11:41 p.m.
Can we add "or None if this column has no field_name." here too.	maubin	March 2, 2026, 11:45 p.m.
Given that this implementation types the return value as datetime \| None, seems like this could say it returns datetime.datetime.	david	March 2, 2026, 11:42 p.m.
Other implementations of this use "Return a JSON-serializable value for an object in a cell" for the description. Looks like …	david	March 2, 2026, 11:42 p.m.
Shouldn't this be using self.get_raw_object_value(obj)? Let's also call the variable something other than datetime so we don't shadow the import.	david	March 2, 2026, 11:44 p.m.
You can use stateful_columns here instead of self.columns.	maubin	March 2, 2026, 11:45 p.m.
Please fix the docstring to say "... with no field name"	david	March 2, 2026, 11:44 p.m.

flake8 passed.

JSHint passed.

djblets/datagrid/grids.py (Diff revision 1)
The issue has been resolved. Show all issues
```
Should probably be "... in a datagrid." instead of "... in a datagrid row."
```

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

The issue has been resolved. Show all issues

Given that this implementation types the return value as datetime | None, seems like this could say it returns datetime.datetime.

chipx86 March 2, 2026, 11:50 p.m.
```
Yeah, copy-paste-o's.
```

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

The issue has been resolved. Show all issues

Other implementations of this use "Return a JSON-serializable value for an object in a cell" for the description. Looks like this was missed as you iterated.

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

The issue has been resolved. Show all issues

Shouldn't this be using self.get_raw_object_value(obj)?

Let's also call the variable something other than datetime so we don't shadow the import.

djblets/datagrid/tests.py (Diff revision 1)
The issue has been resolved. Show all issues
```
Please fix the docstring to say "... with no field name"
```

djblets/datagrid/grids.py (Diff revision 1)
The issue has been resolved. Show all issues
```
Can we add "or None if this column has no field_name." here too.
```
djblets/datagrid/grids.py (Diff revision 1)
The issue has been resolved. Show all issues
```
You can use stateful_columns here instead of self.columns.
```

Change Summary:


Fixed a handful of docs and docstrings.
Updated DateTimeSinceColumn to utilize get_raw_object_value(), and fixed a variable name conflict.
Updated a reference to self.columns to just use the local variable we already pulled out.

Commits:

	Summary	ID
	Add JSON serialization of datagrids. Datagrids can now be serialized to JSON, providing information on active and available columns, pagination, sorting information, rows, and each cell within. The cells contain both rendered HTML (the `<td>` and everything inside) and a JSON value for processing. This can be used to provide datagrid functionality in other contexts. The primary purpose at this time is to enable API access to datagrids. The information can be returned as-is or further processed to provide a more integrated response into an API response format. Columns can provide an explicit JSON value alongside rendered HTML. Both now default to making use of a new `get_raw_object_value()`, which can provide a suitable value from an object. This is intended for column implementations to override and use as necessary, and to simplify common code used for `render_data()` and `to_json()`.	3fbcb7f5fd9f71ed1c49e2acb314f30950c8121b
	Add JSON serialization of datagrids. Datagrids can now be serialized to JSON, providing information on active and available columns, pagination, sorting information, rows, and each cell within. The cells contain both rendered HTML (the `<td>` and everything inside) and a JSON value for processing. This can be used to provide datagrid functionality in other contexts. The primary purpose at this time is to enable API access to datagrids. The information can be returned as-is or further processed to provide a more integrated response into an API response format. Columns can provide an explicit JSON value alongside rendered HTML. Both now default to making use of a new `get_raw_object_value()`, which can provide a suitable value from an object. This is intended for column implementations to override and use as necessary, and to simplify common code used for `render_data()` and `to_json()`.	11740c0c81165439a08fa74dd2a505c34a7efab0

Diff:

Revision 2 (+1480 -56)

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 (1e05185)