.. title:: TraceEventChecker

lisa.trace.TraceEventChecker
============================


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

   
   .. 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.TraceEventChecker.__bool__`
        -
         
         .. withrefctx::
            :module: lisa.trace
            :class: lisa.trace.TraceEventChecker
      * - :meth:`~lisa.trace.TraceEventChecker.get_all_events`
        -
         
         .. withrefctx::
            :module: lisa.trace
            :class: lisa.trace.TraceEventChecker
         
         
            Return a set of all events that are checked by this checker.
      * - :meth:`~lisa.trace.TraceEventChecker.map`
        -
         
         .. withrefctx::
            :module: lisa.trace
            :class: lisa.trace.TraceEventChecker
         
         
            Apply the given function to all the children and rebuild a new object with the result.
      * - :meth:`~lisa.trace.TraceEventCheckerBase.__and__` :sup:`inherited`
        -
         
         .. withrefctx::
            :module: lisa.trace
            :class: lisa.trace.TraceEventCheckerBase
         
         
            Combine two event checkers into one that checks the presence of both.
      * - :meth:`~lisa.trace.TraceEventCheckerBase.__call__` :sup:`inherited`
        -
         
         .. withrefctx::
            :module: lisa.trace
            :class: lisa.trace.TraceEventCheckerBase
         
         
            Decorator for methods that require some given trace events.
      * - :func:`~collections.abc.Iterable.__class_getitem__` :sup:`inherited`
        -
         See :func:`collections.abc.Iterable.__class_getitem__`
      * - :meth:`~lisa.trace.TraceEventCheckerBase.__contains__` :sup:`inherited`
        -
         
         .. withrefctx::
            :module: lisa.trace
            :class: lisa.trace.TraceEventCheckerBase
      * - :meth:`~lisa.trace.TraceEventCheckerBase.__getitem__` :sup:`inherited`
        -
         
         .. withrefctx::
            :module: lisa.trace
            :class: lisa.trace.TraceEventCheckerBase
      * - :meth:`~lisa.trace.TraceEventCheckerBase.__iter__` :sup:`inherited`
        -
         
         .. withrefctx::
            :module: lisa.trace
            :class: lisa.trace.TraceEventCheckerBase
      * - :meth:`~lisa.trace.TraceEventCheckerBase.__len__` :sup:`inherited`
        -
         
         .. withrefctx::
            :module: lisa.trace
            :class: lisa.trace.TraceEventCheckerBase
      * - :meth:`~lisa.trace.TraceEventCheckerBase.__matmul__` :sup:`inherited`
        -
         
         .. withrefctx::
            :module: lisa.trace
            :class: lisa.trace.TraceEventCheckerBase
         
         
            Combine two event checkers into an optional one.
      * - :meth:`~lisa.trace.TraceEventCheckerBase.__or__` :sup:`inherited`
        -
         
         .. withrefctx::
            :module: lisa.trace
            :class: lisa.trace.TraceEventCheckerBase
         
         
            Combine two event checkers into one that checks the presence of either of them.
      * - :meth:`~collections.abc.Sequence.__reversed__` :sup:`inherited`
        -
         See :meth:`collections.abc.Sequence.__reversed__`
      * - :meth:`~lisa.trace.TraceEventCheckerBase.check_events` :sup:`inherited`
        -
         
         .. withrefctx::
            :module: lisa.trace
            :class: lisa.trace.TraceEventCheckerBase
         
         
            Check that certain trace events are available in the given set of events.
      * - :meth:`~collections.abc.Sequence.count` :sup:`inherited`
        -
         See :meth:`collections.abc.Sequence.count`
      * - :meth:`~lisa.trace.TraceEventCheckerBase.doc_str` :sup:`inherited`
        -
         
         .. withrefctx::
            :module: lisa.trace
            :class: lisa.trace.TraceEventCheckerBase
         
         
            Top-level function called by Sphinx's autodoc extension to augment docstrings of the functions.
      * - :meth:`~lisa.trace.TraceEventCheckerBase.expand_namespaces` :sup:`inherited`
        -
         
         .. withrefctx::
            :module: lisa.trace
            :class: lisa.trace.TraceEventCheckerBase
         
         
            Build a :class:`TraceEventCheckerBase` that will fixup the event names to take into account the given namespaces.
      * - :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:`~collections.abc.Sequence.index` :sup:`inherited`
        -
         See :meth:`collections.abc.Sequence.index`
      * - :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.
   


Properties
----------


.. autoproperty:: lisa.trace::TraceEventChecker.logger



Methods
-------


.. automethod:: lisa.trace::TraceEventChecker.__bool__



.. automethod:: lisa.trace::TraceEventChecker.get_all_events



.. automethod:: lisa.trace::TraceEventChecker.map



.. automethod:: lisa.trace::TraceEventChecker.__and__



.. automethod:: lisa.trace::TraceEventChecker.__call__



.. automethod:: lisa.trace::TraceEventChecker.__class_getitem__



.. automethod:: lisa.trace::TraceEventChecker.__contains__



.. automethod:: lisa.trace::TraceEventChecker.__getitem__



.. automethod:: lisa.trace::TraceEventChecker.__iter__



.. automethod:: lisa.trace::TraceEventChecker.__len__



.. automethod:: lisa.trace::TraceEventChecker.__matmul__



.. automethod:: lisa.trace::TraceEventChecker.__or__



.. automethod:: lisa.trace::TraceEventChecker.__reversed__



.. automethod:: lisa.trace::TraceEventChecker.check_events



.. automethod:: lisa.trace::TraceEventChecker.count



.. automethod:: lisa.trace::TraceEventChecker.doc_str



.. automethod:: lisa.trace::TraceEventChecker.expand_namespaces



.. automethod:: lisa.trace::TraceEventChecker.get_logger



.. automethod:: lisa.trace::TraceEventChecker.index



.. automethod:: lisa.trace::TraceEventChecker.log_locals