Summary

Add new resources, part 7/7.

Review Request #14380 — Created March 20, 2025 and submitted May 22, 2025, 4:54 p.m.

Information

Owner

david

Repository

RBTools

Branch

master

Bugs

Depends On

Reviewers

Groups

rbtools

People

Description

This change adds the following new resource implementations:
- ArchivedReviewRequestItemResource
- ArchivedReviewRequestListResource
- MutedReviewRequestItemResource
- MutedReviewRequestListResource

These resources are special because they do not support GET operations,
and the regular links introspection therefore doesn't work. The
implementation of these is therefore done as a custom layer that allows
us to get a "bare" instance of the resource, which can then be used for
create or delete as appropriate.

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 7/7. This change adds the following new resource implementations: - ArchivedReviewRequestItemResource - ArchivedReviewRequestListResource - MutedReviewRequestItemResource - MutedReviewRequestListResource These resources are special because they do not support GET operations, and the regular links introspection therefore doesn't work. The implementation of these is therefore done as a custom layer that allows us to get a "bare" instance of the resource, which can then be used for `create` or `delete` as appropriate. Testing Done: - Ran unit tests. - Used the new resources from a test script and saw that everything worked as expected.	b0232de2c0c5b4a4f5fd141ce1e6a3b50b6c0c04

Summary

Add new resources, part 7/7.

This change adds the following new resource implementations: - ArchivedReviewRequestItemResource - ArchivedReviewRequestListResource - MutedReviewRequestItemResource - MutedReviewRequestListResource These resources are special because they do not support GET operations, and the regular links introspection therefore doesn't work. The implementation of these is therefore done as a custom layer that allows us to get a "bare" instance of the resource, which can then be used for `create` or `delete` as appropriate. Testing Done: - Ran unit tests. - Used the new resources from a test script and saw that everything worked as expected.

b0232de2c0c5b4a4f5fd141ce1e6a3b50b6c0c04

Issues

Description	From	Last Updated
Missing period.	chipx86	April 1, 2025, 8:36 a.m.
LINKS_TOK sorts before ListResource.	chipx86	April 1, 2025, 8:36 a.m.
I can't remember if the base class has been updated for keyword-onlyness. If so, we should fix that here and …	chipx86	April 1, 2025, 8:37 a.m.
But it would be nice (here and below) to call as keyword arguments to be explicit.	chipx86	April 1, 2025, 8:37 a.m.
Should be updated for the full module path.	chipx86	April 1, 2025, 8:38 a.m.
Here, too.	chipx86	April 1, 2025, 8:38 a.m.
"URI template"?	chipx86	April 1, 2025, 8:38 a.m.
Each of these code samples should have double backticks around them.	chipx86	April 1, 2025, 8:39 a.m.
"url" -> "URL".	chipx86	April 1, 2025, 8:39 a.m.
Any way we can avoid repeating all this, given the complexity?	chipx86	April 1, 2025, 8:41 a.m.
These aren't unused, they get passed to the parent __init__.	maubin	April 1, 2025, 5:29 p.m.
Here and below say "Xeyword" now :p	maubin	April 2, 2025, 5:12 p.m.
Same here.	maubin	April 1, 2025, 5:29 p.m.
Should be MutedReviewRequestItemResource and say "item resource" here.	maubin	April 1, 2025, 5:29 p.m.
Add a "Version Added" for this.	maubin	April 1, 2025, 5:30 p.m.
Copy-paste-o referring to API token?	maubin	April 1, 2025, 5:30 p.m.
Should be ArchivedReviewRequestItemResource	maubin	April 1, 2025, 5:31 p.m.
Copy-paste-o referring to API token? Same below	maubin	April 1, 2025, 5:31 p.m.
Should say MutedReviewRequestItemResource	maubin	April 1, 2025, 5:31 p.m.
Missing a trailing period.	chipx86	April 30, 2025, 9:08 a.m.
Python 3.9 is the minimum, right? I forget. If not, we have to adjust this.	chipx86	April 30, 2025, 9:07 a.m.
Can we put these in alphabetical order?	chipx86	April 30, 2025, 9:08 a.m.
Missing a trailing period.	chipx86	April 30, 2025, 9:08 a.m.
Can we sort these?	chipx86	April 30, 2025, 9:08 a.m.

flake8 passed.

JSHint passed.

rbtools/api/resource/archived_review_request.py (Diff revision 1)
The issue has been resolved. Show all issues
```
Missing period.
```
rbtools/api/resource/base_archived_object.py (Diff revision 1)
The issue has been resolved. Show all issues
```
LINKS_TOK sorts before ListResource.
```

rbtools/api/resource/base_archived_object.py (Diff revision 1)

The issue has been dropped. Show all issues

I can't remember if the base class has been updated for keyword-onlyness. If so, we should fix that here and below. If not, ignore this.

