When the following functions return ``frame records,'' each record
is a tuple of six items: the frame object, the filename,
the line number of the current line, the function name, a list of
lines of context from the source code, and the index of the current
line within that list.
Keeping references to frame objects, as found in
the first element of the frame records these functions return, can
cause your program to create reference cycles. Once a reference cycle
has been created, the lifespan of all objects which can be accessed
from the objects which form the cycle can become much longer even if
Python's optional cycle detector is enabled. If such cycles must be
created, it is important to ensure they are explicitly broken to avoid
the delayed destruction of objects and increased memory consumption
Though the cycle detector will catch these, destruction of the frames
(and local variables) can be made deterministic by removing the cycle
in a finally clause. This is also important if the cycle
detector was disabled when Python was compiled or using
gc.disable(). For example:
frame = inspect.currentframe()
# do something with the frame
The optional context argument supported by most of these
functions specifies the number of lines of context to return, which
are centered around the current line.
Get information about a frame or traceback object. A 5-tuple
is returned, the last five elements of the frame's frame record.
Get a list of frame records for a frame and all outer frames. These
frames represent the calls that lead to the creation of frame.
The first entry in the returned list represents frame; the
last entry represents the outermost call on frame's stack.
Get a list of frame records for a traceback's frame and all inner
frames. These frames represent calls made as a consequence of
frame. The first entry in the list represents
traceback; the last entry represents where the exception was
Return the frame object for the caller's stack frame.
Return a list of frame records for the caller's stack. The first
entry in the returned list represents the caller; the last entry
represents the outermost call on the stack.
Return a list of frame records for the stack between the current
frame and the frame in which an exception currently being handled
was raised in. The first entry in the list represents the caller;
the last entry represents where the exception was raised.