Summary

Introduce WebAPIResource.serialize_object_list for serializing lists.

Review Request #14298 — Created Jan. 20, 2025 and submitted Feb. 13, 2025, 6:23 p.m.

Information

Owner

chipx86

Repository

Djblets

Branch

release-5.x

Bugs

Depends On

Reviewers

Groups

djblets

People

Description

This adds a new WebAPIResource.serialize_object_list() method and
serialize_object_list_func argument to WebAPIResponsePaginated.
These allow an implementation to pre-process the list of items going
into a response, or to post-process or replace the serialized result.

The main use case is to allow resources to perform additional logic
across the list of items before or after serializing, such as
bulk-fetching extra data from cache or extensions hooks to include in
results.

Testing Done

Unit tests pass.

Commits

Summary	ID
Introduce WebAPIResource.serialize_object_list for serializing lists. This adds a new `WebAPIResource.serialize_object_list()` method and `serialize_object_list_func` argument to `WebAPIResponsePaginated`. These allow an implementation to pre-process the list of items going into a response, or to post-process or replace the serialized result. The main use case is to allow resources to perform additional logic across the list of items before or after serializing, such as bulk-fetching extra data from cache or extensions hooks to include in results.	356f4b5b88528d427e53302113c9403a46f60894

Summary

Introduce WebAPIResource.serialize_object_list for serializing lists.

This adds a new `WebAPIResource.serialize_object_list()` method and `serialize_object_list_func` argument to `WebAPIResponsePaginated`. These allow an implementation to pre-process the list of items going into a response, or to post-process or replace the serialized result. The main use case is to allow resources to perform additional logic across the list of items before or after serializing, such as bulk-fetching extra data from cache or extensions hooks to include in results.

356f4b5b88528d427e53302113c9403a46f60894

Issues

Description	From	Last Updated
Given that this method isn't using keyword-only args, should we not be adding this to the end of the argument …	david	Jan. 22, 2025, 10:01 p.m.

flake8 passed.

JSHint passed.

djblets/webapi/responses.py (Diff revision 1)

The issue has been dropped. Show all issues

Given that this method isn't using keyword-only args, should we not be adding this to the end of the argument list instead of before extra_data?

Also, want to make this use kw-only args?

chipx86 Jan. 22, 2025, 9:41 p.m.

This is using keyword-only arguments. *args is defined above, placing everything after as a keyword-only argument.

Change Summary:

Fixed passing in request, *args, **kwargs to serialize_object().

Commits:

	Summary	ID
	Introduce WebAPIResource.serialize_object_list for serializing lists. This adds a new `WebAPIResource.serialize_object_list()` method and `serialize_object_list_func` argument to `WebAPIResponsePaginated`. These allow an implementation to pre-process the list of items going into a response, or to post-process or replace the serialized result. The main use case is to allow resources to perform additional logic across the list of items before or after serializing, such as bulk-fetching extra data from cache or extensions hooks to include in results.	b802ba686b1ad42b8fd23f5fd65717e8b4fb8908
	Introduce WebAPIResource.serialize_object_list for serializing lists. This adds a new `WebAPIResource.serialize_object_list()` method and `serialize_object_list_func` argument to `WebAPIResponsePaginated`. These allow an implementation to pre-process the list of items going into a response, or to post-process or replace the serialized result. The main use case is to allow resources to perform additional logic across the list of items before or after serializing, such as bulk-fetching extra data from cache or extensions hooks to include in results.	356f4b5b88528d427e53302113c9403a46f60894

Diff:

Revision 2 (+432 -30)

Show changes

	djblets/webapi/responses.py
	djblets/webapi/resources/base.py
	djblets/webapi/tests/test_responses.py
	djblets/webapi/tests/test_webapiresource.py

Checks run (1 timed out)

JSHint timed out.

Ship it!

```
Ship It!
```

Ship it!

```
Ship It!
```

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