faucet.conf module

Base configuration implementation.

class faucet.conf.Conf(_id, dp_id, conf=None)

Bases: object

Base class for FAUCET configuration.

check_config()

Check config at instantiation time for errors, typically via assert.

conf_diff(other)

Return text diff between two Confs.

conf_hash(subconf=True, ignore_keys=None)

Return hash of keys configurably filtering attributes.

defaults: dict = {}

defaults_types: dict = {}

dyn_finalized = False

dyn_hash = None

finalize()

Configuration parsing marked complete.

ignore_subconf(other, ignore_keys=None)

Return True if this config same as other, ignoring sub config.

merge_dyn(other_conf)

Merge dynamic state from other conf object.

mutable_attrs: frozenset = frozenset({})

set_defaults()

Set default values and run any basic sanity checks.

to_conf()

Return configuration as a dict.

update(conf)

Parse supplied YAML config and sanity check.

exception faucet.conf.InvalidConfigError

Bases: Exception

This error is thrown when the config file is not valid.

faucet.conf.test_config_condition(cond, msg)

Evaluate condition and raise InvalidConfigError if condition True.

Parameters:

• cond (bool) – Condition on which to raise an error if it is true

• msg (str) – Message for the error if the condition is true