lisa.conf.DerivedKeyDesc#

class lisa.conf.DerivedKeyDesc(name, help, classinfo, base_key_paths, compute, newtype=None)[source]#

Bases: KeyDesc

Key descriptor describing a key derived from other keys

Derived keys cannot be added from a source, since they are purely computed out of other keys. It is also not possible to change their source priorities. To achieve that, set the source priorities on the keys it is based on.

Parameters:

base_key_paths (list(list(str))) – List of paths to the keys this key is derived from. The paths in the form of a list of string are relative to the current level. To reference a level above the current one, use the special key ...
compute (collections.abc.Callable) – Function used to compute the value of the key. It takes a dictionary of base keys specified in base_key_paths as only parameter and is expected to return the key’s value.

Attributes

`name` ^inherited	Name of that key.
`parent` ^inherited	Parent `LevelKeyDesc`.

Properties

`help`	Help description associated with the key.
`newtype` ^inherited	Unique type associated with that key.
`path` ^inherited	Path in the config file from the root to that key.
`qualname` ^inherited	Qualified name of the configuration key used for error reporting.

Methods

`can_be_computed()`
`compute_val()`
`get_non_evaluated_base_keys()`	Get the `KeyDescBase` of base keys that have a `DeferredValue` value.
`get_src()`
`make_get_key()`
`get_help()` ^inherited	Get a help message describing the key.
`pretty_format()` ^inherited	Format the value for pretty printing.
`validate_val()` ^inherited	Check that the value is an instance of one of the type specified in the `self.classinfo`.