rbtools.config.loader¶

Loaders for configuration files.

Module Attributes

Functions

rbtools.config.loader.CONFIG_FILENAME: Final[str] = '.reviewboardrc'¶

The name of the default configuration file.

rbtools.config.loader.get_config_paths() → list[str][source]¶

Return the paths to each .reviewboardrc influencing the cwd.

A list of paths to .reviewboardrc files will be returned, where each subsequent list entry should have lower precedence than the previous. i.e. configuration found in files further up the list will take precedence.

Configuration in the paths set in $RBTOOLS_CONFIG_PATH will take precedence over files found in the current working directory or its parents.

Returns:

The list of configuration paths.

Return type:

list of str

rbtools.config.loader.parse_config_file(filename: str) → RBToolsConfig[source]¶

Parse a .reviewboardrc file.

Returns a dictionary containing the configuration from the file.

Parameters:

filename (str) – The full path to a .reviewboardrc file.

Returns:

The loaded configuration data.

Return type:

dict

Raises:

rbtools.config.errors.ConfigSyntaxError – There was a syntax error in the configuration file.

rbtools.config.loader.load_config() → RBToolsConfig[source]¶

Load configuration from .reviewboardrc files.

This will read all of the .reviewboardrc files influencing the cwd and return a dictionary containing the configuration.

Returns:

The loaded configuration data.

Return type:

dict