ConfigFileFinder

class ConfigFileFinder(program_name: str)[source]

Bases: object

Encapsulate the logic for finding and reading config files.

Adapted from:

Initialize object to find config files.

Parameters

program_name (str) – Name of the current program (e.g., catalyst).

Inherited-members

Return type

None

Methods

generate_possible_local_files()

Find and generate all local config files.

local_config_files()

Find all local config files which actually exist.

local_configs()

Parse all local config files into one config object.

user_config()

Parse the user config file into a config object.

generate_possible_local_files()[source]

Find and generate all local config files.

Yields

str – Path to config file.

local_config_files() List[str][source]

Find all local config files which actually exist.

Returns

List of files that exist that are local project config files with extra config files appended to that list (which also exist).

Return type

List[str]

local_configs()[source]

Parse all local config files into one config object.

user_config()[source]

Parse the user config file into a config object.