class documentation

class StackFrame(object):

View In Hierarchy

Representation of a part (frame) of a stack.

Warnings

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

Method __init__ Undocumented
Property type Property: The type of the stack frame.
Property first_context Property: The first context refers to the context where the frame is first seen in the trace on top of the active stack.
Property creation_transition Property: The transition that lead to the creation of the frame.
Method __str__ Information ===========
Method __repr__ Undocumented
Method format_as_html This method gets an html formatting string representation for this class instance.
Instance Variable _first_context Undocumented
Instance Variable _type Undocumented
Instance Variable _creation_transition Undocumented
Method _repr_html_ Representation used by Jupyter Notebook when an instance of this class is displayed in a cell.
def __init__(self, stack, _rvn_frame):

Undocumented

_first_context =

Undocumented

_type =

Undocumented

_creation_transition =

Undocumented

@property
type =

Property: The type of the stack frame.

It indicates in which context the frame was created.

Information

ReturnsA StackFrameType.
@property
first_context =

Property: The first context refers to the context where the frame is first seen in the trace on top of the active stack.

Note

While the transition before the first_context will generally be the creation_transition of this frame, sometimes it is not the case because e.g. the frame was created before the beginning of the trace (Unknown frame), or its stack was manipulated (Damaged frame). In that case, the transition before the first_context will typically be a return to this already existing frame.

Information

ReturnsA reven2.trace.Context.
@property
creation_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.

Note

The context after the creation_transition is always the first_context of this frame.

Information

ReturnsA reven2.trace.Transition if known. Otherwise None
def __str__(self):

Information

RaisesRuntimeErrorif the OSSI resource is not available.
def __repr__(self):

Undocumented

def format_as_html(self):

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

Information

ReturnsString
def _repr_html_(self):

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

API Documentation for reven2, generated by pydoctor 21.2.2 at 2021-11-30 13:45:23.