python / python/cpython

Add `duration` and `visited` to the `gc.callbacks` and `gc.get_stats()` dicts

Open
#140,638 2 comments 0 reactions 1 assignee View on GitHub

@brandtbucher is already working on this.

Since Oct 26, 2025.

3.15 interpreter-core type-feature
Dominant language
Python
Stars
77.2k
Forks
35.9k
PR merge metrics
PR metrics pending

Description

Feature or enhancement

The documentation for gc.callbacks states that its primary use cases are:

Gathering statistics about garbage collection, such as how often various generations are collected, and how long the collection takes.

We can be doing a bit more to serve users of gc.callbacks (and gc.get_stats() too). In particular:

  • duration: Collection time, which is mentioned above, is something we already have a low-overhead mechanism to measure for use with the gc.DEBUG_STATS flag. It's a bit finnicky to get right in a callback, since they're called in two phases (so the start time has to be stashed away somewhere between calls).
  • visited: The number of visited objects is also extremely useful (collected/visited gives you the efficiency of your collection). Getting this information from Python is very expensive (sum(len(gc.get_objects(g)) for g in range(gen + 1))), but it's cheap for us to provide from the GC itself.

With these changes, many users can probably get away with just handling stop events, or ditching callbacks entirely and just periodically checking gc.get_stats() instead for aggregates.

I already ran this idea by @nascheme and @markshannon this week. They were supportive of the idea, so I plan on working on this soon.

(Supersedes #140515.)

Linked PRs
  • gh-141720
  • gh-141814

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Assessment

This issue has not been assessed yet.

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.