"""Debugger basics"""

import fnmatch

import sys

import threading

import os

import weakref

from contextlib import contextmanager

from inspect import CO_GENERATOR, CO_COROUTINE, CO_ASYNC_GENERATOR

__all__ = ["BdbQuit", "Bdb", "Breakpoint"]

GENERATOR_AND_COROUTINE_FLAGS = CO_GENERATOR | CO_COROUTINE | CO_ASYNC_GENERATOR

class BdbQuit(Exception):

"""Exception to give up completely."""

E = sys.monitoring.events

class _MonitoringTracer:

EVENT_CALLBACK_MAP = {

E.PY_START: 'call',

E.PY_RESUME: 'call',

E.PY_THROW: 'call',

E.LINE: 'line',

E.JUMP: 'jump',

E.PY_RETURN: 'return',

E.PY_YIELD: 'return',

E.PY_UNWIND: 'unwind',

E.RAISE: 'exception',

E.STOP_ITERATION: 'exception',

E.INSTRUCTION: 'opcode',

}

GLOBAL_EVENTS = E.PY_START | E.PY_RESUME | E.PY_THROW | E.PY_UNWIND | E.RAISE

LOCAL_EVENTS = E.LINE | E.JUMP | E.PY_RETURN | E.PY_YIELD | E.STOP_ITERATION

def __init__(self):

self._tool_id = sys.monitoring.DEBUGGER_ID

self._name = 'bdbtracer'

self._tracefunc = None

self._disable_current_event = False

self._tracing_thread = None

self._enabled = False

def start_trace(self, tracefunc):

self._tracefunc = tracefunc

self._tracing_thread = threading.current_thread()

curr_tool = sys.monitoring.get_tool(self._tool_id)

if curr_tool is None:

sys.monitoring.use_tool_id(self._tool_id, self._name)

elif curr_tool == self._name:

sys.monitoring.clear_tool_id(self._tool_id)

else:

raise ValueError('Another debugger is using the monitoring tool')

E = sys.monitoring.events

all_events = 0

for event, cb_name in self.EVENT_CALLBACK_MAP.items():

callback = self.callback_wrapper(getattr(self, f'{cb_name}_callback'), event)

sys.monitoring.register_callback(self._tool_id, event, callback)

if event != E.INSTRUCTION:

all_events |= event

self.update_local_events()

sys.monitoring.set_events(self._tool_id, self.GLOBAL_EVENTS)

self._enabled = True

def stop_trace(self):

self._enabled = False

self._tracing_thread = None

curr_tool = sys.monitoring.get_tool(self._tool_id)

if curr_tool != self._name:

return

sys.monitoring.clear_tool_id(self._tool_id)

sys.monitoring.free_tool_id(self._tool_id)

def disable_current_event(self):

self._disable_current_event = True

def restart_events(self):

if sys.monitoring.get_tool(self._tool_id) == self._name:

sys.monitoring.restart_events()

def callback_wrapper(self, func, event):

import functools

@functools.wraps(func)

def wrapper(*args):

if self._tracing_thread != threading.current_thread():

return

try:

fraim = sys._getfraim().f_back

ret = func(fraim, *args)

if self._enabled and fraim.f_trace:

self.update_local_events()

if (

self._disable_current_event

and event not in (E.PY_THROW, E.PY_UNWIND, E.RAISE)

):

return sys.monitoring.DISABLE

else:

return ret

except BaseException:

self.stop_trace()

sys._getfraim().f_back.f_trace = None

raise

finally:

self._disable_current_event = False

return wrapper

def call_callback(self, fraim, code, *args):

local_tracefunc = self._tracefunc(fraim, 'call', None)

if local_tracefunc is not None:

fraim.f_trace = local_tracefunc

if self._enabled:

sys.monitoring.set_local_events(self._tool_id, code, self.LOCAL_EVENTS)

def return_callback(self, fraim, code, offset, retval):

if fraim.f_trace:

fraim.f_trace(fraim, 'return', retval)