rbtools/api/resource/base_archived_object.py (Diff revision 1)
The issue has been resolved. Show all issues
```
But it would be nice (here and below) to call as keyword arguments to be explicit.
```
rbtools/api/resource/root.py (Diff revision 1)
The issue has been resolved. Show all issues
```
Should be updated for the full module path.
```
rbtools/api/resource/root.py (Diff revision 1)
The issue has been resolved. Show all issues
```
Here, too.
```
rbtools/api/resource/root.py (Diff revision 1)
The issue has been resolved. Show all issues
```
"URI template"?
```

rbtools/api/resource/root.py (Diff revision 1)

The issue has been resolved. Show all issues

Each of these code samples should have double backticks around them.

rbtools/api/resource/root.py (Diff revision 1)
The issue has been resolved. Show all issues
```
"url" -> "URL".
```

rbtools/api/resource/root.py (Diff revision 1)

The issue has been dropped. Show all issues

Any way we can avoid repeating all this, given the complexity?

david April 1, 2025, 8:41 a.m.

I don't know that splitting the cast/make_url_from_template stuff out into a separate method really reduces the number of lines in any measurable way.

Commits:

	Summary	ID
	Add new resources, part 7/7. This change adds the following new resource implementations: - ArchivedReviewRequestItemResource - ArchivedReviewRequestListResource - MutedReviewRequestItemResource - MutedReviewRequestListResource These resources are special because they do not support GET operations, and the regular links introspection therefore doesn't work. The implementation of these is therefore done as a custom layer that allows us to get a "bare" instance of the resource, which can then be used for `create` or `delete` as appropriate. Testing Done: - Ran unit tests. - Used the new resources from a test script and saw that everything worked as expected.	a0e719b6a23093e84dfabe0e349da19edf1a30d9
	Add new resources, part 7/7. This change adds the following new resource implementations: - ArchivedReviewRequestItemResource - ArchivedReviewRequestListResource - MutedReviewRequestItemResource - MutedReviewRequestListResource These resources are special because they do not support GET operations, and the regular links introspection therefore doesn't work. The implementation of these is therefore done as a custom layer that allows us to get a "bare" instance of the resource, which can then be used for `create` or `delete` as appropriate. Testing Done: - Ran unit tests. - Used the new resources from a test script and saw that everything worked as expected.	f4155273ca3ea56a9510901ae17c9c01af1709a0

Diff:

Revision 2 (+1206 -32)

Show changes

	rbtools/api/resource/__init__.py
	rbtools/api/resource/archived_review_request.py
	rbtools/api/resource/base_archived_object.py
	rbtools/api/resource/muted_review_request.py
	rbtools/api/resource/root.py
	rbtools/api/resource/user.py

Checks run (2 succeeded)

flake8 passed.

JSHint passed.

rbtools/api/resource/base_archived_object.py (Diff revision 2)
The issue has been resolved. Show all issues
```
These aren't unused, they get passed to the parent __init__.
```
rbtools/api/resource/base_archived_object.py (Diff revision 2)
The issue has been resolved. Show all issues
```
Same here.
```
rbtools/api/resource/muted_review_request.py (Diff revision 2)
The issue has been resolved. Show all issues
```
Should be MutedReviewRequestItemResource and say "item resource" here.
```
rbtools/api/resource/root.py (Diff revision 2)
The issue has been resolved. Show all issues
```
Add a "Version Added" for this.
```
rbtools/api/resource/root.py (Diff revision 2)
The issue has been resolved. Show all issues
```
Copy-paste-o referring to API token?
```
rbtools/api/resource/root.py (Diff revision 2)
The issue has been resolved. Show all issues
```
Should be ArchivedReviewRequestItemResource
```
rbtools/api/resource/root.py (Diff revision 2)
The issue has been resolved. Show all issues
```
Copy-paste-o referring to API token? Same below
```
rbtools/api/resource/root.py (Diff revision 2)
The issue has been resolved. Show all issues
```
Should say MutedReviewRequestItemResource
```

Commits:

	Summary	ID
	Add new resources, part 7/7. This change adds the following new resource implementations: - ArchivedReviewRequestItemResource - ArchivedReviewRequestListResource - MutedReviewRequestItemResource - MutedReviewRequestListResource These resources are special because they do not support GET operations, and the regular links introspection therefore doesn't work. The implementation of these is therefore done as a custom layer that allows us to get a "bare" instance of the resource, which can then be used for `create` or `delete` as appropriate. Testing Done: - Ran unit tests. - Used the new resources from a test script and saw that everything worked as expected.	f4155273ca3ea56a9510901ae17c9c01af1709a0
	Add new resources, part 7/7. This change adds the following new resource implementations: - ArchivedReviewRequestItemResource - ArchivedReviewRequestListResource - MutedReviewRequestItemResource - MutedReviewRequestListResource These resources are special because they do not support GET operations, and the regular links introspection therefore doesn't work. The implementation of these is therefore done as a custom layer that allows us to get a "bare" instance of the resource, which can then be used for `create` or `delete` as appropriate. Testing Done: - Ran unit tests. - Used the new resources from a test script and saw that everything worked as expected.	085d5a97a4ee53d355630f5a41447337d46499d1

