rbtools.diffs.tools.registry¶

Registry of available diff tools.

Module Attributes

Classes

class rbtools.diffs.tools.registry.DiffToolsRegistry[source]¶

Bases: object

A registry managing known and available diff tools.

This provides functionality for querying and registering diff tools classes and instances.

As a single diff tool instance can be used for multiple operations, the registry will cache any created instances and return them the next time they’re needed, instead of creating a new instance every time. This avoids the up-front cost of checking for tool availability more than once.

The registry provides a built-in list of supported tools. For future extensibility, additional tools can be registered as well.

New in version 4.0.

__init__()[source]¶

Initialize the registry.

iter_diff_tool_classes() → Iterator[Type[BaseDiffTool]][source]¶

Iterate through all registered diff tool classes.

This does not guarantee order.

Yields:

type – Each registered subclass of BaseDiffTool.

get_diff_tool_class(diff_tool_id: str) → Optional[Type[BaseDiffTool]][source]¶

Return a diff tool class with the given ID.

If the ID could not be found, this will return None.

Parameters:

diff_tool_id (str) – The ID of the diff tool to return.

Returns:

The diff tool class, or None if not found.

Return type:

type

get_available(compatible_diff_tool_ids: Optional[Iterable[str]] = None) → BaseDiffTool[source]¶

Return an available diff tool out of an optional set of IDs.

This will attempt to find an available diff tool that, optionally restricting results to a set of compatible diff tool IDs.

The instance is cached for future lookups.

Parameters:

compatible_diff_tool_ids (set, optional) – An optional set of compatible diff tool IDs.

Returns:

The available diff tool instance.

Return type:

rbtools.diffs.tools.base.diff_tool.BaseDiffTool

Raises:

rbtools.diffs.tools.errors.MissingDiffToolError – A compatible diff tool could not be found.

register(diff_tool_cls: Type[BaseDiffTool]) → None[source]¶

Register a diff tool class.

To be usable, a tool must be registered before any operations are performed that return an instantiated tool.

Parameters:

diff_tool_cls (type) – The diff tool class to register.

reset() → None[source]¶

Reset the registry to an empty state.

This is primarily intended for unit testing, to ensure that any new attempts to fetch tools will result in fresh instances.

rbtools.diffs.tools.registry.diff_tools_registry = <rbtools.diffs.tools.registry.DiffToolsRegistry object>[source]¶

The main diff tools registry.

New in version 4.0.

Type:

DiffToolsRegistry