eric6/Documentation/Source/eric6.DebugClients.Python.DebugClientBase.html

changeset 7887
c1588f5a83e9
parent 7707
6abcf4275d0e
child 7898
1bcd6d4df182
--- a/eric6/Documentation/Source/eric6.DebugClients.Python.DebugClientBase.html	Thu Dec 17 14:30:46 2020 +0100
+++ b/eric6/Documentation/Source/eric6.DebugClients.Python.DebugClientBase.html	Thu Dec 17 14:40:06 2020 +0100
@@ -48,10 +48,6 @@
 <td>Replacement for the standard os.close(fd).</td>
 </tr>
 <tr>
-<td><a href="#DebugClientFork">DebugClientFork</a></td>
-<td>Replacement for the standard os.fork().</td>
-</tr>
-<tr>
 <td><a href="#DebugClientInput">DebugClientInput</a></td>
 <td>Replacement for the standard input() builtin.</td>
 </tr>
@@ -115,6 +111,10 @@
 <td>Private method to determine the clients capabilities.</td>
 </tr>
 <tr>
+<td><a href="#DebugClientBase.__compileCommand">__compileCommand</a></td>
+<td>Private method to compile source code.</td>
+</tr>
+<tr>
 <td><a href="#DebugClientBase.__compileFileSource">__compileFileSource</a></td>
 <td>Private method to compile source code read from a file.</td>
 </tr>
@@ -199,10 +199,6 @@
 <td>Public method to poll for events like 'set break point'.</td>
 </tr>
 <tr>
-<td><a href="#DebugClientBase.fork">fork</a></td>
-<td>Public method implementing a fork routine deciding which branch to follow.</td>
-</tr>
-<tr>
 <td><a href="#DebugClientBase.getCoding">getCoding</a></td>
 <td>Public method to return the current coding.</td>
 </tr>
@@ -247,6 +243,10 @@
 <td>Public method to signal the deletion of a temporary watch expression.</td>
 </tr>
 <tr>
+<td><a href="#DebugClientBase.sendDebuggerId">sendDebuggerId</a></td>
+<td>Public method to send the debug client id.</td>
+</tr>
+<tr>
 <td><a href="#DebugClientBase.sendException">sendException</a></td>
 <td>Public method to send information for an exception.</td>
 </tr>
@@ -345,6 +345,34 @@
 client capabilities (integer)
 </dd>
 </dl>
+<a NAME="DebugClientBase.__compileCommand" ID="DebugClientBase.__compileCommand"></a>
+<h4>DebugClientBase.__compileCommand</h4>
+<b>__compileCommand</b>(<i>statement, filename="<string>", mode="exec"</i>)
+
+<p>
+        Private method to compile source code.
+</p>
+<dl>
+
+<dt><i>statement</i> (str)</dt>
+<dd>
+source code string to be compiled
+</dd>
+<dt><i>filename</i> (str)</dt>
+<dd>
+name of the source file
+</dd>
+<dt><i>mode</i> (str)</dt>
+<dd>
+kind of code to be generated (exec or eval)
+</dd>
+</dl>
+<dl>
+<dt>Returns:</dt>
+<dd>
+compiled code object (None in case of errors)
+</dd>
+</dl>
 <a NAME="DebugClientBase.__compileFileSource" ID="DebugClientBase.__compileFileSource"></a>
 <h4>DebugClientBase.__compileFileSource</h4>
 <b>__compileFileSource</b>(<i>filename, mode='exec'</i>)
@@ -354,13 +382,13 @@
 </p>
 <dl>
 
-<dt><i>filename</i></dt>
+<dt><i>filename</i> (str)</dt>
 <dd>
-name of the source file (string)
+name of the source file
 </dd>
-<dt><i>mode</i></dt>
+<dt><i>mode</i> (str)</dt>
 <dd>
-kind of code to be generated (string, exec or eval)
+kind of code to be generated (exec or eval)
 </dd>
 </dl>
 <dl>
@@ -406,7 +434,7 @@
 </dd>
 <dt><i>filterList</i> (list of int)</dt>
 <dd>
-the indices of variable types to be filtered
+list of variable types to be filtered
 </dd>
 </dl>
 <a NAME="DebugClientBase.__dumpVariables" ID="DebugClientBase.__dumpVariables"></a>
