Summary

Make ReviewUI generic for typing purposes.

Review Request #13696 — Created April 4, 2024 and submitted April 12, 2024, 12:39 p.m.

Information

Owner

david

Repository

Review Board

Branch

release-7.x

Bugs

Depends On

Reviewers

Groups

reviewboard

People

Description

This change adds generic typing for the ReviewUI class, allowing us to
specify in the subclass what the object type, comment type, and
serialized comment type are. This prevents the need for a bunch of
cast calls in the subclasses.

Testing Done

Ran unit tests.

Commits

Summary	ID
Make ReviewUI generic for typing purposes. This change adds generic typing for the ReviewUI class, allowing us to specify in the subclass what the object type, comment type, and serialized comment type are. This prevents the need for a bunch of `cast` calls in the subclasses. Testing Done: Ran unit tests.	4780bc5de7e4922139e18f51c16f02a4bcd559b1

Issues

Description	From	Last Updated
Can we document these and add Version Added?	chipx86	April 10, 2024, 9:25 a.m.
While you're doing work on these, can you wrap these in ClassVar?	chipx86	April 10, 2024, 9:27 a.m.
We should probably use Sequence here, unless we want to explicitly return a mutable list.	chipx86	April 10, 2024, 9:28 a.m.
collections.abc.Iterator doesn't support generics on Python 3.8.	chipx86	April 10, 2024, 9:28 a.m.
Maybe we should use Sequence for these?	chipx86	April 10, 2024, 9:29 a.m.

flake8 passed.

JSHint passed.

reviewboard/reviews/ui/base.py (Diff revision 1)
The issue has been resolved. Show all issues
```
Can we document these and add Version Added?
```
reviewboard/reviews/ui/base.py (Diff revision 1)
The issue has been resolved. Show all issues
```
While you're doing work on these, can you wrap these in ClassVar?
```

reviewboard/reviews/ui/base.py (Diff revision 1)

The issue has been resolved. Show all issues

We should probably use Sequence here, unless we want to explicitly return a mutable list.

reviewboard/reviews/ui/markdownui.py (Diff revision 1)
The issue has been resolved. Show all issues
```
collections.abc.Iterator doesn't support generics on Python 3.8.
```
reviewboard/reviews/ui/text.py (Diff revision 1)
The issue has been resolved. Show all issues
```
Maybe we should use Sequence for these?
```

Commits:

	Summary	ID
	Make ReviewUI generic for typing purposes. This change adds generic typing for the ReviewUI class, allowing us to specify in the subclass what the object type, comment type, and serialized comment type are. This prevents the need for a bunch of `cast` calls in the subclasses. Testing Done: Ran unit tests.	a87cda8f63b0fcbde7c384bd7e86330bc414faee
	Make ReviewUI generic for typing purposes. This change adds generic typing for the ReviewUI class, allowing us to specify in the subclass what the object type, comment type, and serialized comment type are. This prevents the need for a bunch of `cast` calls in the subclasses. Testing Done: Ran unit tests.	4780bc5de7e4922139e18f51c16f02a4bcd559b1

Diff:

Revision 2 (+236 -218)

Show changes

	reviewboard/reviews/ui/base.py
	reviewboard/reviews/ui/diff.py
	reviewboard/reviews/ui/image.py
	reviewboard/reviews/ui/screenshot.py
	reviewboard/reviews/ui/text.py

Checks run (2 succeeded)

flake8 passed.

JSHint passed.

Ship it!

```
Ship It!
```

Status:: Completed
Change Summary:: Pushed to release-7.x (8faa5a1)