lisa.conf.SimpleMultiSrcConf#

class lisa.conf.SimpleMultiSrcConf(conf=None, src='user', add_default_src=True)[source]#

Bases: MultiSrcConf

Like MultiSrcConf, with a simpler config file.

conf and source are not available, and the behaviour is as all keys were located under a conf key. We do not allow overriding source for this kind of configuration to keep the YAML interface simple and dict-like

Warning

Arbitrary code can be executed while loading an instance from a YAML or Pickle file. To include untrusted data in YAML, use the !untrusted tag along with a string

Attributes

`ATTRIBUTES_SERIALIZATION` ^inherited	Attributes to be treated specially during serialization.
`DEFAULT_SERIALIZATION_FMT` ^inherited	Default format used when serializing objects.
`DEFAULT_SRC` ^inherited	Source added automatically using `add_src()` under the name ‘default’ when instances are built.
`YAML_ENCODING` ^inherited	Encoding used for YAML files.
`__reversed__` ^inherited	See `collections.abc.Mapping.__reversed__`

Properties

`STRUCTURE` ^inherited	Class attribute defining the structure of the configuration file, as a instance of `TopLevelKeyDescBase`.
`as_yaml_map` ^inherited	Give a mapping suitable for storing in a YAML configuration file.
`logger` ^inherited	Convenience short-hand for `self.get_logger()`.

Methods

`from_map()`	Create a new configuration instance, using the output of `to_map()`.
`to_map()`	Export the configuration as a mapping.
`to_yaml_map()`	Write a configuration file, with the key descriptions in comments.
`__class_getitem__()` ^inherited	See `collections.abc.Iterable.__class_getitem__()`
`__contains__()` ^inherited	See `collections.abc.Mapping.__contains__()`
`__copy__()` ^inherited	Shallow copy of the nested configuration tree, without duplicating the leaf values.
`__deepcopy__()` ^inherited
`__getitem__()` ^inherited
`__getstate__()` ^inherited	Filter instances of `DeferredValue` that are not computed already since their runtime parameters will probably not be available after deserialization.
`__iter__()` ^inherited
`__len__()` ^inherited
`__setstate__()` ^inherited
`add_src()` ^inherited	Add a source of configuration.
`eval_deferred()` ^inherited	Evaluate instances of `DeferredValue` that can be used for values that are expensive to compute.
`force_src()` ^inherited	Force the source priority list for a given key.
`force_src_nested()` ^inherited	Force the source priority list for all the keys defined in the nested mapping `key_src_map`.
`from_path()` ^inherited	Deserialize an object from a file.
`from_yaml_map()` ^inherited	Allow reloading from a plain mapping, to avoid having to specify a tag in the configuration file. The content is hosted under the top-level key specified in `STRUCTURE`.
`from_yaml_map_list()` ^inherited	Create a mapping of configuration classes to instance, by loading them from the list of paths using `from_yaml_map()` and merging them.
`get()` ^inherited	See `collections.abc.Mapping.get()`
`get_help()` ^inherited
`get_key()` ^inherited	Get the value of the given key. It returns a deepcopy of the value.
`get_logger()` ^inherited	Provides a `logging.Logger` named after `cls`.
`get_nested_key()` ^inherited	Same as `get_key()` but works on a list of keys to access nested mappings.
`get_src_map()` ^inherited	Get a mapping of all sources for the given `key`, in priority order (first item is the highest priority source).
`items()` ^inherited	Override the default definition of `collections.abc.Mapping.items()` to allow not evaluating deferred values if necessary.
`keys()` ^inherited	See `collections.abc.Mapping.keys()`
`log_locals()` ^inherited	Debugging aid: log the local variables of the calling function.
`pretty_format()` ^inherited	Give a pretty string representation of the configuration.
`resolve_src()` ^inherited	Get the source name that will be used to serve the value of `key`.
`set_default_src()` ^inherited	Set the default source priority list.
`to_path()` ^inherited	Serialize the object to a file.
`to_yaml()` ^inherited	Return a YAML string with the serialized object.
`to_yaml_map_str()` ^inherited	Return the content of the file that would be create by `to_yaml_map()` in a string.
`values()` ^inherited	See `collections.abc.Mapping.values()`

