rbtools.utils.commands¶

Utilities for commands.

Functions

Exceptions

exception rbtools.utils.commands.AlreadyStampedError[source]¶

Bases: Exception

An error indicating the change has already been stamped.

__firstlineno__ = 33¶

__static_attributes__ = ()¶

rbtools.utils.commands.build_rbtools_cmd_argv(options, options_map={'api_token': '--api-token', 'debug': '--debug', 'disable_ssl_verification': '--disable-ssl-verification', 'enable_proxy': '--disable-proxy', 'password': '--password', 'repository_name': '--repository', 'repository_type': '--repository-type', 'repository_url': '--repository-url', 'server': '--server', 'username': '--username'})[source]¶

Generates a list of command line arguments from parsed command options.

Used for building command line arguments from existing options, when calling another RBTools command. options_map specifies the options and their corresponding argument names that need to be included.

rbtools.utils.commands.extract_commit_message(review_request: ReviewRequestItemResource) → str[source]¶

Return a commit message based on the review request.

The commit message returned contains the Summary, Description, Bugs, and Testing Done fields from the review request, if available.

Deprecated since version 7.0: Moved to rbtools.utils.commit_messages.

Parameters:

review_request (rbtools.api.resource.ReviewRequestItemResource) – The review request.

Returns:

A commit message assembled from the review request fields.

Return type:

str

rbtools.utils.commands.stamp_commit_with_review_url(revisions, review_request_url, tool)[source]¶

Amend the tip revision message to include review_request_url.