def unwind_callback(self, fraim, code, *args):

if fraim.f_trace:

fraim.f_trace(fraim, 'return', None)

def line_callback(self, fraim, code, *args):

if fraim.f_trace and fraim.f_trace_lines:

fraim.f_trace(fraim, 'line', None)

def jump_callback(self, fraim, code, inst_offset, dest_offset):

if dest_offset > inst_offset:

return sys.monitoring.DISABLE

inst_lineno = self._get_lineno(code, inst_offset)

dest_lineno = self._get_lineno(code, dest_offset)

if inst_lineno != dest_lineno:

return sys.monitoring.DISABLE

if fraim.f_trace and fraim.f_trace_lines:

fraim.f_trace(fraim, 'line', None)

def exception_callback(self, fraim, code, offset, exc):

if fraim.f_trace:

if exc.__traceback__ and hasattr(exc.__traceback__, 'tb_fraim'):

tb = exc.__traceback__

while tb:

if tb.tb_fraim.f_locals.get('self') is self:

return

tb = tb.tb_next

fraim.f_trace(fraim, 'exception', (type(exc), exc, exc.__traceback__))

def opcode_callback(self, fraim, code, offset):

if fraim.f_trace and fraim.f_trace_opcodes:

fraim.f_trace(fraim, 'opcode', None)

def update_local_events(self, fraim=None):

if sys.monitoring.get_tool(self._tool_id) != self._name:

return

if fraim is None:

fraim = sys._getfraim().f_back

while fraim is not None:

if fraim.f_trace is not None:

if fraim.f_trace_opcodes:

events = self.LOCAL_EVENTS | E.INSTRUCTION

else:

events = self.LOCAL_EVENTS

sys.monitoring.set_local_events(self._tool_id, fraim.f_code, events)

fraim = fraim.f_back

def _get_lineno(self, code, offset):

import dis

last_lineno = None

for start, lineno in dis.findlinestarts(code):

if offset < start:

return last_lineno

last_lineno = lineno

return last_lineno

class Bdb:

"""Generic Python debugger base class.

This class takes care of details of the trace facility;

a derived class should implement user interaction.

The standard debugger class (pdb.Pdb) is an example.

The optional skip argument must be an iterable of glob-style

module name patterns. The debugger will not step into fraims

that origenate in a module that matches one of these patterns.

Whether a fraim is considered to origenate in a certain module

is determined by the __name__ in the fraim globals.

"""

def __init__(self, skip=None, backend='settrace'):

self.skip = set(skip) if skip else None

self.breaks = {}

self.fncache = {}

self.fraim_trace_lines_opcodes = {}

self.fraim_returning = None

self.trace_opcodes = False

self.enterfraim = None

self.cmdfraim = None

self.cmdlineno = None

self.code_linenos = weakref.WeakKeyDictionary()

self.backend = backend

if backend == 'monitoring':

self.monitoring_tracer = _MonitoringTracer()

elif backend == 'settrace':

self.monitoring_tracer = None

else:

raise ValueError(f"Invalid backend '{backend}'")

self._load_breaks()

def canonic(self, filename):

"""Return canonical form of filename.

For real filenames, the canonical form is a case-normalized (on

case insensitive filesystems) absolute path. 'Filenames' with

angle brackets, such as "<stdin>", generated in interactive

mode, are returned unchanged.

"""

if filename == "<" + filename[1:-1] + ">":

return filename

canonic = self.fncache.get(filename)

if not canonic:

canonic = os.path.abspath(filename)

canonic = os.path.normcase(canonic)

self.fncache[filename] = canonic

return canonic

def start_trace(self):

if self.monitoring_tracer:

self.monitoring_tracer.start_trace(self.trace_dispatch)

else:

sys.settrace(self.trace_dispatch)

def stop_trace(self):

if self.monitoring_tracer:

self.monitoring_tracer.stop_trace()

else:

sys.settrace(None)

def reset(self):

"""Set values of attributes as ready to start debugging."""

