eph.config package

Submodules

eph.config.config module

eph.config.config.create_config_file(out_filename)
eph.config.config.get_config_dirs()
eph.config.config.get_config_files(config_file=None)
eph.config.config.get_default_config_file()
eph.config.config.get_parser()
eph.config.config.read_config(config_file=None)

eph.config.exceptions module

Defines configuration related exceptions.

exception eph.config.exceptions.ConfigError

Bases: Exception

Base class for configuration related exceptions.

exception eph.config.exceptions.ConfigNotFoundError(search_list)

Bases: eph.config.exceptions.ConfigError

A ConfigNotFoundError exception is raised when trying to read configurations from files that don’t exist.

format_search_list(delimiter=', ', bullet='')

Module contents

config package contains configuration-related data and modules.

config package contains:

  • config.ini: configuration files containing all project wide default configuration. The file is copied at installation time to ~/.ephrc so that it can be edited by the end user. If the installed file is deleted or not found by eph scripts config.ini configurations are kept.
  • config module: this python module defines functions related to the creation, editing and storing of configurations.