rbtools.commands.api_get¶

Implementation of rbt api-get.

Classes

class rbtools.commands.api_get.APIGet(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

name: ClassVar[str] = 'api-get'[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] = 'Retrieve raw API resource payloads.'[source]¶

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

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

args: ClassVar[str] = '<path> [--<query-arg>=<value> ...]'[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.Option object>, <rbtools.commands.base.options.OptionGroup object>][source]¶

Command-line options for this command.

Type:

list of Option or OptionGroup

main(path, *args)[source]¶

Run 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