Summary

Move all base command support into rbtools.commands.base.

Review Request #13021 — Created May 6, 2023 and submitted May 19, 2023, 3:55 p.m.

Information

Owner

chipx86

Repository

RBTools

Branch

release-5.x

Bugs

Depends On

Blocks

13022

Reviewers

Groups

rbtools

People

Description

Modules in rbtools.commands.base now provide all the base command
classes, option processing, output handling, and errors. This cleans up
the rbtools.commands module and gives us room for further expansion.

This work was planned for RBTools 4, but had to slip.

With the exception of the, well, exception classes, all classes use
housekeeping.ClassMovedMixin to point to the new class. We don't
bother subclassing the old exceptions because catching a subclass
wouldn't do any good. We can't easily deprecate those, for the
time-being, we'll leave them in, directly assigning from the new
modules.

The moved classes have not been modernized. Aside from imports and
version change information in the docstrings, no changes have been made
to any of the moved code.

Testing Done

Unit tests pass, except for one that's sensitive to generated output
and is seeing a warning. This will be addressed in a follow-up change.

Commits

Summary	ID
Mov all base command support into rbtools.commands.base. Modules in `rbtools.commands.base` now provide all the base command classes, option processing, output handling, and errors. This cleans up the `rbtools.commands` module and gives us room for further expansion. This work was planned for RBTools 4, but had to slip. With the exception of the, well, exception classes, all classes use `housekeeping.ClassMovedMixin` to point to the new class. We don't bother subclassing the old exceptions because catching a subclass wouldn't do any good. We can't easily deprecate those, for the time-being, we'll leave them in, directly assigning from the new modules. The moved classes have not been modernized. Aside from imports and version change information in the docstrings, no changes have been made to any of the moved code.	785ea25c142f3c1578024415911506aff05f4b70

Summary

Mov all base command support into rbtools.commands.base.

Modules in `rbtools.commands.base` now provide all the base command classes, option processing, output handling, and errors. This cleans up the `rbtools.commands` module and gives us room for further expansion. This work was planned for RBTools 4, but had to slip. With the exception of the, well, exception classes, all classes use `housekeeping.ClassMovedMixin` to point to the new class. We don't bother subclassing the old exceptions because catching a subclass wouldn't do any good. We can't easily deprecate those, for the time-being, we'll leave them in, directly assigning from the new modules. The moved classes have not been modernized. Aside from imports and version change information in the docstrings, no changes have been made to any of the moved code.

785ea25c142f3c1578024415911506aff05f4b70

Issues

Description	From	Last Updated
Typo in summary: "Mov" -> "Move"	maubin	May 10, 2023, 2:57 p.m.
redefinition of unused 'BaseSubCommand' from line 8 Column: 1 Error code: F811	reviewbot	May 6, 2023, 2:22 a.m.
redefinition of unused 'BaseMultiCommand' from line 8 Column: 1 Error code: F811	reviewbot	May 6, 2023, 2:22 a.m.
'rbtools.deprecation.RemovedInRBTools60Warning' imported but unused Column: 1 Error code: F401	reviewbot	May 6, 2023, 2:23 a.m.
'rbtools.utils.filesystem.is_exe_in_path' imported but unused Column: 1 Error code: F401	reviewbot	May 6, 2023, 2:23 a.m.
undefined name 'json' Column: 35 Error code: F821	reviewbot	May 6, 2023, 2:23 a.m.
undefined name 'six' Column: 37 Error code: F821	reviewbot	May 6, 2023, 2:23 a.m.

flake8 failed.

JSHint passed.

flake8

rbtools/commands/__init__.py (Diff revision 1)
The issue has been resolved. Show all issues
```
redefinition of unused 'BaseSubCommand' from line 8

Column: 1
Error code: F811
```

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

The issue has been resolved. Show all issues

redefinition of unused 'BaseMultiCommand' from line 8

Column: 1
Error code: F811

rbtools/commands/base/commands.py (Diff revision 1)

The issue has been resolved. Show all issues

'rbtools.deprecation.RemovedInRBTools60Warning' imported but unused

Column: 1
Error code: F401

rbtools/commands/base/commands.py (Diff revision 1)

The issue has been resolved. Show all issues

'rbtools.utils.filesystem.is_exe_in_path' imported but unused

Column: 1
Error code: F401

rbtools/commands/base/output.py (Diff revision 1)
The issue has been resolved. Show all issues
```
undefined name 'json'

Column: 35
Error code: F821
```
rbtools/commands/base/output.py (Diff revision 1)
The issue has been resolved. Show all issues
```
undefined name 'six'

Column: 37
Error code: F821
```

Change Summary:

Fixed some imports and incorrect base classes.

Commits:

	Summary	ID
	Mov all base command support into rbtools.commands.base. Modules in `rbtools.commands.base` now provide all the base command classes, option processing, output handling, and errors. This cleans up the `rbtools.commands` module and gives us room for further expansion. This work was planned for RBTools 4, but had to slip. With the exception of the, well, exception classes, all classes use `housekeeping.ClassMovedMixin` to point to the new class. We don't bother subclassing the old exceptions because catching a subclass wouldn't do any good. We can't easily deprecate those, for the time-being, we'll leave them in, directly assigning from the new modules. The moved classes have not been modernized. Aside from imports and version change information in the docstrings, no changes have been made to any of the moved code.	63e4c445ceccf4072f9234881257e7460bbf38a5
	Mov all base command support into rbtools.commands.base. Modules in `rbtools.commands.base` now provide all the base command classes, option processing, output handling, and errors. This cleans up the `rbtools.commands` module and gives us room for further expansion. This work was planned for RBTools 4, but had to slip. With the exception of the, well, exception classes, all classes use `housekeeping.ClassMovedMixin` to point to the new class. We don't bother subclassing the old exceptions because catching a subclass wouldn't do any good. We can't easily deprecate those, for the time-being, we'll leave them in, directly assigning from the new modules. The moved classes have not been modernized. Aside from imports and version change information in the docstrings, no changes have been made to any of the moved code.	785ea25c142f3c1578024415911506aff05f4b70

Diff:

Revision 2 (+3940 -3330)

Show changes

	docs/rbtools/api/coderef/index.rst
	rbtools/deprecation.py
	rbtools/commands/__init__.py
	rbtools/commands/base/__init__.py
	rbtools/commands/base/commands.py
	rbtools/commands/base/errors.py
	rbtools/commands/base/options.py
	rbtools/commands/base/output.py

Checks run (2 succeeded)

flake8 passed.

JSHint passed.

Ship it!

The issue has been resolved. Show all issues
```
Typo in summary: "Mov" -> "Move"
```

Summary:

-	Mov all base command support into rbtools.commands.base.
+	Move all base command support into rbtools.commands.base.

Status: Closed (submitted)

Change Summary:

Pushed to release-5.x (ab8f0d3)