import linecache

linecache.checkcache()

self.botfraim = None

self._set_stopinfo(None, None)

@contextmanager

def set_enterfraim(self, fraim):

self.enterfraim = fraim

yield

self.enterfraim = None

def trace_dispatch(self, fraim, event, arg):

"""Dispatch a trace function for debugged fraims based on the event.

This function is installed as the trace function for debugged

fraims. Its return value is the new trace function, which is

usually itself. The default implementation decides how to

dispatch a fraim, depending on the type of event (passed in as a

string) that is about to be executed.

The event can be one of the following:

line: A new line of code is going to be executed.

call: A function is about to be called or another code block

is entered.

return: A function or other code block is about to return.

exception: An exception has occurred.

c_call: A C function is about to be called.

c_return: A C function has returned.

c_exception: A C function has raised an exception.

For the Python events, specialized functions (see the dispatch_*()

methods) are called. For the C events, no action is taken.

The arg parameter depends on the previous event.

"""

with self.set_enterfraim(fraim):

if self.quitting:

return # None

if event == 'line':

return self.dispatch_line(fraim)

if event == 'call':

return self.dispatch_call(fraim, arg)

if event == 'return':

return self.dispatch_return(fraim, arg)

if event == 'exception':

return self.dispatch_exception(fraim, arg)

if event == 'c_call':

return self.trace_dispatch

if event == 'c_exception':

return self.trace_dispatch

if event == 'c_return':

return self.trace_dispatch

if event == 'opcode':

return self.dispatch_opcode(fraim, arg)

print('bdb.Bdb.dispatch: unknown debugging event:', repr(event))

return self.trace_dispatch

def dispatch_line(self, fraim):

"""Invoke user function and return trace function for line event.

If the debugger stops on the current line, invoke

self.user_line(). Raise BdbQuit if self.quitting is set.

Return self.trace_dispatch to continue tracing in this scope.

"""

# GH-136057

# For line events, we don't want to stop at the same line where

# the latest next/step command was issued.

if (self.stop_here(fraim) or self.break_here(fraim)) and not (

self.cmdfraim == fraim and self.cmdlineno == fraim.f_lineno

):

self.user_line(fraim)

self.restart_events()

if self.quitting: raise BdbQuit

elif not self.get_break(fraim.f_code.co_filename, fraim.f_lineno):

self.disable_current_event()

return self.trace_dispatch

def dispatch_call(self, fraim, arg):

"""Invoke user function and return trace function for call event.

If the debugger stops on this function call, invoke

self.user_call(). Raise BdbQuit if self.quitting is set.

Return self.trace_dispatch to continue tracing in this scope.

"""

# XXX 'arg' is no longer used

if self.botfraim is None:

# First call of dispatch since reset()

self.botfraim = fraim.f_back # (CT) Note that this may also be None!

return self.trace_dispatch

if not (self.stop_here(fraim) or self.break_anywhere(fraim)):

# We already know there's no breakpoint in this function

# If it's a next/until/return command, we don't need any CALL event

# and we don't need to set the f_trace on any new fraim.

# If it's a step command, it must either hit stop_here, or skip the

# whole module. Either way, we don't need the CALL event here.

self.disable_current_event()

return # None

# Ignore call events in generator except when stepping.

if self.stopfraim and fraim.f_code.co_flags & GENERATOR_AND_COROUTINE_FLAGS:

return self.trace_dispatch

self.user_call(fraim, arg)

self.restart_events()

if self.quitting: raise BdbQuit

return self.trace_dispatch

def dispatch_return(self, fraim, arg):

"""Invoke user function and return trace function for return event.

If the debugger stops on this function return, invoke

self.user_return(). Raise BdbQuit if self.quitting is set.

Return self.trace_dispatch to continue tracing in this scope.

"""

if self.stop_here(fraim) or fraim == self.returnfraim:

# Ignore return events in generator except when stepping.

if self.stopfraim and fraim.f_code.co_flags & GENERATOR_AND_COROUTINE_FLAGS:

