Summary

Add new resources, part 3/7.

Review Request #14342 — Created Feb. 10, 2025 and submitted April 30, 2025, 9:06 a.m.

Information

Owner

david

Repository

RBTools

Branch

master

Bugs

Depends On

Reviewers

Groups

rbtools

People

Description

This involves one update to our base ListResource implementation (and
various related plumbing) to allow subclasses to force a specific class
type to be used for items. In the case of repository branches and
commits, these are list resources that do not have an associated item
endpoint or mimetype, and so the basic _wrap_field() and create
functionality was returning a plain ItemResource. For this case,
ListResource subclasses can now set _item_resource_type to force a
specific item resource subclass instead.

Testing Done


Ran unit tests.
Used the new resources from a test script and saw that everything

  worked as expected.

Commits

Summary	ID
Add new resources, part 3/7. This change adds the following new resource implementations: - RepositoryItemResource - RepositoryListResource - RepositoryBranchItemResource - RepositoryBranchListResource - RepositoryCommitItemResource - RepositoryCommitListResource - RepositoryGroupItemResource - RepositoryGroupListResource - RepositoryInfoResource - RepositoryUserItemResource - RepositoryUserListResource This involves one update to our base ListResource implementation (and various related plumbing) to allow subclasses to force a specific class type to be used for items. In the case of repository branches and commits, these are list resources that do not have an associated item endpoint or mimetype, and so the basic `_wrap_field()` and create functionality was returning a plain `ItemResource`. For this case, `ListResource` subclasses can now set `_item_resource_type` to force a specific item resource subclass instead. Testing Done: - Ran unit tests. - Used the new resources from a test script and saw that everything worked as expected.	549a3f62b393c192f28faa46867d96dcf9dceddf

Summary

Add new resources, part 3/7.

This change adds the following new resource implementations: - RepositoryItemResource - RepositoryListResource - RepositoryBranchItemResource - RepositoryBranchListResource - RepositoryCommitItemResource - RepositoryCommitListResource - RepositoryGroupItemResource - RepositoryGroupListResource - RepositoryInfoResource - RepositoryUserItemResource - RepositoryUserListResource This involves one update to our base ListResource implementation (and various related plumbing) to allow subclasses to force a specific class type to be used for items. In the case of repository branches and commits, these are list resources that do not have an associated item endpoint or mimetype, and so the basic `_wrap_field()` and create functionality was returning a plain `ItemResource`. For this case, `ListResource` subclasses can now set `_item_resource_type` to force a specific item resource subclass instead. Testing Done: - Ran unit tests. - Used the new resources from a test script and saw that everything worked as expected.

549a3f62b393c192f28faa46867d96dcf9dceddf

Issues

Description	From	Last Updated
redefinition of unused 'Unpack' from line 11 Column: 5 Error code: F811	reviewbot	Feb. 10, 2025, 9:33 a.m.
line too long (80 > 79 characters) Column: 80 Error code: E501	reviewbot	Feb. 10, 2025, 9:33 a.m.
While here, can we update create_resource to be keyword-only (with deprecation)? If not, we should at least make this new …	chipx86	March 20, 2025, 8:58 a.m.
Needs a Version Added here and a Version Changed in the function doc body.	chipx86	March 20, 2025, 8:58 a.m.
Some notes regarding keyword-only arguments. This applies to other methods below.	chipx86	March 20, 2025, 9 a.m.
Same notes regarding version documentation. This applies to other methods below.	chipx86	March 20, 2025, 9:01 a.m.
This should now be a Mapping.	chipx86	March 20, 2025, 9:02 a.m.
This should also be a Mapping. Same elsewhere.	chipx86	March 20, 2025, 9:02 a.m.
Missing a trailing period.	chipx86	March 20, 2025, 9:03 a.m.
Needs a Version Added here and Version Changed above.	maubin	March 27, 2025, 9:28 a.m.

flake8 failed.

JSHint passed.

flake8

rbtools/api/resource/repository.py (Diff revision 1)
The issue has been dropped. Show all issues
```
redefinition of unused 'Unpack' from line 11

Column: 5
Error code: F811
```
rbtools/api/resource/repository_branches.py (Diff revision 1)
The issue has been dropped. Show all issues
```
line too long (80 > 79 characters)

Column: 80
Error code: E501
```

