rbtools.commands.status_update¶

Implementation of rbt status-update.

Classes

class rbtools.commands.status_update.BaseStatusUpdateSubCommand(options: Namespace, config: RBToolsConfig, *args, **kwargs)[source]¶

Bases: BaseSubCommand

Base class for all status update subcommands.

This provides utilities for printing information or storing JSON data on status updates.

New in version 3.0.

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

print(response)[source]¶

Print output in format specified by user.

Parameters:

response (list, dict) – Response from API with list of status-updates or a single status-update.

class rbtools.commands.status_update.GetStatusUpdateSubCommand(options: Namespace, config: RBToolsConfig, *args, **kwargs)[source]¶

Bases: BaseStatusUpdateSubCommand

Subcommand for displaying information on status updates.

New in version 3.0.

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

The name of the command.

Type:

str

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

Command-line options for this command.

Type:

list of Option or OptionGroup

main()[source]¶

Handle getting status update information from Review Board.

Raises:

• rbtools.commands.CommandError – Error with the execution of the command.

• rbtools.commands.CommandExit – Stop executing and return an exit status.

class rbtools.commands.status_update.SetStatusUpdateSubCommand(options: Namespace, config: RBToolsConfig, *args, **kwargs)[source]¶

Bases: BaseStatusUpdateSubCommand

Subcommand for creating or modifying status updates.

New in version 3.0.

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

The name of the command.

Type:

str

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

Command-line options for this command.

Type:

list of Option or OptionGroup

main()[source]¶

Handle setting status update information on Review Board.

Raises:

• rbtools.commands.CommandError – Error with the execution of the command.

• rbtools.commands.CommandExit – Stop executing and return an exit status.

add_review()[source]¶

Handle adding a review to a review request from a json file.

Looks for reviews, diff_comments, and general_comments keys in the json file contents and populates the review accordingly.

To find appropriate inputs for each key:

reviews:

Look at Web API documentation for POST on the Review List resource for available fields.

diff_comments:

Look at Web API documentation for POST on the Review Diff Comment List resource for available fields. All diff comments require first_line, filediff_id, num_lines, and text field to be specified.

general_comments:

Look at Web API documentation for POST on the Review General Comment List resource for available fields. All general comments require text field to be specified.

Example file contents:

{
    "review": {
        "body_top": "Header comment"
    },
    "diff_comments": [
        {
            "filediff_id": 10,
            "first_line": 729,
            "issue_opened": true,
            "num_lines": 1,
            "text": "Adding a comment on a diff line",
            "text_type": "markdown"
        }
    ],
    "general_comments": [
        {
            "text": "Adding a general comment",
            "text_type": "markdown"
        }
    ]
}

Raises:

rbtools.commands.CommandError – Error with the execution of the command.

class rbtools.commands.status_update.DeleteStatusUpdateSubCommand(options: Namespace, config: RBToolsConfig, *args, **kwargs)[source]¶

Bases: BaseStatusUpdateSubCommand

Subcommand for deleting status updates.

New in version 3.0.

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

The name of the command.

Type:

str

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

Command-line options for this command.

Type:

list of Option or OptionGroup

main()[source]¶

Handle deleting status updates on Review Board.

Raises:

rbtools.commands.CommandError – Error with the execution of the command.

class rbtools.commands.status_update.StatusUpdate(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: BaseMultiCommand

Interact with review request status updates on Review Board.

This command allows setting, getting and deleting status updates for review requests.

A status update is a way for a third-party service or extension to mark some kind of status on a review request.

name: ClassVar[str] = 'status-update'[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] = 'Interact with review request status updates on Review Board.'[source]¶

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

Type:

str

subcommands: list[type[BaseSubCommand]] = [<class 'rbtools.commands.status_update.GetStatusUpdateSubCommand'>, <class 'rbtools.commands.status_update.SetStatusUpdateSubCommand'>, <class 'rbtools.commands.status_update.DeleteStatusUpdateSubCommand'>][source]¶

The available subcommands.

This is a list of BaseSubCommand subclasses.

Type:

list

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

Options common to all subcommands.

Type:

list

run_from_argv(argv)[source]¶

Execute the command using the provided arguments.

This will first check if the command is being called in the legacy (pre-RBTools 3) style, with the subcommand name as the last argument. If so, a warning will be logged and the order of arguments will be corrected.

Parameters:

argv (list of unicode) – The list of command line arguments.