config

This class describes the config for the CLI

CLIConfig

Stores all the configuration items

get(self, key, ensure_exists=False, help_msg='')

Gets a key from config

Prints help_msg if ensure_exists is True and key not found

Parameters:

Name	Type	Description	Default
key	str	the config setting you are looking for	required
ensure_exists	bool	should this die if key doesn't exist?	False
help_msg	str	how to fix this issue	''

Returns:

Type	Description
str	the value for the key

Source code in aicrowd/contexts/config.py

def get(self, key: str, ensure_exists: bool = False, help_msg: str = "") -> str:
    """
    Gets a key from config

    Prints help_msg if ensure_exists is True and key not found

    Args:
        key: the config setting you are looking for
        ensure_exists: should this die if key doesn't exist?
        help_msg: how to fix this issue

    Returns:
        the value for the key
    """
    if self.__settings is None:
        self.load(self.config_path)

    value = self.__settings.get(key)

    if value is None and ensure_exists:
        self.log.warning("Queried config for %s but not found", key)
        raise CLIException(
            f"Config property {key} not set", help_msg, CONFIG_NOT_SET
        )

    return value

load(self, config_path)

Loads the config file

Parameters:

Name	Type	Description	Default
config_path	str	path to config file	required

Source code in aicrowd/contexts/config.py

def load(self, config_path: str):
    """
    Loads the config file

    Args:
        config_path: path to config file
    """
    if config_path is None:
        self.config_path = os.path.join(
            click.get_app_dir("aicrowd-cli"), "config.toml"
        )
        Path(self.config_path).parent.mkdir(parents=True, exist_ok=True)
        Path(self.config_path).touch()
    elif os.path.isfile(config_path):
        self.config_path = config_path
    else:
        self.log.error("Specified config file, '%s' doesn't exist", config_path)
        raise CLIException(
            f"Config file '{config_path}' doesn't exist", exit_code=INVALID_FILE
        )

    self.log.info("Loading config from %s", self.config_path)

    try:
        with open(self.config_path, "r") as config:
            self.__settings = toml.load(config)
            self.log.info("Config loaded")
    except toml.TomlDecodeError:
        self.log.error(
            "Malformed config file: %s. Will be overwritten", self.config_path
        )
        self.__settings = {}

set(self, key, value)

Sets a key to value in config

Parameters:

Name	Type	Description	Default
key	str	config key	required
value	str	config value	required

Source code in aicrowd/contexts/config.py

def set(self, key: str, value: str):
    """
    Sets a key to value in config

    Args:
        key: config key
        value: config value
    """
    if self.__settings is None:
        self.load(self.config_path)

    self.__settings[key] = value

write(self)

Save config to file

Source code in aicrowd/contexts/config.py

def write(self):
    """
    Save config to file
    """
    # make sure parent dir exists
    basedir = Path(self.config_path).parent.absolute()
    Path(basedir).mkdir(parents=True, exist_ok=True)

    with open(self.config_path, "w+") as config_file:
        toml.dump(self.__settings, config_file)
        self.log.info(
            "Successfully saved config to %s\n---\n%s\n---",
            self.config_path,
            self.__settings,
        )