.. title:: WATraceCollector

lisa.wa.WATraceCollector
========================


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

   
   .. rubric:: Attributes
   
   .. list-table::
      :align: left
   
      * - :attr:`~lisa.wa.WATraceCollector.NAME`
        -
         
         .. withrefctx::
            :module: lisa.wa
            :class: lisa.wa.WATraceCollector
   
   
   .. rubric:: Properties
   
   .. list-table::
      :align: left
   
      * - :attr:`~lisa.wa.WATraceCollector.traces`
        -
         
         .. withrefctx::
            :module: lisa.wa
            :class: lisa.wa.WATraceCollector
         
         
            :class:`lisa.utils.LazyMapping` that maps job names & iteration numbers to their corresponding :class:`lisa.trace.Trace`.
      * - :attr:`~lisa.wa.WACollectorBase.df` :sup:`inherited`
        -
         
         .. withrefctx::
            :module: lisa.wa
            :class: lisa.wa.WACollectorBase
         
         
            :class:`pandas.DataFrame` containing the data collected.
      * - :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.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:`~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.wa::WATraceCollector.NAME



Properties
----------


.. autoproperty:: lisa.wa::WATraceCollector.traces



.. autoproperty:: lisa.wa::WATraceCollector.df



.. autoproperty:: lisa.wa::WATraceCollector.logger



.. autoproperty:: lisa.wa::WATraceCollector.stats



Methods
-------


.. automethod:: lisa.wa::WATraceCollector.get_logger



.. automethod:: lisa.wa::WATraceCollector.get_stats



.. automethod:: lisa.wa::WATraceCollector.log_locals