Skip to main content

An extension for IPython to embed a pythontutor iframe that can illustrate the code in the current cell.

Project description


jupytext: cell_metadata_filter: all,-hidden,-heading_collapsed formats: md:myst notebook_metadata_filter: all,-language_info,-toc,-jupytext.text_representation.jupytext_version,-jupytext.text_representation.format_version text_representation: extension: .md format_name: myst kernelspec: display_name: Python 3 language: python name: python3

Licence CC BY-NC-ND - Thierry Parmentelat

+++

Embedding pythontutor.com illustrations in Jupyter

this notebook is stored in text (markdown) format using jupytext, make sure to have this tool installed if you want to open it locally

+++

Installation

$ pip3 install ipythontutor

+++

Screeshot

As github won't render iframes embedded in a ipynb, here's a screenshot

+++

Basic Usage

# required to load the extension
%load_ext ipythontutor

In its simplest form, the code in the cell is handed over (as python3) to the excellent http://pythontutor.com/

%%ipythontutor
original = reference = [1, 2]
original[0] = 'boom'
print(reference)

Setting sizes

%%ipythontutor height=400 width=850
def fact(n):
    return 1 if n <= 1 else n * fact(n-1)
original = [fact(3), fact(4)]
reference = original[:]
original[0] = 'boom'
print(reference)

Scaling

If your page is smaller than what pythontutor can reasonably work with, you can specify a scaling ratio.

%%ipythontutor width=600 height=200 ratio=0.7
import copy
original = [1, [2, 3]]
reference = copy.deepcopy(original)
original[1][0] = 'boom'
print(reference)

Add a button to open pythontutor in a new tab

%%ipythontutor linkButton=true
def fact(n):
    return 1 if n <= 1 else n * fact(n-1)
original = [fact(3), fact(4)]
reference = original[:]
original[0] = 'boom'
print(reference)

Other settings

The following list shows the settings that can be tweaked on the magic line. See also this page about embedding pythontutor for more details on these settings:

from ipythontutor import Magics
for var, default in Magics.defaults.items():
    print(f"{var:>20} - defaults to - {default:<}")

Note on proto

The default is to use https to reach pythontutor, as this is exepcted to work in most cases. If that's not working for you, instead of setting proto=http on each magic cell, you can change this globally - like any other default btw - this way:

from ipythontutor import Magics
Magics.defaults['proto'] = 'http'

Using python2

%%ipythontutor py=2
print "Hey"
original = [1, 2]
copy = original[:]
original[0] = 'boom'

See also

Check out another pure approach, that does not rely on pythontutor, at the nbtutor project.

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 ipythontutor, version 0.2.0
Filename, size File type Python version Upload date Hashes
Filename, size ipythontutor-0.2.0-py3-none-any.whl (4.4 kB) File type Wheel Python version py3 Upload date Hashes View
Filename, size ipythontutor-0.2.0.tar.gz (105.1 kB) File type Source Python version None Upload date Hashes View

Supported by

AWS AWS Cloud computing Datadog Datadog Monitoring DigiCert DigiCert EV certificate Facebook / Instagram Facebook / Instagram PSF Sponsor Fastly Fastly CDN Google Google Object Storage and Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Salesforce Salesforce PSF Sponsor Sentry Sentry Error logging StatusPage StatusPage Status page