.. title:: TraceParserBase

lisa.trace.TraceParserBase
==========================


.. autoclass:: lisa.trace::TraceParserBase
   :no-members:
   :no-inherited-members:
   :no-undoc-members:
   :no-private-members:
   :no-special-members:

   
   .. rubric:: Attributes
   
   .. list-table::
      :align: left
   
      * - :attr:`~lisa.trace.TraceParserBase.METADATA_KEYS`
        -
         
         .. withrefctx::
            :module: lisa.trace
            :class: lisa.trace.TraceParserBase
         
         
            Possible metadata keys.
   
   
   .. 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.trace.TraceParserBase.__enter__`
        -
         
         .. withrefctx::
            :module: lisa.trace
            :class: lisa.trace.TraceParserBase
      * - :meth:`~lisa.trace.TraceParserBase.__exit__`
        -
         
         .. withrefctx::
            :module: lisa.trace
            :class: lisa.trace.TraceParserBase
      * - :meth:`~lisa.trace.TraceParserBase.get_all_metadata`
        -
         
         .. withrefctx::
            :module: lisa.trace
            :class: lisa.trace.TraceParserBase
         
         
            Collect all available metadata.
      * - :meth:`~lisa.trace.TraceParserBase.get_metadata`
        -
         
         .. withrefctx::
            :module: lisa.trace
            :class: lisa.trace.TraceParserBase
         
         
            Return the metadata value.
      * - :meth:`~lisa.trace.TraceParserBase.get_parser_id`
        -
         
         .. withrefctx::
            :module: lisa.trace
            :class: lisa.trace.TraceParserBase
         
         
            Get the unique ID of that parser. Any parameter affecting the output dataframes or metadata must be somehow part of that ID, so that the cache is not accidentally hit with stale data.
      * - :meth:`~lisa.trace.TraceParserBase.parse_all_events`
        -
         
         .. withrefctx::
            :module: lisa.trace
            :class: lisa.trace.TraceParserBase
         
         
            Parse all available events.
      * - :meth:`~lisa.trace.TraceParserBase.parse_event`
        -
         
         .. withrefctx::
            :module: lisa.trace
            :class: lisa.trace.TraceParserBase
         
         
            Parse the given event from the trace and return a :class:`pandas.DataFrame` with the following columns:.
      * - :meth:`~lisa.trace.TraceParserBase.parse_events`
        -
         
         .. withrefctx::
            :module: lisa.trace
            :class: lisa.trace.TraceParserBase
         
         
            Same as :meth:`parse_event` but taking a list of events as input, and returning a mapping of event names to :class:`pandas.DataFrame` for each.
      * - :meth:`~lisa.utils.PartialInit.factory` :sup:`inherited`
        -
         
         .. withrefctx::
            :module: lisa.utils
            :class: lisa.utils.PartialInit
         
         
            Decorator to use on alternative constructors, i.e. classmethods that return instances of the class.
      * - :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.trace::TraceParserBase.METADATA_KEYS



Properties
----------


.. autoproperty:: lisa.trace::TraceParserBase.logger



Methods
-------


.. automethod:: lisa.trace::TraceParserBase.__enter__



.. automethod:: lisa.trace::TraceParserBase.__exit__



.. automethod:: lisa.trace::TraceParserBase.get_all_metadata



.. automethod:: lisa.trace::TraceParserBase.get_metadata



.. automethod:: lisa.trace::TraceParserBase.get_parser_id



.. automethod:: lisa.trace::TraceParserBase.parse_all_events



.. automethod:: lisa.trace::TraceParserBase.parse_event



.. automethod:: lisa.trace::TraceParserBase.parse_events



.. automethod:: lisa.trace::TraceParserBase.factory



.. automethod:: lisa.trace::TraceParserBase.get_logger



.. automethod:: lisa.trace::TraceParserBase.log_locals