@@ -426,9 +454,9 @@
 <dd>
 1 to report global variables, 0 for local variables
 </dd>
-<dt><i>filterList</i> (list of int)</dt>
+<dt><i>filterList</i> (list of str)</dt>
 <dd>
-the indices of variable types to be filtered
+list of variable types to be filtered
 </dd>
 </dl>
 <a NAME="DebugClientBase.__extractIndicators" ID="DebugClientBase.__extractIndicators"></a>
@@ -511,9 +539,9 @@
             Variables are only added to the list, if their name do not match
             any of the filter expressions.
 </dd>
-<dt><i>filterList</i> (list of int)</dt>
+<dt><i>filterList</i> (list of str)</dt>
 <dd>
-the indices of variable types to be filtered.
+list of variable types to be filtered.
             Variables are only added to the list, if their type is not
             contained in the filter list.
 </dd>
@@ -726,7 +754,7 @@
 </dl>
 <a NAME="DebugClientBase.connectDebugger" ID="DebugClientBase.connectDebugger"></a>
 <h4>DebugClientBase.connectDebugger</h4>
-<b>connectDebugger</b>(<i>port, remoteAddress=None, redirect=True</i>)
+<b>connectDebugger</b>(<i>port, remoteAddress=None, redirect=True, name=""</i>)
 
 <p>
         Public method to establish a session with the debugger.
@@ -738,19 +766,22 @@
 </p>
 <dl>
 
-<dt><i>port</i></dt>
+<dt><i>port</i> (int)</dt>
 <dd>
-the port number to connect to (int)
+the port number to connect to
 </dd>
-<dt><i>remoteAddress</i></dt>
+<dt><i>remoteAddress</i> (str)</dt>
 <dd>
 the network address of the debug server host
-            (string)
 </dd>
-<dt><i>redirect</i></dt>
+<dt><i>redirect</i> (bool)</dt>
 <dd>
 flag indicating redirection of stdin, stdout and
-            stderr (boolean)
+            stderr
+</dd>
+<dt><i>name</i> (str)</dt>
+<dd>
+name to be attached to the debugger ID
 </dd>
 </dl>
 <a NAME="DebugClientBase.eventLoop" ID="DebugClientBase.eventLoop"></a>
@@ -775,20 +806,6 @@
 <p>
         Public method to poll for events like 'set break point'.
 </p>
-<a NAME="DebugClientBase.fork" ID="DebugClientBase.fork"></a>
-<h4>DebugClientBase.fork</h4>
-<b>fork</b>(<i></i>)
-
-<p>
-        Public method implementing a fork routine deciding which branch
-        to follow.
-</p>
-<dl>
-<dt>Returns:</dt>
-<dd>
-process ID (integer)
-</dd>
-</dl>
 <a NAME="DebugClientBase.getCoding" ID="DebugClientBase.getCoding"></a>
 <h4>DebugClientBase.getCoding</h4>
 <b>getCoding</b>(<i></i>)
@@ -988,6 +1005,21 @@
 condition of the watch expression to be cleared
 </dd>
 </dl>
+<a NAME="DebugClientBase.sendDebuggerId" ID="DebugClientBase.sendDebuggerId"></a>
+<h4>DebugClientBase.sendDebuggerId</h4>
+<b>sendDebuggerId</b>(<i>debuggerId</i>)
+
+<p>
+        Public method to send the debug client id.
+</p>
+<dl>
+
+<dt><i>debuggerId</i> (str)</dt>
+<dd>
+id of this debug client instance (made up of
+            hostname and process ID)
+</dd>
+</dl>
 <a NAME="DebugClientBase.sendException" ID="DebugClientBase.sendException"></a>
 <h4>DebugClientBase.sendException</h4>
 <b>sendException</b>(<i>exceptionType, exceptionMessage, stack</i>)
@@ -1119,48 +1151,55 @@
 </dl>
 <a NAME="DebugClientBase.startDebugger" ID="DebugClientBase.startDebugger"></a>
 <h4>DebugClientBase.startDebugger</h4>
