.. title:: wa

lisa.wa
=======


.. toctree::
   :hidden:

   plugins <lisa.wa.plugins>
   StatsProp <lisa.wa.StatsProp>
   WAArtifactCollectorBase <lisa.wa.WAArtifactCollectorBase>
   WACollectorBase <lisa.wa.WACollectorBase>
   WAEnergyCollector <lisa.wa.WAEnergyCollector>
   WAJankbenchCollector <lisa.wa.WAJankbenchCollector>
   WAOutput <lisa.wa.WAOutput>
   WAResultsCollector <lisa.wa.WAResultsCollector>
   WASysfsExtractorCollector <lisa.wa.WASysfsExtractorCollector>
   WATraceCollector <lisa.wa.WATraceCollector>
   WAOutputNotFoundError <lisa.wa.WAOutputNotFoundError>

.. module:: lisa.wa


.. withrefctx::
   :module: lisa.wa


   
   .. automodule:: lisa.wa
       :no-index:
       :no-members:
       :no-inherited-members:
       :no-undoc-members:
       :no-private-members:
       :no-special-members:
   


.. rubric:: Modules

.. list-table::
   :align: left

   * - :mod:`~lisa.wa.plugins`
     -
      
      .. withrefctx::
         :module: lisa.wa.plugins
      
      
         Workload Automation plugins.


.. rubric:: Classes

.. list-table::
   :align: left

   * - :class:`~lisa.wa.StatsProp`
     -
      
      .. withrefctx::
         :module: lisa.wa
         :class: lisa.wa.StatsProp
      
      
         Provides a ``stats`` property.
   * - :class:`~lisa.wa.WAArtifactCollectorBase`
     -
      
      .. withrefctx::
         :module: lisa.wa
         :class: lisa.wa.WAArtifactCollectorBase
      
      
         ``Workload Automation`` artifact collector base class.
   * - :class:`~lisa.wa.WACollectorBase`
     -
      
      .. withrefctx::
         :module: lisa.wa
         :class: lisa.wa.WACollectorBase
      
      
         Base class for all ``Workload Automation`` dataframe collectors.
   * - :class:`~lisa.wa.WAEnergyCollector`
     -
      
      .. withrefctx::
         :module: lisa.wa
         :class: lisa.wa.WAEnergyCollector
      
      
         WA collector for the energy_measurement augmentation.
   * - :class:`~lisa.wa.WAJankbenchCollector`
     -
      
      .. withrefctx::
         :module: lisa.wa
         :class: lisa.wa.WAJankbenchCollector
      
      
         WA collector for the jankbench frame timings.
   * - :class:`~lisa.wa.WAOutput`
     -
      
      .. withrefctx::
         :module: lisa.wa
         :class: lisa.wa.WAOutput
      
      
         Recursively parse a ``Workload Automation`` output, using registered collectors (leaf subclasses of :class:`WACollectorBase`). The data collected are accessible through a :class:`pandas.DataFrame` in "database" format:.
   * - :class:`~lisa.wa.WAResultsCollector`
     -
      
      .. withrefctx::
         :module: lisa.wa
         :class: lisa.wa.WAResultsCollector
      
      
         Collector for the ``Workload Automation`` test results.
   * - :class:`~lisa.wa.WASysfsExtractorCollector`
     -
      
      .. withrefctx::
         :module: lisa.wa
         :class: lisa.wa.WASysfsExtractorCollector
      
      
         WA collector for the syfs-extractor augmentation.
   * - :class:`~lisa.wa.WATraceCollector`
     -
      
      .. withrefctx::
         :module: lisa.wa
         :class: lisa.wa.WATraceCollector
      
      
         WA collector for the trace augmentation.


.. rubric:: Exceptions

.. list-table::
   :align: left

   * - :class:`~lisa.wa.WAOutputNotFoundError`
     -
      
      .. withrefctx::
         :module: lisa.wa
         :class: lisa.wa.WAOutputNotFoundError
      
      
         Common base class for all non-exit exceptions.