Python gc.collect() Function: Usage and Examples

gc.

Understanding the Concept

gc.collect() starts an explicit collection and returns the number of unreachable objects found. It is a diagnostic tool rather than a replacement for releasing owned resources.

Always close files and sockets explicitly even if cyclic garbage collection is available.

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 gc
class Node:
    pass
first = Node()
second = Node()
first.peer = second
second.peer = first
del first, second
print(gc.collect() >= 0)

Walkthrough: What Each Part Does

• The central operation is gc.collect(). Read its actual arguments: those values determine what is tested, logged, measured or scheduled. Then locate the line that inspects its result or handles a failure.
• The imports make gc available. These are standard-library building blocks unless the example explicitly names an external tool.
• The definition Node creates reusable behavior. Its body runs when called, awaited or instantiated; defining it alone does not run the body of an ordinary function.
• 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

Calling gc.collect() after every function call, adding overhead without fixing retained references.

Always close files and sockets explicitly even if cyclic garbage collection is available.

Practice Exercise

Build a reference cycle in an isolated example and measure collection count.

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

• Calling gc.collect() after every function call, adding overhead without fixing retained references.
• Comparing results from different workloads or environments as if the measurements were directly interchangeable.

Key Takeaways

• gc.
• Always close files and sockets explicitly even if cyclic garbage collection is available.
• Practice: Build a reference cycle in an isolated example and measure collection count.