Summary:

Add types, update signatures, and modernize docs for rbtools.utils.diffs.

Review Request #12569 — Created Aug. 24, 2022 and submitted Sept. 15, 2022, 1:42 p.m.

Information
Owner:	chipx86
Repository:	RBTools
Branch:	release-4.x
Bugs:
Depends On:
Reviewers
Groups:	rbtools
People:

Description

rbtools.utils.diffs is used in a lot of diff-generation code, and is
sensitive to string types. These functions are old, lacking modern docs,
and contain positional arguments that are non-obvious.

This change adds type annotations to all the functions in here. It also
updates all documentation for our modern standards, and switches some
parameters to keyword-only (deprecating but still allowing them as
positional arguments).

Testing Done

Unit tests pass on Python 3.7-3.11.

Commits

Summary
	Add types, update signatures, and modernize docs for rbtools.utils.diffs.

Screenshots

Issues

Description	From	Last Updated
as keyword arguments -> as a keyword argument	david	Sept. 12, 2022, 12:08 p.m.
Shouldn't file_index_re have to come after the * in order to be a required keyword argument?	maubin	Sept. 14, 2022, 2:19 p.m.

flake8 passed.

JSHint passed.

rbtools/utils/diffs.py (Diff revision 1)
Show all issues
```
as keyword arguments -> as a keyword argument
```

Change Summary:

Fixed a docstring to reference a keyword argument as a singular and not a plural.

Commits:

	Summary
-		Add types, update signatures, and modernize docs for rbtools.utils.diffs.
+		Add types, update signatures, and modernize docs for rbtools.utils.diffs.

Diff:

Revision 2 (+266 -38)

Show changes

rbtools/utils/diffs.py

Checks run (2 succeeded)

flake8 passed.

JSHint passed.

rbtools/utils/diffs.py (Diff revision 2)

Show all issues

Shouldn't file_index_re have to come after the * in order to be a required keyword argument?

chipx86 Sept. 14, 2022, 2:04 p.m.

Oops, yeah. I actually intended for that to not have to be a keyword argument. I'll just update the docstring.

Change Summary:

Fixed an incorrect docstring notice about file_index_re having to be a keyword argument.

Commits:

	Summary
-		Add types, update signatures, and modernize docs for rbtools.utils.diffs.
+		Add types, update signatures, and modernize docs for rbtools.utils.diffs.

Diff:

Revision 3 (+266 -38)

Show changes

rbtools/utils/diffs.py

Checks run (2 succeeded)

flake8 passed.

JSHint passed.

Ship it!

```
Ship It!
```

Status: Closed (submitted)

Change Summary:

Pushed to release-4.x (4649ec7)