python / python/cpython

quitting a debugger based on the bdb module does not always stop code execution

Aperta
#149,309 3 commenti 0 reazioni 0 assegnatari Vedi su GitHub

Nessuno ha ancora preso questa issue.

stdlib type-feature
Lingua principale
Python
Stelle
77.2k
Fork
35.9k
Metriche di merge delle PR
Metriche PR in attesa

Descrizione

Bug report

Bug description:

I encountered a bug while working with the Pyzo Python IDE, and the bug itself is located in the bdb module of Python's standard library. The same bug occurs when using the IDLE Python IDE, as it also uses bdb for the debugger.

When the debugger pauses code execution, e.g. at a breakpoint, the user can decide to quit debugging, which normally stops the execution of further code in the script to be debugged. But this does not work when the breakpoint is inside the "try" block of a try-except-clause and when exceptions are caught and ignored.

The Bdb class internally stops debugging by raising a BdbQuit error. But BdbQuit is like almost all exceptions derived from the Exception class, and therefore the script to be debugged can catch and dismiss the stop:

https://github.com/python/cpython/blob/1fc2b38d63170dd065efc2bc60e861f32c033b17/Lib/bdb.py#L15-L18

I think, it would be safer to change the definition of the BdbQuit class to:

class BdbQuit(BaseException):
    """Exception to give up completely."""

Though, it does not prevent the problem when there is an except clause like except: in the code to be debugged, but this is discouraged anyways.

As far as I have seen, the class definition of BdbQuit basically has not changed since Python v2.3, and so it predates BaseExceptions which where added to Python v2.5 via PEP 352.

Here is an example code to reproduce the problem and demonstrate the fix:

"""
* Save this code somewhere as a Python script (e.g. "/tmp/myscript.py").
* Launch IDLE (the Python IDE).
* Open this Python script in IDLE.
* Set breakpoints in the two code lines where indicated via comments.
    You can do this via the context menu when right-clicking on the line.
* Switch to the Python Shell window in IDLE (via menu "Run -> Python Shell".
* Open the Debugger (via menu "Debug -> Debugger" in the Python Shell).
* In the IDLE editor window, run the script (via menu "Run -> Run Module").
* Press the "Go" button in the "Debug Control" window.
* Execution stops at the line with the first breakpoint.
* Pressing the "Quit" button now would not execute any of the remaining lines.
* But we press "Go" instead of "Quit" to reach the second breakpoint.
* Now, really press "Quit", and see that script code execution is NOT stopped.
    There are some further text outputs from the print functions in the Shell
    window.
* Enable monkey-patching by changing "do_monkeypatch = False" to "do_monkeypatch = True".
    Or edit file "bdb.py" in Python's lib directory:
        change "class BdbQuit(Exception):" to "class BdbQuit(BaseException):"
* Do all the previous steps again, and you will see, that there is no more
    code execution in the script when quitting debugging at the second breakpoint.
"""

do_monkeypatch = False

if do_monkeypatch:
    import bdb

    if issubclass(bdb.BdbQuit, Exception):
        class BdbQuit(BaseException): pass

        bdb.BdbQuit = BdbQuit


print('this is before the first breakpoint')
a = 1  # <-- set a breakpoint in this line
print('this is after the first breakpoint')

try:
    print('this is before the second breakpoint')
    a = 2  # <-- set a breakpoint in this line
    print('this is after the second breakpoint, when continuing execution')
except Exception as e:
    print('this is after the second breakpoint, when quitting the debugger')
    print('got an exception, but ignoring it:', repr(e))

print('deleting important files :-(')
CPython versions tested on:

3.14

Operating systems tested on:

Linux

Linked PRs
  • gh-149337

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 da Lib/bdb.py, alla definizione di BdbQuit collegata nell'issue, quindi esegui lo script di riproduzione fornito per IDLE con il breakpoint all'interno del blocco try. Il lavoro è completato quando uscire dal debugger impedisce l'esecuzione del codice rimanente dello script anche quando l'eccezione viene catturata; esamina il PR collegato gh-149337 prima di iniziare.

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

Valutazione

Stack tecnologico
python
Ambito
devtools
Tipo di issue
Bug
Difficoltà
3/5
Tempo stimato
1-2 giorni
Stato di attività
Ferma
Chiarezza
Abbastanza chiara
Idoneità per principianti
35/100

Ricevi le nuove issue nella tua casella

Un breve riepilogo di issue GitHub adatte ai principianti.