Python pstats.Stats Class: Analyze Profiling Results

pstats.

Understanding the Concept

pstats.Stats loads deterministic profiler results, sorts by time or call count, and filters the displayed output. It supports cProfile data as well as the new tracing profiler.

pstats is for deterministic call statistics, not Tachyon sample-percent interpretation.

How to interpret the measurement

Before optimizing, establish an objective measurement and a representative workload. Memory size, function-call counts, elapsed time and samples are different metrics: knowing one does not determine the others. Repeat observations before drawing a conclusion about a performance regression.

Profiling output is evidence for finding a bottleneck, not a performance guarantee. Check that the program still produces the correct result after any optimization and note version, input size and measurement conditions.

Worked Example

Read the code from the first line to the last. Identify which values are inputs, which operation is being demonstrated and what should happen before running it.

import cProfile
import pstats
from io import StringIO
profiler = cProfile.Profile()
profiler.runcall(lambda: sum(range(200)))
report = StringIO()
pstats.Stats(profiler, stream=report).sort_stats("cumulative").print_stats(3)
print("function calls" in report.getvalue())

Walkthrough: What Each Part Does

The imports make cProfile, pstats, io available. These are standard-library building blocks unless the example explicitly names an external tool.
The printed number or profile is diagnostic data. Repeat the observation and identify the unit before comparing values.

This demonstration focuses on one practical behavior. Before changing several lines, vary one input or one configuration choice and check whether the result changes for the reason you expected.

Example Output

True

The output above was captured by running the example in the available Python environment. The order of concurrent events, durations and platform-dependent values can legitimately differ on your computer.

Important Behavior and Edge Cases

Comparing stats from profiles gathered with different workloads or misunderstanding tottime versus cumtime.

pstats is for deterministic call statistics, not Tachyon sample-percent interpretation.

Practice Exercise

Sort the same profiler results by calls and cumulative time; explain which functions move to the top.

Write down the result you expect before running your changed code. Check at least one normal case and one boundary or failure case. If your example starts workers or opens resources, verify how they are cleaned up.

Further reading: official documentation and API reference.

Common Beginner Mistakes

Comparing stats from profiles gathered with different workloads or misunderstanding tottime versus cumtime.
Comparing results from different workloads or environments as if the measurements were directly interchangeable.

Key Takeaways

pstats.
pstats is for deterministic call statistics, not Tachyon sample-percent interpretation.
Practice: Sort the same profiler results by calls and cumulative time; explain which functions move to the top.