Commits:

	Summary	ID
	Add new resources, part 3/7. This change adds the following new resource implementations: - RepositoryItemResource - RepositoryListResource - RepositoryBranchItemResource - RepositoryBranchListResource - RepositoryCommitItemResource - RepositoryCommitListResource - RepositoryGroupItemResource - RepositoryGroupListResource - RepositoryInfoResource - RepositoryUserItemResource - RepositoryUserListResource This involves one update to our base ListResource implementation (and various related plumbing) to allow subclasses to force a specific class type to be used for items. In the case of repository branches and commits, these are list resources that do not have an associated item endpoint or mimetype, and so the basic `_wrap_field()` and create functionality was returning a plain `ItemResource`. For this case, `ListResource` subclasses can now set `_item_resource_type` to force a specific item resource subclass instead. Testing Done: - Ran unit tests. - Used the new resources from a test script and saw that everything worked as expected.	74ffb631670b659fe47e0e19ecef60a81e7bf530
	Add new resources, part 3/7. This change adds the following new resource implementations: - RepositoryItemResource - RepositoryListResource - RepositoryBranchItemResource - RepositoryBranchListResource - RepositoryCommitItemResource - RepositoryCommitListResource - RepositoryGroupItemResource - RepositoryGroupListResource - RepositoryInfoResource - RepositoryUserItemResource - RepositoryUserListResource This involves one update to our base ListResource implementation (and various related plumbing) to allow subclasses to force a specific class type to be used for items. In the case of repository branches and commits, these are list resources that do not have an associated item endpoint or mimetype, and so the basic `_wrap_field()` and create functionality was returning a plain `ItemResource`. For this case, `ListResource` subclasses can now set `_item_resource_type` to force a specific item resource subclass instead. Testing Done: - Ran unit tests. - Used the new resources from a test script and saw that everything worked as expected.	5c04aeada7d8104c17bb1e9c8186bc542d51a7b2

Diff:

Revision 2 (+2206 -176)

Show changes

	rbtools/api/factory.py
	rbtools/api/resource/__init__.py
	rbtools/api/resource/base.py
	rbtools/api/resource/base_review_group.py
	rbtools/api/resource/diff.py
	rbtools/api/resource/repository.py
	rbtools/api/resource/repository_branches.py
	rbtools/api/resource/repository_commits.py
	6 more

Checks run (2 succeeded)

flake8 passed.

JSHint passed.

Commits:

	Summary	ID
	Add new resources, part 3/7. This change adds the following new resource implementations: - RepositoryItemResource - RepositoryListResource - RepositoryBranchItemResource - RepositoryBranchListResource - RepositoryCommitItemResource - RepositoryCommitListResource - RepositoryGroupItemResource - RepositoryGroupListResource - RepositoryInfoResource - RepositoryUserItemResource - RepositoryUserListResource This involves one update to our base ListResource implementation (and various related plumbing) to allow subclasses to force a specific class type to be used for items. In the case of repository branches and commits, these are list resources that do not have an associated item endpoint or mimetype, and so the basic `_wrap_field()` and create functionality was returning a plain `ItemResource`. For this case, `ListResource` subclasses can now set `_item_resource_type` to force a specific item resource subclass instead. Testing Done: - Ran unit tests. - Used the new resources from a test script and saw that everything worked as expected.	5c04aeada7d8104c17bb1e9c8186bc542d51a7b2
	Add new resources, part 3/7. This change adds the following new resource implementations: - RepositoryItemResource - RepositoryListResource - RepositoryBranchItemResource - RepositoryBranchListResource - RepositoryCommitItemResource - RepositoryCommitListResource - RepositoryGroupItemResource - RepositoryGroupListResource - RepositoryInfoResource - RepositoryUserItemResource - RepositoryUserListResource This involves one update to our base ListResource implementation (and various related plumbing) to allow subclasses to force a specific class type to be used for items. In the case of repository branches and commits, these are list resources that do not have an associated item endpoint or mimetype, and so the basic `_wrap_field()` and create functionality was returning a plain `ItemResource`. For this case, `ListResource` subclasses can now set `_item_resource_type` to force a specific item resource subclass instead. Testing Done: - Ran unit tests. - Used the new resources from a test script and saw that everything worked as expected.	8d69d4f76410fb585a5d50b9779a96890b422fc4

Diff:

Revision 3 (+2206 -174)

Show changes

	rbtools/api/factory.py
	rbtools/api/resource/__init__.py
	rbtools/api/resource/base.py
	rbtools/api/resource/base_review_group.py
	rbtools/api/resource/diff.py
	rbtools/api/resource/repository.py
	rbtools/api/resource/repository_branch.py
	rbtools/api/resource/repository_commit.py
	6 more

Checks run (2 succeeded)

flake8 passed.

JSHint passed.

rbtools/api/factory.py (Diff revision 3)

The issue has been dropped. Show all issues

While here, can we update create_resource to be keyword-only (with deprecation)?

If not, we should at least make this new one keyword-only.

david March 20, 2025, 9:05 a.m.

There's a lot of call sites (mostly in tests). I'll do this in a separate change, so this one doesn't get muddied up further.

rbtools/api/factory.py (Diff revision 3)

The issue has been resolved. Show all issues

Needs a Version Added here and a Version Changed in the function doc body.

rbtools/api/resource/base.py (Diff revision 3)

The issue has been resolved. Show all issues

Some notes regarding keyword-only arguments.

This applies to other methods below.

rbtools/api/resource/base.py (Diff revision 3)

The issue has been resolved. Show all issues

Same notes regarding version documentation.

This applies to other methods below.

rbtools/api/resource/base_review_group.py (Diff revision 3)
The issue has been resolved. Show all issues
```
This should now be a Mapping.
```
rbtools/api/resource/repository.py (Diff revision 3)
The issue has been resolved. Show all issues
```
This should also be a Mapping.
Same elsewhere.
```
rbtools/api/resource/repository_commit.py (Diff revision 3)
The issue has been resolved. Show all issues
```
Missing a trailing period.
```

