.. title:: MultiSrcConfABC

lisa.conf.MultiSrcConfABC
=========================


.. autoclass:: lisa.conf::MultiSrcConfABC
   :no-members:
   :no-inherited-members:
   :no-undoc-members:
   :no-private-members:
   :no-special-members:

   
   .. rubric:: Attributes
   
   .. list-table::
      :align: left
   
      * - :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.
   
   
   .. rubric:: Properties
   
   .. list-table::
      :align: left
   
      * - :attr:`~lisa.conf.MultiSrcConfABC.as_yaml_map`
        -
         
         .. 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
   
      * - :meth:`~lisa.conf.MultiSrcConfABC.from_map`
        -
         
         .. withrefctx::
            :module: lisa.conf
            :class: lisa.conf.MultiSrcConfABC
      * - :meth:`~lisa.conf.MultiSrcConfABC.from_yaml_map`
        -
         
         .. 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`
        -
         
         .. 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:`~lisa.conf.MultiSrcConfABC.to_map`
        -
         
         .. withrefctx::
            :module: lisa.conf
            :class: lisa.conf.MultiSrcConfABC
      * - :meth:`~lisa.conf.MultiSrcConfABC.to_yaml_map`
        -
         
         .. withrefctx::
            :module: lisa.conf
            :class: lisa.conf.MultiSrcConfABC
         
         
            Write a configuration file, with the key descriptions in comments.
      * - :meth:`~lisa.conf.MultiSrcConfABC.to_yaml_map_str`
        -
         
         .. 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:`~lisa.utils.Serializable.__copy__` :sup:`inherited`
        -
         
         .. withrefctx::
            :module: lisa.utils
            :class: lisa.utils.Serializable
         
         
            Regular shallow copy operation, without dropping any attributes.
      * - :meth:`~lisa.utils.Serializable.__getstate__` :sup:`inherited`
        -
         
         .. withrefctx::
            :module: lisa.utils
            :class: lisa.utils.Serializable
         
         
            Filter the instance's attributes upon serialization.
      * - :meth:`~lisa.utils.Serializable.__setstate__` :sup:`inherited`
        -
         
         .. withrefctx::
            :module: lisa.utils
            :class: lisa.utils.Serializable
      * - :meth:`~lisa.utils.Serializable.from_path` :sup:`inherited`
        -
         
         .. withrefctx::
            :module: lisa.utils
            :class: lisa.utils.Serializable
         
         
            Deserialize an object from a file.
      * - :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.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.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.
   


Attributes
----------


.. autoattribute:: lisa.conf::MultiSrcConfABC.ATTRIBUTES_SERIALIZATION



.. autoattribute:: lisa.conf::MultiSrcConfABC.DEFAULT_SERIALIZATION_FMT



.. autoattribute:: lisa.conf::MultiSrcConfABC.YAML_ENCODING



Properties
----------


.. autoproperty:: lisa.conf::MultiSrcConfABC.as_yaml_map



.. autoproperty:: lisa.conf::MultiSrcConfABC.logger



Methods
-------


.. automethod:: lisa.conf::MultiSrcConfABC.from_map



.. automethod:: lisa.conf::MultiSrcConfABC.from_yaml_map



.. automethod:: lisa.conf::MultiSrcConfABC.from_yaml_map_list



.. automethod:: lisa.conf::MultiSrcConfABC.to_map



.. automethod:: lisa.conf::MultiSrcConfABC.to_yaml_map



.. automethod:: lisa.conf::MultiSrcConfABC.to_yaml_map_str



.. automethod:: lisa.conf::MultiSrcConfABC.__copy__



.. automethod:: lisa.conf::MultiSrcConfABC.__getstate__



.. automethod:: lisa.conf::MultiSrcConfABC.__setstate__



.. automethod:: lisa.conf::MultiSrcConfABC.from_path



.. automethod:: lisa.conf::MultiSrcConfABC.get_logger



.. automethod:: lisa.conf::MultiSrcConfABC.log_locals



.. automethod:: lisa.conf::MultiSrcConfABC.to_path



.. automethod:: lisa.conf::MultiSrcConfABC.to_yaml