Diff:

Revision 3 (+1218 -30)

Show changes

	rbtools/api/resource/__init__.py
	rbtools/api/resource/archived_review_request.py
	rbtools/api/resource/base_archived_object.py
	rbtools/api/resource/muted_review_request.py
	rbtools/api/resource/root.py
	rbtools/api/resource/user.py

Checks run (2 succeeded)

flake8 passed.

JSHint passed.

rbtools/api/resource/base_archived_object.py (Diff revisions 2 - 3)
The issue has been resolved. Show all issues
```
Here and below say "Xeyword" now :p
```
1. david April 2, 2025, 5:13 p.m.
  Huh.

Commits:

	Summary	ID
	Add new resources, part 7/7. This change adds the following new resource implementations: - ArchivedReviewRequestItemResource - ArchivedReviewRequestListResource - MutedReviewRequestItemResource - MutedReviewRequestListResource These resources are special because they do not support GET operations, and the regular links introspection therefore doesn't work. The implementation of these is therefore done as a custom layer that allows us to get a "bare" instance of the resource, which can then be used for `create` or `delete` as appropriate. Testing Done: - Ran unit tests. - Used the new resources from a test script and saw that everything worked as expected.	085d5a97a4ee53d355630f5a41447337d46499d1
	Add new resources, part 7/7. This change adds the following new resource implementations: - ArchivedReviewRequestItemResource - ArchivedReviewRequestListResource - MutedReviewRequestItemResource - MutedReviewRequestListResource These resources are special because they do not support GET operations, and the regular links introspection therefore doesn't work. The implementation of these is therefore done as a custom layer that allows us to get a "bare" instance of the resource, which can then be used for `create` or `delete` as appropriate. Testing Done: - Ran unit tests. - Used the new resources from a test script and saw that everything worked as expected.	1f3be896d12e52ad681b0597efe89d9ad47d3e2b

Diff:

Revision 4 (+1218 -30)

Show changes

	rbtools/api/resource/__init__.py
	rbtools/api/resource/archived_review_request.py
	rbtools/api/resource/base_archived_object.py
	rbtools/api/resource/muted_review_request.py
	rbtools/api/resource/root.py
	rbtools/api/resource/user.py

Checks run (2 succeeded)

flake8 passed.

JSHint passed.

Ship it!

```
Ship It!
```

rbtools/api/resource/muted_review_request.py (Diff revision 4)
The issue has been resolved. Show all issues
```
Missing a trailing period.
```

rbtools/api/resource/root.py (Diff revision 4)

The issue has been dropped. Show all issues

Python 3.9 is the minimum, right? I forget. If not, we have to adjust this.

david April 30, 2025, 9:09 a.m.

Yeah, I think for all major releases from now on it's 3.9+. Point releases may still be 3.8, of course.

rbtools/api/resource/root.py (Diff revision 4)
The issue has been resolved. Show all issues
```
Can we put these in alphabetical order?
```
rbtools/api/resource/root.py (Diff revision 4)
The issue has been resolved. Show all issues
```
Missing a trailing period.
```
rbtools/api/resource/root.py (Diff revision 4)
The issue has been resolved. Show all issues
```
Can we sort these?
```

Commits:

	Summary	ID
	Add new resources, part 7/7. This change adds the following new resource implementations: - ArchivedReviewRequestItemResource - ArchivedReviewRequestListResource - MutedReviewRequestItemResource - MutedReviewRequestListResource These resources are special because they do not support GET operations, and the regular links introspection therefore doesn't work. The implementation of these is therefore done as a custom layer that allows us to get a "bare" instance of the resource, which can then be used for `create` or `delete` as appropriate. Testing Done: - Ran unit tests. - Used the new resources from a test script and saw that everything worked as expected.	1f3be896d12e52ad681b0597efe89d9ad47d3e2b
	Add new resources, part 7/7. This change adds the following new resource implementations: - ArchivedReviewRequestItemResource - ArchivedReviewRequestListResource - MutedReviewRequestItemResource - MutedReviewRequestListResource These resources are special because they do not support GET operations, and the regular links introspection therefore doesn't work. The implementation of these is therefore done as a custom layer that allows us to get a "bare" instance of the resource, which can then be used for `create` or `delete` as appropriate. Testing Done: - Ran unit tests. - Used the new resources from a test script and saw that everything worked as expected.	b0232de2c0c5b4a4f5fd141ce1e6a3b50b6c0c04

Diff:

Revision 5 (+1218 -30)

Show changes

	rbtools/api/resource/__init__.py
	rbtools/api/resource/archived_review_request.py
	rbtools/api/resource/base_archived_object.py
	rbtools/api/resource/muted_review_request.py
	rbtools/api/resource/root.py
	rbtools/api/resource/user.py

Checks run (2 succeeded)

flake8 passed.

JSHint passed.

Ship it!

```
Ship It!
```

Ship it!

```
Ship It!
```

Status:: Completed
Change Summary:: Pushed to master (19ebba2)