Documentation/Source/eric6.Debugger.DebugServer.html

changeset 6352
4bdc6503df81
parent 5899
0516f6548ca6
child 6374
fcd97204ff16
--- a/Documentation/Source/eric6.Debugger.DebugServer.html	Sun Jun 17 13:09:00 2018 +0200
+++ b/Documentation/Source/eric6.Debugger.DebugServer.html	Sun Jun 17 16:56:10 2018 +0200
@@ -1226,44 +1226,43 @@
 </dd>
 </dl><a NAME="DebugServer.remoteCoverage" ID="DebugServer.remoteCoverage"></a>
 <h4>DebugServer.remoteCoverage</h4>
-<b>remoteCoverage</b>(<i>interpreter, fn, argv, wd, env, autoClearShell=True, erase=False, forProject=False, runInConsole=False, clientType=""</i>)
+<b>remoteCoverage</b>(<i>venvName, fn, argv, wd, env, autoClearShell=True, erase=False, forProject=False, runInConsole=False, clientType=""</i>)
 <p>
         Public method to load a new program to collect coverage data.
 </p><dl>
-<dt><i>interpreter</i></dt>
+<dt><i>venvName</i> (str)</dt>
 <dd>
-interpreter to be used to execute the remote
-            side (string)
-</dd><dt><i>fn</i></dt>
+name of the virtual environment to be used
+</dd><dt><i>fn</i> (str)</dt>
 <dd>
-the filename to run (string)
-</dd><dt><i>argv</i></dt>
+the filename to debug
+</dd><dt><i>argv</i> (str)</dt>
 <dd>
-the commandline arguments to pass to the program (string)
-</dd><dt><i>wd</i></dt>
+the command line arguments to pass to the program
+</dd><dt><i>wd</i> (str)</dt>
 <dd>
-the working directory for the program (string)
-</dd><dt><i>env</i></dt>
+the working directory for the program
+</dd><dt><i>env</i> (str)</dt>
 <dd>
-environment settings (string)
-</dd><dt><i>autoClearShell=</i></dt>
+environment parameter settings
+</dd><dt><i>autoClearShell=</i> (bool)</dt>
 <dd>
 flag indicating, that the interpreter window
-            should be cleared (boolean)
-</dd><dt><i>erase=</i></dt>
+            should be cleared
+</dd><dt><i>erase=</i> (bool)</dt>
 <dd>
 flag indicating that coverage info should be
-            cleared first (boolean)
-</dd><dt><i>forProject=</i></dt>
+            cleared first
+</dd><dt><i>forProject=</i> (bool)</dt>
 <dd>
-flag indicating a project related action (boolean)
-</dd><dt><i>runInConsole=</i></dt>
+flag indicating a project related action
+</dd><dt><i>runInConsole=</i> (bool)</dt>
 <dd>
 flag indicating to start the debugger in a
-            console window (boolean)
-</dd><dt><i>clientType=</i></dt>
+            console window
+</dd><dt><i>clientType=</i> (str)</dt>
 <dd>
-client type to be used (string)
+client type to be used
 </dd>
 </dl><a NAME="DebugServer.remoteEnvironment" ID="DebugServer.remoteEnvironment"></a>
 <h4>DebugServer.remoteEnvironment</h4>
@@ -1277,59 +1276,57 @@
 </dd>
 </dl><a NAME="DebugServer.remoteLoad" ID="DebugServer.remoteLoad"></a>
 <h4>DebugServer.remoteLoad</h4>
-<b>remoteLoad</b>(<i>interpreter, fn, argv, wd, env, autoClearShell=True, tracePython=False, autoContinue=True, forProject=False, runInConsole=False, autoFork=False, forkChild=False, clientType="", enableCallTrace=False</i>)
+<b>remoteLoad</b>(<i>venvName, fn, argv, wd, env, autoClearShell=True, tracePython=False, autoContinue=True, forProject=False, runInConsole=False, autoFork=False, forkChild=False, clientType="", enableCallTrace=False</i>)
 <p>
         Public method to load a new program to debug.
 </p><dl>
-<dt><i>interpreter</i></dt>
+<dt><i>venvName</i> (str)</dt>
 <dd>
-interpreter to be used to execute the remote
-            side (string)
-</dd><dt><i>fn</i></dt>
+name of the virtual environment to be used
+</dd><dt><i>fn</i> (str)</dt>
 <dd>
-the filename to debug (string)
-</dd><dt><i>argv</i></dt>
+the filename to debug
+</dd><dt><i>argv</i> (str)</dt>
 <dd>
-the commandline arguments to pass to the program (string)
-</dd><dt><i>wd</i></dt>
+the command line arguments to pass to the program
+</dd><dt><i>wd</i> (str)</dt>
 <dd>
-the working directory for the program (string)
-</dd><dt><i>env</i></dt>
+the working directory for the program
+</dd><dt><i>env</i> (str)</dt>
 <dd>
