Skip to main content

Python Call Graph is a library and command line tool that visualises the flow of your Python application. This is a fork of the original, updated to work with Python 3.5 - 3.11 and from 2.1.0 3.8 - 3.12 See https://pycallgraph.readthedocs.io/en/develop/ for more information.

Project description

Python Call Graph

Welcome! Python Call Graph is a Python module that creates call graph visualizations for Python applications.

This repo used to be pycallgraph which is still hosted at pypi link.

The uploader makes no representations of their contribution, and merely wanted this to work in python 3.5; with a goal to porting it to 3.11 and 3.12

CI Status

Screenshots

Click on the images below to see a larger version and the source code that generated them.

Basic Output thumbnail

Regex grouped Output thumbnail

Regex ungrouped Output thumbnail

Project Status

The latest version is 2.1.1 which was released on 2024-03-31. The latest version has been tested running on Python versions 3.8 - 3.12

The project lives on GitHub, where you can report issues, contribute to the project by forking the project then creating a pull request, or just browse the source code.

The documentation needs some work stiil. Feel free to contribute :smile:

Features

  • Support for Python 3.8 - 3.12.
  • Static visualizations of the call graph using various tools such as Graphviz and Gephi.
  • Execute pycallgraph from the command line or import it in your code.
  • Customisable colors. You can programatically set the colors based on number of calls, time taken, memory usage, etc.
  • Modules can be visually grouped together.
  • Easily extendable to create your own output formats.

Quick Start

Installation is easy as

pip install python-call-graph

You can either use the command-line interface for a quick visualization of your Python script, or the pycallgraph module for more fine-grained settings.

The following examples specify graphviz as the outputter, so it's required to be installed. They will generate a file called pycallgraph.png.

The command-line method of running pycallgraph is

pycallgraph graphviz -- ./mypythonscript.py

A simple use of the API is

from pycallgraph import PyCallGraph
from pycallgraph.output import GraphvizOutput

with PyCallGraph(output=GraphvizOutput()):
    code_to_profile()

Documentation

Feel free to browse the documentation of pycallgraph for the usage guide and API reference.

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

python-call-graph-2.1.1.tar.gz (471.8 kB view details)

Uploaded Source

File details

Details for the file python-call-graph-2.1.1.tar.gz.

File metadata

  • Download URL: python-call-graph-2.1.1.tar.gz
  • Upload date:
  • Size: 471.8 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/5.0.0 CPython/3.12.2

File hashes

Hashes for python-call-graph-2.1.1.tar.gz
Algorithm Hash digest
SHA256 c87ecd5f43ac2ba46760ec5ca3e8542be84afc1478ebb81ba14cbdcf81f833b2
MD5 08d73a9b4a123443f77a107e97755e5f
BLAKE2b-256 ffe95ac7accc66edb0c3e7a41f45b8e7e68aa5b81aa2d71c24e4b3c6d62ffcc9

See more details on using hashes here.

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