rbtools.commands.stamp¶

Implementation of rbt stamp.

Classes

class rbtools.commands.stamp.Stamp(transport_cls: type[Transport] = <class 'rbtools.api.transport.sync.SyncTransport'>, stdout: TextIO = <_io.TextIOWrapper name='<stdout>' mode='w' encoding='utf-8'>, stderr: TextIO = <_io.TextIOWrapper name='<stderr>' mode='w' encoding='utf-8'>, stdin: TextIO = <_io.TextIOWrapper name='<stdin>' mode='r' encoding='utf-8'>)[source]¶

Bases: BaseCommand

Add the review request URL to the commit message.

Stamps the review request URL onto the commit message of the revision specified. The revisions argument behaves like it does in rbt post, where it is required for some SCMs (e.g. Perforce) and unnecessary/ignored for others (e.g. Git).

Normally, this command will guess the review request (based on the revision number if provided, and the commit summary and description otherwise). However, if a review request ID is specified by the user, it stamps the URL of that review request instead of guessing.

name: ClassVar[str] = 'stamp'[source]¶

The name of the command.

Type:

str

author: ClassVar[str] = 'The Review Board Project'[source]¶

The author of the command.

Type:

str

description: ClassVar[str] = 'Adds the review request URL to the commit message.'[source]¶

A short description of the command, suitable for display in usage text.

Type:

str

needs_api: ClassVar[bool] = True[source]¶

Whether the command needs the API client.

If this is set, the initialization of the command will set api_client and api_root.

New in version 3.0.

Type:

bool

needs_scm_client: ClassVar[bool] = True[source]¶

Whether the command needs the SCM client.

If this is set, the initialization of the command will set repository_info and tool.

New in version 3.0.

Type:

bool

needs_repository: ClassVar[bool] = True[source]¶

Whether the command needs the remote repository object.

If this is set, the initialization of the command will set repository.

Setting this will imply setting both needs_api and needs_scm_client to True.

New in version 3.0.

Type:

bool

args: ClassVar[str] = '[revisions]'[source]¶

Usage text for what arguments the command takes.

Arguments for the command are anything passed in other than defined options (for example, revisions passed to rbt post).

Type:

str

option_list: ClassVar[list[Union[Option, OptionGroup]]] = [<rbtools.commands.base.options.OptionGroup object>, <rbtools.commands.base.options.OptionGroup object>, <rbtools.commands.base.options.OptionGroup object>, <rbtools.commands.base.options.OptionGroup object>, <rbtools.commands.base.options.OptionGroup object>, <rbtools.commands.base.options.OptionGroup object>][source]¶

Command-line options for this command.

Type:

list of Option or OptionGroup

no_commit_error()[source]¶

determine_review_request(revisions: SCMClientRevisionSpec) → tuple[Optional[int], Optional[str]][source]¶

Determine the correct review request for a commit.

Parameters:

revisions (rbtools.clients.base.scmclient.SCMClientRevisionSpec) – The parsed revisions from the command line.

Returns:

A 2-tuple containing:

Tuple:

• 0 (int) – The matching review request ID. If no match was found, this will be None.

• 1 (str) – The matching review request URL. If no match was found, this will be None.

Return type:

tuple

Raises:

rbtools.commands.CommandError – An error occurred while attempting to find a matching review request.

main(*args)[source]¶

Add the review request URL to a commit message.