rbtools.commands.diff¶

Implementation of rbt diff.

Classes

Diff(transport_cls, stdout, stderr, stdin)

Prints a diff to the terminal.

class rbtools.commands.diff.Diff(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

Prints a diff to the terminal.

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

The name of the command.

Type:: str

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

The author of the command.

Type:: str

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

needs_diffs: ClassVar[bool] = True[source]¶

Whether the command needs to generate diffs.

If this is set, the initialization of the command will check for the presence of a diff tool compatible with the chosen type of repository.

This depends on needs_repository and needs_scm_client both being set to True.

New in version 4.0.

Type:: bool

needs_repository: ClassVar[bool] = True[source]¶

Whether the command needs the remote repository object.

If this is set, the initialization of the command will set repository.

Setting this will imply setting both needs_api and needs_scm_client to True.

New in version 3.0.

Type:: bool

needs_scm_client: ClassVar[bool] = True[source]¶

Whether the command needs the SCM client.

If this is set, the initialization of the command will set repository_info and tool.

New in version 3.0.

Type:: bool

args: ClassVar[str] = '[revisions]'[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: ClassVar[list[Union[Option, OptionGroup]]] = [<rbtools.commands.base.options.OptionGroup 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>, <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

main(*args)[source]¶: Print the diff to terminal.