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-login 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 6.0: Deprecated the -l option in favour of --debug.

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.

__firstlineno__ = 23¶

__static_attributes__ = ('_global_options', 'api_client', 'api_root', 'server_url')¶

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

The author of the command.

Type:

str

create_parser(*args, **kwargs) → argparse.ArgumentParser[source]¶

Create and return the argument parser for this command.

Added in version 6.0.

Parameters:

• *args (tuple) – Positional arguments to pass to the parent method.

• **kwargs (dict) – Keyword arguments to pass to the parent method.

Returns:

The argument parser.

Return type:

argparse.ArgumentParser

main() → int[source]¶

Run the command.

Returns:

The resulting exit code.

Return type:

int

Raises:

rbtools.command.CommandError – The login failed.

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

The name of the command.

Type:

str

option_list: ClassVar[list[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