mycroft.configuration.config.Configuration Class Reference

Static Public Member Functions
def	get (configs=None, cache=True)
def	init (ws)
def	load_config_stack (configs=None, cache=False)
def	patch (message)
def	updated (message)

Static Private Attributes
dictionary	__config = {}
dictionary	__patch = {}

Detailed Description

Definition at line 178 of file config.py.

Member Function Documentation

def mycroft.configuration.config.Configuration.get (   configs = None,   cache = True  )

static

    Get configuration, returns cached instance if available otherwise
    builds a new configuration dict.

    Args:
configs (list): List of configuration dicts
cache (boolean): True if the result should be cached

Definition at line 183 of file config.py.

def mycroft.configuration.config.Configuration.init (   ws )

static

    Setup websocket handlers to update config.

    Args:
ws:     Websocket instance

Definition at line 233 of file config.py.

def mycroft.configuration.config.Configuration.load_config_stack (   configs = None,   cache = False  )

static

    load a stack of config dicts into a single dict

    Args:
configs (list): list of dicts to load
cache (boolean): True if result should be cached

    Returns: merged dict of all configuration files

Definition at line 198 of file config.py.

def mycroft.configuration.config.Configuration.patch (   message )

static

    patch the volatile dict usable by skills

    Args:
message: Messagebus message should contain a config
         in the data payload.

Definition at line 252 of file config.py.

def mycroft.configuration.config.Configuration.updated (   message )

static

    handler for configuration.updated, triggers an update
    of cached config.

Definition at line 244 of file config.py.

Member Data Documentation

dictionary mycroft.configuration.config.Configuration.__config = {}

staticprivate

Definition at line 179 of file config.py.

dictionary mycroft.configuration.config.Configuration.__patch = {}

staticprivate

Definition at line 180 of file config.py.

---

The documentation for this class was generated from the following file:

• config.py