lisa.trace.TraceEventChecker#

class lisa.trace.TraceEventChecker(event, check=True)[source]#

Bases: TraceEventCheckerBase

Check for one single event.

Parameters:

event (str) – Name of the event to check for.
check (bool) – Check that the listed events are present in the self.trace attribute of the instance on which the decorated method is applied. If no such attribute is found, no check will be done.

Properties

logger ^inherited

Convenience short-hand for self.get_logger().

Methods

`__bool__()`
`get_all_events()`	Return a set of all events that are checked by this checker.
`map()`	Apply the given function to all the children and rebuild a new object with the result.
`__and__()` ^inherited	Combine two event checkers into one that checks the presence of both.
`__call__()` ^inherited	Decorator for methods that require some given trace events.
`__class_getitem__()` ^inherited	See `collections.abc.Iterable.__class_getitem__()`
`__contains__()` ^inherited
`__getitem__()` ^inherited
`__iter__()` ^inherited
`__len__()` ^inherited
`__matmul__()` ^inherited	Combine two event checkers into an optional one.
`__or__()` ^inherited	Combine two event checkers into one that checks the presence of either of them.
`__reversed__()` ^inherited	See `collections.abc.Sequence.__reversed__()`
`check_events()` ^inherited	Check that certain trace events are available in the given set of events.
`count()` ^inherited	See `collections.abc.Sequence.count()`
`doc_str()` ^inherited	Top-level function called by Sphinx’s autodoc extension to augment docstrings of the functions.
`expand_namespaces()` ^inherited	Build a `TraceEventCheckerBase` that will fixup the event names to take into account the given namespaces.
`get_logger()` ^inherited	Provides a `logging.Logger` named after `cls`.
`index()` ^inherited	See `collections.abc.Sequence.index()`
`log_locals()` ^inherited	Debugging aid: log the local variables of the calling function.

Properties#

property TraceEventChecker.logger#

Inherited property, see lisa.utils.Loggable.logger

Convenience short-hand for self.get_logger().

Methods#

TraceEventChecker.__bool__()[source]#

TraceEventChecker.get_all_events()[source]#

Return a set of all events that are checked by this checker.

That may be a superset of events that are strictly required, when the checker checks a logical OR combination of events for example.

TraceEventChecker.map(f)[source]#: Apply the given function to all the children and rebuild a new object with the result.

TraceEventChecker.__and__(other)#

Inherited method, see lisa.trace.TraceEventCheckerBase.__and__()

Combine two event checkers into one that checks the presence of both.

TraceEventChecker.__call__(f)#

Inherited method, see lisa.trace.TraceEventCheckerBase.__call__()

Decorator for methods that require some given trace events.

classmethod TraceEventChecker.__class_getitem__()#: Inherited method, see collections.abc.Iterable.__class_getitem__()

TraceEventChecker.__contains__(event)#: Inherited method, see lisa.trace.TraceEventCheckerBase.__contains__()

TraceEventChecker.__getitem__(i)#: Inherited method, see lisa.trace.TraceEventCheckerBase.__getitem__()

TraceEventChecker.__iter__()#: Inherited method, see lisa.trace.TraceEventCheckerBase.__iter__()

TraceEventChecker.__len__(event)#: Inherited method, see lisa.trace.TraceEventCheckerBase.__len__()

TraceEventChecker.__matmul__(other)#

Inherited method, see lisa.trace.TraceEventCheckerBase.__matmul__()

Combine two event checkers into an optional one.

TraceEventChecker.__or__(other)#

Inherited method, see lisa.trace.TraceEventCheckerBase.__or__()

Combine two event checkers into one that checks the presence of either of them.

TraceEventChecker.__reversed__()#: Inherited method, see collections.abc.Sequence.__reversed__()

TraceEventChecker.check_events(event_set, check_optional=False, namespaces=None)#

Inherited method, see lisa.trace.TraceEventCheckerBase.check_events()

Check that certain trace events are available in the given set of events.

TraceEventChecker.count()#: Inherited method, see collections.abc.Sequence.count()

TraceEventChecker.doc_str()#

Inherited method, see lisa.trace.TraceEventCheckerBase.doc_str()

Top-level function called by Sphinx’s autodoc extension to augment docstrings of the functions.

TraceEventChecker.expand_namespaces(namespaces=None)#

Inherited method, see lisa.trace.TraceEventCheckerBase.expand_namespaces()

Build a TraceEventCheckerBase that will fixup the event names to take into account the given namespaces.

classmethod TraceEventChecker.get_logger(suffix=None)#

Inherited method, see lisa.utils.Loggable.get_logger()

Provides a logging.Logger named after cls.

TraceEventChecker.index()#: Inherited method, see collections.abc.Sequence.index()

classmethod TraceEventChecker.log_locals(var_names=None, level='debug')#

Inherited method, see lisa.utils.Loggable.log_locals()

Debugging aid: log the local variables of the calling function.

lisa.trace.TraceEventChecker#

Properties#

Methods#

This Page