Structseq objects created with PyStructSequence_New() are not tracked by the GC
Dieses Issue hat noch niemand übernommen.
- Vorherrschende Sprache
- Python
- Sterne
- 77.2k
- Forks
- 35.9k
- PR-Merge-Kennzahlen
- PR-Kennzahlen ausstehend
Beschreibung
Bug report
PyStructSequence_New() allocates the object with PyObject_GC_NewVar() but never calls PyObject_GC_Track(). Only structseq_new_impl() (calling the type from Python) and __replace__() track the result (bpo-37126, gh-145376). All 45 C callers of PyStructSequence_New() in the tree, including make_unraisable_hook_args() in Python/errors.c, produce objects which the GC never sees, so a reference cycle through them is never collected.
Most structseq objects hold only ints and strings, but sys.UnraisableHookArgs holds the exception and its traceback, which keeps the frames alive (the current frame, when the exception has no traceback, format_unraisable_v() synthesizes one from it). Storing the hook argument in something reachable from those frames creates an uncollectable cycle:
import gc
import sys
import weakref
class Holder:
pass
def f():
holder = Holder()
def hook(unraisable):
holder.unraisable = unraisable
sys.unraisablehook = hook
class C:
def __del__(self):
raise ValueError
C()
print(gc.is_tracked(holder.unraisable))
return weakref.ref(holder)
wr = f()
sys.unraisablehook = sys.__unraisablehook__
gc.collect()
print(wr())
Output (3.13 and main):
False
<__main__.Holder object at 0x7a7fda9d22c0>
Expected: True and None.
test.support.catch_unraisable_exception() works around this by deleting its unraisable attribute on exit (bpo-37261). I hit it in test_class.test_detach_materialized_dict_no_memory(), which leaks about 140 references per run as soon as it keeps ex.unraisable in a local variable.
The simplest fix is to call _PyObject_GC_TRACK() in PyStructSequence_New(), as PyTuple_New() does, and drop the explicit calls in structseq_new_impl() and structseq_replace(). Py_VISIT() handles the NULL items of a partially filled object.
Linked PRs
- gh-157447
Beitragsleitfaden
Erste Schritte
- Lies das ganze Issue und danach den Beitragsleitfaden des Projekts.
- Schreib ins Issue, dass du es übernimmst — das erspart doppelte Arbeit.
- Forke das Repository und arbeite in einem Branch.
- Öffne einen Pull Request, der die Issue-Nummer nennt.
Rechercherichtung
Beginne in Python/errors.c bei make_unraisable_hook_args(), untersuche anschließend PyStructSequence_New() sowie die im Bericht beschriebenen Aufrufer von structseq_new_impl() und structseq_replace(). Führe test_class.test_detach_materialized_dict_no_memory() aus und reproduziere das gc.is_tracked()-Beispiel. Als erledigt gilt die Aufgabe, wenn über die C API erstellte structseq-Objekte getrackt werden und der demonstrierte Referenzzyklus eingesammelt wird.
Vom Indexierungsmodell aus dem Issue-Text verfasst.
Bewertung
- Tech-Stack
- c, python
- Bereich
- backend
- Issue-Typ
- Bug
- Schwierigkeit
- 4/5
- Geschätzter Aufwand
- 3-5 Tage
- Aktivitätsstatus
- Veraltet
- Klarheit
- Klar beschrieben
- Anfängerfreundlichkeit
- 25/100