Skip to main content

Convenience functions for the python execution stack.

Project description

Release 20190812: stack_dump(): trim the last 2 frames from the listing by default (they are part of stack_dump's implementation).

I find the supplied python traceback facilities quite awkward. These functions provide convenient facilities.

Function caller(frame_index=-3)

Return the Frame of the caller's caller.

Useful frame_index values:

  • -1: caller, this function
  • -2: invoker, who wants to know the caller
  • -3: the calling function of the invoker

The default from_index value is -3.

Class Frame

MRO: Frame, builtins.tuple
A namedtuple for stack frame contents.

Function frames()

Return the current stack as a list of Frame objects.

Function stack_dump(fp=None, indent=0, Fs=None, skip=None)

Recite current or supplied stack to fp, default sys.stderr.

Parameters:

  • fp: the output file object, default sys.stderr
  • indent: how many spaces to indent the stack lines, default 0
  • Fs: the stack Frames to write, default obtained from the current stack
  • skip: the number of Frames to trim from the end of Fs; if Fs is None this defaults to 2 to trim the Frames for the stack_dump function and its call to frames(), otherwise the default is 0 to use the supplied Frames as is

Release Log

Release 20190812: stack_dump(): trim the last 2 frames from the listing by default (they are part of stack_dump's implementation).

Release 20190101: _Frame: rename .functionname to .funcname; caller: turn raw frames into Frames. caller(): accept optional frame_index, default -3.

Release 20160827: Add stack_dump().

Release 20150115: PyPI metadata fixups.

Release 20150111: Tag for initial PyPI release of cs.py.stack.

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Files for cs.py.stack, version 20190812
Filename, size File type Python version Upload date Hashes
Filename, size cs.py.stack-20190812.tar.gz (2.9 kB) File type Source Python version None Upload date Hashes View hashes

Supported by

Elastic Elastic Search Pingdom Pingdom Monitoring Google Google BigQuery Sentry Sentry Error logging AWS AWS Cloud computing DataDog DataDog Monitoring Fastly Fastly CDN DigiCert DigiCert EV certificate StatusPage StatusPage Status page