.. title:: WAOutput

lisa.wa.WAOutput
================


.. autoclass:: lisa.wa::WAOutput
   :no-members:
   :no-inherited-members:
   :no-undoc-members:
   :no-private-members:
   :no-special-members:

   
   .. rubric:: Attributes
   
   .. list-table::
      :align: left
   
      * - :attr:`~collections.abc.Mapping.__reversed__` :sup:`inherited`
        -
         See :attr:`collections.abc.Mapping.__reversed__`
   
   
   .. rubric:: Properties
   
   .. list-table::
      :align: left
   
      * - :attr:`~lisa.wa.WAOutput.df`
        -
         
         .. withrefctx::
            :module: lisa.wa
            :class: lisa.wa.WAOutput
         
         
            DataFrame containing the data collected by all the registered :class:`WAOutput` collectors.
      * - :attr:`~lisa.wa.WAOutput.jobs`
        -
         
         .. withrefctx::
            :module: lisa.wa
            :class: lisa.wa.WAOutput
         
         
            List containing all the jobs present in the output of 'wa run'.
      * - :attr:`~lisa.wa.WAOutput.outputs`
        -
         
         .. withrefctx::
            :module: lisa.wa
            :class: lisa.wa.WAOutput
         
         
            Dict containing a mapping of 'wa run' names to :class:`RunOutput` objects.
      * - :attr:`~lisa.utils.Loggable.logger` :sup:`inherited`
        -
         
         .. withrefctx::
            :module: lisa.utils
            :class: lisa.utils.Loggable
         
         
            Convenience short-hand for ``self.get_logger()``.
      * - :attr:`~lisa.wa.StatsProp.stats` :sup:`inherited`
        -
         
         .. withrefctx::
            :module: lisa.wa
            :class: lisa.wa.StatsProp
         
         
            Short-hand property equivalent to ``self.get_stats()``.
   
   
   .. rubric:: Methods
   
   .. list-table::
      :align: left
   
      * - :meth:`~lisa.wa.WAOutput.__contains__`
        -
         
         .. withrefctx::
            :module: lisa.wa
            :class: lisa.wa.WAOutput
      * - :meth:`~lisa.wa.WAOutput.__getitem__`
        -
         
         .. withrefctx::
            :module: lisa.wa
            :class: lisa.wa.WAOutput
      * - :meth:`~lisa.wa.WAOutput.__hash__`
        -
         
         .. withrefctx::
            :module: lisa.wa
            :class: lisa.wa.WAOutput
         
         
            Each instance is different, like regular objects, and unlike dictionaries.
      * - :meth:`~lisa.wa.WAOutput.__iter__`
        -
         
         .. withrefctx::
            :module: lisa.wa
            :class: lisa.wa.WAOutput
      * - :meth:`~lisa.wa.WAOutput.__len__`
        -
         
         .. withrefctx::
            :module: lisa.wa
            :class: lisa.wa.WAOutput
      * - :meth:`~lisa.wa.WAOutput.get_collector`
        -
         
         .. withrefctx::
            :module: lisa.wa
            :class: lisa.wa.WAOutput
         
         
            Returns a new collector with custom parameters passed to it.
      * - :func:`~collections.abc.Iterable.__class_getitem__` :sup:`inherited`
        -
         See :func:`collections.abc.Iterable.__class_getitem__`
      * - :meth:`~collections.abc.Mapping.get` :sup:`inherited`
        -
         See :meth:`collections.abc.Mapping.get`
      * - :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.wa.StatsProp.get_stats` :sup:`inherited`
        -
         
         .. withrefctx::
            :module: lisa.wa
            :class: lisa.wa.StatsProp
         
         
            Returns a :class:`lisa.stats.Stats` loaded with the result :class:`pandas.DataFrame`.
      * - :meth:`~collections.abc.Mapping.items` :sup:`inherited`
        -
         See :meth:`collections.abc.Mapping.items`
      * - :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:`~collections.abc.Mapping.values` :sup:`inherited`
        -
         See :meth:`collections.abc.Mapping.values`
   


Attributes
----------


.. autoattribute:: lisa.wa::WAOutput.__reversed__



Properties
----------


.. autoproperty:: lisa.wa::WAOutput.df



.. autoproperty:: lisa.wa::WAOutput.jobs



.. autoproperty:: lisa.wa::WAOutput.outputs



.. autoproperty:: lisa.wa::WAOutput.logger



.. autoproperty:: lisa.wa::WAOutput.stats



Methods
-------


.. automethod:: lisa.wa::WAOutput.__contains__



.. automethod:: lisa.wa::WAOutput.__getitem__



.. automethod:: lisa.wa::WAOutput.__hash__



.. automethod:: lisa.wa::WAOutput.__iter__



.. automethod:: lisa.wa::WAOutput.__len__



.. automethod:: lisa.wa::WAOutput.get_collector



.. automethod:: lisa.wa::WAOutput.__class_getitem__



.. automethod:: lisa.wa::WAOutput.get



.. automethod:: lisa.wa::WAOutput.get_logger



.. automethod:: lisa.wa::WAOutput.get_stats



.. automethod:: lisa.wa::WAOutput.items



.. automethod:: lisa.wa::WAOutput.keys



.. automethod:: lisa.wa::WAOutput.log_locals



.. automethod:: lisa.wa::WAOutput.values