Skip to main content

Table-based exploration tool for Python profiling data (pstats files).

Project description

https://img.shields.io/github/actions/workflow/status/adamchainz/profiling-explorer/main.yml.svg?branch=main&style=for-the-badge https://img.shields.io/badge/Coverage-70%25-success?style=for-the-badge https://img.shields.io/pypi/v/profiling-explorer.svg?style=for-the-badge https://img.shields.io/badge/code%20style-black-000000.svg?style=for-the-badge pre-commit

Table-based exploration tool for Python profiling data (pstats files).

profiling-explorer screenshot

Read more in the introductory blog post.


Get better at command line Git with my book Boost Your Git DX.


Requirements

Python 3.10 to 3.14 supported.

Installation

  1. Install with pip:

    python -m pip install profiling-explorer

Usage

profiling-explorer reads pstats files as generated by Python’s profilers: profiling.tracing (called cProfile on Python < 3.15) and profiling.sampling (new in Python 3.15). To use it, first generate a profile file, for example by running your program under cProfile:

$ python -m cProfile -o example.pstats example.py

(Also runnable as python -m profiling.tracing instead on Python 3.15+.)

Then run profiling-explorer with the generated file:

$ profiling-explorer example.pstats

The report will open in your web browser, and you can explore the profile data with the interactive interface. Features:

  • Click the calls, internal ms, or cumulative ms column headers to sort by that column.

  • Use the search box to filter by filename or function name. Separate multiple search terms by spaces to match records that contain all terms.

  • Press a keyboard shortcut to focus the search box: /, Control+K, or Command+K. Select some text first, like a filename, to pre-fill the search box with that text.

  • Hover by a filename + line number pair to reveal the copy button, which copies the location to your clipboard for faster opening.

  • Click the callers or callees links on the right of a row to see the callers or callees of that function.

Full help:

usage: profiling-explorer [-h] [--port PORT] [--dev] FILE

positional arguments:
  FILE         The pstats data file to explore.

options:
  -h, --help   show this help message and exit
  --port PORT  Port for the local web server (default: 8099).
  --dev        Run in development mode (enables server reload and debug mode).

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

profiling_explorer-1.2.0.tar.gz (16.6 kB view details)

Uploaded Source

Built Distribution

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

profiling_explorer-1.2.0-py3-none-any.whl (17.6 kB view details)

Uploaded Python 3

File details

Details for the file profiling_explorer-1.2.0.tar.gz.

File metadata

  • Download URL: profiling_explorer-1.2.0.tar.gz
  • Upload date:
  • Size: 16.6 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.13.12

File hashes

Hashes for profiling_explorer-1.2.0.tar.gz
Algorithm Hash digest
SHA256 5e132b4d3b08b4d5e628cd1447d9a398c23a0de18c2349ef562c9f8d127374f8
MD5 3052d3012ac5ea422845bc25f5464f7b
BLAKE2b-256 40ed47717b258c6c9443ad88133e8608d974220a29ba9b6c6802ed494d3914ce

See more details on using hashes here.

Provenance

The following attestation bundles were made for profiling_explorer-1.2.0.tar.gz:

Publisher: main.yml on adamchainz/profiling-explorer

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

File details

Details for the file profiling_explorer-1.2.0-py3-none-any.whl.

File metadata

File hashes

Hashes for profiling_explorer-1.2.0-py3-none-any.whl
Algorithm Hash digest
SHA256 9ce158e4e7e48848eba179c4a531263a8b2178d46e2ce93bd685aed8509fcc48
MD5 6ac1523fad062641704c4594a0e2e222
BLAKE2b-256 f0effb5146819dd422a8f64aee481a470cd551e54a347e3baec94687bb8128bf

See more details on using hashes here.

Provenance

The following attestation bundles were made for profiling_explorer-1.2.0-py3-none-any.whl:

Publisher: main.yml on adamchainz/profiling-explorer

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

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