rbtools.commands.close¶

Implementation of rbt close.

Classes

class rbtools.commands.close.Close(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

Close a specific review request as discarded or submitted.

By default, the command will change the status to submitted. The user can provide an optional description for this action.

name: str = 'close'[source]¶

The name of the command.

Type:

str

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

The author of the command.

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

str

option_list: List[Union[Option, OptionGroup]] = [<rbtools.commands.base.options.Option object>, <rbtools.commands.base.options.Option 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

check_valid_type(close_type)[source]¶

Check if the user specified a proper type.

Type must either be ‘discarded’ or ‘submitted’. If the type is wrong, the command will stop and alert the user.

main(review_request_id)[source]¶

Run the command.