rbtools.commands.status¶

Implementation of rbt status.

Classes

class rbtools.commands.status.Status(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

Display review requests for the current repository.

name: str = 'status'[source]¶

The name of the command.

Type:

str

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

The author of the command.

Type:

str

description: str = 'Output a list of your pending review requests.'[source]¶

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

Type:

str

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

args: str = '[review-request [revision]]'[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: List[Union[Option, OptionGroup]] = [<rbtools.commands.base.options.Option object>, <rbtools.commands.base.options.Option object>, <rbtools.commands.base.options.Option 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

TAB_SIZE = 3[source]¶

PADDING = 5[source]¶

tabulate(review_requests)[source]¶

Print review request summary and status in a table.

Parameters:

review_requests (list of dict) – A list that contains statistics about each review request.

get_data(review_requests)[source]¶

Return current status and review summary for all review requests.

Parameters:

review_requests (ListResource) – A ListResource that contains data on all open/draft review requests.

Returns:

A list whose elements are dicts of each review request’s statistics.

Return type:

list

initialize()[source]¶

Initialize the command.

This override of the base command initialize method exists so we can conditionally set whether the SCM Client is necessary. Without any options, this command will only print the status of review requests on the current repository, which requires the client. If –all is passed, this command only needs the API.

main()[source]¶

The main logic of the command.

This method should be overridden to implement the commands functionality.

Parameters:

*args (tuple) – Positional arguments passed to the command.

Returns:

The resulting exit code.

Return type:

int

format_results(review_requests)[source]¶

Print formatted information about the review requests.

Parameters:

review_requests (list of dict) – The information about the review requests.