-environment settings (string)
-</dd><dt><i>autoClearShell=</i></dt>
+environment parameter settings
+</dd><dt><i>autoClearShell=</i> (bool)</dt>
 <dd>
 flag indicating, that the interpreter window
-            should be cleared (boolean)
-</dd><dt><i>tracePython=</i></dt>
+            should be cleared
+</dd><dt><i>tracePython=</i> (bool)</dt>
 <dd>
 flag indicating if the Python library should be
-            traced as well (boolean)
-</dd><dt><i>autoContinue=</i></dt>
+            traced as well
+</dd><dt><i>autoContinue=</i> (bool)</dt>
 <dd>
 flag indicating, that the debugger should not
-            stop at the first executable line (boolean)
-</dd><dt><i>forProject=</i></dt>
+            stop at the first executable line
+</dd><dt><i>forProject=</i> (bool)</dt>
 <dd>
-flag indicating a project related action (boolean)
-</dd><dt><i>runInConsole=</i></dt>
+flag indicating a project related action
+</dd><dt><i>runInConsole=</i> (bool)</dt>
 <dd>
 flag indicating to start the debugger in a
-            console window (boolean)
-</dd><dt><i>autoFork=</i></dt>
+            console window
+</dd><dt><i>autoFork=</i> (bool)</dt>
 <dd>
-flag indicating the automatic fork mode (boolean)
-</dd><dt><i>forkChild=</i></dt>
+flag indicating the automatic fork mode
+</dd><dt><i>forkChild=</i> (bool)</dt>
 <dd>
 flag indicating to debug the child after forking
-            (boolean)
-</dd><dt><i>clientType=</i></dt>
+</dd><dt><i>clientType=</i> (str)</dt>
 <dd>
-client type to be used (string)
-</dd><dt><i>enableCallTrace=</i></dt>
+client type to be used
+</dd><dt><i>enableCallTrace=</i> (bool)</dt>
 <dd>
 flag indicating to enable the call trace
-            function (boolean)
+            function
 </dd>
 </dl><a NAME="DebugServer.remoteMoveIP" ID="DebugServer.remoteMoveIP"></a>
 <h4>DebugServer.remoteMoveIP</h4>
@@ -1343,44 +1340,43 @@
 </dd>
 </dl><a NAME="DebugServer.remoteProfile" ID="DebugServer.remoteProfile"></a>
 <h4>DebugServer.remoteProfile</h4>
-<b>remoteProfile</b>(<i>interpreter, fn, argv, wd, env, autoClearShell=True, erase=False, forProject=False, runInConsole=False, clientType=""</i>)
+<b>remoteProfile</b>(<i>venvName, fn, argv, wd, env, autoClearShell=True, erase=False, forProject=False, runInConsole=False, clientType=""</i>)
 <p>
         Public method to load a new program to collect profiling data.
 </p><dl>
-<dt><i>interpreter</i></dt>
+<dt><i>venvName</i> (str)</dt>
 <dd>
-interpreter to be used to execute the remote
-            side (string)
-</dd><dt><i>fn</i></dt>
+name of the virtual environment to be used
+</dd><dt><i>fn</i> (str)</dt>
 <dd>
-the filename to run (string)
-</dd><dt><i>argv</i></dt>
+the filename to debug
+</dd><dt><i>argv</i> (str)</dt>
 <dd>
-the commandline arguments to pass to the program (string)
-</dd><dt><i>wd</i></dt>
+the command line arguments to pass to the program
+</dd><dt><i>wd</i> (str)</dt>
 <dd>
-the working directory for the program (string)
-</dd><dt><i>env</i></dt>
+the working directory for the program
+</dd><dt><i>env</i> (str)</dt>
 <dd>
-environment settings (string)
-</dd><dt><i>autoClearShell=</i></dt>
+environment parameter settings
+</dd><dt><i>autoClearShell=</i> (bool)</dt>
 <dd>
 flag indicating, that the interpreter window
-            should be cleared (boolean)
-</dd><dt><i>erase=</i></dt>
+            should be cleared
+</dd><dt><i>erase=</i> (bool)</dt>
 <dd>
-flag indicating that timing info should be cleared
-            first (boolean)
-</dd><dt><i>forProject=</i></dt>
+flag indicating that coverage info should be
+            cleared first
+</dd><dt><i>forProject=</i> (bool)</dt>
 <dd>
-flag indicating a project related action (boolean)
-</dd><dt><i>runInConsole=</i></dt>
+flag indicating a project related action
+</dd><dt><i>runInConsole=</i> (bool)</dt>
 <dd>
 flag indicating to start the debugger in a
-            console window (boolean)
-</dd><dt><i>clientType=</i></dt>
+            console window
+</dd><dt><i>clientType=</i> (str)</dt>
 <dd>
-client type to be used (string)
+client type to be used
 </dd>
 </dl><a NAME="DebugServer.remoteRawInput" ID="DebugServer.remoteRawInput"></a>
 <h4>DebugServer.remoteRawInput</h4>