Commits:

	Summary	ID
	Add new resources, part 3/7. This change adds the following new resource implementations: - RepositoryItemResource - RepositoryListResource - RepositoryBranchItemResource - RepositoryBranchListResource - RepositoryCommitItemResource - RepositoryCommitListResource - RepositoryGroupItemResource - RepositoryGroupListResource - RepositoryInfoResource - RepositoryUserItemResource - RepositoryUserListResource This involves one update to our base ListResource implementation (and various related plumbing) to allow subclasses to force a specific class type to be used for items. In the case of repository branches and commits, these are list resources that do not have an associated item endpoint or mimetype, and so the basic `_wrap_field()` and create functionality was returning a plain `ItemResource`. For this case, `ListResource` subclasses can now set `_item_resource_type` to force a specific item resource subclass instead. Testing Done: - Ran unit tests. - Used the new resources from a test script and saw that everything worked as expected.	8d69d4f76410fb585a5d50b9779a96890b422fc4
	Add new resources, part 3/7. This change adds the following new resource implementations: - RepositoryItemResource - RepositoryListResource - RepositoryBranchItemResource - RepositoryBranchListResource - RepositoryCommitItemResource - RepositoryCommitListResource - RepositoryGroupItemResource - RepositoryGroupListResource - RepositoryInfoResource - RepositoryUserItemResource - RepositoryUserListResource This involves one update to our base ListResource implementation (and various related plumbing) to allow subclasses to force a specific class type to be used for items. In the case of repository branches and commits, these are list resources that do not have an associated item endpoint or mimetype, and so the basic `_wrap_field()` and create functionality was returning a plain `ItemResource`. For this case, `ListResource` subclasses can now set `_item_resource_type` to force a specific item resource subclass instead. Testing Done: - Ran unit tests. - Used the new resources from a test script and saw that everything worked as expected.	d057edfb7b4505d7f80c332c9a5e98e2fd7bac62

Diff:

Revision 4 (+2248 -174)

Show changes

	rbtools/api/factory.py
	rbtools/api/resource/__init__.py
	rbtools/api/resource/base.py
	rbtools/api/resource/base_review_group.py
	rbtools/api/resource/diff.py
	rbtools/api/resource/repository.py
	rbtools/api/resource/repository_branch.py
	rbtools/api/resource/repository_commit.py
	6 more

Checks run (2 succeeded)

flake8 passed.

JSHint passed.

Ship it!

rbtools/api/resource/base.py (Diff revision 4)
The issue has been resolved. Show all issues
```
Needs a Version Added here and Version Changed above.
```

Commits:

	Summary	ID
	Add new resources, part 3/7. This change adds the following new resource implementations: - RepositoryItemResource - RepositoryListResource - RepositoryBranchItemResource - RepositoryBranchListResource - RepositoryCommitItemResource - RepositoryCommitListResource - RepositoryGroupItemResource - RepositoryGroupListResource - RepositoryInfoResource - RepositoryUserItemResource - RepositoryUserListResource This involves one update to our base ListResource implementation (and various related plumbing) to allow subclasses to force a specific class type to be used for items. In the case of repository branches and commits, these are list resources that do not have an associated item endpoint or mimetype, and so the basic `_wrap_field()` and create functionality was returning a plain `ItemResource`. For this case, `ListResource` subclasses can now set `_item_resource_type` to force a specific item resource subclass instead. Testing Done: - Ran unit tests. - Used the new resources from a test script and saw that everything worked as expected.	d057edfb7b4505d7f80c332c9a5e98e2fd7bac62
	Add new resources, part 3/7. This change adds the following new resource implementations: - RepositoryItemResource - RepositoryListResource - RepositoryBranchItemResource - RepositoryBranchListResource - RepositoryCommitItemResource - RepositoryCommitListResource - RepositoryGroupItemResource - RepositoryGroupListResource - RepositoryInfoResource - RepositoryUserItemResource - RepositoryUserListResource This involves one update to our base ListResource implementation (and various related plumbing) to allow subclasses to force a specific class type to be used for items. In the case of repository branches and commits, these are list resources that do not have an associated item endpoint or mimetype, and so the basic `_wrap_field()` and create functionality was returning a plain `ItemResource`. For this case, `ListResource` subclasses can now set `_item_resource_type` to force a specific item resource subclass instead. Testing Done: - Ran unit tests. - Used the new resources from a test script and saw that everything worked as expected.	549a3f62b393c192f28faa46867d96dcf9dceddf

Diff:

Revision 5 (+2258 -176)

Show changes

	rbtools/api/factory.py
	rbtools/api/resource/__init__.py
	rbtools/api/resource/base.py
	rbtools/api/resource/base_review_group.py
	rbtools/api/resource/diff.py
	rbtools/api/resource/repository.py
	rbtools/api/resource/repository_branch.py
	rbtools/api/resource/repository_commit.py
	6 more

Checks run (2 succeeded)

flake8 passed.

JSHint passed.

Ship it!

```
Ship It!
```

Status:: Completed
Change Summary:: Pushed to master (24a1de7)