reviewbot.config¶
Configuration loading and validation.
Module Attributes
The default configuration for Review Bot. |
|
Deprecated configuration keys. |
|
The active configuration for Review Bot. |
Functions
Return the configuration file path. |
|
Load the Review Bot configuraiton. |
|
Reset the configuration to defaults. |
- DEFAULT_CONFIG = {'cookie_dir': '/Users/chipx86/Library/Caches/reviewbot', 'exe_paths': {}, 'java_classpaths': {}, 'repositories': [], 'repositories_config_path': None, 'reviewboard_servers': [], 'reviewboard_servers_config_path': None}[source]¶
The default configuration for Review Bot.
config
is generated from this.New in version 3.0.
- deprecated_keys = {'pmd_path', 'review_board_servers'}[source]¶
Deprecated configuration keys.
New in version 3.0.
- config = {'cookie_dir': '/Users/chipx86/Library/Caches/reviewbot', 'exe_paths': {}, 'java_classpaths': {}, 'repositories': [], 'repositories_config_path': None, 'reviewboard_servers': [], 'reviewboard_servers_config_path': None}[source]¶
The active configuration for Review Bot.
- get_config_file_path()[source]¶
Return the configuration file path.
New in version 3.0.
- Returns:
The configuration file path.
- Return type:
str
- load_config()[source]¶
Load the Review Bot configuraiton.
This will load the configuration file
reviewbot/config.py
, located in the system’s main configuration directory (/etc/
on Linux).If the
REVIEWBOT_CONFIG_FILE
environment variable is provided, configuration from that file will be loaded instead.If anything goes wrong when loading the configuration, the defaults will be used.
New in version 3.0: This was previously called
init
. As it’s internal API, hopefully nobody was calling that.