@@ -1394,47 +1390,45 @@
 </dd>
 </dl><a NAME="DebugServer.remoteRun" ID="DebugServer.remoteRun"></a>
 <h4>DebugServer.remoteRun</h4>
-<b>remoteRun</b>(<i>interpreter, fn, argv, wd, env, autoClearShell=True, forProject=False, runInConsole=False, autoFork=False, forkChild=False, clientType=""</i>)
+<b>remoteRun</b>(<i>venvName, fn, argv, wd, env, autoClearShell=True, forProject=False, runInConsole=False, autoFork=False, forkChild=False, clientType=""</i>)
 <p>
         Public method to load a new program to run.
 </p><dl>
-<dt><i>interpreter</i></dt>
+<dt><i>venvName</i> (str)</dt>
 <dd>
-interpreter to be used to execute the remote
-            side (string)
-</dd><dt><i>fn</i></dt>
+name of the virtual environment to be used
+</dd><dt><i>fn</i> (str)</dt>
 <dd>
-the filename to run (string)
-</dd><dt><i>argv</i></dt>
+the filename to debug
+</dd><dt><i>argv</i> (str)</dt>
 <dd>
-the commandline arguments to pass to the program (string)
-</dd><dt><i>wd</i></dt>
+the command line arguments to pass to the program
+</dd><dt><i>wd</i> (str)</dt>
 <dd>
-the working directory for the program (string)
-</dd><dt><i>env</i></dt>
+the working directory for the program
+</dd><dt><i>env</i> (str)</dt>
 <dd>
-environment settings (string)
-</dd><dt><i>autoClearShell=</i></dt>
+environment parameter settings
+</dd><dt><i>autoClearShell=</i> (bool)</dt>
 <dd>
 flag indicating, that the interpreter window
-            should be cleared (boolean)
-</dd><dt><i>forProject=</i></dt>
+            should be cleared
+</dd><dt><i>forProject=</i> (bool)</dt>
 <dd>
-flag indicating a project related action (boolean)
-</dd><dt><i>runInConsole=</i></dt>
+flag indicating a project related action
+</dd><dt><i>runInConsole=</i> (bool)</dt>
 <dd>
 flag indicating to start the debugger in a
-            console window (boolean)
-</dd><dt><i>autoFork=</i></dt>
+            console window
+</dd><dt><i>autoFork=</i> (bool)</dt>
 <dd>
-flag indicating the automatic fork mode (boolean)
-</dd><dt><i>forkChild=</i></dt>
+flag indicating the automatic fork mode
+</dd><dt><i>forkChild=</i> (bool)</dt>
 <dd>
 flag indicating to debug the child after forking
-            (boolean)
-</dd><dt><i>clientType=</i></dt>
+</dd><dt><i>clientType=</i> (str)</dt>
 <dd>
-client type to be used (string)
+client type to be used
 </dd>
 </dl><a NAME="DebugServer.remoteSetThread" ID="DebugServer.remoteSetThread"></a>
 <h4>DebugServer.remoteSetThread</h4>
@@ -1844,27 +1838,26 @@
 </dd>
 </dl><a NAME="DebugServer.startClient" ID="DebugServer.startClient"></a>
 <h4>DebugServer.startClient</h4>
-<b>startClient</b>(<i>unplanned=True, clType=None, forProject=False, runInConsole=False, interpreter=""</i>)
+<b>startClient</b>(<i>unplanned=True, clType=None, forProject=False, runInConsole=False, venvName=""</i>)
 <p>
         Public method to start a debug client.
 </p><dl>
-<dt><i>unplanned=</i></dt>
+<dt><i>unplanned=</i> (bool)</dt>
 <dd>
-flag indicating that the client has died (boolean)
-</dd><dt><i>clType=</i></dt>
+flag indicating that the client has died
+</dd><dt><i>clType=</i> (str)</dt>
 <dd>
-type of client to be started (string)
-</dd><dt><i>forProject=</i></dt>
+type of client to be started
+</dd><dt><i>forProject=</i> (bool)</dt>
 <dd>
-flag indicating a project related action (boolean)
-</dd><dt><i>runInConsole=</i></dt>
+flag indicating a project related action
+</dd><dt><i>runInConsole=</i> (bool)</dt>
 <dd>
 flag indicating to start the debugger in a
-            console window (boolean)
-</dd><dt><i>interpreter=</i></dt>
+            console window
+</dd><dt><i>venvName=</i> (str)</dt>
 <dd>
-interpreter to be used to execute the remote
-            side (string)
+name of the virtual environment to be used
 </dd>
 </dl><a NAME="DebugServer.unregisterDebuggerInterface" ID="DebugServer.unregisterDebuggerInterface"></a>
 <h4>DebugServer.unregisterDebuggerInterface</h4>

eric ide

mercurial