Summary

Add typing for Repository, Tool, and the managers.

Review Request #14032 — Created July 12, 2024 and submitted July 13, 2024, 12:10 a.m.

Information

Owner

chipx86

Repository

Review Board

Branch

release-7.x

Bugs

Depends On

Reviewers

Groups

reviewboard

People

Description

Repository is one of the main models used in Review Board, and until
now, we lacked any typing for the functions.

This change adds typing for Repository, RepositoryManager, Tool,
and ToolManager. It should ensure we don't pass incorrect parameters
to anything in these classes.

Testing Done

Unit tests pass.

Commits

Summary	ID
Add typing for Repository, Tool, and the managers. `Repository` is one of the main models used in Review Board, and until now, we lacked any typing for the functions. This change adds typing for `Repository`, `RepositoryManager`, `Tool`, and `ToolManager`. It should ensure we don't pass incorrect parameters to anything in these classes.	80d4de5e87f12f2ed9c6970c20c0bddf8a7082b8

Issues

Description	From	Last Updated
I've been adding blank lines within the TYPE_CHECKING imports to mirror the sections in regular imports.	david	July 13, 2024, 12:02 a.m.
Why the quotes here?	david	July 13, 2024, 12:09 a.m.

flake8 passed.

JSHint passed.

reviewboard/scmtools/managers.py (Diff revision 1)

The issue has been resolved. Show all issues

I've been adding blank lines within the TYPE_CHECKING imports to mirror the sections in regular imports.

reviewboard/scmtools/managers.py (Diff revision 1)

The issue has been dropped. Show all issues

Why the quotes here?

chipx86 July 13, 2024, 12:01 a.m.

We can't safely import Tool within managers.py (circular import), and Manager doesn't actually care what goes into the [...] but type checkers will understand it's a type reference. So the docs say to put the type in quotes.

reviewboard/scmtools/models.py (Diff revision 1)
```
eek
```

Change Summary:

Added blank lines within TYPE_CHECKING.

Commits:

	Summary	ID
	Add typing for Repository, Tool, and the managers. `Repository` is one of the main models used in Review Board, and until now, we lacked any typing for the functions. This change adds typing for `Repository`, `RepositoryManager`, `Tool`, and `ToolManager`. It should ensure we don't pass incorrect parameters to anything in these classes.	6c8582f8e5d033426fefa2ba105bfc3f7daed3ea
	Add typing for Repository, Tool, and the managers. `Repository` is one of the main models used in Review Board, and until now, we lacked any typing for the functions. This change adds typing for `Repository`, `RepositoryManager`, `Tool`, and `ToolManager`. It should ensure we don't pass incorrect parameters to anything in these classes.	80d4de5e87f12f2ed9c6970c20c0bddf8a7082b8

Diff:

Revision 2 (+538 -262)

Show changes

	reviewboard/scmtools/managers.py
	reviewboard/scmtools/models.py

Checks run (2 succeeded)

flake8 passed.

JSHint passed.

Ship it!

```
Ship It!
```

Status:: Completed
Change Summary:: Pushed to release-7.x (335d124)