rbtools.commands.review¶

Implementation of rbt review.

Classes

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

Bases: ReviewSubCommand

Base class for comment subcommands.

__firstlineno__ = 83¶

__static_attributes__ = ()¶

add_comment(text_type)[source]¶

Create the comment.

Parameters:

text_type (unicode) – The text type to use.

Raises:

rbtools.api.errors.APIError – An error occurred while performing API requests.

main()[source]¶

Run the command.

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

Command-line options for this command.

Type:

list of Option or OptionGroup

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

Bases: AddCommentSubCommand

Subcommand to add a diff comment to a draft review.

__annotations_cache__ = {}¶

__firstlineno__ = 133¶

__static_attributes__ = ()¶

add_comment(text_type)[source]¶

Create the comment.

Parameters:

text_type (unicode) – The text type to use.

Raises:

• rbtools.api.errors.APIError – An error occurred while performing API requests.

• rbtools.commands.CommandError – Another error occurred while creating the comment.

help_text: str = 'Add a comment to a diff as part of a draft review.'[source]¶

The subcommand’s help text.

Type:

str

name: ClassVar[str] = 'add-diff-comment'[source]¶

The name of the command.

Type:

str

option_list: ClassVar[list[Option | OptionGroup]] = [<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

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

Bases: AddCommentSubCommand

Subcommand to add a file attachment comment to a review draft.

__annotations_cache__ = {}¶

__firstlineno__ = 234¶

__static_attributes__ = ()¶

add_comment(text_type)[source]¶

Create the comment.

Parameters:

text_type (unicode) – The text type to use.

Raises:

rbtools.api.errors.APIError – An error occurred while performing API requests.

help_text: str = 'Add a comment to a file attachment as part of a draft review.'[source]¶

The subcommand’s help text.

Type:

str

name: ClassVar[str] = 'add-file-attachment-comment'[source]¶

The name of the command.

Type:

str

option_list: ClassVar[list[Option | OptionGroup]] = [<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

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

Bases: AddCommentSubCommand

Subcommand to add a general comment to a review draft.

__annotations_cache__ = {}¶

__firstlineno__ = 290¶

__static_attributes__ = ()¶

add_comment(text_type)[source]¶

Create the comment.

Parameters:

text_type (unicode) – The text type to use.

Raises:

rbtools.api.errors.APIError – An error occurred while performing API requests.

help_text: str = 'Add a general comment as part of a draft review.'[source]¶

The subcommand’s help text.

Type:

str

name: ClassVar[str] = 'add-general-comment'[source]¶

The name of the command.

Type:

str

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

Bases: ReviewSubCommand

Subcommand to discard a draft review.

__annotations_cache__ = {}¶

__firstlineno__ = 317¶

__static_attributes__ = ()¶

create_review_if_missing = False[source]¶

Whether to create the review if it does not exist.

Type:

bool

help_text: str = 'Discard a draft review.'[source]¶

The subcommand’s help text.

Type:

str

main()[source]¶

Run the review discard command.

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

The name of the command.

Type:

str

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

Bases: ReviewSubCommand

Subcommand to create or edit draft reviews.

__annotations_cache__ = {}¶

__firstlineno__ = 341¶

__static_attributes__ = ()¶

help_text: str = 'Create or edit a draft review.'[source]¶

The subcommand’s help text.

Type:

str

main()[source]¶

Run the review edit command.

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

The name of the command.

Type:

str

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

Command-line options for this command.

Type:

list of Option or OptionGroup

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

Bases: ReviewSubCommand

Subcommand for publishing a review draft.

__annotations_cache__ = {}¶

__firstlineno__ = 413¶

__static_attributes__ = ()¶

create_review_if_missing = False[source]¶

Whether to create the review if it does not exist.

Type:

bool

help_text: str = 'Publish a draft review.'[source]¶

The subcommand’s help text.

Type:

str

main()[source]¶

Run the review publish command.

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

The name of the command.

Type:

str

class rbtools.commands.review.Review(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

RBTools command to create and publish reviews.

__firstlineno__ = 436¶

__static_attributes__ = ()¶

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

The author of the command.

Type:

str

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

Options common to all subcommands.

Type:

list

description: ClassVar[str] = 'Creates, updates, and edits reviews.'[source]¶

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

Type:

str

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

The name of the command.

Type:

str

subcommands: list[type[BaseSubCommand]] = [<class 'rbtools.commands.review.Edit'>, <class 'rbtools.commands.review.Publish'>, <class 'rbtools.commands.review.AddDiffComment'>, <class 'rbtools.commands.review.AddGeneralComment'>, <class 'rbtools.commands.review.AddFileAttachmentComment'>, <class 'rbtools.commands.review.Discard'>][source]¶

The available subcommands.

This is a list of BaseSubCommand subclasses.

Type:

list

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

Bases: BaseSubCommand

A subcommand for review actions.

__annotations_cache__ = {}¶

__firstlineno__ = 24¶

__static_attributes__ = ()¶

create_review_if_missing = True[source]¶

Whether to create the review if it does not exist.

Type:

bool

get_review_draft() → ReviewItemResource[source]¶

Return the review draft, creating if desired.

Returrns:

rbtools.api.resource.ReviewItemResource: The review draft resource.

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.

Added in version 3.0.

Type:

bool