Summary

Add typing and docs for all functionality in the base command classes.

Review Request #13038 — Created May 10, 2023 and submitted May 30, 2023, 3:25 p.m.

Information

Owner

chipx86

Repository

RBTools

Branch

release-5.x

Bugs

Depends On

Reviewers

Groups

rbtools

People

Description

BaseCommand, BaseMultiCommand, and BaseSubCommand now include
typing for all code, and modernized documentation.

This has required some small typing fixes throughout the codebase, but
has also found a few typing and logic errors that are being fixed. For
instance, BaseCommand._init_server_url() received a fix to avoid
crashing if repository information couldn't be found.

Some legacy Python 2 conditional code has been removed. There are some
other deprecated code paths that don't have proper typing, but those
will be going away in a separate change.

Testing Done

Unit tests pass.

Tested posting several review requests for review, including this one.

Commits

Summary	ID
Add typing and docs for all functionality in the base command classes. `BaseCommand`, `BaseMultiCommand`, and `BaseSubCommand` now include typing for all code, and modernized documentation. This has required some small typing fixes throughout the codebase, but has also found a few typing and logic errors that are being fixed. For instance, `BaseCommand._init_server_url()` received a fix to avoid crashing if repository information couldn't be found. Some legacy Python 2 conditional code has been removed. There are some other deprecated code paths that don't have proper typing, but those will be going away in a separate change.	8e9e0ac3b505ebbfba43c4295400e98a1dccd522

Summary

Add typing and docs for all functionality in the base command classes.

`BaseCommand`, `BaseMultiCommand`, and `BaseSubCommand` now include typing for all code, and modernized documentation. This has required some small typing fixes throughout the codebase, but has also found a few typing and logic errors that are being fixed. For instance, `BaseCommand._init_server_url()` received a fix to avoid crashing if repository information couldn't be found. Some legacy Python 2 conditional code has been removed. There are some other deprecated code paths that don't have proper typing, but those will be going away in a separate change.

8e9e0ac3b505ebbfba43c4295400e98a1dccd522

Issues

Description	From	Last Updated
'typing.Dict' imported but unused Column: 1 Error code: F401	reviewbot	May 10, 2023, 9:23 p.m.

flake8 failed.

JSHint passed.

flake8

rbtools/clients/__init__.py (Diff revision 1)
The issue has been resolved. Show all issues
```
'typing.Dict' imported but unused

Column: 1
Error code: F401
```

Change Summary:

Removed an unused import.

Commits:

	Summary	ID
	Add typing and docs for all functionality in the base command classes. `BaseCommand`, `BaseMultiCommand`, and `BaseSubCommand` now include typing for all code, and modernized documentation. This has required some small typing fixes throughout the codebase, but has also found a few typing and logic errors that are being fixed. For instance, `BaseCommand._init_server_url()` received a fix to avoid crashing if repository information couldn't be found. Some legacy Python 2 conditional code has been removed. There are some other deprecated code paths that don't have proper typing, but those will be going away in a separate change.	50c0a1e7aa8d9723ac7e11e00eef84ba97c3fcad
	Add typing and docs for all functionality in the base command classes. `BaseCommand`, `BaseMultiCommand`, and `BaseSubCommand` now include typing for all code, and modernized documentation. This has required some small typing fixes throughout the codebase, but has also found a few typing and logic errors that are being fixed. For instance, `BaseCommand._init_server_url()` received a fix to avoid crashing if repository information couldn't be found. Some legacy Python 2 conditional code has been removed. There are some other deprecated code paths that don't have proper typing, but those will be going away in a separate change.	8e9e0ac3b505ebbfba43c4295400e98a1dccd522

Diff:

Revision 2 (+588 -192)

Show changes

	rbtools/api/capabilities.py
	rbtools/api/client.py
	rbtools/api/resource.py
	rbtools/api/transport/__init__.py
	rbtools/api/transport/sync.py
	rbtools/clients/__init__.py
	rbtools/commands/base/commands.py

Checks run (2 succeeded)

flake8 passed.

JSHint passed.

Ship it!

```
Ship It!
```

Status:: Completed
Change Summary:: Pushed to release-5.x (14fae2d)

Status:: Completed
Change Summary:: Pushed to master (14fae2d)

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