Summary

Move base rbtools.clients support into rbtools.clients.base.

Review Request #12518 — Created Aug. 9, 2022 and submitted Aug. 15, 2022, 7:15 p.m.

Information

Owner

chipx86

Repository

RBTools

Branch

release-4.x

Bugs

Depends On

Reviewers

Groups

rbtools

People

Description

We have a lot of support code in rbtools.clients.__init__, with more

coming. This has been hard to maintain, and was going to create some

circular dependency issues.
This cleanup has been long-overdue. This change moves SCMClient,

RepositoryInfo, PatchAuthor, and PatchResult into sub-modules of

rbtools.clients.base.
In the process, SCMClient has been renamed to BaseSCMClient, to

better fit modern naming of base classes.
There is a legacy SCMClient class in rbtools.clients that emits a

deprecation warning when instantiated. It will be removed in 5.0.
Aside from that, all the changes are mechanical or updates to references

in documentation.

Testing Done

All unit tests pass.

Posted this change using this build.

Commits

Summary	ID
Move base rbtools.clients support into rbtools.clients.base. We have a lot of support code in `rbtools.clients.__init__`, with more coming. This has been hard to maintain, and was going to create some circular dependency issues. This cleanup has been long-overdue. This change moves `SCMClient`, `RepositoryInfo`, `PatchAuthor`, and `PatchResult` into sub-modules of `rbtools.clients.base`. In the process, `SCMClient` has been renamed to `BaseSCMClient`, to better fit modern naming of base classes. There is a legacy `SCMClient` class in `rbtools.clients` that emits a deprecation warning when instantiated. It will be removed in 5.0. Aside from that, all the changes are mechanical or updates to references in documentation.	05e95e31749b26d95d991c6068a071b7f8b38893

Summary

Move base rbtools.clients support into rbtools.clients.base.

We have a lot of support code in `rbtools.clients.__init__`, with more coming. This has been hard to maintain, and was going to create some circular dependency issues. This cleanup has been long-overdue. This change moves `SCMClient`, `RepositoryInfo`, `PatchAuthor`, and `PatchResult` into sub-modules of `rbtools.clients.base`. In the process, `SCMClient` has been renamed to `BaseSCMClient`, to better fit modern naming of base classes. There is a legacy `SCMClient` class in `rbtools.clients` that emits a deprecation warning when instantiated. It will be removed in 5.0. Aside from that, all the changes are mechanical or updates to references in documentation.

05e95e31749b26d95d991c6068a071b7f8b38893

flake8 passed.

JSHint passed.

Change Summary:

Updated to target RBTools 4.0.

Description:

		We have a lot of support code in `rbtools.clients.__init__`, with more
		coming. This has been hard to maintain, and was going to create some
		circular dependency issues.

		This cleanup has been long-overdue. This change moves `SCMClient`,
		`RepositoryInfo`, `PatchAuthor`, and `PatchResult` into sub-modules of
		`rbtools.clients.base`.

		In the process, `SCMClient` has been renamed to `BaseSCMClient`, to
		better fit modern naming of base classes.

		There is a legacy `SCMClient` class in `rbtools.clients` that emits a
~		deprecation warning when instantiated. It will be removed in 4.0.
	~	deprecation warning when instantiated. It will be removed in 5.0.

		Aside from that, all the changes are mechanical or updates to references
		in documentation.

Commits:

	Summary	ID
	Move base rbtools.clients support into rbtools.clients.base. We have a lot of support code in `rbtools.clients.__init__`, with more coming. This has been hard to maintain, and was going to create some circular dependency issues. This cleanup has been long-overdue. This change moves `SCMClient`, `RepositoryInfo`, `PatchAuthor`, and `PatchResult` into sub-modules of `rbtools.clients.base`. In the process, `SCMClient` has been renamed to `BaseSCMClient`, to better fit modern naming of base classes. There is a legacy `SCMClient` class in `rbtools.clients` that emits a deprecation warning when instantiated. It will be removed in 4.0. Aside from that, all the changes are mechanical or updates to references in documentation.	26cdab0784482f038e50ee08706132d55811c750
	Move base rbtools.clients support into rbtools.clients.base. We have a lot of support code in `rbtools.clients.__init__`, with more coming. This has been hard to maintain, and was going to create some circular dependency issues. This cleanup has been long-overdue. This change moves `SCMClient`, `RepositoryInfo`, `PatchAuthor`, and `PatchResult` into sub-modules of `rbtools.clients.base`. In the process, `SCMClient` has been renamed to `BaseSCMClient`, to better fit modern naming of base classes. There is a legacy `SCMClient` class in `rbtools.clients` that emits a deprecation warning when instantiated. It will be removed in 5.0. Aside from that, all the changes are mechanical or updates to references in documentation.	61e0001eda8f47fc0b98abda79f8d8227469fb42

Branch:

release-3.x

release-4.x

Diff:

Revision 2 (+2448 -2158)

Show changes

	rbtools/clients/__init__.py
	rbtools/clients/bazaar.py
	rbtools/clients/clearcase.py
	rbtools/clients/cvs.py
	rbtools/clients/git.py
	rbtools/clients/mercurial.py
	rbtools/clients/perforce.py
	rbtools/clients/plastic.py
	12 more

Checks run (2 succeeded)

flake8 passed.

JSHint passed.

Change Summary:

Added a missing rbtools/clients/base/__init__.py.

Commits:

	Summary	ID
	Move base rbtools.clients support into rbtools.clients.base. We have a lot of support code in `rbtools.clients.__init__`, with more coming. This has been hard to maintain, and was going to create some circular dependency issues. This cleanup has been long-overdue. This change moves `SCMClient`, `RepositoryInfo`, `PatchAuthor`, and `PatchResult` into sub-modules of `rbtools.clients.base`. In the process, `SCMClient` has been renamed to `BaseSCMClient`, to better fit modern naming of base classes. There is a legacy `SCMClient` class in `rbtools.clients` that emits a deprecation warning when instantiated. It will be removed in 5.0. Aside from that, all the changes are mechanical or updates to references in documentation.	61e0001eda8f47fc0b98abda79f8d8227469fb42
	Move base rbtools.clients support into rbtools.clients.base. We have a lot of support code in `rbtools.clients.__init__`, with more coming. This has been hard to maintain, and was going to create some circular dependency issues. This cleanup has been long-overdue. This change moves `SCMClient`, `RepositoryInfo`, `PatchAuthor`, and `PatchResult` into sub-modules of `rbtools.clients.base`. In the process, `SCMClient` has been renamed to `BaseSCMClient`, to better fit modern naming of base classes. There is a legacy `SCMClient` class in `rbtools.clients` that emits a deprecation warning when instantiated. It will be removed in 5.0. Aside from that, all the changes are mechanical or updates to references in documentation.	05e95e31749b26d95d991c6068a071b7f8b38893

Diff:

Revision 3 (+2458 -2158)

Show changes

	rbtools/clients/__init__.py
	rbtools/clients/bazaar.py
	rbtools/clients/clearcase.py
	rbtools/clients/cvs.py
	rbtools/clients/git.py
	rbtools/clients/mercurial.py
	rbtools/clients/perforce.py
	rbtools/clients/plastic.py
	13 more

Checks run (2 succeeded)

flake8 passed.

JSHint passed.

Ship it!

```
Ship It!
```

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