Skip to main content

Jupyter widget and CLI that trace Python expression evaluation step by step (the %%steps cell magic and the print-steps command)

Project description

steps-widget

Jupyter widget and CLI that trace Python expression evaluation step by step.

  • %%steps -- a cell magic (registered by import steps_widget) that renders the substitution/reduction trace of any # PRINT STEPS-tagged statement as a widget below the cell.
  • print-steps -- the command-line equivalent: print-steps student_script.py prints the same trace to stderr for every tagged line in a script.

Tag convention: append # PRINT STEPS (or #PRINT-STEPS, # printsteps, ... -- see steps_widget.print_steps._COMMENT_TAGS for every recognized spelling) to a statement to have it evaluated one operation at a time instead of all at once.

import steps_widget

%%steps
x = 7
y = 5
z = x * y + 4  # PRINT STEPS

Requires Python 3.10 through 3.13 -- the stepper dispatches on CPython bytecode opcode names, which change across these versions; each is handled by its own dispatch table (see CLAUDE.md).

pip install steps-widget
# or
conda install -c munch-group steps-widget

See the docs for more.

Initial set up

pixi run init

Get updates to upstream fork

Add upstream if not already added

git remote add upstream https://github.com/munch-group/steps-widget.git

Fetch upstream changes

git fetch upstream

Either rebase your changes on top of upstream (cleaner history)

git rebase upstream/main

Or, merge upstream into your fork (preserves history)

git merge upstream/main

If you want to see what's changed upstream before applying:

git log HEAD..upstream/main

See the actual diff

git diff HEAD...upstream/main

Then push your updated fork:

git push origin main

If you rebased and need to force push

git push origin main --force-with-lease

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

steps_widget-0.1.22.tar.gz (426.6 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

steps_widget-0.1.22-py3-none-any.whl (32.4 kB view details)

Uploaded Python 3

File details

Details for the file steps_widget-0.1.22.tar.gz.

File metadata

  • Download URL: steps_widget-0.1.22.tar.gz
  • Upload date:
  • Size: 426.6 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.1.0 CPython/3.13.12

File hashes

Hashes for steps_widget-0.1.22.tar.gz
Algorithm Hash digest
SHA256 58c6c297675e3f3b5b4994fed81c1cdb6b1eb81027e229c3c035001d6bcc75b3
MD5 dec1cab77ed11a0c026e7b8d172311aa
BLAKE2b-256 c4be8fdc265e6cbdf283f2d70e62e83382850981d5e74140e297d3009f0cb7f4

See more details on using hashes here.

File details

Details for the file steps_widget-0.1.22-py3-none-any.whl.

File metadata

  • Download URL: steps_widget-0.1.22-py3-none-any.whl
  • Upload date:
  • Size: 32.4 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.1.0 CPython/3.13.12

File hashes

Hashes for steps_widget-0.1.22-py3-none-any.whl
Algorithm Hash digest
SHA256 66aa9836ffd5b4437dfe20b2d449aab13e6a033b0bb493e93e5b64562cab5b2c
MD5 7ea7e083c165c7644d5916be49176314
BLAKE2b-256 5fb918fdb7c18f8a4d195c93d9eba799d72bcb46bb2b55a18fedaf52a5913af0

See more details on using hashes here.

Supported by

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