Attributes#

SimpleMultiSrcConf.ATTRIBUTES_SERIALIZATION = {'allowed': [], 'ignored': [], 'placeholders': {}}#

Inherited attribute, see lisa.utils.Serializable.ATTRIBUTES_SERIALIZATION

Attributes to be treated specially during serialization.

SimpleMultiSrcConf.DEFAULT_SERIALIZATION_FMT = 'yaml'#

Inherited attribute, see lisa.utils.Serializable.DEFAULT_SERIALIZATION_FMT

Default format used when serializing objects.

SimpleMultiSrcConf.DEFAULT_SRC = {}#

Inherited attribute, see lisa.conf.MultiSrcConf.DEFAULT_SRC

Source added automatically using add_src() under the name ‘default’ when instances are built.

SimpleMultiSrcConf.YAML_ENCODING = 'utf-8'#

Inherited attribute, see lisa.utils.Serializable.YAML_ENCODING

Encoding used for YAML files.

SimpleMultiSrcConf.__reversed__ = None#

Properties#

abstract property SimpleMultiSrcConf.STRUCTURE#

Inherited property, see lisa.conf.MultiSrcConf.STRUCTURE

Class attribute defining the structure of the configuration file, as a instance of TopLevelKeyDescBase.

property SimpleMultiSrcConf.as_yaml_map#

Inherited property, see lisa.conf.MultiSrcConfABC.as_yaml_map

Give a mapping suitable for storing in a YAML configuration file.

property SimpleMultiSrcConf.logger#

Inherited property, see lisa.utils.Loggable.logger

Convenience short-hand for self.get_logger().

Methods#

classmethod SimpleMultiSrcConf.from_map(*args, **kwargs)[source]#: Create a new configuration instance, using the output of to_map()

SimpleMultiSrcConf.to_map()[source]#

Export the configuration as a mapping.

The return value should preserve key-specific priority override list, which is not done if directly passing that instance to dict().

SimpleMultiSrcConf.to_yaml_map(path, add_placeholder=False, placeholder='<no default>')[source]#

Write a configuration file, with the key descriptions in comments.

Parameters:

path (str) – Path to the file to write to.
add_placeholder (bool) – If True, a placeholder value will be used for keys that don’t have values. This allows creating template configuration files that list all keys.
placeholder (object) – Placeholder to use for missing values when add_placeholder is used.

classmethod SimpleMultiSrcConf.__class_getitem__()#: Inherited method, see collections.abc.Iterable.__class_getitem__()

SimpleMultiSrcConf.__contains__()#: Inherited method, see collections.abc.Mapping.__contains__()

SimpleMultiSrcConf.__copy__()#

Inherited method, see lisa.conf.MultiSrcConf.__copy__()

Shallow copy of the nested configuration tree, without duplicating the leaf values.

SimpleMultiSrcConf.__deepcopy__(memo)#: Inherited method, see lisa.conf.MultiSrcConf.__deepcopy__()

SimpleMultiSrcConf.__getitem__(key)#: Inherited method, see lisa.conf.MultiSrcConf.__getitem__()

SimpleMultiSrcConf.__getstate__()#

Inherited method, see lisa.conf.MultiSrcConf.__getstate__()

Filter instances of DeferredValue that are not computed already since their runtime parameters will probably not be available after deserialization.

SimpleMultiSrcConf.__iter__()#: Inherited method, see lisa.conf.MultiSrcConf.__iter__()

SimpleMultiSrcConf.__len__()#: Inherited method, see lisa.conf.MultiSrcConf.__len__()

SimpleMultiSrcConf.__setstate__(dct)#: Inherited method, see lisa.utils.Serializable.__setstate__()

SimpleMultiSrcConf.add_src(src, conf, filter_none=False, fallback=False, inplace=True)#

Inherited method, see lisa.conf.MultiSrcConf.add_src()

Add a source of configuration.

SimpleMultiSrcConf.eval_deferred(cls=<class 'lisa.conf.DeferredValue'>, src=None, resolve_src=True, error='raise')#

Inherited method, see lisa.conf.MultiSrcConf.eval_deferred()

