lisa.conf.TopLevelKeyDesc#

class lisa.conf.TopLevelKeyDesc(name, *args, **kwargs)[source]#

Bases: TopLevelKeyDescBase

Regular top-level key descriptor, with only one level.

Parameters:

name (str) – Name of the top-level key, as a string.

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#

TopLevelKeyDesc.__reversed__ = None#
TopLevelKeyDesc.help#

Inherited attribute, see lisa.conf.KeyDescBase.help

Help description associated with the key.

TopLevelKeyDesc.name#

Inherited attribute, see lisa.conf.KeyDescBase.name

Name of that key.

TopLevelKeyDesc.parent#

Inherited attribute, see lisa.conf.KeyDescBase.parent

Parent LevelKeyDesc.

Properties#

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

Inherited property, see lisa.conf.KeyDescBase.path

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

property TopLevelKeyDesc.qualname#

Inherited property, see lisa.conf.KeyDescBase.qualname

Qualified name of the configuration key used for error reporting.

Methods#

classmethod TopLevelKeyDesc.__class_getitem__()#

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

TopLevelKeyDesc.__contains__()#

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

TopLevelKeyDesc.__getattr__(attr)#

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

TopLevelKeyDesc.__getitem__(key)#

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

TopLevelKeyDesc.__iter__()#

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

TopLevelKeyDesc.__len__()#

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

TopLevelKeyDesc.check_allowed_key(key)#

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

Checks that a given key is allowed under that levels.

TopLevelKeyDesc.get()#

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

TopLevelKeyDesc.get_help(style=None, **kwargs)#

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

Get a help message describing the key.

TopLevelKeyDesc.items()#

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

TopLevelKeyDesc.keys()#

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

TopLevelKeyDesc.validate_val(conf)#

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

Validate a mapping to be used as a configuration source.

TopLevelKeyDesc.values()#

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