Summary

Add a registry for SCMClient classes and move defaults into code.

Review Request #12525 — Created Aug. 10, 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

This introduces rbtools.clients.base.registry.SCMClientRegistry, which
keeps track of all the available BaseSCMClient subclasses. This
enables fetching a client by ID, iterating through all clients, and
registering new ones.

The registry is accessible via a rbtools.clients.scmclient_registry
instance.

SCMClient classes should now set a scmclient_id attribute. This will
be mandated in RBTools 5. For now, any loaded via entry point that lack
an ID will have one assigned, with a warning.

To improve performance and to avoid packaging-related complications,
the default list of clients are now fully inline, rather than
introspected via entrypoints. This matches what we've been doing within
Review Board. The registry still scans entrypoints for third-party
packages, but only when needed (if listing all clients or if a lookup
fails to find it in the built-in list).

Entry points use the modern importlib.metadata.entry_points API. This
has only solidified as of Python 3.10 (3.8/3.9 had it but it's not
compatible), so we pull in the official backport for those versions.

Testing Done

Unit tests pass.

Posted this change for review.

Ran mypy and pyright on the new registry code, with no errors
or warnings.

Commits

Summary	ID
Add a registry for SCMClient classes and move defaults into code. This introduces `rbtools.clients.base.registry.SCMClientRegistry`, which keeps track of all the available `BaseSCMClient` subclasses. This enables fetching a client by ID, iterating through all clients, and registering new ones. The registry is accessible via a `rbtools.clients.scmclient_registry` instance. `SCMClient` classes should now set a `scmclient_id` attribute. This will be mandated in RBTools 5. For now, any loaded via entry point that lack an ID will have one assigned, with a warning. To improve performance and to avoid packaging-related complications, the default list of clients are now fully inline, rather than introspected via entrypoints. This matches what we've been doing within Review Board. The registry still scans entrypoints for third-party packages, but only when needed (if listing all clients or if a lookup fails to find it in the built-in list).	483cf2eeac0ed8377ff9c00505a31ec1a8b33f7c

Summary

Add a registry for SCMClient classes and move defaults into code.

This introduces `rbtools.clients.base.registry.SCMClientRegistry`, which keeps track of all the available `BaseSCMClient` subclasses. This enables fetching a client by ID, iterating through all clients, and registering new ones. The registry is accessible via a `rbtools.clients.scmclient_registry` instance. `SCMClient` classes should now set a `scmclient_id` attribute. This will be mandated in RBTools 5. For now, any loaded via entry point that lack an ID will have one assigned, with a warning. To improve performance and to avoid packaging-related complications, the default list of clients are now fully inline, rather than introspected via entrypoints. This matches what we've been doing within Review Board. The registry still scans entrypoints for third-party packages, but only when needed (if listing all clients or if a lookup fails to find it in the built-in list).

483cf2eeac0ed8377ff9c00505a31ec1a8b33f7c

Issues

Description	From	Last Updated
local variable 'e' is assigned to but never used Column: 9 Error code: F841	reviewbot	Aug. 10, 2022, 12:03 a.m.
'typing.Optional' imported but unused Column: 1 Error code: F401	reviewbot	Aug. 10, 2022, 12:04 a.m.
undefined name 'RemovedInRBTools50Warning' Column: 9 Error code: F821	reviewbot	Aug. 10, 2022, 12:04 a.m.
local variable 'cm' is assigned to but never used Column: 75 Error code: F841	reviewbot	Aug. 10, 2022, 12:04 a.m.
local variable 'cm' is assigned to but never used Column: 75 Error code: F841	reviewbot	Aug. 10, 2022, 12:04 a.m.

flake8 failed.

JSHint passed.

flake8

rbtools/clients/__init__.py (Diff revision 1)
The issue has been resolved. Show all issues
```
local variable 'e' is assigned to but never used

Column: 9
Error code: F841
```
rbtools/clients/base/scmclient.py (Diff revision 1)
The issue has been resolved. Show all issues
```
'typing.Optional' imported but unused

Column: 1
Error code: F401
```
rbtools/clients/base/scmclient.py (Diff revision 1)
The issue has been resolved. Show all issues
```
undefined name 'RemovedInRBTools50Warning'

Column: 9
Error code: F821
```
rbtools/clients/tests/test_scmclient_registry.py (Diff revision 1)
The issue has been resolved. Show all issues
```
local variable 'cm' is assigned to but never used

Column: 75
Error code: F841
```
rbtools/clients/tests/test_scmclient_registry.py (Diff revision 1)
The issue has been resolved. Show all issues
```
local variable 'cm' is assigned to but never used

Column: 75
Error code: F841
```

