Summary

Improve typing in some review-request related code.

Review Request #14017 — Created July 9, 2024 and submitted Aug. 5, 2024, 9:08 a.m.

Information

Owner

david

Repository

Review Board

Branch

release-7.x

Bugs

Depends On

Reviewers

Groups

reviewboard

People

Description

This change just has some typing and docs improvements in some code that
I've been touching to do the new admin-draft stuff.

Testing Done

Ran unit tests.

Commits

Summary	ID
Improve typing in some review-request related code. This change just has some typing and docs improvements in some code that I've been touching to do the new admin-draft stuff. Testing Done: Ran unit tests.	4e20de2fdfde719807259d80ed3181e7da719fec

Issues

Description	From	Last Updated
undefined name 'Tuple' Column: 10 Error code: F821	reviewbot	July 9, 2024, 4:45 p.m.
undefined name 'List' Column: 29 Error code: F821	reviewbot	July 9, 2024, 4:45 p.m.
trailing whitespace Column: 48 Error code: W291	reviewbot	July 9, 2024, 4:45 p.m.
line too long (80 > 79 characters) Column: 80 Error code: E501	reviewbot	July 9, 2024, 4:45 p.m.
These lines should be swapped.	chipx86	July 15, 2024, 9:21 p.m.
What is pending typed as?	chipx86	July 15, 2024, 9:22 p.m.
We shoudl probably use Sequence, since this doesn't need to be a mutable result.	chipx86	July 15, 2024, 9:23 p.m.
Might be a good time to begin making these arguments keyword-only.	chipx86	July 15, 2024, 9:23 p.m.
Missing Args.	chipx86	July 15, 2024, 9:24 p.m.
While here you could get rid of the "Return" language and "Returns" section, and use "Type:" instead.	maubin	July 17, 2024, 1 p.m.
Forgot to document **kwargs.	maubin	July 17, 2024, 1 p.m.
Missing a ** prefix to kwargs.	maubin	July 17, 2024, 1 p.m.
Missing Args.	chipx86	Aug. 5, 2024, 9:05 a.m.
No colon here.	chipx86	Aug. 5, 2024, 9:05 a.m.

flake8 failed.

JSHint passed.

flake8

reviewboard/reviews/models/review_request.py (Diff revision 1)
The issue has been dropped. Show all issues
```
undefined name 'Tuple'

Column: 10
Error code: F821
```
reviewboard/reviews/models/review_request.py (Diff revision 1)
The issue has been dropped. Show all issues
```
undefined name 'List'

Column: 29
Error code: F821
```
reviewboard/reviews/models/review_request.py (Diff revision 1)
The issue has been dropped. Show all issues
```
trailing whitespace

Column: 48
Error code: W291
```
reviewboard/reviews/views/mixins.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
	Improve typing in some review-request related code. This change just has some typing and docs improvements in some code that I've been touching to do the new admin-draft stuff. Testing Done: Ran unit tests.	648464efe389c79730b9b52d32e470f43dbe9a42
	Improve typing in some review-request related code. This change just has some typing and docs improvements in some code that I've been touching to do the new admin-draft stuff. Testing Done: Ran unit tests.	078f40b414cce33ce633687eee53ae26aac05407

Diff:

Revision 2 (+596 -198)

Show changes

	reviewboard/reviews/models/review_request.py
	reviewboard/reviews/templatetags/reviewtags.py
	reviewboard/reviews/views/mixins.py

Checks run (2 succeeded)

flake8 passed.

JSHint passed.

reviewboard/reviews/models/review_request.py (Diff revision 2)
The issue has been resolved. Show all issues
```
These lines should be swapped.
```

reviewboard/reviews/models/review_request.py (Diff revision 2)

The issue has been resolved. Show all issues

What is pending typed as?

david July 15, 2024, 9:24 p.m.

Should be bool but we don't have typing for scmtool/repository in the right place. I'll just remove this for now.

reviewboard/reviews/models/review_request.py (Diff revision 2)
The issue has been resolved. Show all issues
```
We shoudl probably use Sequence, since this doesn't need to be a mutable result.
```

reviewboard/reviews/models/review_request.py (Diff revision 2)

The issue has been dropped. Show all issues

Might be a good time to begin making these arguments keyword-only.

david July 15, 2024, 9:24 p.m.

I'd rather not chase down all the call sites for this right now.

reviewboard/reviews/models/review_request.py (Diff revision 2)
The issue has been resolved. Show all issues
```
Missing Args.
```

Commits:

	Summary	ID
	Improve typing in some review-request related code. This change just has some typing and docs improvements in some code that I've been touching to do the new admin-draft stuff. Testing Done: Ran unit tests.	078f40b414cce33ce633687eee53ae26aac05407
	Improve typing in some review-request related code. This change just has some typing and docs improvements in some code that I've been touching to do the new admin-draft stuff. Testing Done: Ran unit tests.	e5d7b3aeccd4e27b11d37d7cf5f9ab1f81bdd4ca

Diff:

Revision 3 (+604 -198)

Show changes

	reviewboard/reviews/models/review_request.py
	reviewboard/reviews/templatetags/reviewtags.py
	reviewboard/reviews/views/mixins.py

Checks run (2 succeeded)

flake8 passed.

JSHint passed.

reviewboard/reviews/models/review_request.py (Diff revision 3)

The issue has been resolved. Show all issues

While here you could get rid of the "Return" language and "Returns" section, and use "Type:" instead.

reviewboard/reviews/models/review_request.py (Diff revision 3)

The issue has been resolved. Show all issues

Forgot to document **kwargs.

reviewboard/reviews/models/review_request.py (Diff revision 3)
The issue has been resolved. Show all issues
```
Missing a ** prefix to kwargs.
```

Commits:

	Summary	ID
	Improve typing in some review-request related code. This change just has some typing and docs improvements in some code that I've been touching to do the new admin-draft stuff. Testing Done: Ran unit tests.	e5d7b3aeccd4e27b11d37d7cf5f9ab1f81bdd4ca
	Improve typing in some review-request related code. This change just has some typing and docs improvements in some code that I've been touching to do the new admin-draft stuff. Testing Done: Ran unit tests.	4e20de2fdfde719807259d80ed3181e7da719fec

Diff:

Revision 4 (+616 -206)

Show changes

	reviewboard/reviews/models/review_request.py
	reviewboard/reviews/templatetags/reviewtags.py
	reviewboard/reviews/views/mixins.py

Checks run (2 succeeded)

flake8 passed.

JSHint passed.

Ship it!

```
Ship It!
```

Ship it!

reviewboard/reviews/models/review_request.py (Diff revision 4)
The issue has been resolved. Show all issues
```
Missing Args.
```
reviewboard/reviews/models/review_request.py (Diff revision 4)
The issue has been resolved. Show all issues
```
No colon here.
```

Status:: Completed
Change Summary:: Pushed to release-7.x (398a752)