lisa.conf.VariadicLevelKeyDesc#

class lisa.conf.VariadicLevelKeyDesc(name, help, child, value_path=None)[source]#

Bases: LevelKeyDesc

Level key descriptor that allows configuration-source-defined sub-level keys.

Parameters:

child (lisa.conf.LevelKeyDesc) – Variadic level. Its name will only be used for documentation purposes, the configuration instances will be able to hold any string.

Variable keyword arguments:

Forwarded to lisa.conf.LevelKeyDesc.

This allows “instantiating” a whole sub-configuration for variable level keys.

Attributes

__reversed__ inherited

See collections.abc.Mapping.__reversed__

help inherited

Help description associated with the key.

name inherited

Name of that key.

parent inherited

Parent LevelKeyDesc.

Properties

key_desc inherited

Leaf KeyDescBase that this level will delegate to in case it is assigned a leaf value.

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

__class_getitem__() inherited

See collections.abc.Iterable.__class_getitem__()

__contains__() inherited

See collections.abc.Mapping.__contains__()

__getattr__() inherited

__getitem__() inherited

__iter__() inherited

__len__() inherited

check_allowed_key() inherited

Checks that a given key is allowed under that levels.

get() inherited

See collections.abc.Mapping.get()

get_help() inherited

Get a help message describing the key.

items() inherited

See collections.abc.Mapping.items()

keys() inherited

See collections.abc.Mapping.keys()

validate_val() inherited

Validate a mapping to be used as a configuration source.

values() inherited

See collections.abc.Mapping.values()

Attributes#

VariadicLevelKeyDesc.__reversed__ = None#
VariadicLevelKeyDesc.help#

Inherited attribute, see lisa.conf.KeyDescBase.help

Help description associated with the key.

VariadicLevelKeyDesc.name#

Inherited attribute, see lisa.conf.KeyDescBase.name

Name of that key.

VariadicLevelKeyDesc.parent#

Inherited attribute, see lisa.conf.KeyDescBase.parent

Parent LevelKeyDesc.

Properties#

property VariadicLevelKeyDesc.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 VariadicLevelKeyDesc.path#

Inherited property, see lisa.conf.KeyDescBase.path

Path in the config file from the root to that key.

property VariadicLevelKeyDesc.qualname#

Inherited property, see lisa.conf.KeyDescBase.qualname

Qualified name of the configuration key used for error reporting.

Methods#

classmethod VariadicLevelKeyDesc.__class_getitem__()#

Inherited method, see collections.abc.Iterable.__class_getitem__()

VariadicLevelKeyDesc.__contains__()#

Inherited method, see collections.abc.Mapping.__contains__()

VariadicLevelKeyDesc.__getattr__(attr)#

Inherited method, see lisa.conf.LevelKeyDesc.__getattr__()

VariadicLevelKeyDesc.__getitem__(key)#

Inherited method, see lisa.conf.LevelKeyDesc.__getitem__()

VariadicLevelKeyDesc.__iter__()#

Inherited method, see lisa.conf.LevelKeyDesc.__iter__()

VariadicLevelKeyDesc.__len__()#

Inherited method, see lisa.conf.LevelKeyDesc.__len__()

VariadicLevelKeyDesc.check_allowed_key(key)#

Inherited method, see lisa.conf.LevelKeyDesc.check_allowed_key()

Checks that a given key is allowed under that levels.

VariadicLevelKeyDesc.get()#

Inherited method, see collections.abc.Mapping.get()

VariadicLevelKeyDesc.get_help(style=None, last=False, children=True)#

Inherited method, see lisa.conf.LevelKeyDesc.get_help()

Get a help message describing the key.

VariadicLevelKeyDesc.items()#

Inherited method, see collections.abc.Mapping.items()

VariadicLevelKeyDesc.keys()#

Inherited method, see collections.abc.Mapping.keys()

VariadicLevelKeyDesc.validate_val(conf)#

Inherited method, see lisa.conf.LevelKeyDesc.validate_val()

Validate a mapping to be used as a configuration source.

VariadicLevelKeyDesc.values()#

Inherited method, see collections.abc.Mapping.values()