rbtools.commands.login¶

Implementation of rbt login.

Classes

class rbtools.commands.login.Login(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

Logs into a Review Board server.

The user will either be directed to log in via the Review Board web page, or prompted for a username and password. This depends on whether the --web option is enabled.

Optionally, the user can pass an API token or username and password on the command line.

A session cookie will be saved upon successful authentication.

If the user is already logged in, this won’t do anything.

Changed in version 5.0: Added the --web option for web-based login, along with the --open and --enable-logging options that are specific to web-based login.

name: str = 'login'[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

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

Run the command.