Skip to main content

IPython magic for cProfile graphs w gprof2dot and graphviz in Jupyter/iterm.

Project description

profilegraph

pypi badge

A line/cell magic for displaying cProfile results in graph form. Like %time or %%time, but with far more information (with the performance penalty you'd expect from cProfile.run).

Inspired by mattijn/gprof2dot_magic.

A trivial profilegraph example.

Install

This package requires Jupyter with a python kernel to be installed. The only other python dependency is gprof2dot, which is used to convert cProfile output to a graphviz-compatible dotfile and is installed by pip automatically, and a graphviz binary, which is used to render the SVG output. You can install graphviz from the provided download link or using the package manager of your choice.

pip install profilegraph

Use

Load the extension in a Jupyter notebook:

%load_ext profilegraph

Profile a line of code by sticking %profilegraph at the start:

import re
%profilegraph re.sub("biz", "baz", "foobarbiz")

Profile result on re.sub

If you have a whole cell that needs to be profiled, you can use the cell magic form:

%%profilegraph
for i in range(10):
    print(i)

Develop

profilegraph uses flit. Install flit with pip install flit.

Install in editable mode with:

flit install [--symlink] [--python path/to/python]

Upload to PyPI with:

flit publish

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

profilegraph-0.2.0.tar.gz (174.1 kB view hashes)

Uploaded Source

Built Distribution

profilegraph-0.2.0-py3-none-any.whl (15.6 kB view hashes)

Uploaded Python 3

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