Skip to main content

Shows a simplified view of the call stack.

Project description

ShowCallStack

Shows a simplified view of the call stack.

This module is similar to Python's built-in traceback and inspect modules, but is easier to use and displays more simple output. This module is useful for demonstrating what the call stack looks like during recursive function calls. Simply add a from showcallstack import showCallStack line and then call showCallStack() from wherever you wish to see the state of the call stack and the local variables in each call frame.

Example Usage

This program...

from showcallstack import showcallstack

def a():
    varA = 42
    b()

def b():
    varB = 86
    c()

def c():
    varC = 99
    showcallstack()

a()

...outputs this:

The call stack is 3 call(s) deep:
(Here is the "bottom" of the call stack.)
Function/method: a(), Local variables: {'varA': 42}
Function/method: b(), Local variables: {'varB': 86}
Function/method: c(), Local variables: {'varC': 99}
(Here is the "top" of the call stack.)

This recursive factorial program...

from showcallstack import showcallstack

def factorial(num):
    showcallstack()
    if num == 1:
        return 1
    else:
        return num * factorial(num - 1)

factorial(4)

...outputs this:

The call stack is 1 call(s) deep:
(Here is the "bottom" of the call stack.)
Function/method: factorial(), Local variables: {'num': 4}
(Here is the "top" of the call stack.)

The call stack is 2 call(s) deep:
(Here is the "bottom" of the call stack.)
Function/method: factorial(), Local variables: {'num': 4}
Function/method: factorial(), Local variables: {'num': 3}
(Here is the "top" of the call stack.)

The call stack is 3 call(s) deep:
(Here is the "bottom" of the call stack.)
Function/method: factorial(), Local variables: {'num': 4}
Function/method: factorial(), Local variables: {'num': 3}
Function/method: factorial(), Local variables: {'num': 2}
(Here is the "top" of the call stack.)

The call stack is 4 call(s) deep:
(Here is the "bottom" of the call stack.)
Function/method: factorial(), Local variables: {'num': 4}
Function/method: factorial(), Local variables: {'num': 3}
Function/method: factorial(), Local variables: {'num': 2}
Function/method: factorial(), Local variables: {'num': 1}
(Here is the "top" of the call stack.)

You can also call the showcallstack.getcallstack() function to get this output as a list of strings.

Support

If you find this project helpful and would like to support its development, consider donating to its creator on Patreon.

Project details


Download files

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

Source Distribution

ShowCallStack-0.2.2.tar.gz (3.8 kB view details)

Uploaded Source

File details

Details for the file ShowCallStack-0.2.2.tar.gz.

File metadata

  • Download URL: ShowCallStack-0.2.2.tar.gz
  • Upload date:
  • Size: 3.8 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.7.1 importlib_metadata/4.8.2 pkginfo/1.8.2 requests/2.26.0 requests-toolbelt/0.9.1 tqdm/4.62.3 CPython/3.10.0

File hashes

Hashes for ShowCallStack-0.2.2.tar.gz
Algorithm Hash digest
SHA256 88e9b47568cff31046ef41a6720298223c8490b3f993d14f4845fc41172f6b8b
MD5 b59818056f521684408ac265b97e2bb2
BLAKE2b-256 f01553cc25745c0b50790bd08aa5fb3a1383e8b16261d84acc371b583164788a

See more details on using hashes here.

Provenance

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page