֦i% d Z ddlZddlZddlZddlmZ ddlmZmZm Z g dZ
eez e z Z G d de Z
G d d Zd
Z G d d Zd
Zd Z G d de Zd Zd Zd Zy)zDebugger basics N)contextmanager) CO_GENERATOR CO_COROUTINECO_ASYNC_GENERATOR)BdbQuitBdb
Breakpointc e Zd ZdZy)r z Exception to give up completely.N)__name__
__module__ __qualname____doc__ /usr/lib64/python3.12/bdb.pyr r s *r r c B e Zd ZdZd1dZd Zd Zed Zd Z d Z
d Z d
Z d Z
d Zd
Zd Zd Zd Zd Zd Zd Zd Zd2dZd Zd1dZd Zd Zd Z d1dZ d Z d Z d Z d3d Z!d Z"d! Z#d" Z$d# Z%d$ Z&d% Z'd& Z(d' Z)d( Z*d) Z+d* Z,d+ Z-d4d,Z.d5d-Z/d5d.Z0d/ Z1d0 Z2y)6r a 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 frames
that originate in a module that matches one of these patterns.
Whether a frame is considered to originate in a certain module
is determined by the __name__ in the frame globals.
Nc |r t | nd | _ i | _ i | _ d | _ d | _ | j
y N)setskipbreaksfncacheframe_returning
enterframe _load_breaks)selfr s r __init__z Bdb.__init__ s: !%CI4 # r c |d|dd z dz k( r|S | j j | }|sMt j j | }t j j | }|| j |< |S )a% 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 "", generated in interactive
mode, are returned unchanged.
< >)r getospathabspathnormcase)r filenamecanonics r r) z Bdb.canonic) sq sXa^+c1 1O,,""8,ggooh/Ggg&&w/G%,DLL "r c ^ ddl }|j d| _ | j dd y)z5Set values of attributes as ready to start debugging.r N) linecache
checkcachebotframe
_set_stopinfo)r r+ s r resetz Bdb.reset: s(
4&r c # 0 K || _ d d | _ y wr )r r frames r set_enterframezBdb.set_enterframeA s
s c X | j | 5 | j r
ddd y|dk( r| j | cddd S |dk( r| j || cddd S |dk( r| j || cddd S |dk( r| j || cddd S |dk( r| j cddd S |dk( r| j cddd S |dk( r| j cddd S t d t | | j cddd S # 1 sw Y yxY w)
aO Dispatch a trace function for debugged frames based on the event.
This function is installed as the trace function for debugged
frames. Its return value is the new trace function, which is
usually itself. The default implementation decides how to
dispatch a frame, 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.
Nlinecallreturn exceptionc_call c_exceptionc_returnz*bdb.Bdb.dispatch: unknown debugging event:) r3 quitting
dispatch_line
dispatch_calldispatch_returndispatch_exceptiontrace_dispatchprintrepr)r r2 eventargs r rA zBdb.trace_dispatchG s 2
'}} (
' ))%0 (
'
))%5
(
' ++E37 (
' #..uc: (
' ** (
'
%** (
'
"**! (
'"
>U L&&% (
'
's: D D D (D D (D D D 6 D D)c | j | s| j | r#| j | | j rt | j
S )a 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.
) stop_here
break_here user_liner< r rA r1 s r r= zBdb.dispatch_linet s> >>% DOOE$: NN5 !}}Gm"""r c d | j |j | _ | j S | j | s| j | sy| j
r)|j j t z r | j S | j || | j rt | j S )a 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.
N) r- f_backrA rG break_anywhere stopframef_codeco_flags GENERATOR_AND_COROUTINE_FLAGS user_callr< r r r2 rE s r r> zBdb.dispatch_call s == !LLDM&& &u%)<)>ell 3 36S S&& & uc" ==-"""r c | j | s|| j k( r| j r)|j j t
z r | j S || _ | j || d| _ | j rt | j |u r!| j dk7 r| j dd | j dk7 r| j | | j S # d| _ w xY w)a 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.
Nr! )rG returnframerM rN rO rP rA r user_returnr< r
stoplinenor. _set_caller_tracefuncrR s r r? zBdb.dispatch_return s >>% ET-=-=$=~~%,,"7"7:W"W***
,',$ ,'+$}}Gm~~&4??b+@""4. "$**51""" (,$s C$ $ C-c | j | r]|j j t z r|d t u r|d $| j || | j rt | j S | j rj|| j ur\| j j j t z r5|d t t fv r$| j || | j rt | j S )a 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.
r ) rG rN rO rP
StopIterationuser_exceptionr< r rM
GeneratorExitrA rR s r r@ zBdb.dispatch_exception s >>% LL)),IIA-/CFN##E3/==- """
nndnn!<NN))225RRF}m << s +}}Gm"""r c \ |y| j D ] }t j || s y y)z4Return True if module_name matches any skip pattern.FT)r fnmatch)r module_namepatterns r is_skipped_modulezBdb.is_skipped_module s/ yyG{G4 ! r c | j r+| j |j j d ry|| j u r)| j
dk( ry|j | j
k\ S | j syy)z>Return True if frame is below the starting frame in the stack.r Fr! T)r ra f_globalsr# rM rV f_linenor1 s r rG z
Bdb.stop_here sf 99%%eoo&9&9*&EF DNN ""$ >>T__4 4~~r c | j |j j }|| j vry|j }|| j | vr(|j j
}|| j | vryt
||| \ }}|rD|j | _ |r0|j r$| j t |j yy)zReturn 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.
FT) r) rN co_filenamer rd co_firstlineno effectivenumber currentbp temporarydo_clearstr)r r2 r( linenobpflags r rH zBdb.break_here s << 8 89 4;; & X. . \\00FT[[ 22 x7
T
YYDN
c"))n-r c t d )zlRemove temporary breakpoint.
Must implement in derived classes or get NotImplementedError.
z)subclass of bdb must implement do_clear())NotImplementedError)r rE s r rl z Bdb.do_clear s
""MNNr c d | j |j j | j v S )zEReturn True if there is any breakpoint for frame's filename.
)r) rN rf r r1 s r rL zBdb.break_anywhere
s& ||ELL 4 45DDr c y)z&Called if we might stop in a function.Nr )r r2
argument_lists r rQ z
Bdb.user_call r c y)z'Called when we stop or break at a line.Nr r1 s r rI z
Bdb.user_line rv r c y)z&Called when a return trap is set here.Nr )r r2 return_values r rU zBdb.user_return rv r c y)z$Called when we stop on an exception.Nr )r r2 exc_infos r r[ zBdb.user_exception rv r c < || _ || _ d| _ || _ y)zSet 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.
FN)rM rT r< rV )r rM rT rV s r r. zBdb._set_stopinfo" s# #&
%r c | |j }|r.|j s!|| j ur| j |_ y y y y r )rK f_tracer- rA )r
current_frame caller_frames r rW zBdb._set_caller_tracefunc0 s> %++ 4 4 T]]9Z#'#6#6L :[ 4^^a'F 5%0r c ( | j dd y)z Stop after one line of code.Nr. r s r set_stepz Bdb.set_stepE s 4&r c ( | j |d y)z2Stop on the next line in or below the given frame.Nr r1 s r set_nextz Bdb.set_nextI s 5$'r c |j j t z r| j |dd y| j |j | y)z)Stop when returning from the given frame.Nr! )rN rO rP r. rK r1 s r
set_returnzBdb.set_returnM s; << #@ @ udB / u||U 3r c t j d | t j j }| j | j | 5 |r'| j |_ || _ |j }|r'| j ddd t j | j y# 1 sw Y )xY w)znStart debugging from frame.
If frame is not specified, debugging starts from caller's frame.
N)
syssettrace _getframerK r/ r3 rA r~ r- r r1 s r set_tracez
Bdb.set_traceT s
T =MMO**E
' $ 3 3
%
MMO ( T(()
(
's )B9B99Cc " | j | j dd | j sft j d t j
j }|r0|| j ur!|`|j }|r|| j ur yyyyy)zStop only at breakpoints or when finished.
If there are no breakpoints, set the system trace function to None.
Nr! )r. r- r r r r rK r~ r1 s r set_continuezBdb.set_continuee sv
4==$3{{ LL MMO**EE 6M E 6% 6% r c l | j | _ d| _ d| _ t j
d y)zuSet quitting attribute to True.
Raises BdbQuit exception in the next call to a dispatch_*() method.
NT)r- rM rT r< r r r s r set_quitz Bdb.set_quitt s*
Tr c h | j j |g }||vr|j | yy)z/Add breakpoint to breaks, if not already there.N)r
setdefaultappend)r r( rn
bp_linenoss r _add_to_breakszBdb._add_to_breaks s3 [[++Hb9
# f % $r c $ | j | }ddl}|j || }|sd||fz S | j || t ||||| }| j
} | r1| j
| r| j | _ | j } | r1y)zSet 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.
r NzLine %s:%d does not exist)
r) r+ getliner r r rL rA r~ rK )
r r( rn rk condfuncnamer+ r5 ro r2 s
r set_breakz
Bdb.set_break s <<) 62.(F1CC C Hf-
&)T8
D ""5) $ 3 3
LLE r c t t j j D ] \ }}| j || y)aO 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().
N)r bplistkeysr r r( rn s r r zBdb._load_breaks s2 #-"3"3"8"8": Xv & 1 #;r c ||ft j vr | j | j | | j | s| j |= yy)a 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.
N)r r r remover s r
_prune_breakszBdb._prune_breaks sK
f Z%6%6 6 KK ! ( ( 0{{8$ H% %r c | j | }|| j vrd|z S || j | vrd||fz S t j ||f dd D ] }|j | j || y)znDelete breakpoints for filename:lineno.
If no breakpoints were set, return an error message.
There are no breakpoints in %sz There is no breakpoint at %s:%dN)r) r r r deleteMer )r r( rn ro s r clear_breakzBdb.clear_break s
<<) 4;; &3h> > X. .4&7II I ##Hf$45a8B KKM 9 8V,r c | j | }|j | j |j
|j y# t $ r}t | cY d}~S d}~ww xY w)zxDelete a breakpoint by its index in Breakpoint.bpbynumber.
If arg is invalid, return an error message.
N)get_bpbynumber
ValueErrorrm r r filer5 )r rE ro errs r clear_bpbynumberzBdb.clear_bpbynumber sX
$$S)B
277BGG, s8O s A
A(
A# A(#A(c | j | }|| j vrd|z S | j | D ]. }t j ||f }|D ] }|j 0 | j |= y)z`Delete all breakpoints in filename.
If none were set, return an error message.
r N)r) r r r r )r r( r5 blistro s r clear_all_file_breakszBdb.clear_all_file_breaks st
<<) 4;; &3h> >KK)D %%hn5E
*
KK !r c | | j syt j D ] }|s|j i | _ y)z]Delete all existing breakpoints.
If none were set, return an error message.
zThere are no breakpointsN)r r
bpbynumberr )r ro s r clear_all_breakszBdb.clear_all_breaks s6
{{- ''B
( r c |s t d t | } t j | }|t d|z |S # t $ r t d|z dw xY w# t $ r t d|z dw xY w)zReturn a breakpoint by its index in Breakpoint.bybpnumber.
For invalid arg values or if the breakpoint doesn't exist,
raise a ValueError.
zBreakpoint number expectedz Non-numeric breakpoint number %sNz!Breakpoint number %d out of rangez Breakpoint %d already deleted)r intr r
IndexError)r rE ri ro s r r zBdb.get_bpbynumber s 9: : QXF U&&v.B : "m LL!**akk2 3 A m
9As5zA~&Aaxr c ddl }ddl}|\ }}| j |j j }|d|d}|j j
r||j j
z
}n|dz
}|dz
}d|j v r(|j d } |dz
}||j | z
}|7|j |||j }
|
r|||
j z z
}|S || d z
}|S )
a: Return a string with information about a stack entry.
The stack entry frame_lineno is a (frame, lineno) tuple. The
return string contains the canonical filename, the function name
or '', the input arguments, the return value, and the
line of code (if it exists).
r N()zz()
__return__z->zWarning: lineno is None) r+ reprlibr) rN rf co_namef_localsrC r rc strip) r frame_linenolprefixr+ r r2 rn r( srvr5 s r format_stack_entryzBdb.format_stack_entryB s "$
v<< 8 89 & ) <<
%% %A
OA T 5>> ) -B
IA
b! !A $$XvuGDWtzz|++
G9 34 4Ar c | |ddl }|j }||}| j t |t r
t |dd }t
j | j t ||| d| _ t
j d y# t $ r Y (w xY w# d| _ t
j d w xY w)zDebug a statement executed via the exec() function.
globals defaults to __main__.dict; locals defaults to globals.
Nr zexecT) __main____dict__r/
isinstancerm compiler r rA r r r< )r cmdglobalslocalsr s r runzBdb.rund s
? ''G > F
c3 #z62C T(() gv & !DM LL !DM LL s$ $
B BB BB B;c | |ddl }|j }||}| j t j | j
t
||| d| _ t j d S # t $ r Y nw xY w d| _ t j d y# d| _ t j d w xY w)zDebug an expression executed via the eval() function.
globals defaults to __main__.dict; locals defaults to globals.
Nr T) r r r/ r r rA evalr< r )r exprr r r s r runevalz Bdb.runevalz s
? ''G > F
T(() gv. !DM LL DM LL !DM LL s$ A0 0 A<9B ;A<<B B;c * | j ||| y)z.For backwards-compatibility. Defers to run().N)r )r r r r s r runctxz
Bdb.runctx s
gv&r c | j t j | j d} ||i |}d| _ t j d |S # t $ r Y )w xY w# d| _ t j d w xY w)zWDebug a single function call.
Return the result of the function call.
NT)r/ r r rA r r< )r funcargskwdsress r runcallz Bdb.runcall s|
T(() %%C !DM LL
!DM LL s# A A%"A( $A%%A( ( Br )r FNN)z: NN)3r r r
r r r) r/ r r3 rA r= r> r? r@ ra rG rH rl rL rQ rI rU r[ r. rW r r r r r r r r r r r r r r r r r r r r r r r r r r r r r r r s
"'
+'Z
##,#6#>
6OE
% 71'(4*"
% "& AE 0 2 &"
(, 6 . D , ('r r c 4 t j y)z>DD <<'>D'>D, T04 4990F F 99 DII7 7C ;; , ~= =C 99yy1} 9TYYOK KC
r c T d| j d| j d| j S )z1Return a condensed description of the breakpoint.z breakpoint z at :)ri r r5 r s r __str__zBreakpoint.__str__ s +/;; 499MMr r r )r r r
r r r r r staticmethodr r r r r r r r r r r r sR (
D
FJ-( ' '
# ) <Nr r c | j s| j |j k7 ryy|j j | j k7 ry| j
s|j | _ | j
|j k7 ryy)aV Return True if break should happen here.
Whether a break should happen depends on the way that b (the breakpoint)
was set. If it was set via line number, check if b.line is the same as
the one in the frame. If it was set via function name, check if this is
the right function and if it is on the first executable line.
FT)r r5 rd rN r r )br2 s r
checkfuncnamer & sm
:: 66U^^ #
||qzz)
' '',~~$##u~~5 r c t j | |f }|D ] }|j st || s |xj dz
c_ |j
s+|j dkD r|xj dz c_ c|dfc S t |j
|j |j }|r+|j dkD r|xj dz c_ n|dfc S y# |dfcY c S xY w)a= Return (active breakpoint, delete temporary flag) or (None, None) as
breakpoint to act upon.
The "active breakpoint" is the first entry in bplist[line, file] (which
must exist) that is enabled, for which checkfuncname is True, and that
has neither a False condition nor a positive ignore count. The flag,
meaning that a temporary breakpoint should be deleted, is False only
when the condiion cannot be evaluated (in which case, ignore count is
ignored).
If no such entry exists, then (None, None) is returned.
r r TFr )
r r r r r r r r rc r )r r5 r2 possiblesr vals r rh rh F s !!$*-I
yy Q& ! vvxx!|A
4y
"1665??ENNCxx!|A
!"4y(5 D
" 5z!s
AC C'c $ e Zd Zd Zd Zd Zd Zy)Tdbc R |j j }|sd}t d|| y )N???z+++ call)rN r rB )r r2 r names r rQ z
Tdb.user_call| s$ ||##ET
j$%r c ( dd l }|j j }|sd}| j |j j }|j ||j |j }t d||j |d|j y )Nr r z+++r )
r+ rN r r) rf r rd rc rB r )r r2 r+ r fnr5 s r rI z
Tdb.user_line sk ||##ET
\\%,,22
3 U^^U__E
eR sDJJLAr c t d| y )Nz
+++ returnrB )r r2 retvals r rU zTdb.user_return s
lF#r c < t d| | j y )Nz
+++ exception)rB r )r r2 exc_stuffs r r[ zTdb.user_exception s
oy) r N)r r r
rQ rI rU r[ r r r r r { s &B$ r r c R t d| d t | dz }t d| y )Nzfoo(r
z bar returned)rB bar)nxs r foor( s% &!S AbD A .! r c & t d| d | dz S )Nzbar(r rY r )as r r% r% s &!S Q3Jr c : t } | j d y )Nzimport bdb; bdb.foo(10))r r )r s r testr, s AEE
#$r )r r^ r r$
contextlibr inspectr r r __all__rP Exceptionr r r r r rh r r( r% r, r r r r1 s
% B B
* ,| ;>P P +i +R
R
j
uN uNt @0j # $
%r