eyconf.config.EYConf

class eyconf.config.EYConf(schema: type[D])

Configuration class.

This class is used to generate a default configuration file from a schema represented by a dataclass.

It allows to generate, validate and load a configuration file.

Attributes

path

Methods

__init__(schema)
default_yaml()	Return the default yaml configuration as string.
get_file()	Get the path to the configuration file.
refresh()	Reload the configuration file.

__init__(schema: type[D])

default_yaml() → str

Return the default yaml configuration as string.

You may overwrite this method to customize the default configuration generation.

static get_file() → Path

Get the path to the configuration file.

refresh()

Reload the configuration file.