rbtools.commands.patch¶

Implementation of rbt patch.

Classes

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

Bases: Command

Applies a specific patch from a RB server.

The patch file indicated by the request id is downloaded from the server and then applied locally.

name = 'patch'[source]¶

The name of the command.

Type:

unicode

author = 'The Review Board Project'[source]¶

The author of the command.

Type:

unicode

needs_api = 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 = 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

args = '<review-request-id>'[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:

unicode

option_list = [<rbtools.commands.Option object>, <rbtools.commands.Option object>, <rbtools.commands.Option object>, <rbtools.commands.Option object>, <rbtools.commands.Option object>, <rbtools.commands.Option object>, <rbtools.commands.Option object>, <rbtools.commands.Option object>, <rbtools.commands.Option object>, <rbtools.commands.OptionGroup object>, <rbtools.commands.OptionGroup object>][source]¶

Command-line options for this command.

Type:

list of Option or OptionGroup

get_patches(diff_revision=None, commit_ids=None, squashed=False, reverted=False)[source]¶

Return the requested patches and their metadata.

If a diff revision is not specified, then this will look at the most recent diff.

Parameters:

• diff_revision (int, optional) –

  The diff revision to apply.

  The latest revision will be used if not provided.

• commit_ids (list of unicode, optional) –

  The specific commit IDs to apply.

  If not specified, the squashed version of any commits (or the sole diff, in a non-multi-commit review request) will be applied.

• squashed (bool, optional) – Whether to return a squashed version of the commits, if using a multi-commit review request.

• reverted (bool, optional) – Return patches in the order needed to revert them.

Returns:

A list of dictionaries with the following keys:

basedir (unicode):

The base directory of the returned patch.

diff (bytes):

The actual patch contents.

patch_num (int):

The application number for the patch. This is 1-based.

revision (int):

The revision of the returned patch.

commit_meta (dict):

Metadata about the requested commit if one was requested. Otherwise, this will be None.

Return type:

list of dict

Raises:

rbtools.command.CommandError – One of the following occurred: * The patch could not be retrieved or does not exist * The review request was created without history support and commit_ids was provided. * One or more requested commit IDs could not be found.

apply_patch(diff_file_path, base_dir, patch_num, total_patches, revert=False)[source]¶

Apply a patch to the tree.

Parameters:

• diff_file_path (unicode) – The file path of the diff being applied.

• base_dir (unicode) – The base directory within which to apply the patch.

• patch_num (int) – The 1-based index of the patch being applied.

• total_patches (int) – The total number of patches being applied.

• revert (bool, optional) – Whether the patch is being reverted.

Returns:

True if the patch was applied/reverted successfully. False if the patch was partially applied/reverted but there were conflicts.

Return type:

bool

Raises:

rbtools.command.CommandError – There was an error applying or reverting the patch.

initialize()[source]¶

Initialize the command.

This overrides Command.initialize in order to handle full review request URLs on the command line. In this case, we want to parse that URL in order to pull the server name and diff revision out of it.

Raises:

rbtools.commands.CommandError – A review request URL passed in as the review request ID could not be parsed correctly or included a bad diff revision.

main(review_request_id)[source]¶

Run the command.

Parameters:

review_request_id (int) – The ID of the review request to patch from.

Raises:

rbtools.command.CommandError – Patching the tree has failed.