lisa.conf.DelegatedLevelKeyDesc#
- class lisa.conf.DelegatedLevelKeyDesc(name, help, conf, **kwargs)[source]#
Bases:
LevelKeyDesc
Level key descriptor that imports the keys from another
MultiSrcConfABC
subclass.- Parameters:
conf (MultiSrcConfABC) – Configuration class to extract keys from.
- Variable keyword arguments:
Forwarded to
lisa.conf.LevelKeyDesc
.
This allows embedding a configuration inside another one, mostly to be able to split a configuration class while preserving backward compatibility.
Note
Only the children keys are taken from the passed level, other information such as
value_path
are ignored and must be set explicitly.Attributes
__reversed__
inheritedSee
collections.abc.Mapping.__reversed__
help
inheritedHelp description associated with the key.
name
inheritedName of that key.
parent
inheritedParent
LevelKeyDesc
.Properties
key_desc
inheritedLeaf
KeyDescBase
that this level will delegate to in case it is assigned a leaf value.path
inheritedPath in the config file from the root to that key.
qualname
inheritedQualified name of the configuration key used for error reporting.
Methods
__class_getitem__()
inheritedSee
collections.abc.Iterable.__class_getitem__()
__contains__()
inheritedSee
collections.abc.Mapping.__contains__()
__getattr__()
inherited__getitem__()
inherited__iter__()
inherited__len__()
inheritedcheck_allowed_key()
inheritedChecks that a given key is allowed under that levels.
get()
inheritedSee
collections.abc.Mapping.get()
get_help()
inheritedGet a help message describing the key.
items()
inheritedSee
collections.abc.Mapping.items()
keys()
inheritedSee
collections.abc.Mapping.keys()
validate_val()
inheritedValidate a mapping to be used as a configuration source.
values()
inheritedSee
collections.abc.Mapping.values()
Attributes#
- DelegatedLevelKeyDesc.__reversed__ = None#
- DelegatedLevelKeyDesc.help#
Inherited attribute, see
lisa.conf.KeyDescBase.help
Help description associated with the key.
- DelegatedLevelKeyDesc.name#
Inherited attribute, see
lisa.conf.KeyDescBase.name
Name of that key.
- DelegatedLevelKeyDesc.parent#
Inherited attribute, see
lisa.conf.KeyDescBase.parent
Parent
LevelKeyDesc
.
Properties#
- property DelegatedLevelKeyDesc.key_desc#
Inherited property, see
lisa.conf.LevelKeyDesc.key_desc
Leaf
KeyDescBase
that this level will delegate to in case it is assigned a leaf value.
- property DelegatedLevelKeyDesc.path#
Inherited property, see
lisa.conf.KeyDescBase.path
Path in the config file from the root to that key.
- property DelegatedLevelKeyDesc.qualname#
Inherited property, see
lisa.conf.KeyDescBase.qualname
Qualified name of the configuration key used for error reporting.
Methods#
- classmethod DelegatedLevelKeyDesc.__class_getitem__()#
Inherited method, see
collections.abc.Iterable.__class_getitem__()
- DelegatedLevelKeyDesc.__contains__()#
Inherited method, see
collections.abc.Mapping.__contains__()
- DelegatedLevelKeyDesc.__getattr__(attr)#
Inherited method, see
lisa.conf.LevelKeyDesc.__getattr__()
- DelegatedLevelKeyDesc.__getitem__(key)#
Inherited method, see
lisa.conf.LevelKeyDesc.__getitem__()
- DelegatedLevelKeyDesc.__iter__()#
Inherited method, see
lisa.conf.LevelKeyDesc.__iter__()
- DelegatedLevelKeyDesc.__len__()#
Inherited method, see
lisa.conf.LevelKeyDesc.__len__()
- DelegatedLevelKeyDesc.check_allowed_key(key)#
Inherited method, see
lisa.conf.LevelKeyDesc.check_allowed_key()
Checks that a given key is allowed under that levels.
- DelegatedLevelKeyDesc.get()#
Inherited method, see
collections.abc.Mapping.get()
- DelegatedLevelKeyDesc.get_help(style=None, last=False, children=True)#
Inherited method, see
lisa.conf.LevelKeyDesc.get_help()
Get a help message describing the key.
- DelegatedLevelKeyDesc.items()#
Inherited method, see
collections.abc.Mapping.items()
- DelegatedLevelKeyDesc.keys()#
Inherited method, see
collections.abc.Mapping.keys()
- DelegatedLevelKeyDesc.validate_val(conf)#
Inherited method, see
lisa.conf.LevelKeyDesc.validate_val()
Validate a mapping to be used as a configuration source.
- DelegatedLevelKeyDesc.values()#
Inherited method, see
collections.abc.Mapping.values()