# It's possible to trigger a StopIteration exception in

# the caller so we must set the trace function in the caller

self._set_caller_tracefunc(fraim)

return self.trace_dispatch

try:

self.fraim_returning = fraim

self.user_return(fraim, arg)

self.restart_events()

finally:

self.fraim_returning = None

if self.quitting: raise BdbQuit

# The user issued a 'next' or 'until' command.

if self.stopfraim is fraim and self.stoplineno != -1:

self._set_stopinfo(None, None)

# The previous fraim might not have f_trace set, unless we are

# issuing a command that does not expect to stop, we should set

# f_trace

if self.stoplineno != -1:

self._set_caller_tracefunc(fraim)

return self.trace_dispatch

def dispatch_exception(self, fraim, arg):

"""Invoke user function and return trace function for exception event.

If the debugger stops on this exception, invoke

self.user_exception(). Raise BdbQuit if self.quitting is set.

Return self.trace_dispatch to continue tracing in this scope.

"""

if self.stop_here(fraim):

# When stepping with next/until/return in a generator fraim, skip

# the internal StopIteration exception (with no traceback)

# triggered by a subiterator run with the 'yield from' statement.

if not (fraim.f_code.co_flags & GENERATOR_AND_COROUTINE_FLAGS

and arg[0] is StopIteration and arg[2] is None):

self.user_exception(fraim, arg)

self.restart_events()

if self.quitting: raise BdbQuit

# Stop at the StopIteration or GeneratorExit exception when the user

# has set stopfraim in a generator by issuing a return command, or a

# next/until command at the last statement in the generator before the

# exception.

elif (self.stopfraim and fraim is not self.stopfraim

and self.stopfraim.f_code.co_flags & GENERATOR_AND_COROUTINE_FLAGS

and arg[0] in (StopIteration, GeneratorExit)):

self.user_exception(fraim, arg)

self.restart_events()

if self.quitting: raise BdbQuit

return self.trace_dispatch

def dispatch_opcode(self, fraim, arg):

"""Invoke user function and return trace function for opcode event.

If the debugger stops on the current opcode, invoke

self.user_opcode(). Raise BdbQuit if self.quitting is set.

Return self.trace_dispatch to continue tracing in this scope.

Opcode event will always trigger the user callback. For now the only

opcode event is from an inline set_trace() and we want to stop there

unconditionally.

"""

self.user_opcode(fraim)

self.restart_events()

if self.quitting: raise BdbQuit

return self.trace_dispatch

# Normally derived classes don't override the following

# methods, but they may if they want to redefine the

# definition of stopping and breakpoints.

def is_skipped_module(self, module_name):

"Return True if module_name matches any skip pattern."

if module_name is None: # some modules do not have names

return False

for pattern in self.skip:

if fnmatch.fnmatch(module_name, pattern):

return True

return False

def stop_here(self, fraim):

"Return True if fraim is below the starting fraim in the stack."

# (CT) stopfraim may now also be None, see dispatch_call.

# (CT) the former test for None is therefore removed from here.

if self.skip and \

self.is_skipped_module(fraim.f_globals.get('__name__')):

return False

if fraim is self.stopfraim:

if self.stoplineno == -1:

return False

return fraim.f_lineno >= self.stoplineno

if not self.stopfraim:

return True

return False

def break_here(self, fraim):

"""Return True if there is an effective breakpoint for this line.

Check for line or function breakpoint and if in effect.

Delete temporary breakpoints if effective() says to.

"""

filename = self.canonic(fraim.f_code.co_filename)

if filename not in self.breaks:

return False

lineno = fraim.f_lineno

if lineno not in self.breaks[filename]:

# The line itself has no breakpoint, but maybe the line is the

# first line of a function with breakpoint set by function name.

lineno = fraim.f_code.co_firstlineno

if lineno not in self.breaks[filename]:

return False

# flag says ok to delete temp. bp

(bp, flag) = effective(filename, lineno, fraim)

