Summary

Fix type issues in TFS support and add typing annotations everywhere.

Review Request #12566 — Created Aug. 24, 2022 and submitted Sept. 13, 2022, 12:08 p.m.

Information

Owner

chipx86

Repository

RBTools

Branch

release-4.x

Bugs

Depends On

Reviewers

Groups

rbtools

People

Description

TFS lacked any unit tests prior to RBTools 4, and had numerous
type-related issues that broke on Python 3. Users could go back to
Python 2 on earlier versions, but that won't be the case any longer.

This change fixes up all the known type issues. It also adds typing
annotations to all parts of the code, ensuring that we are using the
proper types.

Documentation in parts have been updated as well to help keep things a
bit more maintainable.

Testing Done

Unit tests pass in Python 3.7-3.11.

Commits

Summary	ID
Fix type issues in TFS support and add typing annotations everywhere. TFS lacked any unit tests prior to RBTools 4, and had numerous type-related issues that broke on Python 3. Users could go back to Python 2 on earlier versions, but that won't be the case any longer. This change fixes up all the known type issues. It also adds typing annotations to all parts of the code, ensuring that we are using the proper types. Documentation in parts have been updated as well to help keep things a bit more maintainable.	396acea0a341b5bca94f16b3415643df22b3a192

Summary

Fix type issues in TFS support and add typing annotations everywhere.

TFS lacked any unit tests prior to RBTools 4, and had numerous type-related issues that broke on Python 3. Users could go back to Python 2 on earlier versions, but that won't be the case any longer. This change fixes up all the known type issues. It also adds typing annotations to all parts of the code, ensuring that we are using the proper types. Documentation in parts have been updated as well to help keep things a bit more maintainable.

396acea0a341b5bca94f16b3415643df22b3a192

Issues

Description	From	Last Updated
Can take this out.	maubin	Sept. 12, 2022, 11:38 a.m.
I don't see a parent_key in SCMClientDiffResult. Did you mean parent_diff?	maubin	Sept. 12, 2022, 11:38 a.m.
Should we mention anything about how this is the format of SCMClientRevisionSpec here?	maubin	Sept. 12, 2022, 11:40 a.m.
Same parent_key comment as above.	maubin	Sept. 12, 2022, 11:39 a.m.
Same parent_key comment as above.	maubin	Sept. 12, 2022, 11:40 a.m.
Should we mention anything about how this is the format of SCMClientRevisionSpec here?	maubin	Sept. 12, 2022, 11:40 a.m.

flake8 passed.

JSHint passed.

rbtools/clients/tfs.py (Diff revision 1)
The issue has been resolved. Show all issues
```
Can take this out.
```
rbtools/clients/tfs.py (Diff revision 1)
The issue has been resolved. Show all issues
```
I don't see a parent_key in SCMClientDiffResult. Did you mean parent_diff?
```
1. chipx86 Sept. 12, 2022, 11:40 a.m.
  Good catch!

rbtools/clients/tfs.py (Diff revision 1)

The issue has been dropped. Show all issues

Should we mention anything about how this is the format of SCMClientRevisionSpec here?

chipx86 Sept. 12, 2022, 11:40 a.m.

I do another pass in a future change that standardizes all these. We can fix those up there.

rbtools/clients/tfs.py (Diff revision 1)
The issue has been resolved. Show all issues
```
Same parent_key comment as above.
```
rbtools/clients/tfs.py (Diff revision 1)
The issue has been resolved. Show all issues
```
Same parent_key comment as above.
```
rbtools/clients/tfs.py (Diff revision 1)
The issue has been dropped. Show all issues
```
Should we mention anything about how this is the format of SCMClientRevisionSpec here?
```
1. chipx86 Sept. 12, 2022, 11:40 a.m.
  Same above.

Change Summary:


Fixed several typos (parent_key -> parent_diff)
Removed unused argument docs.

Commits:

	Summary	ID
	Fix type issues in TFS support and add typing annotations everywhere. TFS lacked any unit tests prior to RBTools 4, and had numerous type-related issues that broke on Python 3. Users could go back to Python 2 on earlier versions, but that won't be the case any longer. This change fixes up all the known type issues. It also adds typing annotations to all parts of the code, ensuring that we are using the proper types. Documentation in parts have been updated as well to help keep things a bit more maintainable.	15c9737ec9e683817bb7e14ad3302666fb4d6117
	Fix type issues in TFS support and add typing annotations everywhere. TFS lacked any unit tests prior to RBTools 4, and had numerous type-related issues that broke on Python 3. Users could go back to Python 2 on earlier versions, but that won't be the case any longer. This change fixes up all the known type issues. It also adds typing annotations to all parts of the code, ensuring that we are using the proper types. Documentation in parts have been updated as well to help keep things a bit more maintainable.	396acea0a341b5bca94f16b3415643df22b3a192

Diff:

Revision 2 (+504 -472)

Show changes

rbtools/clients/tfs.py

Checks run (2 succeeded)

flake8 passed.

JSHint passed.

Ship it!

```
Ship It!
```

Status:: Completed
Change Summary:: Pushed to release-4.x (fc57de6)

Ship it!

```
Ship It!
```