Evaluate instances of DeferredValue that can be used for values that are expensive to compute.

SimpleMultiSrcConf.force_src(key, src_prio)#

Inherited method, see lisa.conf.MultiSrcConf.force_src()

Force the source priority list for a given key.

SimpleMultiSrcConf.force_src_nested(key_src_map)#

Inherited method, see lisa.conf.MultiSrcConf.force_src_nested()

Force the source priority list for all the keys defined in the nested mapping key_src_map.

classmethod SimpleMultiSrcConf.from_path(filepath, fmt=None)#

Inherited method, see lisa.utils.Serializable.from_path()

Deserialize an object from a file.

classmethod SimpleMultiSrcConf.from_yaml_map(path, add_default_src=True)#

Inherited method, see lisa.conf.MultiSrcConfABC.from_yaml_map()

Allow reloading from a plain mapping, to avoid having to specify a tag in the configuration file. The content is hosted under the top-level key specified in STRUCTURE.

classmethod SimpleMultiSrcConf.from_yaml_map_list(path_list, add_default_src=True)#

Inherited method, see lisa.conf.MultiSrcConfABC.from_yaml_map_list()

Create a mapping of configuration classes to instance, by loading them from the list of paths using from_yaml_map() and merging them.

SimpleMultiSrcConf.get()#: Inherited method, see collections.abc.Mapping.get()

classmethod SimpleMultiSrcConf.get_help(*args, **kwargs)#: Inherited method, see lisa.conf.MultiSrcConf.get_help()

SimpleMultiSrcConf.get_key(key, src=None, eval_deferred=True, quiet=False)#

Inherited method, see lisa.conf.MultiSrcConf.get_key()

Get the value of the given key. It returns a deepcopy of the value.

classmethod SimpleMultiSrcConf.get_logger(suffix=None)#

Inherited method, see lisa.utils.Loggable.get_logger()

Provides a logging.Logger named after cls.

SimpleMultiSrcConf.get_nested_key(key, *args, **kwargs)#

Inherited method, see lisa.conf.MultiSrcConf.get_nested_key()

Same as get_key() but works on a list of keys to access nested mappings.

SimpleMultiSrcConf.get_src_map(key)#

Inherited method, see lisa.conf.MultiSrcConf.get_src_map()

Get a mapping of all sources for the given key, in priority order (first item is the highest priority source).

SimpleMultiSrcConf.items(eval_deferred=True)#

Inherited method, see lisa.conf.MultiSrcConf.items()

Override the default definition of collections.abc.Mapping.items() to allow not evaluating deferred values if necessary.

SimpleMultiSrcConf.keys()#: Inherited method, see collections.abc.Mapping.keys()

classmethod SimpleMultiSrcConf.log_locals(var_names=None, level='debug')#

Inherited method, see lisa.utils.Loggable.log_locals()

Debugging aid: log the local variables of the calling function.

SimpleMultiSrcConf.pretty_format(eval_deferred=False)#

Inherited method, see lisa.conf.MultiSrcConf.pretty_format()

Give a pretty string representation of the configuration.

SimpleMultiSrcConf.resolve_src(key)#

Inherited method, see lisa.conf.MultiSrcConf.resolve_src()

Get the source name that will be used to serve the value of key.

SimpleMultiSrcConf.set_default_src(src_prio)#

Inherited method, see lisa.conf.MultiSrcConf.set_default_src()

Set the default source priority list.

SimpleMultiSrcConf.to_path(filepath, fmt=None)#

Inherited method, see lisa.utils.Serializable.to_path()

Serialize the object to a file.

SimpleMultiSrcConf.to_yaml()#

Inherited method, see lisa.utils.Serializable.to_yaml()

Return a YAML string with the serialized object.

SimpleMultiSrcConf.to_yaml_map_str(**kwargs)#

Inherited method, see lisa.conf.MultiSrcConfABC.to_yaml_map_str()

Return the content of the file that would be create by to_yaml_map() in a string.

SimpleMultiSrcConf.values()#: Inherited method, see collections.abc.Mapping.values()

lisa.conf.SimpleMultiSrcConf#

Attributes#

Properties#

Methods#

This Page