Change Summary:


Removed unused variables.
Removed some unused imports.
Added a missing import.

Commits:

	Summary	ID
	Add a registry for SCMClient classes and move defaults into code. This introduces `rbtools.clients.base.registry.SCMClientRegistry`, which keeps track of all the available `BaseSCMClient` subclasses. This enables fetching a client by ID, iterating through all clients, and registering new ones. The registry is accessible via a `rbtools.clients.scmclient_registry` instance. `SCMClient` classes should now set a `scmclient_id` attribute. This will be mandated in RBTools 5. For now, any loaded via entry point that lack an ID will have one assigned, with a warning. To improve performance and to avoid packaging-related complications, the default list of clients are now fully inline, rather than introspected via entrypoints. This matches what we've been doing within Review Board. The registry still scans entrypoints for third-party packages, but only when needed (if listing all clients or if a lookup fails to find it in the built-in list).	a479deec3cb25bd212ebed0a4f026c4f0eafb6f0
	Add a registry for SCMClient classes and move defaults into code. This introduces `rbtools.clients.base.registry.SCMClientRegistry`, which keeps track of all the available `BaseSCMClient` subclasses. This enables fetching a client by ID, iterating through all clients, and registering new ones. The registry is accessible via a `rbtools.clients.scmclient_registry` instance. `SCMClient` classes should now set a `scmclient_id` attribute. This will be mandated in RBTools 5. For now, any loaded via entry point that lack an ID will have one assigned, with a warning. To improve performance and to avoid packaging-related complications, the default list of clients are now fully inline, rather than introspected via entrypoints. This matches what we've been doing within Review Board. The registry still scans entrypoints for third-party packages, but only when needed (if listing all clients or if a lookup fails to find it in the built-in list).	6b7a04cf9f5030e8173e5f06cb7afc7a5fd31479

Diff:

Revision 2 (+1108 -40)

Show changes

	setup.py
	rbtools/clients/__init__.py
	rbtools/clients/bazaar.py
	rbtools/clients/clearcase.py
	rbtools/clients/cvs.py
	rbtools/clients/errors.py
	rbtools/clients/git.py
	rbtools/clients/mercurial.py
	9 more

Checks run (2 succeeded)

flake8 passed.

JSHint passed.

Ship it!

```
Ship It!
```

Change Summary:


Added __contains__, for checking for presence.
Tweaked some errors.

Commits:

	Summary	ID
	Add a registry for SCMClient classes and move defaults into code. This introduces `rbtools.clients.base.registry.SCMClientRegistry`, which keeps track of all the available `BaseSCMClient` subclasses. This enables fetching a client by ID, iterating through all clients, and registering new ones. The registry is accessible via a `rbtools.clients.scmclient_registry` instance. `SCMClient` classes should now set a `scmclient_id` attribute. This will be mandated in RBTools 5. For now, any loaded via entry point that lack an ID will have one assigned, with a warning. To improve performance and to avoid packaging-related complications, the default list of clients are now fully inline, rather than introspected via entrypoints. This matches what we've been doing within Review Board. The registry still scans entrypoints for third-party packages, but only when needed (if listing all clients or if a lookup fails to find it in the built-in list).	6b7a04cf9f5030e8173e5f06cb7afc7a5fd31479
	Add a registry for SCMClient classes and move defaults into code. This introduces `rbtools.clients.base.registry.SCMClientRegistry`, which keeps track of all the available `BaseSCMClient` subclasses. This enables fetching a client by ID, iterating through all clients, and registering new ones. The registry is accessible via a `rbtools.clients.scmclient_registry` instance. `SCMClient` classes should now set a `scmclient_id` attribute. This will be mandated in RBTools 5. For now, any loaded via entry point that lack an ID will have one assigned, with a warning. To improve performance and to avoid packaging-related complications, the default list of clients are now fully inline, rather than introspected via entrypoints. This matches what we've been doing within Review Board. The registry still scans entrypoints for third-party packages, but only when needed (if listing all clients or if a lookup fails to find it in the built-in list).	483cf2eeac0ed8377ff9c00505a31ec1a8b33f7c

Diff:

Revision 3 (+1186 -40)

Show changes

	setup.py
	rbtools/clients/__init__.py
	rbtools/clients/bazaar.py
	rbtools/clients/clearcase.py
	rbtools/clients/cvs.py
	rbtools/clients/errors.py
	rbtools/clients/git.py
	rbtools/clients/mercurial.py
	9 more

Checks run (2 succeeded)

flake8 passed.

JSHint passed.

Ship it!

```
Ship It!
```

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

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