--- a/eric6/Documentation/Source/eric6.DebugClients.Python.DebugBase.html Sun Jan 17 13:53:08 2021 +0100 +++ b/eric6/Documentation/Source/eric6.DebugClients.Python.DebugBase.html Mon Feb 01 10:38:16 2021 +0100 @@ -200,6 +200,10 @@ <td>Public method to start debugging from 'frame'.</td> </tr> <tr> +<td><a href="#DebugBase.set_until">set_until</a></td> +<td>Public method to stop when the line with the lineno greater than the current one is reached or when returning from current frame.</td> +</tr> +<tr> <td><a href="#DebugBase.step">step</a></td> <td>Public method to perform a step operation in this thread.</td> </tr> @@ -268,7 +272,7 @@ </dd> </dl> <dl> -<dt>Returns:</dt> +<dt>Return:</dt> <dd> Flag indicating a function / method with breakpoint </dd> @@ -294,7 +298,7 @@ </dd> </dl> <dl> -<dt>Returns:</dt> +<dt>Return:</dt> <dd> dictionary containing the disassembly information </dd> @@ -360,7 +364,7 @@ </dd> </dl> <dl> -<dt>Returns:</dt> +<dt>Return:</dt> <dd> exception name (string) </dd> @@ -380,7 +384,7 @@ </dd> </dl> <dl> -<dt>Returns:</dt> +<dt>Return:</dt> <dd> SystemExit code and message </dd> @@ -406,7 +410,7 @@ </dd> </dl> <dl> -<dt>Returns:</dt> +<dt>Return:</dt> <dd> list of stack frames </dd> @@ -452,7 +456,7 @@ </dd> </dl> <dl> -<dt>Returns:</dt> +<dt>Return:</dt> <dd> flag indicating whether the debugger should skip this frame </dd> @@ -465,7 +469,7 @@ </dl> <a NAME="DebugBase._set_stopinfo" ID="DebugBase._set_stopinfo"></a> <h4>DebugBase._set_stopinfo</h4> -<b>_set_stopinfo</b>(<i>stopframe, returnframe</i>) +<b>_set_stopinfo</b>(<i>stopframe, returnframe, stoplineno=0</i>) <p> Protected method to update the frame pointers. @@ -480,6 +484,12 @@ <dd> the frame object where to stop on a function return </dd> +<dt><i>stoplineno</i> (int)</dt> +<dd> +line number to stop at. 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. +</dd> </dl> <a NAME="DebugBase.bootstrap" ID="DebugBase.bootstrap"></a> <h4>DebugBase.bootstrap</h4> @@ -526,7 +536,7 @@ </dd> </dl> <dl> -<dt>Returns:</dt> +<dt>Return:</dt> <dd> flag indicating the break status </dd> @@ -564,7 +574,7 @@ </dd> </dl> <dl> -<dt>Returns:</dt> +<dt>Return:</dt> <dd> fixed up file name </dd> @@ -583,7 +593,7 @@ Public method to return the current frame. </p> <dl> -<dt>Returns:</dt> +<dt>Return:</dt> <dd> the current frame </dd> @@ -604,14 +614,14 @@ </p> <dl> -<dt><i>frmnr=</i></dt> +<dt><i>frmnr</i></dt> <dd> distance of frame to get locals dictionary of. 0 is the current frame (int) </dd> </dl> <dl> -<dt>Returns:</dt> +<dt>Return:</dt> <dd> locals dictionary of the frame </dd> @@ -625,17 +635,17 @@ </p> <dl> -<dt><i>frame=</i> (frame object or list)</dt> +<dt><i>frame</i> (frame object or list)</dt> <dd> frame object to inspect </dd> -<dt><i>applyTrace=</i> (bool)</dt> +<dt><i>applyTrace</i> (bool)</dt> <dd> flag to assign trace function to fr.f_trace </dd> </dl> <dl> -<dt>Returns:</dt> +<dt>Return:</dt> <dd> list of lists with file name (string), line number (integer) and function name (string) @@ -727,7 +737,7 @@ </dl> <a NAME="DebugBase.run" ID="DebugBase.run"></a> <h4>DebugBase.run</h4> -<b>run</b>(<i>cmd, globalsDict=None, localsDict=None, debug=True</i>) +<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. @@ -738,18 +748,35 @@ <dd> command / code to execute under debugger control </dd> -<dt><i>globalsDict=</i> (dict)</dt> +<dt><i>globalsDict</i> (dict)</dt> <dd> dictionary of global variables for cmd </dd> -<dt><i>localsDict=</i> (dict)</dt> +<dt><i>localsDict</i> (dict)</dt> <dd> dictionary of local variables for cmd </dd> -<dt><i>debug=</i> (bool)</dt> +<dt><i>debug</i> (bool)</dt> <dd> flag if command should run under debugger control </dd> +<dt><i>closeSession</i> (bool)</dt> +<dd> +flag indicating to close the debugger session + at exit +</dd> +</dl> +<dl> +<dt>Return:</dt> +<dd> +exit code of the program +</dd> +</dl> +<dl> +<dt>Return Type:</dt> +<dd> +int +</dd> </dl> <a NAME="DebugBase.setRecursionDepth" ID="DebugBase.setRecursionDepth"></a> <h4>DebugBase.setRecursionDepth</h4> @@ -838,11 +865,30 @@ </p> <dl> -<dt><i>frame=</i> (frame object)</dt> +<dt><i>frame</i> (frame object)</dt> <dd> frame to start debugging from </dd> </dl> +<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> +<dd> +reference to the frame object +</dd> +<dt><i>lineno</i> (int)</dt> +<dd> +line number to continue to +</dd> +</dl> <a NAME="DebugBase.step" ID="DebugBase.step"></a> <h4>DebugBase.step</h4> <b>step</b>(<i>traceMode</i>) @@ -884,7 +930,7 @@ </dd> </dl> <dl> -<dt>Returns:</dt> +<dt>Return:</dt> <dd> flag indicating whether the debugger should stop here </dd> @@ -905,7 +951,7 @@ </p> <dl> -<dt><i>frmnr=</i></dt> +<dt><i>frmnr</i></dt> <dd> distance of frame to store locals dictionary to. 0 is the current frame (int) @@ -953,7 +999,7 @@ </dd> </dl> <dl> -<dt>Returns:</dt> +<dt>Return:</dt> <dd> local trace function </dd> @@ -984,7 +1030,7 @@ <dd> details about the exception </dd> -<dt><i>unhandled=</i> (bool)</dt> +<dt><i>unhandled</i> (bool)</dt> <dd> flag indicating an uncaught exception </dd>