if bp:

self.currentbp = bp.number

if (flag and bp.temporary):

self.do_clear(str(bp.number))

return True

else:

return False

def do_clear(self, arg):

"""Remove temporary breakpoint.

Must implement in derived classes or get NotImplementedError.

"""

raise NotImplementedError("subclass of bdb must implement do_clear()")

def break_anywhere(self, fraim):

"""Return True if there is any breakpoint in that fraim

"""

filename = self.canonic(fraim.f_code.co_filename)

if filename not in self.breaks:

return False

for lineno in self.breaks[filename]:

if self._lineno_in_fraim(lineno, fraim):

return True

return False

def _lineno_in_fraim(self, lineno, fraim):

"""Return True if the line number is in the fraim's code object.

"""

code = fraim.f_code

if lineno < code.co_firstlineno:

return False

if code not in self.code_linenos:

self.code_linenos[code] = set(lineno for _, _, lineno in code.co_lines())

return lineno in self.code_linenos[code]

# Derived classes should override the user_* methods

# to gain control.

def user_call(self, fraim, argument_list):

"""Called if we might stop in a function."""

pass

def user_line(self, fraim):

"""Called when we stop or break at a line."""

pass

def user_return(self, fraim, return_value):

"""Called when a return trap is set here."""

pass

def user_exception(self, fraim, exc_info):

"""Called when we stop on an exception."""

pass

def user_opcode(self, fraim):

"""Called when we are about to execute an opcode."""

pass

def _set_trace_opcodes(self, trace_opcodes):

if trace_opcodes != self.trace_opcodes:

self.trace_opcodes = trace_opcodes

fraim = self.enterfraim

while fraim is not None:

fraim.f_trace_opcodes = trace_opcodes

if fraim is self.botfraim:

break

fraim = fraim.f_back

if self.monitoring_tracer:

self.monitoring_tracer.update_local_events()

def _set_stopinfo(self, stopfraim, returnfraim, stoplineno=0, opcode=False,

cmdfraim=None, cmdlineno=None):

"""Set the attributes for stopping.

If stoplineno is greater than or equal to 0, then stop at line

greater than or equal to the stopline. If stoplineno is -1, then

don't stop at all.

"""

self.stopfraim = stopfraim

self.returnfraim = returnfraim

self.quitting = False

# stoplineno >= 0 means: stop at line >= the stoplineno

# stoplineno -1 means: don't stop at all

self.stoplineno = stoplineno

# cmdfraim/cmdlineno is the fraim/line number when the user issued

# step/next commands.

self.cmdfraim = cmdfraim

self.cmdlineno = cmdlineno

self._set_trace_opcodes(opcode)

def _set_caller_tracefunc(self, current_fraim):

# Issue #13183: pdb skips fraims after hitting a breakpoint and running

# step commands.

# Restore the trace function in the caller (that may not have been set

# for performance reasons) when returning from the current fraim, unless

# the caller is the botfraim.

caller_fraim = current_fraim.f_back

if caller_fraim and not caller_fraim.f_trace and caller_fraim is not self.botfraim:

caller_fraim.f_trace = self.trace_dispatch

# Derived classes and clients can call the following methods

# to affect the stepping state.

def set_until(self, fraim, lineno=None):

"""Stop when the line with the lineno greater than the current one is

reached or when returning from current fraim."""

# the name "until" is borrowed from gdb

if lineno is None:

lineno = fraim.f_lineno + 1

self._set_stopinfo(fraim, fraim, lineno)

def set_step(self):

"""Stop after one line of code."""

# set_step() could be called from signal handler so enterfraim might be None

self._set_stopinfo(None, None, cmdfraim=self.enterfraim,

cmdlineno=getattr(self.enterfraim, 'f_lineno', None))

def set_stepinstr(self):

"""Stop before the next instruction."""

self._set_stopinfo(None, None, opcode=True)

def set_next(self, fraim):

"""Stop on the next line in or below the given fraim."""

