.. title:: Serializable

lisa.utils.Serializable
=======================


.. autoclass:: lisa.utils::Serializable
   :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`
        -
         
         .. withrefctx::
            :module: lisa.utils
            :class: lisa.utils.Serializable
         
         
            Attributes to be treated specially during serialization.
      * - :attr:`~lisa.utils.Serializable.DEFAULT_SERIALIZATION_FMT`
        -
         
         .. withrefctx::
            :module: lisa.utils
            :class: lisa.utils.Serializable
         
         
            Default format used when serializing objects.
      * - :attr:`~lisa.utils.Serializable.YAML_ENCODING`
        -
         
         .. withrefctx::
            :module: lisa.utils
            :class: lisa.utils.Serializable
         
         
            Encoding used for YAML files.
   
   
   .. rubric:: Properties
   
   .. list-table::
      :align: left
   
      * - :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.utils.Serializable.__copy__`
        -
         
         .. withrefctx::
            :module: lisa.utils
            :class: lisa.utils.Serializable
         
         
            Regular shallow copy operation, without dropping any attributes.
      * - :meth:`~lisa.utils.Serializable.__getstate__`
        -
         
         .. withrefctx::
            :module: lisa.utils
            :class: lisa.utils.Serializable
         
         
            Filter the instance's attributes upon serialization.
      * - :meth:`~lisa.utils.Serializable.__setstate__`
        -
         
         .. withrefctx::
            :module: lisa.utils
            :class: lisa.utils.Serializable
      * - :meth:`~lisa.utils.Serializable.from_path`
        -
         
         .. withrefctx::
            :module: lisa.utils
            :class: lisa.utils.Serializable
         
         
            Deserialize an object from a file.
      * - :meth:`~lisa.utils.Serializable.to_path`
        -
         
         .. withrefctx::
            :module: lisa.utils
            :class: lisa.utils.Serializable
         
         
            Serialize the object to a file.
      * - :meth:`~lisa.utils.Serializable.to_yaml`
        -
         
         .. withrefctx::
            :module: lisa.utils
            :class: lisa.utils.Serializable
         
         
            Return a YAML string with the serialized object.
      * - :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.
   


Attributes
----------


.. autoattribute:: lisa.utils::Serializable.ATTRIBUTES_SERIALIZATION



.. autoattribute:: lisa.utils::Serializable.DEFAULT_SERIALIZATION_FMT



.. autoattribute:: lisa.utils::Serializable.YAML_ENCODING



Properties
----------


.. autoproperty:: lisa.utils::Serializable.logger



Methods
-------


.. automethod:: lisa.utils::Serializable.__copy__



.. automethod:: lisa.utils::Serializable.__getstate__



.. automethod:: lisa.utils::Serializable.__setstate__



.. automethod:: lisa.utils::Serializable.from_path



.. automethod:: lisa.utils::Serializable.to_path



.. automethod:: lisa.utils::Serializable.to_yaml



.. automethod:: lisa.utils::Serializable.get_logger



.. automethod:: lisa.utils::Serializable.log_locals