.. title:: AssociativeTraceEventChecker lisa.trace.AssociativeTraceEventChecker ======================================= .. autoclass:: lisa.trace::AssociativeTraceEventChecker :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.AssociativeTraceEventChecker.__bool__` - .. withrefctx:: :module: lisa.trace :class: lisa.trace.AssociativeTraceEventChecker * - :meth:`~lisa.trace.AssociativeTraceEventChecker.from_events` - .. withrefctx:: :module: lisa.trace :class: lisa.trace.AssociativeTraceEventChecker Build an instance of the class, converting ``str`` to ``TraceEventChecker``. * - :meth:`~lisa.trace.AssociativeTraceEventChecker.get_all_events` - .. withrefctx:: :module: lisa.trace :class: lisa.trace.AssociativeTraceEventChecker Return a set of all events that are checked by this checker. * - :meth:`~lisa.trace.AssociativeTraceEventChecker.map` - .. withrefctx:: :module: lisa.trace :class: lisa.trace.AssociativeTraceEventChecker 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::AssociativeTraceEventChecker.logger Methods ------- .. automethod:: lisa.trace::AssociativeTraceEventChecker.__bool__ .. automethod:: lisa.trace::AssociativeTraceEventChecker.from_events .. automethod:: lisa.trace::AssociativeTraceEventChecker.get_all_events .. automethod:: lisa.trace::AssociativeTraceEventChecker.map .. automethod:: lisa.trace::AssociativeTraceEventChecker.__and__ .. automethod:: lisa.trace::AssociativeTraceEventChecker.__call__ .. automethod:: lisa.trace::AssociativeTraceEventChecker.__class_getitem__ .. automethod:: lisa.trace::AssociativeTraceEventChecker.__contains__ .. automethod:: lisa.trace::AssociativeTraceEventChecker.__getitem__ .. automethod:: lisa.trace::AssociativeTraceEventChecker.__iter__ .. automethod:: lisa.trace::AssociativeTraceEventChecker.__len__ .. automethod:: lisa.trace::AssociativeTraceEventChecker.__matmul__ .. automethod:: lisa.trace::AssociativeTraceEventChecker.__or__ .. automethod:: lisa.trace::AssociativeTraceEventChecker.__reversed__ .. automethod:: lisa.trace::AssociativeTraceEventChecker.check_events .. automethod:: lisa.trace::AssociativeTraceEventChecker.count .. automethod:: lisa.trace::AssociativeTraceEventChecker.doc_str .. automethod:: lisa.trace::AssociativeTraceEventChecker.expand_namespaces .. automethod:: lisa.trace::AssociativeTraceEventChecker.get_logger .. automethod:: lisa.trace::AssociativeTraceEventChecker.index .. automethod:: lisa.trace::AssociativeTraceEventChecker.log_locals