-<b>startDebugger</b>(<i>filename=None, host=None, port=None, enableTrace=True, exceptions=True, tracePython=False, redirect=True</i>)
+<b>startDebugger</b>(<i>filename=None, host=None, port=None, enableTrace=True, exceptions=True, tracePython=False, redirect=True, passive=True, multiprocessSupport=False</i>)
 
 <p>
         Public method used to start the remote debugger.
 </p>
 <dl>
 
-<dt><i>filename</i></dt>
+<dt><i>filename</i> (str)</dt>
 <dd>
-the program to be debugged (string)
+the program to be debugged
 </dd>
-<dt><i>host</i></dt>
+<dt><i>host</i> (str)</dt>
 <dd>
-hostname of the debug server (string)
+hostname of the debug server
 </dd>
-<dt><i>port</i></dt>
+<dt><i>port</i> (int)</dt>
 <dd>
-portnumber of the debug server (int)
+portnumber of the debug server
 </dd>
-<dt><i>enableTrace</i></dt>
+<dt><i>enableTrace</i> (bool)</dt>
 <dd>
-flag to enable the tracing function (boolean)
+flag to enable the tracing function
 </dd>
-<dt><i>exceptions</i></dt>
+<dt><i>exceptions</i> (bool)</dt>
 <dd>
 flag to enable exception reporting of the IDE
-            (boolean)
 </dd>
-<dt><i>tracePython</i></dt>
+<dt><i>tracePython</i> (bool)</dt>
 <dd>
 flag to enable tracing into the Python library
-            (boolean)
 </dd>
-<dt><i>redirect</i></dt>
+<dt><i>redirect</i> (bool)</dt>
 <dd>
 flag indicating redirection of stdin, stdout and
-            stderr (boolean)
+            stderr
+</dd>
+<dt><i>passive</i> (bool)</dt>
+<dd>
+flag indicating a passive debugging session
+</dd>
+<dt><i>multiprocessSupport</i> (bool)</dt>
+<dd>
+flag indicating to enable multiprocess
+            debugging support
 </dd>
 </dl>
 <a NAME="DebugClientBase.startProgInDebugger" ID="DebugClientBase.startProgInDebugger"></a>
 <h4>DebugClientBase.startProgInDebugger</h4>
-<b>startProgInDebugger</b>(<i>progargs, wd='', host=None, port=None, exceptions=True, tracePython=False, redirect=True</i>)
+<b>startProgInDebugger</b>(<i>progargs, wd='', host=None, port=None, exceptions=True, tracePython=False, redirect=True, passive=True, multiprocessSupport=False, codeStr=""</i>)
 
 <p>
         Public method used to start the remote debugger.
@@ -1199,6 +1238,31 @@
 flag indicating redirection of stdin, stdout and
             stderr (boolean)
 </dd>
+<dt><i>passive</i> (bool)</dt>
+<dd>
+flag indicating a passive debugging session
+</dd>
+<dt><i>multiprocessSupport</i> (bool)</dt>
+<dd>
+flag indicating to enable multiprocess
+            debugging support
+</dd>
+<dt><i>codeStr</i> (str)</dt>
+<dd>
+string containing Python code to execute
+</dd>
+</dl>
+<dl>
+<dt>Returns:</dt>
+<dd>
+exit code of the debugged program
+</dd>
+</dl>
+<dl>
+<dt>Return Type:</dt>
+<dd>
+int
+</dd>
 </dl>
 <a NAME="DebugClientBase.writeReady" ID="DebugClientBase.writeReady"></a>
 <h4>DebugClientBase.writeReady</h4>
@@ -1234,22 +1298,6 @@
 <div align="right"><a href="#top">Up</a></div>
 <hr />
 <hr />
-<a NAME="DebugClientFork" ID="DebugClientFork"></a>
-<h2>DebugClientFork</h2>
-<b>DebugClientFork</b>(<i></i>)
-
-<p>
-    Replacement for the standard os.fork().
-</p>
-<dl>
-<dt>Returns:</dt>
-<dd>
-result of the fork() call
-</dd>
-</dl>
-<div align="right"><a href="#top">Up</a></div>
-<hr />
-<hr />
 <a NAME="DebugClientInput" ID="DebugClientInput"></a>
 <h2>DebugClientInput</h2>
 <b>DebugClientInput</b>(<i>prompt=""</i>)

eric ide

mercurial