reven2.stack.StackFrame

class documentation

class StackFrame(object):

Representation of a part (frame) of a stack.

Warnings

Must not be directly constructed but retrieved through the Stack.frames property.

Method	`__eq__`	Compares the instance for equality with an object.
Method	`__hash__`	Undocumented
Method	`__init__`	Undocumented
Method	`__repr__`	Undocumented
Method	`__str__`	Returns the nicely printable string representation of this instance.
Method	`ancestors`	An iterator to all the ancestors of this frame.
Method	`children`	An iterator over the children frames in the start order.
Method	`descendant_events`	An iterator over the descendant events sorted by their start order.
Method	`format_as_html`	This method gets an html formatting string representation for this class instance.
Method	`function_location`	The OSSI location corresponding to the function associated with this frame.
Method	`function_start`	The transition where the function associated with this frame is starting.
Method	`reversed_children`	An iterator over the children frames in the reversed start order.
Property	`creation_transition`	Property: The transition that lead to the creation of the frame.
Property	`end_event`	Property: The event ending this frame.
Property	`first_context`	Property: The first context where this frame exists.
Property	`first_executed_context`	Property: The first context where this frame exists and is executed (not one of its children).
Property	`last_context`	Property: The last context where this frame exists.
Property	`parent`	Property: The parent frame of this frame.
Property	`start_event`	Property: The event starting this frame.
Property	`type`	Property: The type of the stack frame.
Method	`_repr_html_`	Representation used by Jupyter Notebook when an instance of this class is displayed in a cell.
Instance Variable	`_data_source`	Undocumented
Instance Variable	`_end`	Undocumented
Instance Variable	`_first_context`	Undocumented
Instance Variable	`_first_executed_context`	Undocumented
Instance Variable	`_last_context`	Undocumented
Instance Variable	`_rvn_frame`	Undocumented
Instance Variable	`_start`	Undocumented
Instance Variable	`_trace`	Undocumented

def __eq__(self, other):

Compares the instance for equality with an object.

if the object is not a StackFrame, will return False.

Parameters
other:`object`	Undocumented
Returns
`bool`	Undocumented

def __hash__(self):

Undocumented

Returns
`int`	Undocumented

def __init__(self, data_source, trace, rvn_frame):

Undocumented

Parameters
data_source:`_DataSource`	Undocumented
trace:`_Trace`	Undocumented
rvn_frame:`_reven_api.StackFrame`	Undocumented

def __repr__(self):

Undocumented

Returns
`str`	Undocumented

def __str__(self):

Returns the nicely printable string representation of this instance.

Information

Returns
`str`	Undocumented
Raises
`RuntimeError`	if the OSSI resource is not available.

def ancestors(self):

An iterator to all the ancestors of this frame.

Returns
`_Iterator[StackFrame]`	Undocumented

def children(self):

An iterator over the children frames in the start order.

Returns
`_Iterator[StackFrame]`	Undocumented

def descendant_events(self, fetch_count=100):

An iterator over the descendant events sorted by their start order.

Information

Parameters
fetch_count	Technical parameter indicating how many events should be fetched from the server by query. Modifying this parameter allows to fine-tune performance according to the use-case: If you intend to make a lot of queries that you expect will return only a few events, then you should use a small value (e.g. 20) If you intend to make a few queries that you expect will return a lot of events, then you should use a large value (e.g. 1000) The default value should provide sufficient performance for most cases. NOTE: Modifying this parameter does not modify the results of the query.
Returns
`EventsIterator`	Undocumented

def format_as_html(self):

This method gets an html formatting string representation for this class instance.

Information

Returns
`str`	`String`

def function_location(self):

The OSSI location corresponding to the function associated with this frame.

If the call is unknown (before the trace), the location that will be returned is the first location seen where this frame was executed (so the ret from a direct child call).

Returns
`_Optional[_Location]`	Undocumented

def function_start(self):

The transition where the function associated with this frame is starting.

If it contains a trampoline it will be the end of the trampoline.

Returns
`_Optional[_Transition]`	Undocumented

def reversed_children(self):

An iterator over the children frames in the reversed start order.

Returns
`_Iterator[StackFrame]`	Undocumented

@property
@_deprecated('Use the start_event property')
creation_transition: _Optional[_Transition] =

Property: The transition that lead to the creation of the frame.

Sometimes this transition is unknown because e.g. the frame was created before the beginning of the trace (Unknown frame) or its stack was manipulated (Damaged frame). In these cases, None will be returned.

Deprecation

This property is deprecated, please use the property start_event to retrieve information about the start of this frame.

Information

Returns
A `reven2.trace.Transition` if known. Otherwise `None`

@property
end_event: FrameEnd =

Property: The event ending this frame.

@property
first_context: _Context =

Property: The first context where this frame exists.

For functions that started prior to the beginning of the trace, this yields the earliest context where this function or one of its children was being executed.

@property
first_executed_context: _Context =

Property: The first context where this frame exists and is executed (not one of its children).

@property
last_context: _Context =

Property: The last context where this frame exists.

For functions that ended after the ending of the trace, this yields the latest context where this function or one of its children was being executed.

@property
parent: _Optional[StackFrame] =

Property: The parent frame of this frame.

@property
start_event: FrameStart =

Property: The event starting this frame.

@property
@_deprecated('Use the start_event property')
type: StackFrameType =

Property: The type of the stack frame.

It indicates in which context the frame was created.

Deprecation

This property is deprecated, please use the property start_event to retrieve information about the start of this frame.

Information

Returns
A `StackFrameType`.

def _repr_html_(self):

Representation used by Jupyter Notebook when an instance of this class is displayed in a cell.

Returns
`str`	Undocumented

_data_source =

Undocumented

_end =

Undocumented

_first_context =

Undocumented

_first_executed_context =

Undocumented

_last_context =

Undocumented

_rvn_frame =

Undocumented

_start =

Undocumented

_trace =

Undocumented