python / python/cpython

Debug abort when calling <generator>.throw(StopIteration) on a generator that hasn't started yet

Aperta
#152,685 0 commenti 0 reazioni 0 assegnatari Vedi su GitHub

Nessuno ha ancora preso questa issue.

interpreter-core type-crash
Lingua principale
Python
Stelle
77.2k
Fork
36k
Metriche di merge delle PR
Metriche PR in attesa

Descrizione

Crash report

What happened?

In a debug build the following:

(_ for _ in ()).throw(StopIteration)

aborts with:

python3: Objects/genobject.c:318: PySendResult gen_send_ex2(PyGenObject *, PyObject *, PyObject **, int): Assertion `!PyErr_ExceptionMatches(PyExc_StopIteration)' failed.

Basically, calling generator.throw(StopIteration) on a generator that hasn't started yet triggers this.

In a non-debug build, the assert calls are not evaluated, but this very contrived example shows that there is a tortured violation of the PEP-479 fix that's possible (but unlikely to be seen in real code?):

Non-debug build script
from contextlib import contextmanager

@contextmanager
def transaction(level):
    print(f"begin {level}")
    try:
        yield
        print(f"commit {level}")
    except:
        print(f"rollback {level}")
        raise

def bad_helper(start_first):
    g = (_ for _ in (1, ))
    if start_first:
        next(g)
    return g.throw(StopIteration)

def rows(start_first):
    def next_row():
        with transaction(2):
            return bad_helper(start_first)
    return iter(next_row, None)

def run(start_first):
    print(f"Running with start_first={start_first}")
    try:
        with transaction(1):
            for row in rows(start_first):
                print(f"processed {row}")
    except BaseException as e:
        print(f"exception: {e!r}")
    finally:
        print("-=-=-=-=-=-  STOP -=-=-=-=-=-")

run(False)
run(True)

Running this outputs:

Running with start_first=False
begin 1
begin 2
rollback 2
commit 1
-=-=-=-=-=-  STOP -=-=-=-=-=-
Running with start_first=True
begin 1
begin 2
rollback 2
rollback 1
exception: RuntimeError('generator raised StopIteration')
-=-=-=-=-=-  STOP -=-=-=-=-=-

You can see that if the generator is started, both levels of transaction roll back correctly and we get a RuntimeError. But if the generator is not started, then tx2 is rolled back, but tx1 is committed, and no exception raised.

What's happening

Disassembly of <code object <genexpr> at 0xfffff7291360, file "eval", line 1>:
  --                 RESUME                   4

1:16-1:21            LOAD_FAST                0 (.0)
1:16-1:21            GET_ITER                 0
1:?-1:?              RETURN_GENERATOR
1:?-1:?              POP_TOP
1:0-1:0      L1:     RESUME                   0
1:16-1:21    L2:     FOR_ITER                 7 (to L3)
1:11-1:12            STORE_FAST_LOAD_FAST    17 (_, _)
1:5-1:6              YIELD_VALUE              0
1:5-1:6              RESUME                   9
1:5-1:6              POP_TOP
1:5-1:6              JUMP_BACKWARD            9 (to L2)
1:16-1:21    L3:     END_FOR
1:16-1:21            POP_ITER
1:16-1:21            LOAD_COMMON_CONSTANT     7 (None)
1:16-1:21            RETURN_VALUE

  --         L4:     CALL_INTRINSIC_1         3 (INTRINSIC_STOPITERATION_ERROR)
  --                 RERAISE                  1
ExceptionTable:
  L1 to L4 -> L4 [2] lasti

We see that the INTRINSIC_STOPITERATION_ERROR call at L4 resolves to stopiteration_error
which is where the Runtime Error is instantiated, and set:
https://github.com/python/cpython/blob/ecdef1773006529b0fea6639d0effeecbb41679c/Python/intrinsics.c#L172

  • BUT if the iterator has not started, we haven't reached L1 yet (the initial resume wasn't called). so the Exception table does not cover those opcodes, and no stopiteration_error wrapper is called.

The assertions are doing their fine job and catching the problem here, but I'm reasonably confident that the root issue is actually the opcode wrapping.

I'm not sure what the fix should be here, maybe it's as simple as somehow moving L1 up one opcode?

Introduced by

f4adb975061874566766f7a67206cb7b0439bc11 is the first bad commit
commit f4adb975061874566766f7a67206cb7b0439bc11
Author: Mark Shannon <mark@hotpy.org>
Date:   Thu Nov 3 04:38:51 2022 -0700

    GH-96793: Implement PEP 479 in bytecode. (GH-99006)

    * Handle converting StopIteration to RuntimeError in bytecode.

    * Add custom instruction for converting StopIteration into RuntimeError.
CPython versions tested on:

CPython main branch

Operating systems tested on:

macOS, Linux

Output from running 'python -VV' on the command line:

Python 3.14.5 (main, May 14 2026, 10:03:03) [GCC 15.2.1 20260209]

Linked PRs
  • gh-154492

Guida per i contributori

Apri la guida per i contributori

Come iniziare

  1. Leggi tutta la issue e poi la guida ai contributi del progetto.
  2. Commenta sulla issue per dire che te ne occupi tu — evita che due persone facciano lo stesso lavoro.
  3. Fai un fork del repository e lavora su un branch.
  4. Apri una pull request che faccia riferimento al numero della issue.

Direzione di ricerca

Inizia con i percorsi citati in Objects/genobject.c e Python/intrinsics.c, tracciando _gen_throw(), gen_throw_current_exception(), gen_send_ex2() e stopiteration_error(). Riproduci i casi di generator.throw(StopIteration) riportati nel report in una build di debug, quindi aggiungi o aggiorna la copertura di regressione pertinente in modo che l'assertion di debug non venga più attivata e che il comportamento documentato sia verificato.

Scritto dal modello di indicizzazione a partire dal testo della issue.

Valutazione

Stack tecnologico
python
Ambito
compilers
Tipo di issue
Bug
Difficoltà
5/5
Tempo stimato
Più di una settimana
Stato di attività
Ferma
Chiarezza
Da chiarire
Idoneità per principianti
25/100

Ricevi le nuove issue nella tua casella

Un breve riepilogo di issue GitHub adatte ai principianti.