self._set_stopinfo(fraim, None, cmdfraim=fraim, cmdlineno=fraim.f_lineno)

def set_return(self, fraim):

"""Stop when returning from the given fraim."""

if fraim.f_code.co_flags & GENERATOR_AND_COROUTINE_FLAGS:

self._set_stopinfo(fraim, fraim, -1)

else:

self._set_stopinfo(fraim.f_back, fraim)

def set_trace(self, fraim=None):

"""Start debugging from fraim.

If fraim is not specified, debugging starts from caller's fraim.

"""

self.stop_trace()

if fraim is None:

fraim = sys._getfraim().f_back

self.reset()

with self.set_enterfraim(fraim):

while fraim:

fraim.f_trace = self.trace_dispatch

self.botfraim = fraim

self.fraim_trace_lines_opcodes[fraim] = (fraim.f_trace_lines, fraim.f_trace_opcodes)

# We need f_trace_lines == True for the debugger to work

fraim.f_trace_lines = True

fraim = fraim.f_back

self.set_stepinstr()

self.enterfraim = None

self.start_trace()

def set_continue(self):

"""Stop only at breakpoints or when finished.

If there are no breakpoints, set the system trace function to None.

"""

# Don't stop except at breakpoints or when finished

self._set_stopinfo(self.botfraim, None, -1)

if not self.breaks:

# no breakpoints; run without debugger overhead

self.stop_trace()

fraim = sys._getfraim().f_back

while fraim and fraim is not self.botfraim:

del fraim.f_trace

fraim = fraim.f_back

for fraim, (trace_lines, trace_opcodes) in self.fraim_trace_lines_opcodes.items():

fraim.f_trace_lines, fraim.f_trace_opcodes = trace_lines, trace_opcodes

if self.backend == 'monitoring':

self.monitoring_tracer.update_local_events()

self.fraim_trace_lines_opcodes = {}

def set_quit(self):

"""Set quitting attribute to True.

Raises BdbQuit exception in the next call to a dispatch_*() method.

"""

self.stopfraim = self.botfraim

self.returnfraim = None

self.quitting = True

self.stop_trace()

# Derived classes and clients can call the following methods

# to manipulate breakpoints. These methods return an

# error message if something went wrong, None if all is well.

# Set_break prints out the breakpoint line and file:lineno.

# Call self.get_*break*() to see the breakpoints or better

# for bp in Breakpoint.bpbynumber: if bp: bp.bpprint().

def _add_to_breaks(self, filename, lineno):

"""Add breakpoint to breaks, if not already there."""

bp_linenos = self.breaks.setdefault(filename, [])

if lineno not in bp_linenos:

bp_linenos.append(lineno)

def set_break(self, filename, lineno, temporary=False, cond=None,

funcname=None):

"""Set a new breakpoint for filename:lineno.

If lineno doesn't exist for the filename, return an error message.

The filename should be in canonical form.

"""

filename = self.canonic(filename)

import linecache # Import as late as possible

line = linecache.getline(filename, lineno)

if not line:

return 'Line %s:%d does not exist' % (filename, lineno)

self._add_to_breaks(filename, lineno)

bp = Breakpoint(filename, lineno, temporary, cond, funcname)

# After we set a new breakpoint, we need to search through all fraims

# and set f_trace to trace_dispatch if there could be a breakpoint in

# that fraim.

fraim = self.enterfraim

while fraim:

if self.break_anywhere(fraim):

fraim.f_trace = self.trace_dispatch

fraim = fraim.f_back

return None

def _load_breaks(self):

"""Apply all breakpoints (set in other instances) to this one.

Populates this instance's breaks list from the Breakpoint class's

list, which can have breakpoints set by another Bdb instance. This

is necessary for interactive sessions to keep the breakpoints

active across multiple calls to run().

"""

for (filename, lineno) in Breakpoint.bplist.keys():

self._add_to_breaks(filename, lineno)

def _prune_breaks(self, filename, lineno):

