tracemalloc records Python-tracked memory allocations with locations so you can compare snapshots and find growth.
Understanding the Concept
tracemalloc records Python-tracked memory allocations with locations so you can compare snapshots and find growth. It does not cover every byte allocated by native extensions or the operating system.
Start tracing early enough to observe allocations relevant to the investigation.
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 tracemalloc
tracemalloc.start()
values = [str(i) for i in range(500)]
current, peak = tracemalloc.get_traced_memory()
print(peak >= current >= 0)
tracemalloc.stop()Walkthrough: What Each Part Does
- The imports make tracemalloc 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
TrueThe 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
Treating traced bytes as the full process RSS or assuming all retained objects are leaks.
Start tracing early enough to observe allocations relevant to the investigation.
Practice Exercise
Capture memory before and after releasing a temporary list; discuss why peak and current differ.
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
- Treating traced bytes as the full process RSS or assuming all retained objects are leaks.
- Comparing results from different workloads or environments as if the measurements were directly interchangeable.
Key Takeaways
- tracemalloc records Python-tracked memory allocations with locations so you can compare snapshots and find growth.
- Start tracing early enough to observe allocations relevant to the investigation.
- Practice: Capture memory before and after releasing a temporary list; discuss why peak and current differ.