--- /dev/null Thu Jan 01 00:00:00 1970 +0000 +++ b/Documentation/Source/eric5.Debugger.DebuggerInterfacePython.html Sat Jan 02 18:19:35 2010 +0000 @@ -0,0 +1,763 @@ +<?xml version="1.0" encoding="utf-8"?> +<!DOCTYPE html PUBLIC '-//W3C//DTD XHTML 1.0 Strict//EN' +'http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd'> +<html><head> +<title>eric5.Debugger.DebuggerInterfacePython</title> +<style> +b'body {\n background:white;\n margin: 0em 1em 10em 1em;\n color: black;\n}\n\nh1 { color: white; background: #4FA4FF; }\nh2 { color: white; background: #4FA4FF; }\nh3 { color: white; background: #00557F; }\nh4 { color: white; background: #00557F; }\n \na { color: #AA5500; }\n' +</style> +</head> +<body><a NAME="top" ID="top"></a> +<h1>eric5.Debugger.DebuggerInterfacePython</h1> +<p> +Module implementing the Python debugger interface for the debug server. +</p> +<h3>Global Attributes</h3> +<table> +<tr><td>ClientDefaultCapabilities</td></tr> +</table> +<h3>Classes</h3> +<table> +<tr> +<td><a href="#DebuggerInterfacePython">DebuggerInterfacePython</a></td> +<td>Class implementing the Python debugger interface for the debug server.</td> +</tr> +</table> +<h3>Functions</h3> +<table> +<tr> +<td><a href="#getRegistryData">getRegistryData</a></td> +<td>Module function to get characterising data for the debugger interface.</td> +</tr> +</table> +<hr /><hr /> +<a NAME="DebuggerInterfacePython" ID="DebuggerInterfacePython"></a> +<h2>DebuggerInterfacePython</h2> +<p> + Class implementing the Python debugger interface for the debug server. +</p> +<h3>Derived from</h3> +QObject +<h3>Class Attributes</h3> +<table> +<tr><td>None</td></tr> +</table> +<h3>Methods</h3> +<table> +<tr> +<td><a href="#DebuggerInterfacePython.__init__">DebuggerInterfacePython</a></td> +<td>Constructor</td> +</tr><tr> +<td><a href="#DebuggerInterfacePython.__askForkTo">__askForkTo</a></td> +<td>Private method to ask the user which branch of a fork to follow.</td> +</tr><tr> +<td><a href="#DebuggerInterfacePython.__identityTranslation">__identityTranslation</a></td> +<td>Private method to perform the identity path translation.</td> +</tr><tr> +<td><a href="#DebuggerInterfacePython.__parseClientLine">__parseClientLine</a></td> +<td>Private method to handle data from the client.</td> +</tr><tr> +<td><a href="#DebuggerInterfacePython.__remoteTranslation">__remoteTranslation</a></td> +<td>Private method to perform the path translation.</td> +</tr><tr> +<td><a href="#DebuggerInterfacePython.__sendCommand">__sendCommand</a></td> +<td>Private method to send a single line command to the client.</td> +</tr><tr> +<td><a href="#DebuggerInterfacePython.__startProcess">__startProcess</a></td> +<td>Private method to start the debugger client process.</td> +</tr><tr> +<td><a href="#DebuggerInterfacePython.flush">flush</a></td> +<td>Public slot to flush the queue.</td> +</tr><tr> +<td><a href="#DebuggerInterfacePython.getClientCapabilities">getClientCapabilities</a></td> +<td>Public method to retrieve the debug clients capabilities.</td> +</tr><tr> +<td><a href="#DebuggerInterfacePython.isConnected">isConnected</a></td> +<td>Public method to test, if a debug client has connected.</td> +</tr><tr> +<td><a href="#DebuggerInterfacePython.newConnection">newConnection</a></td> +<td>Public slot to handle a new connection.</td> +</tr><tr> +<td><a href="#DebuggerInterfacePython.remoteBanner">remoteBanner</a></td> +<td>Public slot to get the banner info of the remote client.</td> +</tr><tr> +<td><a href="#DebuggerInterfacePython.remoteBreakpoint">remoteBreakpoint</a></td> +<td>Public method to set or clear a breakpoint.</td> +</tr><tr> +<td><a href="#DebuggerInterfacePython.remoteBreakpointEnable">remoteBreakpointEnable</a></td> +<td>Public method to enable or disable a breakpoint.</td> +</tr><tr> +<td><a href="#DebuggerInterfacePython.remoteBreakpointIgnore">remoteBreakpointIgnore</a></td> +<td>Public method to ignore a breakpoint the next couple of occurrences.</td> +</tr><tr> +<td><a href="#DebuggerInterfacePython.remoteCapabilities">remoteCapabilities</a></td> +<td>Public slot to get the debug clients capabilities.</td> +</tr><tr> +<td><a href="#DebuggerInterfacePython.remoteClientSetFilter">remoteClientSetFilter</a></td> +<td>Public method to set a variables filter list.</td> +</tr><tr> +<td><a href="#DebuggerInterfacePython.remoteClientVariable">remoteClientVariable</a></td> +<td>Public method to request the variables of the debugged program.</td> +</tr><tr> +<td><a href="#DebuggerInterfacePython.remoteClientVariables">remoteClientVariables</a></td> +<td>Public method to request the variables of the debugged program.</td> +</tr><tr> +<td><a href="#DebuggerInterfacePython.remoteCompletion">remoteCompletion</a></td> +<td>Public slot to get the a list of possible commandline completions from the remote client.</td> +</tr><tr> +<td><a href="#DebuggerInterfacePython.remoteContinue">remoteContinue</a></td> +<td>Public method to continue the debugged program.</td> +</tr><tr> +<td><a href="#DebuggerInterfacePython.remoteCoverage">remoteCoverage</a></td> +<td>Public method to load a new program to collect coverage data.</td> +</tr><tr> +<td><a href="#DebuggerInterfacePython.remoteEnvironment">remoteEnvironment</a></td> +<td>Public method to set the environment for a program to debug, run, ...</td> +</tr><tr> +<td><a href="#DebuggerInterfacePython.remoteEval">remoteEval</a></td> +<td>Public method to evaluate arg in the current context of the debugged program.</td> +</tr><tr> +<td><a href="#DebuggerInterfacePython.remoteExec">remoteExec</a></td> +<td>Public method to execute stmt in the current context of the debugged program.</td> +</tr><tr> +<td><a href="#DebuggerInterfacePython.remoteLoad">remoteLoad</a></td> +<td>Public method to load a new program to debug.</td> +</tr><tr> +<td><a href="#DebuggerInterfacePython.remoteProfile">remoteProfile</a></td> +<td>Public method to load a new program to collect profiling data.</td> +</tr><tr> +<td><a href="#DebuggerInterfacePython.remoteRawInput">remoteRawInput</a></td> +<td>Public method to send the raw input to the debugged program.</td> +</tr><tr> +<td><a href="#DebuggerInterfacePython.remoteRun">remoteRun</a></td> +<td>Public method to load a new program to run.</td> +</tr><tr> +<td><a href="#DebuggerInterfacePython.remoteSetThread">remoteSetThread</a></td> +<td>Public method to request to set the given thread as current thread.</td> +</tr><tr> +<td><a href="#DebuggerInterfacePython.remoteStatement">remoteStatement</a></td> +<td>Public method to execute a Python statement.</td> +</tr><tr> +<td><a href="#DebuggerInterfacePython.remoteStep">remoteStep</a></td> +<td>Public method to single step the debugged program.</td> +</tr><tr> +<td><a href="#DebuggerInterfacePython.remoteStepOut">remoteStepOut</a></td> +<td>Public method to step out the debugged program.</td> +</tr><tr> +<td><a href="#DebuggerInterfacePython.remoteStepOver">remoteStepOver</a></td> +<td>Public method to step over the debugged program.</td> +</tr><tr> +<td><a href="#DebuggerInterfacePython.remoteStepQuit">remoteStepQuit</a></td> +<td>Public method to stop the debugged program.</td> +</tr><tr> +<td><a href="#DebuggerInterfacePython.remoteThreadList">remoteThreadList</a></td> +<td>Public method to request the list of threads from the client.</td> +</tr><tr> +<td><a href="#DebuggerInterfacePython.remoteUTPrepare">remoteUTPrepare</a></td> +<td>Public method to prepare a new unittest run.</td> +</tr><tr> +<td><a href="#DebuggerInterfacePython.remoteUTRun">remoteUTRun</a></td> +<td>Public method to start a unittest run.</td> +</tr><tr> +<td><a href="#DebuggerInterfacePython.remoteUTStop">remoteUTStop</a></td> +<td>Public method to stop a unittest run.</td> +</tr><tr> +<td><a href="#DebuggerInterfacePython.remoteWatchpoint">remoteWatchpoint</a></td> +<td>Public method to set or clear a watch expression.</td> +</tr><tr> +<td><a href="#DebuggerInterfacePython.remoteWatchpointEnable">remoteWatchpointEnable</a></td> +<td>Public method to enable or disable a watch expression.</td> +</tr><tr> +<td><a href="#DebuggerInterfacePython.remoteWatchpointIgnore">remoteWatchpointIgnore</a></td> +<td>Public method to ignore a watch expression the next couple of occurrences.</td> +</tr><tr> +<td><a href="#DebuggerInterfacePython.shutdown">shutdown</a></td> +<td>Public method to cleanly shut down.</td> +</tr><tr> +<td><a href="#DebuggerInterfacePython.startRemote">startRemote</a></td> +<td>Public method to start a remote Python interpreter.</td> +</tr><tr> +<td><a href="#DebuggerInterfacePython.startRemoteForProject">startRemoteForProject</a></td> +<td>Public method to start a remote Python interpreter for a project.</td> +</tr> +</table> +<a NAME="DebuggerInterfacePython.__init__" ID="DebuggerInterfacePython.__init__"></a> +<h4>DebuggerInterfacePython (Constructor)</h4> +<b>DebuggerInterfacePython</b>(<i>debugServer, passive</i>) +<p> + Constructor +</p><dl> +<dt><i>debugServer</i></dt> +<dd> +reference to the debug server (DebugServer) +</dd><dt><i>passive</i></dt> +<dd> +flag indicating passive connection mode (boolean) +</dd> +</dl><a NAME="DebuggerInterfacePython.__askForkTo" ID="DebuggerInterfacePython.__askForkTo"></a> +<h4>DebuggerInterfacePython.__askForkTo</h4> +<b>__askForkTo</b>(<i></i>) +<p> + Private method to ask the user which branch of a fork to follow. +</p><a NAME="DebuggerInterfacePython.__identityTranslation" ID="DebuggerInterfacePython.__identityTranslation"></a> +<h4>DebuggerInterfacePython.__identityTranslation</h4> +<b>__identityTranslation</b>(<i>fn, remote2local = True</i>) +<p> + Private method to perform the identity path translation. +</p><dl> +<dt><i>fn</i></dt> +<dd> +filename to be translated (string) +</dd><dt><i>remote2local</i></dt> +<dd> +flag indicating the direction of translation + (False = local to remote, True = remote to local [default]) +</dd> +</dl><dl> +<dt>Returns:</dt> +<dd> +translated filename (string) +</dd> +</dl><a NAME="DebuggerInterfacePython.__parseClientLine" ID="DebuggerInterfacePython.__parseClientLine"></a> +<h4>DebuggerInterfacePython.__parseClientLine</h4> +<b>__parseClientLine</b>(<i></i>) +<p> + Private method to handle data from the client. +</p><a NAME="DebuggerInterfacePython.__remoteTranslation" ID="DebuggerInterfacePython.__remoteTranslation"></a> +<h4>DebuggerInterfacePython.__remoteTranslation</h4> +<b>__remoteTranslation</b>(<i>fn, remote2local = True</i>) +<p> + Private method to perform the path translation. +</p><dl> +<dt><i>fn</i></dt> +<dd> +filename to be translated (string) +</dd><dt><i>remote2local</i></dt> +<dd> +flag indicating the direction of translation + (False = local to remote, True = remote to local [default]) +</dd> +</dl><dl> +<dt>Returns:</dt> +<dd> +translated filename (string) +</dd> +</dl><a NAME="DebuggerInterfacePython.__sendCommand" ID="DebuggerInterfacePython.__sendCommand"></a> +<h4>DebuggerInterfacePython.__sendCommand</h4> +<b>__sendCommand</b>(<i>cmd</i>) +<p> + Private method to send a single line command to the client. +</p><dl> +<dt><i>cmd</i></dt> +<dd> +command to send to the debug client (string) +</dd> +</dl><a NAME="DebuggerInterfacePython.__startProcess" ID="DebuggerInterfacePython.__startProcess"></a> +<h4>DebuggerInterfacePython.__startProcess</h4> +<b>__startProcess</b>(<i>program, arguments, environment = None</i>) +<p> + Private method to start the debugger client process. +</p><dl> +<dt><i>program</i></dt> +<dd> +name of the executable to start (string) +</dd><dt><i>arguments</i></dt> +<dd> +arguments to be passed to the program (list of string) +</dd><dt><i>environment</i></dt> +<dd> +dictionary of environment settings to pass (dict of string) +</dd> +</dl><dl> +<dt>Returns:</dt> +<dd> +the process object (QProcess) or None +</dd> +</dl><a NAME="DebuggerInterfacePython.flush" ID="DebuggerInterfacePython.flush"></a> +<h4>DebuggerInterfacePython.flush</h4> +<b>flush</b>(<i></i>) +<p> + Public slot to flush the queue. +</p><a NAME="DebuggerInterfacePython.getClientCapabilities" ID="DebuggerInterfacePython.getClientCapabilities"></a> +<h4>DebuggerInterfacePython.getClientCapabilities</h4> +<b>getClientCapabilities</b>(<i></i>) +<p> + Public method to retrieve the debug clients capabilities. +</p><dl> +<dt>Returns:</dt> +<dd> +debug client capabilities (integer) +</dd> +</dl><a NAME="DebuggerInterfacePython.isConnected" ID="DebuggerInterfacePython.isConnected"></a> +<h4>DebuggerInterfacePython.isConnected</h4> +<b>isConnected</b>(<i></i>) +<p> + Public method to test, if a debug client has connected. +</p><dl> +<dt>Returns:</dt> +<dd> +flag indicating the connection status (boolean) +</dd> +</dl><a NAME="DebuggerInterfacePython.newConnection" ID="DebuggerInterfacePython.newConnection"></a> +<h4>DebuggerInterfacePython.newConnection</h4> +<b>newConnection</b>(<i>sock</i>) +<p> + Public slot to handle a new connection. +</p><dl> +<dt><i>sockreference</i></dt> +<dd> +to the socket object (QTcpSocket) +</dd> +</dl><dl> +<dt>Returns:</dt> +<dd> +flag indicating success (boolean) +</dd> +</dl><a NAME="DebuggerInterfacePython.remoteBanner" ID="DebuggerInterfacePython.remoteBanner"></a> +<h4>DebuggerInterfacePython.remoteBanner</h4> +<b>remoteBanner</b>(<i></i>) +<p> + Public slot to get the banner info of the remote client. +</p><a NAME="DebuggerInterfacePython.remoteBreakpoint" ID="DebuggerInterfacePython.remoteBreakpoint"></a> +<h4>DebuggerInterfacePython.remoteBreakpoint</h4> +<b>remoteBreakpoint</b>(<i>fn, line, set, cond = None, temp = False</i>) +<p> + Public method to set or clear a breakpoint. +</p><dl> +<dt><i>fn</i></dt> +<dd> +filename the breakpoint belongs to (string) +</dd><dt><i>line</i></dt> +<dd> +linenumber of the breakpoint (int) +</dd><dt><i>set</i></dt> +<dd> +flag indicating setting or resetting a breakpoint (boolean) +</dd><dt><i>cond</i></dt> +<dd> +condition of the breakpoint (string) +</dd><dt><i>temp</i></dt> +<dd> +flag indicating a temporary breakpoint (boolean) +</dd> +</dl><a NAME="DebuggerInterfacePython.remoteBreakpointEnable" ID="DebuggerInterfacePython.remoteBreakpointEnable"></a> +<h4>DebuggerInterfacePython.remoteBreakpointEnable</h4> +<b>remoteBreakpointEnable</b>(<i>fn, line, enable</i>) +<p> + Public method to enable or disable a breakpoint. +</p><dl> +<dt><i>fn</i></dt> +<dd> +filename the breakpoint belongs to (string) +</dd><dt><i>line</i></dt> +<dd> +linenumber of the breakpoint (int) +</dd><dt><i>enable</i></dt> +<dd> +flag indicating enabling or disabling a breakpoint (boolean) +</dd> +</dl><a NAME="DebuggerInterfacePython.remoteBreakpointIgnore" ID="DebuggerInterfacePython.remoteBreakpointIgnore"></a> +<h4>DebuggerInterfacePython.remoteBreakpointIgnore</h4> +<b>remoteBreakpointIgnore</b>(<i>fn, line, count</i>) +<p> + Public method to ignore a breakpoint the next couple of occurrences. +</p><dl> +<dt><i>fn</i></dt> +<dd> +filename the breakpoint belongs to (string) +</dd><dt><i>line</i></dt> +<dd> +linenumber of the breakpoint (int) +</dd><dt><i>count</i></dt> +<dd> +number of occurrences to ignore (int) +</dd> +</dl><a NAME="DebuggerInterfacePython.remoteCapabilities" ID="DebuggerInterfacePython.remoteCapabilities"></a> +<h4>DebuggerInterfacePython.remoteCapabilities</h4> +<b>remoteCapabilities</b>(<i></i>) +<p> + Public slot to get the debug clients capabilities. +</p><a NAME="DebuggerInterfacePython.remoteClientSetFilter" ID="DebuggerInterfacePython.remoteClientSetFilter"></a> +<h4>DebuggerInterfacePython.remoteClientSetFilter</h4> +<b>remoteClientSetFilter</b>(<i>scope, filter</i>) +<p> + Public method to set a variables filter list. +</p><dl> +<dt><i>scope</i></dt> +<dd> +the scope of the variables (0 = local, 1 = global) +</dd><dt><i>filter</i></dt> +<dd> +regexp string for variable names to filter out (string) +</dd> +</dl><a NAME="DebuggerInterfacePython.remoteClientVariable" ID="DebuggerInterfacePython.remoteClientVariable"></a> +<h4>DebuggerInterfacePython.remoteClientVariable</h4> +<b>remoteClientVariable</b>(<i>scope, filter, var, framenr = 0</i>) +<p> + Public method to request the variables of the debugged program. +</p><dl> +<dt><i>scope</i></dt> +<dd> +the scope of the variables (0 = local, 1 = global) +</dd><dt><i>filter</i></dt> +<dd> +list of variable types to filter out (list of int) +</dd><dt><i>var</i></dt> +<dd> +list encoded name of variable to retrieve (string) +</dd><dt><i>framenr</i></dt> +<dd> +framenumber of the variables to retrieve (int) +</dd> +</dl><a NAME="DebuggerInterfacePython.remoteClientVariables" ID="DebuggerInterfacePython.remoteClientVariables"></a> +<h4>DebuggerInterfacePython.remoteClientVariables</h4> +<b>remoteClientVariables</b>(<i>scope, filter, framenr = 0</i>) +<p> + Public method to request the variables of the debugged program. +</p><dl> +<dt><i>scope</i></dt> +<dd> +the scope of the variables (0 = local, 1 = global) +</dd><dt><i>filter</i></dt> +<dd> +list of variable types to filter out (list of int) +</dd><dt><i>framenr</i></dt> +<dd> +framenumber of the variables to retrieve (int) +</dd> +</dl><a NAME="DebuggerInterfacePython.remoteCompletion" ID="DebuggerInterfacePython.remoteCompletion"></a> +<h4>DebuggerInterfacePython.remoteCompletion</h4> +<b>remoteCompletion</b>(<i>text</i>) +<p> + Public slot to get the a list of possible commandline completions + from the remote client. +</p><dl> +<dt><i>text</i></dt> +<dd> +the text to be completed (string) +</dd> +</dl><a NAME="DebuggerInterfacePython.remoteContinue" ID="DebuggerInterfacePython.remoteContinue"></a> +<h4>DebuggerInterfacePython.remoteContinue</h4> +<b>remoteContinue</b>(<i>special = False</i>) +<p> + Public method to continue the debugged program. +</p><dl> +<dt><i>special</i></dt> +<dd> +flag indicating a special continue operation (boolean) +</dd> +</dl><a NAME="DebuggerInterfacePython.remoteCoverage" ID="DebuggerInterfacePython.remoteCoverage"></a> +<h4>DebuggerInterfacePython.remoteCoverage</h4> +<b>remoteCoverage</b>(<i>fn, argv, wd, erase = False</i>) +<p> + Public method to load a new program to collect coverage data. +</p><dl> +<dt><i>fn</i></dt> +<dd> +the filename to run (string) +</dd><dt><i>argv</i></dt> +<dd> +the commandline arguments to pass to the program (string) +</dd><dt><i>wd</i></dt> +<dd> +the working directory for the program (string) +</dd><dt><i>erase=</i></dt> +<dd> +flag indicating that coverage info should be + cleared first (boolean) +</dd> +</dl><a NAME="DebuggerInterfacePython.remoteEnvironment" ID="DebuggerInterfacePython.remoteEnvironment"></a> +<h4>DebuggerInterfacePython.remoteEnvironment</h4> +<b>remoteEnvironment</b>(<i>env</i>) +<p> + Public method to set the environment for a program to debug, run, ... +</p><dl> +<dt><i>env</i></dt> +<dd> +environment settings (dictionary) +</dd> +</dl><a NAME="DebuggerInterfacePython.remoteEval" ID="DebuggerInterfacePython.remoteEval"></a> +<h4>DebuggerInterfacePython.remoteEval</h4> +<b>remoteEval</b>(<i>arg</i>) +<p> + Public method to evaluate arg in the current context of the debugged program. +</p><dl> +<dt><i>arg</i></dt> +<dd> +the arguments to evaluate (string) +</dd> +</dl><a NAME="DebuggerInterfacePython.remoteExec" ID="DebuggerInterfacePython.remoteExec"></a> +<h4>DebuggerInterfacePython.remoteExec</h4> +<b>remoteExec</b>(<i>stmt</i>) +<p> + Public method to execute stmt in the current context of the debugged program. +</p><dl> +<dt><i>stmt</i></dt> +<dd> +statement to execute (string) +</dd> +</dl><a NAME="DebuggerInterfacePython.remoteLoad" ID="DebuggerInterfacePython.remoteLoad"></a> +<h4>DebuggerInterfacePython.remoteLoad</h4> +<b>remoteLoad</b>(<i>fn, argv, wd, traceInterpreter = False, autoContinue = True, autoFork = False, forkChild = False</i>) +<p> + Public method to load a new program to debug. +</p><dl> +<dt><i>fn</i></dt> +<dd> +the filename to debug (string) +</dd><dt><i>argv</i></dt> +<dd> +the commandline arguments to pass to the program (string) +</dd><dt><i>wd</i></dt> +<dd> +the working directory for the program (string) +</dd><dt><i>traceInterpreter=</i></dt> +<dd> +flag indicating if the interpreter library should be + traced as well (boolean) +</dd><dt><i>autoContinue=</i></dt> +<dd> +flag indicating, that the debugger should not stop + at the first executable line (boolean) +</dd><dt><i>autoFork=</i></dt> +<dd> +flag indicating the automatic fork mode (boolean) +</dd><dt><i>forkChild=</i></dt> +<dd> +flag indicating to debug the child after forking (boolean) +</dd> +</dl><a NAME="DebuggerInterfacePython.remoteProfile" ID="DebuggerInterfacePython.remoteProfile"></a> +<h4>DebuggerInterfacePython.remoteProfile</h4> +<b>remoteProfile</b>(<i>fn, argv, wd, erase = False</i>) +<p> + Public method to load a new program to collect profiling data. +</p><dl> +<dt><i>fn</i></dt> +<dd> +the filename to run (string) +</dd><dt><i>argv</i></dt> +<dd> +the commandline arguments to pass to the program (string) +</dd><dt><i>wd</i></dt> +<dd> +the working directory for the program (string) +</dd><dt><i>erase=</i></dt> +<dd> +flag indicating that timing info should be cleared first (boolean) +</dd> +</dl><a NAME="DebuggerInterfacePython.remoteRawInput" ID="DebuggerInterfacePython.remoteRawInput"></a> +<h4>DebuggerInterfacePython.remoteRawInput</h4> +<b>remoteRawInput</b>(<i>s</i>) +<p> + Public method to send the raw input to the debugged program. +</p><dl> +<dt><i>s</i></dt> +<dd> +the raw input (string) +</dd> +</dl><a NAME="DebuggerInterfacePython.remoteRun" ID="DebuggerInterfacePython.remoteRun"></a> +<h4>DebuggerInterfacePython.remoteRun</h4> +<b>remoteRun</b>(<i>fn, argv, wd</i>) +<p> + Public method to load a new program to run. +</p><dl> +<dt><i>fn</i></dt> +<dd> +the filename to run (string) +</dd><dt><i>argv</i></dt> +<dd> +the commandline arguments to pass to the program (string) +</dd><dt><i>wd</i></dt> +<dd> +the working directory for the program (string) +</dd> +</dl><a NAME="DebuggerInterfacePython.remoteSetThread" ID="DebuggerInterfacePython.remoteSetThread"></a> +<h4>DebuggerInterfacePython.remoteSetThread</h4> +<b>remoteSetThread</b>(<i>tid</i>) +<p> + Public method to request to set the given thread as current thread. +</p><dl> +<dt><i>tid</i></dt> +<dd> +id of the thread (integer) +</dd> +</dl><a NAME="DebuggerInterfacePython.remoteStatement" ID="DebuggerInterfacePython.remoteStatement"></a> +<h4>DebuggerInterfacePython.remoteStatement</h4> +<b>remoteStatement</b>(<i>stmt</i>) +<p> + Public method to execute a Python statement. +</p><dl> +<dt><i>stmt</i></dt> +<dd> +the Python statement to execute (string). It + should not have a trailing newline. +</dd> +</dl><a NAME="DebuggerInterfacePython.remoteStep" ID="DebuggerInterfacePython.remoteStep"></a> +<h4>DebuggerInterfacePython.remoteStep</h4> +<b>remoteStep</b>(<i></i>) +<p> + Public method to single step the debugged program. +</p><a NAME="DebuggerInterfacePython.remoteStepOut" ID="DebuggerInterfacePython.remoteStepOut"></a> +<h4>DebuggerInterfacePython.remoteStepOut</h4> +<b>remoteStepOut</b>(<i></i>) +<p> + Public method to step out the debugged program. +</p><a NAME="DebuggerInterfacePython.remoteStepOver" ID="DebuggerInterfacePython.remoteStepOver"></a> +<h4>DebuggerInterfacePython.remoteStepOver</h4> +<b>remoteStepOver</b>(<i></i>) +<p> + Public method to step over the debugged program. +</p><a NAME="DebuggerInterfacePython.remoteStepQuit" ID="DebuggerInterfacePython.remoteStepQuit"></a> +<h4>DebuggerInterfacePython.remoteStepQuit</h4> +<b>remoteStepQuit</b>(<i></i>) +<p> + Public method to stop the debugged program. +</p><a NAME="DebuggerInterfacePython.remoteThreadList" ID="DebuggerInterfacePython.remoteThreadList"></a> +<h4>DebuggerInterfacePython.remoteThreadList</h4> +<b>remoteThreadList</b>(<i></i>) +<p> + Public method to request the list of threads from the client. +</p><a NAME="DebuggerInterfacePython.remoteUTPrepare" ID="DebuggerInterfacePython.remoteUTPrepare"></a> +<h4>DebuggerInterfacePython.remoteUTPrepare</h4> +<b>remoteUTPrepare</b>(<i>fn, tn, tfn, cov, covname, coverase</i>) +<p> + Public method to prepare a new unittest run. +</p><dl> +<dt><i>fn</i></dt> +<dd> +the filename to load (string) +</dd><dt><i>tn</i></dt> +<dd> +the testname to load (string) +</dd><dt><i>tfn</i></dt> +<dd> +the test function name to load tests from (string) +</dd><dt><i>cov</i></dt> +<dd> +flag indicating collection of coverage data is requested +</dd><dt><i>covname</i></dt> +<dd> +filename to be used to assemble the coverage caches + filename +</dd><dt><i>coverase</i></dt> +<dd> +flag indicating erasure of coverage data is requested +</dd> +</dl><a NAME="DebuggerInterfacePython.remoteUTRun" ID="DebuggerInterfacePython.remoteUTRun"></a> +<h4>DebuggerInterfacePython.remoteUTRun</h4> +<b>remoteUTRun</b>(<i></i>) +<p> + Public method to start a unittest run. +</p><a NAME="DebuggerInterfacePython.remoteUTStop" ID="DebuggerInterfacePython.remoteUTStop"></a> +<h4>DebuggerInterfacePython.remoteUTStop</h4> +<b>remoteUTStop</b>(<i></i>) +<p> + Public method to stop a unittest run. +</p><a NAME="DebuggerInterfacePython.remoteWatchpoint" ID="DebuggerInterfacePython.remoteWatchpoint"></a> +<h4>DebuggerInterfacePython.remoteWatchpoint</h4> +<b>remoteWatchpoint</b>(<i>cond, set, temp = False</i>) +<p> + Public method to set or clear a watch expression. +</p><dl> +<dt><i>cond</i></dt> +<dd> +expression of the watch expression (string) +</dd><dt><i>set</i></dt> +<dd> +flag indicating setting or resetting a watch expression (boolean) +</dd><dt><i>temp</i></dt> +<dd> +flag indicating a temporary watch expression (boolean) +</dd> +</dl><a NAME="DebuggerInterfacePython.remoteWatchpointEnable" ID="DebuggerInterfacePython.remoteWatchpointEnable"></a> +<h4>DebuggerInterfacePython.remoteWatchpointEnable</h4> +<b>remoteWatchpointEnable</b>(<i>cond, enable</i>) +<p> + Public method to enable or disable a watch expression. +</p><dl> +<dt><i>cond</i></dt> +<dd> +expression of the watch expression (string) +</dd><dt><i>enable</i></dt> +<dd> +flag indicating enabling or disabling a watch expression (boolean) +</dd> +</dl><a NAME="DebuggerInterfacePython.remoteWatchpointIgnore" ID="DebuggerInterfacePython.remoteWatchpointIgnore"></a> +<h4>DebuggerInterfacePython.remoteWatchpointIgnore</h4> +<b>remoteWatchpointIgnore</b>(<i>cond, count</i>) +<p> + Public method to ignore a watch expression the next couple of occurrences. +</p><dl> +<dt><i>cond</i></dt> +<dd> +expression of the watch expression (string) +</dd><dt><i>count</i></dt> +<dd> +number of occurrences to ignore (int) +</dd> +</dl><a NAME="DebuggerInterfacePython.shutdown" ID="DebuggerInterfacePython.shutdown"></a> +<h4>DebuggerInterfacePython.shutdown</h4> +<b>shutdown</b>(<i></i>) +<p> + Public method to cleanly shut down. +</p><p> + It closes our socket and shuts down + the debug client. (Needed on Win OS) +</p><a NAME="DebuggerInterfacePython.startRemote" ID="DebuggerInterfacePython.startRemote"></a> +<h4>DebuggerInterfacePython.startRemote</h4> +<b>startRemote</b>(<i>port, runInConsole</i>) +<p> + Public method to start a remote Python interpreter. +</p><dl> +<dt><i>port</i></dt> +<dd> +portnumber the debug server is listening on (integer) +</dd><dt><i>runInConsole</i></dt> +<dd> +flag indicating to start the debugger in a + console window (boolean) +</dd> +</dl><dl> +<dt>Returns:</dt> +<dd> +client process object (QProcess) and a flag to indicate + a network connection (boolean) +</dd> +</dl><a NAME="DebuggerInterfacePython.startRemoteForProject" ID="DebuggerInterfacePython.startRemoteForProject"></a> +<h4>DebuggerInterfacePython.startRemoteForProject</h4> +<b>startRemoteForProject</b>(<i>port, runInConsole</i>) +<p> + Public method to start a remote Python interpreter for a project. +</p><dl> +<dt><i>port</i></dt> +<dd> +portnumber the debug server is listening on (integer) +</dd><dt><i>runInConsole</i></dt> +<dd> +flag indicating to start the debugger in a + console window (boolean) +</dd> +</dl><dl> +<dt>Returns:</dt> +<dd> +client process object (QProcess) and a flag to indicate + a network connection (boolean) +</dd> +</dl> +<div align="right"><a href="#top">Up</a></div> +<hr /><hr /> +<a NAME="getRegistryData" ID="getRegistryData"></a> +<h2>getRegistryData</h2> +<b>getRegistryData</b>(<i></i>) +<p> + Module function to get characterising data for the debugger interface. +</p><dl> +<dt>Returns:</dt> +<dd> +list of the following data. Client type (string), client + capabilities (integer), client type association (list of strings) +</dd> +</dl> +<div align="right"><a href="#top">Up</a></div> +<hr /> +</body></html> \ No newline at end of file