.. title:: AEPConf lisa.energy_meter.AEPConf ========================= .. autoclass:: lisa.energy_meter::AEPConf :no-members: :no-inherited-members: :no-undoc-members: :no-private-members: :no-special-members: .. rubric:: Attributes .. list-table:: :align: left * - :attr:`~lisa.energy_meter.AEPConf.DEFAULT_SRC` - .. withrefctx:: :module: lisa.conf :class: lisa.conf.MultiSrcConf Source added automatically using :meth:`~lisa.conf.MultiSrcConf.add_src` under the name 'default' when instances are built. * - :attr:`~lisa.energy_meter.AEPConf.STRUCTURE` - .. withrefctx:: :module: lisa.energy_meter :class: lisa.energy_meter.AEPConf Regular top-level key descriptor, with only one level. * - :attr:`~lisa.utils.Serializable.ATTRIBUTES_SERIALIZATION` :sup:`inherited` - .. withrefctx:: :module: lisa.utils :class: lisa.utils.Serializable Attributes to be treated specially during serialization. * - :attr:`~lisa.utils.Serializable.DEFAULT_SERIALIZATION_FMT` :sup:`inherited` - .. withrefctx:: :module: lisa.utils :class: lisa.utils.Serializable Default format used when serializing objects. * - :attr:`~lisa.utils.Serializable.YAML_ENCODING` :sup:`inherited` - .. withrefctx:: :module: lisa.utils :class: lisa.utils.Serializable Encoding used for YAML files. * - :attr:`~collections.abc.Mapping.__reversed__` :sup:`inherited` - See :attr:`collections.abc.Mapping.__reversed__` .. rubric:: Properties .. list-table:: :align: left * - :attr:`~lisa.conf.MultiSrcConfABC.as_yaml_map` :sup:`inherited` - .. withrefctx:: :module: lisa.conf :class: lisa.conf.MultiSrcConfABC Give a mapping suitable for storing in a YAML configuration file. * - :attr:`~lisa.utils.Loggable.logger` :sup:`inherited` - .. withrefctx:: :module: lisa.utils :class: lisa.utils.Loggable Convenience short-hand for ``self.get_logger()``. .. rubric:: Methods .. list-table:: :align: left * - :func:`~collections.abc.Iterable.__class_getitem__` :sup:`inherited` - See :func:`collections.abc.Iterable.__class_getitem__` * - :meth:`~collections.abc.Mapping.__contains__` :sup:`inherited` - See :meth:`collections.abc.Mapping.__contains__` * - :meth:`~lisa.conf.MultiSrcConf.__copy__` :sup:`inherited` - .. withrefctx:: :module: lisa.conf :class: lisa.conf.MultiSrcConf Shallow copy of the nested configuration tree, without duplicating the leaf values. * - :meth:`~lisa.conf.MultiSrcConf.__deepcopy__` :sup:`inherited` - .. withrefctx:: :module: lisa.conf :class: lisa.conf.MultiSrcConf * - :meth:`~lisa.conf.MultiSrcConf.__getitem__` :sup:`inherited` - .. withrefctx:: :module: lisa.conf :class: lisa.conf.MultiSrcConf * - :meth:`~lisa.conf.MultiSrcConf.__getstate__` :sup:`inherited` - .. withrefctx:: :module: lisa.conf :class: lisa.conf.MultiSrcConf Filter instances of :class:`DeferredValue` that are not computed already since their runtime parameters will probably not be available after deserialization. * - :meth:`~lisa.conf.MultiSrcConf.__iter__` :sup:`inherited` - .. withrefctx:: :module: lisa.conf :class: lisa.conf.MultiSrcConf * - :meth:`~lisa.conf.MultiSrcConf.__len__` :sup:`inherited` - .. withrefctx:: :module: lisa.conf :class: lisa.conf.MultiSrcConf * - :meth:`~lisa.utils.Serializable.__setstate__` :sup:`inherited` - .. withrefctx:: :module: lisa.utils :class: lisa.utils.Serializable * - :meth:`~lisa.conf.MultiSrcConf.add_src` :sup:`inherited` - .. withrefctx:: :module: lisa.conf :class: lisa.conf.MultiSrcConf Add a source of configuration. * - :meth:`~lisa.conf.MultiSrcConf.eval_deferred` :sup:`inherited` - .. withrefctx:: :module: lisa.conf :class: lisa.conf.MultiSrcConf Evaluate instances of :class:`DeferredValue` that can be used for values that are expensive to compute. * - :meth:`~lisa.conf.MultiSrcConf.force_src` :sup:`inherited` - .. withrefctx:: :module: lisa.conf :class: lisa.conf.MultiSrcConf Force the source priority list for a given key. * - :meth:`~lisa.conf.MultiSrcConf.force_src_nested` :sup:`inherited` - .. withrefctx:: :module: lisa.conf :class: lisa.conf.MultiSrcConf Force the source priority list for all the keys defined in the nested mapping ``key_src_map``. * - :meth:`~lisa.conf.SimpleMultiSrcConf.from_map` :sup:`inherited` - .. withrefctx:: :module: lisa.conf :class: lisa.conf.SimpleMultiSrcConf Create a new configuration instance, using the output of :meth:`to_map`. * - :meth:`~lisa.utils.Serializable.from_path` :sup:`inherited` - .. withrefctx:: :module: lisa.utils :class: lisa.utils.Serializable Deserialize an object from a file. * - :meth:`~lisa.conf.MultiSrcConfABC.from_yaml_map` :sup:`inherited` - .. withrefctx:: :module: lisa.conf :class: lisa.conf.MultiSrcConfABC 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``. * - :meth:`~lisa.conf.MultiSrcConfABC.from_yaml_map_list` :sup:`inherited` - .. withrefctx:: :module: lisa.conf :class: lisa.conf.MultiSrcConfABC Create a mapping of configuration classes to instance, by loading them from the list of paths using :meth:`from_yaml_map` and merging them. * - :meth:`~collections.abc.Mapping.get` :sup:`inherited` - See :meth:`collections.abc.Mapping.get` * - :meth:`~lisa.conf.MultiSrcConf.get_help` :sup:`inherited` - .. withrefctx:: :module: lisa.conf :class: lisa.conf.MultiSrcConf * - :meth:`~lisa.conf.MultiSrcConf.get_key` :sup:`inherited` - .. withrefctx:: :module: lisa.conf :class: lisa.conf.MultiSrcConf Get the value of the given key. It returns a deepcopy of the value. * - :meth:`~lisa.utils.Loggable.get_logger` :sup:`inherited` - .. withrefctx:: :module: lisa.utils :class: lisa.utils.Loggable Provides a :class:`logging.Logger` named after ``cls``. * - :meth:`~lisa.conf.MultiSrcConf.get_nested_key` :sup:`inherited` - .. withrefctx:: :module: lisa.conf :class: lisa.conf.MultiSrcConf Same as :meth:`get_key` but works on a list of keys to access nested mappings. * - :meth:`~lisa.conf.MultiSrcConf.get_src_map` :sup:`inherited` - .. withrefctx:: :module: lisa.conf :class: lisa.conf.MultiSrcConf Get a mapping of all sources for the given ``key``, in priority order (first item is the highest priority source). * - :meth:`~lisa.conf.MultiSrcConf.items` :sup:`inherited` - .. withrefctx:: :module: lisa.conf :class: lisa.conf.MultiSrcConf Override the default definition of ``collections.abc.Mapping.items()`` to allow not evaluating deferred values if necessary. * - :meth:`~collections.abc.Mapping.keys` :sup:`inherited` - See :meth:`collections.abc.Mapping.keys` * - :meth:`~lisa.utils.Loggable.log_locals` :sup:`inherited` - .. withrefctx:: :module: lisa.utils :class: lisa.utils.Loggable Debugging aid: log the local variables of the calling function. * - :meth:`~lisa.conf.MultiSrcConf.pretty_format` :sup:`inherited` - .. withrefctx:: :module: lisa.conf :class: lisa.conf.MultiSrcConf Give a pretty string representation of the configuration. * - :meth:`~lisa.conf.MultiSrcConf.resolve_src` :sup:`inherited` - .. withrefctx:: :module: lisa.conf :class: lisa.conf.MultiSrcConf Get the source name that will be used to serve the value of ``key``. * - :meth:`~lisa.conf.MultiSrcConf.set_default_src` :sup:`inherited` - .. withrefctx:: :module: lisa.conf :class: lisa.conf.MultiSrcConf Set the default source priority list. * - :meth:`~lisa.conf.SimpleMultiSrcConf.to_map` :sup:`inherited` - .. withrefctx:: :module: lisa.conf :class: lisa.conf.SimpleMultiSrcConf Export the configuration as a mapping. * - :meth:`~lisa.utils.Serializable.to_path` :sup:`inherited` - .. withrefctx:: :module: lisa.utils :class: lisa.utils.Serializable Serialize the object to a file. * - :meth:`~lisa.utils.Serializable.to_yaml` :sup:`inherited` - .. withrefctx:: :module: lisa.utils :class: lisa.utils.Serializable Return a YAML string with the serialized object. * - :meth:`~lisa.conf.SimpleMultiSrcConf.to_yaml_map` :sup:`inherited` - .. withrefctx:: :module: lisa.conf :class: lisa.conf.SimpleMultiSrcConf Write a configuration file, with the key descriptions in comments. * - :meth:`~lisa.conf.MultiSrcConfABC.to_yaml_map_str` :sup:`inherited` - .. withrefctx:: :module: lisa.conf :class: lisa.conf.MultiSrcConfABC Return the content of the file that would be create by :meth:`to_yaml_map` in a string. * - :meth:`~collections.abc.Mapping.values` :sup:`inherited` - See :meth:`collections.abc.Mapping.values` Attributes ---------- .. autoattribute:: lisa.energy_meter::AEPConf.DEFAULT_SRC .. autoattribute:: lisa.energy_meter::AEPConf.STRUCTURE .. autoattribute:: lisa.energy_meter::AEPConf.ATTRIBUTES_SERIALIZATION .. autoattribute:: lisa.energy_meter::AEPConf.DEFAULT_SERIALIZATION_FMT .. autoattribute:: lisa.energy_meter::AEPConf.YAML_ENCODING .. autoattribute:: lisa.energy_meter::AEPConf.__reversed__ Properties ---------- .. autoproperty:: lisa.energy_meter::AEPConf.as_yaml_map .. autoproperty:: lisa.energy_meter::AEPConf.logger Methods ------- .. automethod:: lisa.energy_meter::AEPConf.__class_getitem__ .. automethod:: lisa.energy_meter::AEPConf.__contains__ .. automethod:: lisa.energy_meter::AEPConf.__copy__ .. automethod:: lisa.energy_meter::AEPConf.__deepcopy__ .. automethod:: lisa.energy_meter::AEPConf.__getitem__ .. automethod:: lisa.energy_meter::AEPConf.__getstate__ .. automethod:: lisa.energy_meter::AEPConf.__iter__ .. automethod:: lisa.energy_meter::AEPConf.__len__ .. automethod:: lisa.energy_meter::AEPConf.__setstate__ .. automethod:: lisa.energy_meter::AEPConf.add_src .. automethod:: lisa.energy_meter::AEPConf.eval_deferred .. automethod:: lisa.energy_meter::AEPConf.force_src .. automethod:: lisa.energy_meter::AEPConf.force_src_nested .. automethod:: lisa.energy_meter::AEPConf.from_map .. automethod:: lisa.energy_meter::AEPConf.from_path .. automethod:: lisa.energy_meter::AEPConf.from_yaml_map .. automethod:: lisa.energy_meter::AEPConf.from_yaml_map_list .. automethod:: lisa.energy_meter::AEPConf.get .. automethod:: lisa.energy_meter::AEPConf.get_help .. automethod:: lisa.energy_meter::AEPConf.get_key .. automethod:: lisa.energy_meter::AEPConf.get_logger .. automethod:: lisa.energy_meter::AEPConf.get_nested_key .. automethod:: lisa.energy_meter::AEPConf.get_src_map .. automethod:: lisa.energy_meter::AEPConf.items .. automethod:: lisa.energy_meter::AEPConf.keys .. automethod:: lisa.energy_meter::AEPConf.log_locals .. automethod:: lisa.energy_meter::AEPConf.pretty_format .. automethod:: lisa.energy_meter::AEPConf.resolve_src .. automethod:: lisa.energy_meter::AEPConf.set_default_src .. automethod:: lisa.energy_meter::AEPConf.to_map .. automethod:: lisa.energy_meter::AEPConf.to_path .. automethod:: lisa.energy_meter::AEPConf.to_yaml .. automethod:: lisa.energy_meter::AEPConf.to_yaml_map .. automethod:: lisa.energy_meter::AEPConf.to_yaml_map_str .. automethod:: lisa.energy_meter::AEPConf.values