Summary

Add typing for the functions in TestCase.

Review Request #14035 — Created July 13, 2024 and updated Oct. 11, 2024, 2:13 p.m.

Information

Owner

chipx86

Repository

RBTools

Branch

release-5.x

Bugs

Depends On

Reviewers

Groups

rbtools

People

Description

This updates TestCase to add type hints all throughout. This helps
ensure we pass in the right typse to functions, and that we get the
right transport and client types when setting up state for API tests.

Testing Done

Unit tests pass.

Commits

Summary	ID
Add typing for the functions in TestCase. This updates `TestCase` to add type hints all throughout. This helps ensure we pass in the right typse to functions, and that we get the right transport and client types when setting up state for API tests.	9ae2883847e5d422970e673033ec2840462c31be

Issues

Description	From	Last Updated
'typing.Any' imported but unused Column: 1 Error code: F401	reviewbot	July 13, 2024, 2:13 a.m.
redefinition of unused 'RBClient' from line 17 Column: 5 Error code: F811	reviewbot	July 13, 2024, 2:13 a.m.
While you're here, mind adding docstrings and changing to super()?	david	Oct. 10, 2024, 3:53 p.m.
Here too.	david	Oct. 10, 2024, 3:53 p.m.
Now that we're properly using __future__.annotations, we should change from Dict to dict and List to list.	david	Oct. 11, 2024, 2:13 p.m.
Blank line between these two.	david	Oct. 11, 2024, 2:13 p.m.
Can we add a doc comment for this?	david	Oct. 11, 2024, 2:13 p.m.
maxDiff doesn't appear to be used anywhere within the rbtools codebase. Can we just get rid of this?	david	Oct. 11, 2024, 2:13 p.m.
Should probably be Any instead of object.	david	Oct. 11, 2024, 2:13 p.m.

flake8 failed.

JSHint passed.

flake8

rbtools/testing/testcase.py (Diff revision 1)
The issue has been resolved. Show all issues
```
'typing.Any' imported but unused

Column: 1
Error code: F401
```
rbtools/testing/testcase.py (Diff revision 1)
The issue has been resolved. Show all issues
```
redefinition of unused 'RBClient' from line 17

Column: 5
Error code: F811
```

Change Summary:

Removed an unused import and a duplicate import.

Commits:

	Summary	ID
	Add typing for the functions in TestCase. This updates `TestCase` to add type hints all throughout. This helps ensure we pass in the right typse to functions, and that we get the right transport and client types when setting up state for API tests.	6006d70d24e42d186300de3f86073b6b931b2b3b
	Add typing for the functions in TestCase. This updates `TestCase` to add type hints all throughout. This helps ensure we pass in the right typse to functions, and that we get the right transport and client types when setting up state for API tests.	9c81b7bfff3bec145667b91c415b0f60a6734587

Diff:

Revision 2 (+126 -46)

Show changes

rbtools/testing/testcase.py

Checks run (2 succeeded)

flake8 passed.

JSHint passed.

rbtools/testing/testcase.py (Diff revision 2)

The issue has been resolved. Show all issues

While you're here, mind adding docstrings and changing to super()?

rbtools/testing/testcase.py (Diff revision 2)
The issue has been resolved. Show all issues
```
Here too.
```

Change Summary:


Added some docstrings to the setup/teardown methods.
Added additional type hints for class/instance variables.
Simplified super() calls.

Commits:

	Summary	ID
	Add typing for the functions in TestCase. This updates `TestCase` to add type hints all throughout. This helps ensure we pass in the right typse to functions, and that we get the right transport and client types when setting up state for API tests.	9c81b7bfff3bec145667b91c415b0f60a6734587
	Add typing for the functions in TestCase. This updates `TestCase` to add type hints all throughout. This helps ensure we pass in the right typse to functions, and that we get the right transport and client types when setting up state for API tests.	9ae2883847e5d422970e673033ec2840462c31be

Diff:

Revision 3 (+216 -62)

Show changes

rbtools/testing/testcase.py

Checks run (2 succeeded)

flake8 passed.

JSHint passed.

Fix it!

rbtools/testing/testcase.py (Diff revision 3)

An issue was opened. Show all issues

Now that we're properly using __future__.annotations, we should change from Dict to dict and List to list.

rbtools/testing/testcase.py (Diff revision 3)
An issue was opened. Show all issues
```
Blank line between these two.
```
rbtools/testing/testcase.py (Diff revision 3)
An issue was opened. Show all issues
```
Can we add a doc comment for this?
```

rbtools/testing/testcase.py (Diff revision 3)

An issue was opened. Show all issues

maxDiff doesn't appear to be used anywhere within the rbtools codebase. Can we just get rid of this?

rbtools/testing/testcase.py (Diff revision 3)
An issue was opened. Show all issues
```
Should probably be Any instead of object.
```