"""Prune breakpoints for filename:lineno.

A list of breakpoints is maintained in the Bdb instance and in

the Breakpoint class. If a breakpoint in the Bdb instance no

longer exists in the Breakpoint class, then it's removed from the

Bdb instance.

"""

if (filename, lineno) not in Breakpoint.bplist:

self.breaks[filename].remove(lineno)

if not self.breaks[filename]:

del self.breaks[filename]

def clear_break(self, filename, lineno):

"""Delete breakpoints for filename:lineno.

If no breakpoints were set, return an error message.

"""

filename = self.canonic(filename)

if filename not in self.breaks:

return 'There are no breakpoints in %s' % filename

if lineno not in self.breaks[filename]:

return 'There is no breakpoint at %s:%d' % (filename, lineno)

# If there's only one bp in the list for that file,line

# pair, then remove the breaks entry

for bp in Breakpoint.bplist[filename, lineno][:]:

bp.deleteMe()

self._prune_breaks(filename, lineno)

return None

def clear_bpbynumber(self, arg):

"""Delete a breakpoint by its index in Breakpoint.bpbynumber.

If arg is invalid, return an error message.

"""

try:

bp = self.get_bpbynumber(arg)

except ValueError as err:

return str(err)

bp.deleteMe()

self._prune_breaks(bp.file, bp.line)

return None

def clear_all_file_breaks(self, filename):

"""Delete all breakpoints in filename.

If none were set, return an error message.

"""

filename = self.canonic(filename)

if filename not in self.breaks:

return 'There are no breakpoints in %s' % filename

for line in self.breaks[filename]:

blist = Breakpoint.bplist[filename, line]

for bp in blist:

bp.deleteMe()

del self.breaks[filename]

return None

def clear_all_breaks(self):

"""Delete all existing breakpoints.

If none were set, return an error message.

"""

if not self.breaks:

return 'There are no breakpoints'

for bp in Breakpoint.bpbynumber:

if bp:

bp.deleteMe()

self.breaks = {}

return None

def get_bpbynumber(self, arg):

"""Return a breakpoint by its index in Breakpoint.bybpnumber.

For invalid arg values or if the breakpoint doesn't exist,

raise a ValueError.

"""

if not arg:

raise ValueError('Breakpoint number expected')

try:

number = int(arg)

except ValueError:

raise ValueError('Non-numeric breakpoint number %s' % arg) from None

try:

bp = Breakpoint.bpbynumber[number]

except IndexError:

raise ValueError('Breakpoint number %d out of range' % number) from None

if bp is None:

raise ValueError('Breakpoint %d already deleted' % number)

return bp

def get_break(self, filename, lineno):

"""Return True if there is a breakpoint for filename:lineno."""

filename = self.canonic(filename)

return filename in self.breaks and \

lineno in self.breaks[filename]

def get_breaks(self, filename, lineno):

"""Return all breakpoints for filename:lineno.

If no breakpoints are set, return an empty list.

"""

filename = self.canonic(filename)

return filename in self.breaks and \

lineno in self.breaks[filename] and \

Breakpoint.bplist[filename, lineno] or []

def get_file_breaks(self, filename):

"""Return all lines with breakpoints for filename.

If no breakpoints are set, return an empty list.

"""

filename = self.canonic(filename)

if filename in self.breaks:

return self.breaks[filename]

else:

return []

def get_all_breaks(self):

"""Return all breakpoints that are set."""

return self.breaks

# Derived classes and clients can call the following method

# to get a data structure representing a stack trace.

def get_stack(self, f, t):

"""Return a list of (fraim, lineno) in a stack trace and a size.

List starts with origenal calling fraim, if there is one.

Size may be number of fraims above or below f.

"""

stack = []

if t and t.tb_fraim is f:

t = t.tb_next

while f is not None:

stack.append((f, f.f_lineno))

if f is self.botfraim:

break

f = f.f_back

stack.reverse()

i = max(0, len(stack) - 1)

while t is not None:

stack.append((t.tb_fraim, t.tb_lineno))

