Config¶

A Config object stores configuration values. A global topwrap.config.config object is used throughout the codebase to access topwrap’s configuration. This is created by ConfigManager that reads config files defined in topwrap.config.ConfigManager.DEFAULT_SEARCH_PATHS, with files most local to the project taking precedence.

class Config(force_interface_compliance: bool | None = False, repositories: ~typing.List[~topwrap.config.RepositoryEntry] | None = <factory>)¶

Global topwrap configuration

__init__(force_interface_compliance: bool | None = False, repositories: ~typing.List[~topwrap.config.RepositoryEntry] | None = <factory>)¶

Schema¶

alias of Config

class ConfigManager(search_paths: List[PathLike] | None = None)¶

Manager used to load topwrap’s configuration from files.

The configuration files are loaded in a specific order, which also determines the priority of settings that are defined differently in the files. The list of default search paths is defined in the DEFAULT_SEARCH_PATH class variable. Configuration files that are specified earlier in the list have higher priority and can overwrite the settings from the files that follow. The default list of search paths can be changed by passing a different list to the ConfigManager constructor.

__init__(search_paths: List[PathLike] | None = None)¶