--- a/src/eric7/Documentation/Source/eric7.DebugClients.Python.DebugBase.html Thu Jan 04 17:16:15 2024 +0100
+++ b/src/eric7/Documentation/Source/eric7.DebugClients.Python.DebugBase.html Thu Jan 04 18:02:25 2024 +0100
@@ -7,28 +7,26 @@
<body>
<a NAME="top" ID="top"></a>
<h1>eric7.DebugClients.Python.DebugBase</h1>
-
<p>
Module implementing the debug base class which based originally on bdb.
</p>
+
<h3>Global Attributes</h3>
-
<table>
-<tr><td>GENERATOR_AND_COROUTINE_FLAGS</td></tr><tr><td>gRecursionLimit</td></tr>
+<tr><td>GENERATOR_AND_COROUTINE_FLAGS</td></tr>
+<tr><td>gRecursionLimit</td></tr>
</table>
+
<h3>Classes</h3>
-
<table>
-
<tr>
<td><a href="#DebugBase">DebugBase</a></td>
<td>Class implementing base class of the debugger.</td>
</tr>
</table>
+
<h3>Functions</h3>
-
<table>
-
<tr>
<td><a href="#printerr">printerr</a></td>
<td>Module function used for debugging the debug client.</td>
@@ -38,33 +36,36 @@
<td>Module function to set the recursion limit.</td>
</tr>
</table>
+
<hr />
<hr />
<a NAME="DebugBase" ID="DebugBase"></a>
<h2>DebugBase</h2>
-
<p>
Class implementing base class of the debugger.
</p>
<p>
Provides methods for the 'owning' client to call to step etc.
</p>
+
<h3>Derived from</h3>
None
<h3>Class Attributes</h3>
+<table>
+<tr><td>_fnCache</td></tr>
+<tr><td>filesToSkip</td></tr>
+<tr><td>lib</td></tr>
+<tr><td>pathsToSkip</td></tr>
+<tr><td>pollTimerEnabled</td></tr>
+</table>
-<table>
-<tr><td>_fnCache</td></tr><tr><td>filesToSkip</td></tr><tr><td>lib</td></tr><tr><td>pathsToSkip</td></tr><tr><td>pollTimerEnabled</td></tr>
-</table>
<h3>Class Methods</h3>
-
<table>
<tr><td>None</td></tr>
</table>
+
<h3>Methods</h3>
-
<table>
-
<tr>
<td><a href="#DebugBase.__init__">DebugBase</a></td>
<td>Constructor</td>
@@ -222,19 +223,20 @@
<td>Public method reimplemented to handle the program about to execute a particular line.</td>
</tr>
</table>
+
<h3>Static Methods</h3>
-
<table>
<tr><td>None</td></tr>
</table>
+
<a NAME="DebugBase.__init__" ID="DebugBase.__init__"></a>
<h4>DebugBase (Constructor)</h4>
<b>DebugBase</b>(<i>dbgClient</i>)
-
<p>
Constructor
</p>
+
<dl>
<dt><i>dbgClient</i> (DebugClient)</dt>
@@ -245,11 +247,11 @@
<a NAME="DebugBase.__checkBreakInFrame" ID="DebugBase.__checkBreakInFrame"></a>
<h4>DebugBase.__checkBreakInFrame</h4>
<b>__checkBreakInFrame</b>(<i>frame</i>)
-
<p>
Private method to check if the function / method has a line number
which is a breakpoint.
</p>
+
<dl>
<dt><i>frame</i> (frame object)</dt>
@@ -272,10 +274,10 @@
<a NAME="DebugBase.__disassemble" ID="DebugBase.__disassemble"></a>
<h4>DebugBase.__disassemble</h4>
<b>__disassemble</b>(<i>frame</i>)
-
<p>
Private method to generate a disassembly of the given code object.
</p>
+
<dl>
<dt><i>frame</i> (code)</dt>
@@ -298,10 +300,10 @@
<a NAME="DebugBase.__do_clearBreak" ID="DebugBase.__do_clearBreak"></a>
<h4>DebugBase.__do_clearBreak</h4>
<b>__do_clearBreak</b>(<i>filename, lineno</i>)
-
<p>
Private method called to clear a temporary breakpoint.
</p>
+
<dl>
<dt><i>filename</i> (str)</dt>
@@ -316,10 +318,10 @@
<a NAME="DebugBase.__do_clearWatch" ID="DebugBase.__do_clearWatch"></a>
<h4>DebugBase.__do_clearWatch</h4>
<b>__do_clearWatch</b>(<i>cond</i>)
-
<p>
Private method called to clear a temporary watch expression.
</p>
+
<dl>
<dt><i>cond</i> (str)</dt>
@@ -330,18 +332,18 @@
<a NAME="DebugBase.__eventPollTimer" ID="DebugBase.__eventPollTimer"></a>
<h4>DebugBase.__eventPollTimer</h4>
<b>__eventPollTimer</b>(<i></i>)
-
<p>
Private method to set a flag every 0.5 s to check for new messages.
</p>
+
<a NAME="DebugBase.__extractExceptionName" ID="DebugBase.__extractExceptionName"></a>
<h4>DebugBase.__extractExceptionName</h4>
<b>__extractExceptionName</b>(<i>exctype</i>)
-
<p>
Private method to extract the exception name given the exception
type object.
</p>
+
<dl>
<dt><i>exctype</i> (type)</dt>
@@ -364,10 +366,10 @@
<a NAME="DebugBase.__extractSystemExitMessage" ID="DebugBase.__extractSystemExitMessage"></a>
<h4>DebugBase.__extractSystemExitMessage</h4>
<b>__extractSystemExitMessage</b>(<i>excinfo</i>)
-
<p>
Private method to get the SystemExit code and message.
</p>
+
<dl>
<dt><i>excinfo</i> (tuple(Exception, excval object, traceback frame object))</dt>
@@ -390,10 +392,10 @@
<a NAME="DebugBase.__extract_stack" ID="DebugBase.__extract_stack"></a>
<h4>DebugBase.__extract_stack</h4>
<b>__extract_stack</b>(<i>exctb</i>)
-
<p>
Private member to return a list of stack frames.
</p>
+
<dl>
<dt><i>exctb</i> (traceback)</dt>
@@ -416,10 +418,10 @@
<a NAME="DebugBase.__sendCallTrace" ID="DebugBase.__sendCallTrace"></a>
<h4>DebugBase.__sendCallTrace</h4>
<b>__sendCallTrace</b>(<i>event, fromFrame, toFrame</i>)
-
<p>
Private method to send a call/return trace.
</p>
+
<dl>
<dt><i>event</i> (str)</dt>
@@ -438,7 +440,6 @@
<a NAME="DebugBase.__skipFrame" ID="DebugBase.__skipFrame"></a>
<h4>DebugBase.__skipFrame</h4>
<b>__skipFrame</b>(<i>frame</i>)
-
<p>
Private method to filter out debugger files.
</p>
@@ -446,6 +447,7 @@
Tracing is turned off for files that are part of the
debugger that are called from the application being debugged.
</p>
+
<dl>
<dt><i>frame</i> (frame object)</dt>
@@ -468,10 +470,10 @@
<a NAME="DebugBase._set_stopinfo" ID="DebugBase._set_stopinfo"></a>
<h4>DebugBase._set_stopinfo</h4>
<b>_set_stopinfo</b>(<i>stopframe, returnframe, stoplineno=0</i>)
-
<p>
Protected method to update the frame pointers.
</p>
+
<dl>
<dt><i>stopframe</i> (frame object)</dt>
@@ -492,7 +494,6 @@
<a NAME="DebugBase.bootstrap" ID="DebugBase.bootstrap"></a>
<h4>DebugBase.bootstrap</h4>
<b>bootstrap</b>(<i>target, args, kwargs</i>)
-
<p>
Public method to bootstrap a thread.
</p>
@@ -500,6 +501,7 @@
It wraps the call to the user function to enable tracing
before hand.
</p>
+
<dl>
<dt><i>target</i> (function pointer)</dt>
@@ -518,7 +520,6 @@
<a NAME="DebugBase.break_here" ID="DebugBase.break_here"></a>
<h4>DebugBase.break_here</h4>
<b>break_here</b>(<i>frame</i>)
-
<p>
Public method reimplemented from bdb.py to fix the filename from the
frame.
@@ -526,6 +527,7 @@
<p>
See fix_frame_filename for more info.
</p>
+
<dl>
<dt><i>frame</i> (frame object)</dt>
@@ -548,7 +550,6 @@
<a NAME="DebugBase.fix_frame_filename" ID="DebugBase.fix_frame_filename"></a>
<h4>DebugBase.fix_frame_filename</h4>
<b>fix_frame_filename</b>(<i>frame</i>)
-
<p>
Public method used to fixup the filename for a given frame.
</p>
@@ -564,6 +565,7 @@
on the original machine. Another case might be sharing
code over a network... This logic deals with that.
</p>
+
<dl>
<dt><i>frame</i> (frame object)</dt>
@@ -586,10 +588,10 @@
<a NAME="DebugBase.getFrame" ID="DebugBase.getFrame"></a>
<h4>DebugBase.getFrame</h4>
<b>getFrame</b>(<i>frmnr=0</i>)
-
<p>
Public method to return the frame "frmnr" down the stack.
</p>
+
<dl>
<dt><i>frmnr</i> (int)</dt>
@@ -613,11 +615,11 @@
<a NAME="DebugBase.getFrameLocals" ID="DebugBase.getFrameLocals"></a>
<h4>DebugBase.getFrameLocals</h4>
<b>getFrameLocals</b>(<i>frmnr=0</i>)
-
<p>
Public method to return the locals dictionary of the current frame
or a frame below.
</p>
+
<dl>
<dt><i>frmnr</i> (int)</dt>
@@ -641,10 +643,10 @@
<a NAME="DebugBase.getStack" ID="DebugBase.getStack"></a>
<h4>DebugBase.getStack</h4>
<b>getStack</b>(<i>frame=None, applyTrace=False</i>)
-
<p>
Public method to get the stack.
</p>
+
<dl>
<dt><i>frame</i> (frame object or list)</dt>
@@ -672,13 +674,13 @@
<a NAME="DebugBase.go" ID="DebugBase.go"></a>
<h4>DebugBase.go</h4>
<b>go</b>(<i>special</i>)
-
<p>
Public method to resume the thread.
</p>
<p>
It resumes the thread stopping only at breakpoints or exceptions.
</p>
+
<dl>
<dt><i>special</i> (bool)</dt>
@@ -689,10 +691,10 @@
<a NAME="DebugBase.move_instruction_pointer" ID="DebugBase.move_instruction_pointer"></a>
<h4>DebugBase.move_instruction_pointer</h4>
<b>move_instruction_pointer</b>(<i>lineno</i>)
-
<p>
Public method to move the instruction pointer to another line.
</p>
+
<dl>
<dt><i>lineno</i> (int)</dt>
@@ -703,11 +705,11 @@
<a NAME="DebugBase.profile" ID="DebugBase.profile"></a>
<h4>DebugBase.profile</h4>
<b>profile</b>(<i>frame, event, arg</i>)
-
<p>
Public method used to trace some stuff independent of the debugger
trace function.
</p>
+
<dl>
<dt><i>frame</i> (frame object)</dt>
@@ -726,11 +728,11 @@
<a NAME="DebugBase.profileWithRecursion" ID="DebugBase.profileWithRecursion"></a>
<h4>DebugBase.profileWithRecursion</h4>
<b>profileWithRecursion</b>(<i>frame, event, arg</i>)
-
<p>
Public method used to trace some stuff independent of the debugger
trace function.
</p>
+
<dl>
<dt><i>frame</i> (frame object)</dt>
@@ -756,10 +758,10 @@
<a NAME="DebugBase.run" ID="DebugBase.run"></a>
<h4>DebugBase.run</h4>
<b>run</b>(<i>cmd, globalsDict=None, localsDict=None, debug=True, closeSession=True</i>)
-
<p>
Public method to start a given command under debugger control.
</p>
+
<dl>
<dt><i>cmd</i> (str or CodeType)</dt>
@@ -799,10 +801,10 @@
<a NAME="DebugBase.setRecursionDepth" ID="DebugBase.setRecursionDepth"></a>
<h4>DebugBase.setRecursionDepth</h4>
<b>setRecursionDepth</b>(<i>frame</i>)
-
<p>
Public method to determine the current recursion depth.
</p>
+
<dl>
<dt><i>frame</i> (frame object)</dt>
@@ -813,10 +815,10 @@
<a NAME="DebugBase.set_continue" ID="DebugBase.set_continue"></a>
<h4>DebugBase.set_continue</h4>
<b>set_continue</b>(<i>special</i>)
-
<p>
Public method to stop only on next breakpoint.
</p>
+
<dl>
<dt><i>special</i> (bool)</dt>
@@ -827,10 +829,10 @@
<a NAME="DebugBase.set_next" ID="DebugBase.set_next"></a>
<h4>DebugBase.set_next</h4>
<b>set_next</b>(<i>frame</i>)
-
<p>
Public method to stop on the next line in or below the given frame.
</p>
+
<dl>
<dt><i>frame</i> (frame object)</dt>
@@ -841,20 +843,20 @@
<a NAME="DebugBase.set_quit" ID="DebugBase.set_quit"></a>
<h4>DebugBase.set_quit</h4>
<b>set_quit</b>(<i></i>)
-
<p>
Public method to quit.
</p>
<p>
Disables the trace functions and resets all frame pointer.
</p>
+
<a NAME="DebugBase.set_return" ID="DebugBase.set_return"></a>
<h4>DebugBase.set_return</h4>
<b>set_return</b>(<i>frame</i>)
-
<p>
Public method to stop when returning from the given frame.
</p>
+
<dl>
<dt><i>frame</i> (frame object)</dt>
@@ -865,14 +867,13 @@
<a NAME="DebugBase.set_step" ID="DebugBase.set_step"></a>
<h4>DebugBase.set_step</h4>
<b>set_step</b>(<i></i>)
-
<p>
Public method to stop after one line of code.
</p>
+
<a NAME="DebugBase.set_trace" ID="DebugBase.set_trace"></a>
<h4>DebugBase.set_trace</h4>
<b>set_trace</b>(<i>frame=None</i>)
-
<p>
Public method to start debugging from 'frame'.
</p>
@@ -881,6 +882,7 @@
Because of jump optimizations it's not possible to use sys.breakpoint()
as last instruction in a function or method.
</p>
+
<dl>
<dt><i>frame</i> (frame object)</dt>
@@ -891,11 +893,11 @@
<a NAME="DebugBase.set_until" ID="DebugBase.set_until"></a>
<h4>DebugBase.set_until</h4>
<b>set_until</b>(<i>frame=None, lineno=None</i>)
-
<p>
Public method to stop when the line with the lineno greater than the
current one is reached or when returning from current frame.
</p>
+
<dl>
<dt><i>frame</i> (frame object)</dt>
@@ -910,10 +912,10 @@
<a NAME="DebugBase.step" ID="DebugBase.step"></a>
<h4>DebugBase.step</h4>
<b>step</b>(<i>traceMode</i>)
-
<p>
Public method to perform a step operation in this thread.
</p>
+
<dl>
<dt><i>traceMode</i> (bool)</dt>
@@ -925,14 +927,13 @@
<a NAME="DebugBase.stepOut" ID="DebugBase.stepOut"></a>
<h4>DebugBase.stepOut</h4>
<b>stepOut</b>(<i></i>)
-
<p>
Public method to perform a step out of the current call.
</p>
+
<a NAME="DebugBase.stop_here" ID="DebugBase.stop_here"></a>
<h4>DebugBase.stop_here</h4>
<b>stop_here</b>(<i>frame</i>)
-
<p>
Public method reimplemented to filter out debugger files.
</p>
@@ -940,6 +941,7 @@
Tracing is turned off for files that are part of the
debugger that are called from the application being debugged.
</p>
+
<dl>
<dt><i>frame</i> (frame object)</dt>
@@ -962,11 +964,11 @@
<a NAME="DebugBase.storeFrameLocals" ID="DebugBase.storeFrameLocals"></a>
<h4>DebugBase.storeFrameLocals</h4>
<b>storeFrameLocals</b>(<i>frmnr=0</i>)
-
<p>
Public method to store the locals into the frame, so an access to
frame.f_locals returns the last data.
</p>
+
<dl>
<dt><i>frmnr</i> (int)</dt>
@@ -978,10 +980,10 @@
<a NAME="DebugBase.tracePythonLibs" ID="DebugBase.tracePythonLibs"></a>
<h4>DebugBase.tracePythonLibs</h4>
<b>tracePythonLibs</b>(<i>enable</i>)
-
<p>
Public method to update the settings to trace into Python libraries.
</p>
+
<dl>
<dt><i>enable</i> (bool)</dt>
@@ -992,7 +994,6 @@
<a NAME="DebugBase.trace_dispatch" ID="DebugBase.trace_dispatch"></a>
<h4>DebugBase.trace_dispatch</h4>
<b>trace_dispatch</b>(<i>frame, event, arg</i>)
-
<p>
Public method reimplemented from bdb.py to do some special things.
</p>
@@ -1001,6 +1002,7 @@
for new events (i.e. new breakpoints) while we are going through
the code.
</p>
+
<dl>
<dt><i>frame</i> (frame object)</dt>
@@ -1038,10 +1040,10 @@
<a NAME="DebugBase.user_exception" ID="DebugBase.user_exception"></a>
<h4>DebugBase.user_exception</h4>
<b>user_exception</b>(<i>excinfo, unhandled=False</i>)
-
<p>
Public method reimplemented to report an exception to the debug server.
</p>
+
<dl>
<dt><i>excinfo</i> (tuple(Exception, excval object, traceback frame object))</dt>
@@ -1056,11 +1058,11 @@
<a NAME="DebugBase.user_line" ID="DebugBase.user_line"></a>
<h4>DebugBase.user_line</h4>
<b>user_line</b>(<i>frame</i>)
-
<p>
Public method reimplemented to handle the program about to execute a
particular line.
</p>
+
<dl>
<dt><i>frame</i> (frame object)</dt>
@@ -1074,10 +1076,10 @@
<a NAME="printerr" ID="printerr"></a>
<h2>printerr</h2>
<b>printerr</b>(<i>s</i>)
-
<p>
Module function used for debugging the debug client.
</p>
+
<dl>
<dt><i>s</i> (str)</dt>
@@ -1091,10 +1093,10 @@
<a NAME="setRecursionLimit" ID="setRecursionLimit"></a>
<h2>setRecursionLimit</h2>
<b>setRecursionLimit</b>(<i>limit</i>)
-
<p>
Module function to set the recursion limit.
</p>
+
<dl>
<dt><i>limit</i> (int)</dt>
@@ -1104,4 +1106,4 @@
</dl>
<div align="right"><a href="#top">Up</a></div>
<hr />
-</body></html>
\ No newline at end of file
+</body></html>