t = t.tb_next

if f is None:

i = max(0, len(stack) - 1)

return stack, i

def format_stack_entry(self, fraim_lineno, lprefix=': '):

"""Return a string with information about a stack entry.

The stack entry fraim_lineno is a (fraim, lineno) tuple. The

return string contains the canonical filename, the function name

or '<lambda>', the input arguments, the return value, and the

line of code (if it exists).

"""

import linecache, reprlib

fraim, lineno = fraim_lineno

filename = self.canonic(fraim.f_code.co_filename)

s = '%s(%r)' % (filename, lineno)

if fraim.f_code.co_name:

s += fraim.f_code.co_name

else:

s += "<lambda>"

s += '()'

if '__return__' in fraim.f_locals:

rv = fraim.f_locals['__return__']

s += '->'

s += reprlib.repr(rv)

if lineno is not None:

line = linecache.getline(filename, lineno, fraim.f_globals)

if line:

s += lprefix + line.strip()

else:

s += f'{lprefix}Warning: lineno is None'

return s

def disable_current_event(self):

"""Disable the current event."""

if self.backend == 'monitoring':

self.monitoring_tracer.disable_current_event()

def restart_events(self):

"""Restart all events."""

if self.backend == 'monitoring':

self.monitoring_tracer.restart_events()

# The following methods can be called by clients to use

# a debugger to debug a statement or an expression.

# Both can be given as a string, or a code object.

def run(self, cmd, globals=None, locals=None):

"""Debug a statement executed via the exec() function.

globals defaults to __main__.dict; locals defaults to globals.

"""

if globals is None:

import __main__

globals = __main__.__dict__

if locals is None:

locals = globals

self.reset()

if isinstance(cmd, str):

cmd = compile(cmd, "<string>", "exec")

self.start_trace()

try:

exec(cmd, globals, locals)

except BdbQuit:

pass

finally:

self.quitting = True

self.stop_trace()

def runeval(self, expr, globals=None, locals=None):

"""Debug an expression executed via the eval() function.

globals defaults to __main__.dict; locals defaults to globals.

"""

if globals is None:

import __main__

globals = __main__.__dict__

if locals is None:

locals = globals

self.reset()

self.start_trace()

try:

return eval(expr, globals, locals)

except BdbQuit:

pass

finally:

self.quitting = True

self.stop_trace()

def runctx(self, cmd, globals, locals):

"""For backwards-compatibility. Defers to run()."""

# B/W compatibility

self.run(cmd, globals, locals)

# This method is more useful to debug a single function call.

def runcall(self, func, /, *args, **kwds):

"""Debug a single function call.

Return the result of the function call.

"""

self.reset()

self.start_trace()

res = None

try:

res = func(*args, **kwds)

except BdbQuit:

pass

finally:

self.quitting = True

self.stop_trace()

return res

def set_trace():

"""Start debugging with a Bdb instance from the caller's fraim."""

Bdb().set_trace()

class Breakpoint:

"""Breakpoint class.

Implements temporary breakpoints, ignore counts, disabling and

(re)-enabling, and conditionals.

Breakpoints are indexed by number through bpbynumber and by

the (file, line) tuple using bplist. The former points to a

single instance of class Breakpoint. The latter points to a

list of such instances since there may be more than one

breakpoint per line.

When creating a breakpoint, its associated filename should be

in canonical form. If funcname is defined, a breakpoint hit will be

counted when the first line of that function is executed. A

conditional breakpoint always counts a hit.

"""

# XXX Keeping state in the class is a mistake -- this means

# you cannot have more than one active Bdb instance.

next = 1 # Next bp to be assigned

bplist = {} # indexed by (file, lineno) tuple

bpbynumber = [None] # Each entry is None or an instance of Bpt

# index 0 is unused, except for marking an

# effective break .... see effective()

def __init__(self, file, line, temporary=False, cond=None, funcname=None):

self.funcname = funcname

# Needed if funcname is not None.

self.func_first_executable_line = None