rbtools.commands.setup_completion¶

Implementation of rbt setup-completion.

Classes

class rbtools.commands.setup_completion.SetupCompletion(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

Setup auto-completion for rbt.

This outputs a script for the given shell to enable auto-completion of rbt.

Changed in version 5.0: This no longer attempts to write files to a system directory, and instead outputs to the console.

name: ClassVar[str] = 'setup-completion'[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] = 'Output RBTools auto-completion code for bash or zsh.'[source]¶

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

Type:

str

args: ClassVar[str] = '<shell>'[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

main(shell: Optional[str] = None, *args) → None[source]¶

Run the command.

Parameters:

shell (str) – An optional string specifying name of shell for which auto-completions will be installed for.