Memory growth becomes suspicious when live allocations increase after equivalent work has finished and resources should have been released.
Understanding the Concept
Memory growth becomes suspicious when live allocations increase after equivalent work has finished and resources should have been released. Tracemalloc snapshots can compare those checkpoints.
Native extension allocations may not appear in Python tracemalloc statistics.
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()
cache = []
first = tracemalloc.take_snapshot()
for index in range(200):
cache.append(str(index) * 10)
second = tracemalloc.take_snapshot()
print(len(second.compare_to(first, "lineno")) > 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 loop repeats one well-defined unit of work. Check termination, ordering and whether an item may be processed more than once.
- 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
Assuming one peak-memory measurement proves a leak; caches may intentionally retain data.
Native extension allocations may not appear in Python tracemalloc statistics.
Practice Exercise
Clear cache between experiments and compare traced allocations after each completed cycle.
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
- Assuming one peak-memory measurement proves a leak; caches may intentionally retain data.
- Comparing results from different workloads or environments as if the measurements were directly interchangeable.
Key Takeaways
- Memory growth becomes suspicious when live allocations increase after equivalent work has finished and resources should have been released.
- Native extension allocations may not appear in Python tracemalloc statistics.
- Practice: Clear cache between experiments and compare traced allocations after each completed cycle.