--- a/src/eric7/Documentation/Source/eric7.Debugger.DebuggerInterfacePython.html Fri Jun 14 11:18:10 2024 +0200
+++ b/src/eric7/Documentation/Source/eric7.Debugger.DebuggerInterfacePython.html Fri Jun 14 11:23:45 2024 +0200
@@ -72,19 +72,27 @@
<td>Private method to determine the debug client to be started.</td>
</tr>
<tr>
+<td><a href="#DebuggerInterfacePython.__ericServerTranslation">__ericServerTranslation</a></td>
+<td>Private method to perform the eric-ide server path translation.</td>
+</tr>
+<tr>
<td><a href="#DebuggerInterfacePython.__flush">__flush</a></td>
<td>Private slot to flush the queue.</td>
</tr>
<tr>
-<td><a href="#DebuggerInterfacePython.__handleJsonCommand">__handleJsonCommand</a></td>
-<td>Private method to handle a command or response serialized as a JSON string.</td>
+<td><a href="#DebuggerInterfacePython.__handleServerDebugClientDisconnected">__handleServerDebugClientDisconnected</a></td>
+<td>Private slot handling the disconnect of a debug client.</td>
+</tr>
+<tr>
+<td><a href="#DebuggerInterfacePython.__handleServerLastClientExited">__handleServerLastClientExited</a></td>
+<td>Private slot to handle the exit of the last debug client connected.</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><a href="#DebuggerInterfacePython.__receiveJson">__receiveJson</a></td>
<td>Private method to handle data from the client.</td>
</tr>
<tr>
@@ -120,6 +128,10 @@
<td>Public method to return the IDs of the connected debugger backends.</td>
</tr>
<tr>
+<td><a href="#DebuggerInterfacePython.handleJsonCommand">handleJsonCommand</a></td>
+<td>Public method to handle a command or response serialized as a JSON string.</td>
+</tr>
+<tr>
<td><a href="#DebuggerInterfacePython.isConnected">isConnected</a></td>
<td>Public method to test, if a debug client has connected.</td>
</tr>
@@ -331,38 +343,11 @@
str
</dd>
</dl>
-<a NAME="DebuggerInterfacePython.__flush" ID="DebuggerInterfacePython.__flush"></a>
-<h4>DebuggerInterfacePython.__flush</h4>
-<b>__flush</b>(<i></i>)
-<p>
- Private slot to flush the queue.
-</p>
-
-<a NAME="DebuggerInterfacePython.__handleJsonCommand" ID="DebuggerInterfacePython.__handleJsonCommand"></a>
-<h4>DebuggerInterfacePython.__handleJsonCommand</h4>
-<b>__handleJsonCommand</b>(<i>jsonStr, sock</i>)
+<a NAME="DebuggerInterfacePython.__ericServerTranslation" ID="DebuggerInterfacePython.__ericServerTranslation"></a>
+<h4>DebuggerInterfacePython.__ericServerTranslation</h4>
+<b>__ericServerTranslation</b>(<i>fn, remote2local=True</i>)
<p>
- Private method to handle a command or response serialized as a
- JSON string.
-</p>
-
-<dl>
-
-<dt><i>jsonStr</i> (str)</dt>
-<dd>
-string containing the command or response received
- from the debug backend
-</dd>
-<dt><i>sock</i> (QTcpSocket)</dt>
-<dd>
-reference to the socket the data was received from
-</dd>
-</dl>
-<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.
+ Private method to perform the eric-ide server path translation.
</p>
<dl>
@@ -371,10 +356,10 @@
<dd>
filename to be translated
</dd>
-<dt><i>remote2local</i> (bool)</dt>
+<dt><i>remote2local</i> (bool (optional))</dt>
<dd>
flag indicating the direction of translation
- (False = local to remote, True = remote to local [default]) (unused)
+ (False = local to remote, True = remote to local) (defaults to True)
</dd>
</dl>
<dl>
@@ -389,9 +374,69 @@
str
</dd>
</dl>
-<a NAME="DebuggerInterfacePython.__parseClientLine" ID="DebuggerInterfacePython.__parseClientLine"></a>
-<h4>DebuggerInterfacePython.__parseClientLine</h4>
-<b>__parseClientLine</b>(<i>sock</i>)
+<a NAME="DebuggerInterfacePython.__flush" ID="DebuggerInterfacePython.__flush"></a>
+<h4>DebuggerInterfacePython.__flush</h4>
+<b>__flush</b>(<i></i>)
+<p>
+ Private slot to flush the queue.
+</p>
+
+<a NAME="DebuggerInterfacePython.__handleServerDebugClientDisconnected" ID="DebuggerInterfacePython.__handleServerDebugClientDisconnected"></a>
+<h4>DebuggerInterfacePython.__handleServerDebugClientDisconnected</h4>
+<b>__handleServerDebugClientDisconnected</b>(<i>debuggerId</i>)
+<p>
+ Private slot handling the disconnect of a debug client.
+</p>
+
+<dl>
+
+<dt><i>debuggerId</i> (str)</dt>
+<dd>
+ID of the disconnected debugger
+</dd>
+</dl>
+<a NAME="DebuggerInterfacePython.__handleServerLastClientExited" ID="DebuggerInterfacePython.__handleServerLastClientExited"></a>
+<h4>DebuggerInterfacePython.__handleServerLastClientExited</h4>
+<b>__handleServerLastClientExited</b>(<i></i>)
+<p>
+ Private slot to handle the exit of the last debug client connected.
+</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> (str)</dt>
+<dd>
+filename to be translated
+</dd>
+<dt><i>remote2local</i> (bool (optional))</dt>
+<dd>
+flag indicating the direction of translation
+ (False = local to remote, True = remote to local) (defaults to True)
+ (unused)
+</dd>
+</dl>
+<dl>
+<dt>Return:</dt>
+<dd>
+translated filename
+</dd>
+</dl>
+<dl>
+<dt>Return Type:</dt>
+<dd>
+str
+</dd>
+</dl>
+<a NAME="DebuggerInterfacePython.__receiveJson" ID="DebuggerInterfacePython.__receiveJson"></a>
+<h4>DebuggerInterfacePython.__receiveJson</h4>
+<b>__receiveJson</b>(<i>sock</i>)
<p>
Private method to handle data from the client.
</p>
@@ -416,10 +461,10 @@
<dd>
filename to be translated
</dd>
-<dt><i>remote2local</i> (bool)</dt>
+<dt><i>remote2local</i> (bool (optional))</dt>
<dd>
flag indicating the direction of translation
- (False = local to remote, True = remote to local [default])
+ (False = local to remote, True = remote to local) (defaults to True)
</dd>
</dl>
<dl>
@@ -491,7 +536,7 @@
</dl>
<a NAME="DebuggerInterfacePython.__startProcess" ID="DebuggerInterfacePython.__startProcess"></a>
<h4>DebuggerInterfacePython.__startProcess</h4>
-<b>__startProcess</b>(<i>program, arguments, environment=None, workingDir=None</i>)
+<b>__startProcess</b>(<i>program, arguments, environment=None, workingDir=""</i>)
<p>
Private method to start the debugger client process.
</p>
@@ -583,6 +628,26 @@
list of str
</dd>
</dl>
+<a NAME="DebuggerInterfacePython.handleJsonCommand" ID="DebuggerInterfacePython.handleJsonCommand"></a>
+<h4>DebuggerInterfacePython.handleJsonCommand</h4>
+<b>handleJsonCommand</b>(<i>jsonStr, sock</i>)
+<p>
+ Public method to handle a command or response serialized as a
+ JSON string.
+</p>
+
+<dl>
+
+<dt><i>jsonStr</i> (str)</dt>
+<dd>
+string containing the command or response received
+ from the debug backend
+</dd>
+<dt><i>sock</i> (QTcpSocket)</dt>
+<dd>
+reference to the socket the data was received from
+</dd>
+</dl>
<a NAME="DebuggerInterfacePython.isConnected" ID="DebuggerInterfacePython.isConnected"></a>
<h4>DebuggerInterfacePython.isConnected</h4>
<b>isConnected</b>(<i></i>)
@@ -1307,7 +1372,7 @@
<a NAME="DebuggerInterfacePython.startRemote" ID="DebuggerInterfacePython.startRemote"></a>
<h4>DebuggerInterfacePython.startRemote</h4>
-<b>startRemote</b>(<i>port, runInConsole, venvName, originalPathString, workingDir=None, configOverride=None, </i>)
+<b>startRemote</b>(<i>port, runInConsole, venvName, originalPathString, workingDir="", configOverride=None, startRemote=None, </i>)
<p>
Public method to start a remote Python interpreter.
</p>
@@ -1331,14 +1396,19 @@
<dd>
original PATH environment variable
</dd>
-<dt><i>workingDir</i> (str)</dt>
+<dt><i>workingDir</i> (str (optional))</dt>
<dd>
-directory to start the debugger client in
+directory to start the debugger client in (defaults to "")
</dd>
-<dt><i>configOverride</i> (dict)</dt>
+<dt><i>configOverride</i> (dict (optional))</dt>
<dd>
-dictionary containing the global config override
- data
+dictionary containing the global config override data
+ (defaults to None)
+</dd>
+<dt><i>startRemote</i> (bool (optional))</dt>
+<dd>
+flag indicating to start the client via an eric-ide server
+ (defaults to None)
</dd>
</dl>
<dl>
@@ -1356,7 +1426,7 @@
</dl>
<a NAME="DebuggerInterfacePython.startRemoteForProject" ID="DebuggerInterfacePython.startRemoteForProject"></a>
<h4>DebuggerInterfacePython.startRemoteForProject</h4>
-<b>startRemoteForProject</b>(<i>port, runInConsole, venvName, originalPathString, workingDir=None, configOverride=None, </i>)
+<b>startRemoteForProject</b>(<i>port, runInConsole, venvName, originalPathString, workingDir=None, configOverride=None, startRemote=False, </i>)
<p>
Public method to start a remote Python interpreter for a project.
</p>
@@ -1389,6 +1459,11 @@
dictionary containing the global config override
data
</dd>
+<dt><i>startRemote</i> (bool (optional))</dt>
+<dd>
+flag indicating to start the client via an eric-ide server
+ (defaults to False)
+</dd>
</dl>
<dl>
<dt>Return:</dt>
