rbtools.clients¶

Support for interfacing with source code management systems.

This provides support for creating, looking up, and registering SCM client integrations, enabling RBTools to interact with local source code repositories and communicate on their behalf to Review Board.

This particular module provides forwarding imports for:

`rbtools.diffs.patches.PatchAuthor`	The author of a patch or commit.
`rbtools.diffs.patches.PatchResult`	The result of a patch operation.
`rbtools.clients.base.registry.scmclient_registry`	The main SCMClients registry used by RBTools.
`rbtools.clients.base.repository.RepositoryInfo`	A representation of a source code repository.
`rbtools.clients.base.scmclient.BaseSCMClient`	A base class for interfacing with a source code management tool.

As well as some (soon to be legacy) utility functions and classes.

Changed in version 5.1:

PatchAuthor and ` PatchResult should now be imported from rbtools.diffs.patches.

Changed in version 4.0:

Moved and renamed rbtools.clients.base.scmclient.BaseSCMClient and added a forwarding import and temporary legacy class.
Moved RepositoryInfo and added a forwarding import.

Functions

`load_scmclients`(config, options)	Load the available SCM clients.
`scan_usable_client`(config, options[, ...])	Scan for a usable SCMClient.

Classes

`PatchAuthor`(args, *kwargs)	The author of a patch or commit.
`PatchResult`(args, *kwargs)	The result of a patch operation.

rbtools.clients.load_scmclients(config, options)[source]¶

Load the available SCM clients.

Parameters:

config (dict) – The loaded user config.
options (argparse.Namespace) – The parsed command line arguments.

rbtools.clients.scan_usable_client(config: RBToolsConfig, options: argparse.Namespace, client_name: Optional[str] = None, *, tool_required: bool = True) → tuple[Optional[RepositoryInfo], Optional[BaseSCMClient]][source]¶

Scan for a usable SCMClient.

Changed in version 5.2.1: Added the tool_required argument.

Parameters:

config (dict) – The loaded user config.
options (argparse.Namespace) – The parsed command line arguments.
client_name (str, optional) – A specific client name, which can come from the configuration. This can be used to disambiguate if there are nested repositories, or to speed up detection.
tool_required (bool, optional) –
Whether a usable client is required.

New in version 5.2.1.

Returns:

A 2-tuple, containing the repository info structure and the tool instance.

Return type:

tuple