Summary

Add type hints for the diff parsing code.

Review Request #14010 — Created July 3, 2024 and submitted July 12, 2024, 3:30 p.m.

Information

Owner

chipx86

Repository

Review Board

Branch

release-7.x

Bugs

Depends On

Reviewers

Groups

reviewboard

People

Description

This updates reviewboard.diffviewer.parser to include full type hints,
making it easier to properly implement a diff parser or change diff
parsing logic. This is being done in preparation for additional work for
diff parsers.

Several methods have been updated to require keyword-only arguments,
deprecating positional arguments.

We also had some parameters that were meant to be removed back in
Review Board 6. We never added deprecation warnings for those changes,
so those have been added, and the deprecations have been pushed to
Review Board 9.

Testing Done

Unit tests pass.

Commits

Summary	ID
Add type hints for the diff parsing code. This updates `reviewboard.diffviewer.parser` to include full type hints, making it easier to properly implement a diff parser or change diff parsing logic. This is being done in preparation for additional work for diff parsers. Several methods have been updated to require keyword-only arguments, deprecating positional arguments. We also had some parameters that were meant to be removed back in Review Board 6. We never added deprecation warnings for those changes, so those have been added, and the deprecations have been pushed to Review Board 9.	c38f348987f24e2e88b8eef03283bf97b814c2b8

Summary

Add type hints for the diff parsing code.

This updates `reviewboard.diffviewer.parser` to include full type hints, making it easier to properly implement a diff parser or change diff parsing logic. This is being done in preparation for additional work for diff parsers. Several methods have been updated to require keyword-only arguments, deprecating positional arguments. We also had some parameters that were meant to be removed back in Review Board 6. We never added deprecation warnings for those changes, so those have been added, and the deprecations have been pushed to Review Board 9.

c38f348987f24e2e88b8eef03283bf97b814c2b8

Issues

Description	From	Last Updated
Why this change?	david	July 12, 2024, 3:28 p.m.
And here too.	david	July 12, 2024, 3:28 p.m.

flake8 passed.

JSHint passed.

reviewboard/diffviewer/parser.py (Diff revision 1)

The issue has been resolved. Show all issues

Why this change?

chipx86 July 3, 2024, 12:16 p.m.

split() returns a list[str]. I could have gone with split(...)[:2], but thought I'd just make the naming clear. Either way would be fine with me though.

david July 3, 2024, 12:54 p.m.

Clear naming sounds good. Let's add a blank line before the return statement for both places, though.

reviewboard/diffviewer/parser.py (Diff revision 1)
The issue has been resolved. Show all issues
```
And here too.
```

Change Summary:

Added missing blank lines before return statements.

Commits:

	Summary	ID
	Add type hints for the diff parsing code. This updates `reviewboard.diffviewer.parser` to include full type hints, making it easier to properly implement a diff parser or change diff parsing logic. This is being done in preparation for additional work for diff parsers. Several methods have been updated to require keyword-only arguments, deprecating positional arguments. We also had some parameters that were meant to be removed back in Review Board 6. We never added deprecation warnings for those changes, so those have been added, and the deprecations have been pushed to Review Board 9.	26a76a668cbff05ca02157b64b3b2ec0760e36a7
	Add type hints for the diff parsing code. This updates `reviewboard.diffviewer.parser` to include full type hints, making it easier to properly implement a diff parser or change diff parsing logic. This is being done in preparation for additional work for diff parsers. Several methods have been updated to require keyword-only arguments, deprecating positional arguments. We also had some parameters that were meant to be removed back in Review Board 6. We never added deprecation warnings for those changes, so those have been added, and the deprecations have been pushed to Review Board 9.	c38f348987f24e2e88b8eef03283bf97b814c2b8

Diff:

Revision 2 (+690 -260)

Show changes

reviewboard/diffviewer/parser.py

Checks run (2 succeeded)

flake8 passed.

JSHint passed.

Ship it!

```
Ship It!
```

Status:: Completed
Change Summary:: Pushed to release-7.x (9c11994)