--- a/src/eric7/Documentation/Source/eric7.DebugClients.Python.MultiProcessDebugExtension.html Thu Jan 04 17:16:15 2024 +0100
+++ b/src/eric7/Documentation/Source/eric7.DebugClients.Python.MultiProcessDebugExtension.html Thu Jan 04 18:02:25 2024 +0100
@@ -7,25 +7,23 @@
<body>
<a NAME="top" ID="top"></a>
<h1>eric7.DebugClients.Python.MultiProcessDebugExtension</h1>
-
<p>
Module implementing a function to patch the process creation functions to
support multiprocess debugging.
</p>
+
<h3>Global Attributes</h3>
-
<table>
<tr><td>_debugClient</td></tr>
</table>
+
<h3>Classes</h3>
-
<table>
<tr><td>None</td></tr>
</table>
+
<h3>Functions</h3>
-
<table>
-
<tr>
<td><a href="#_shallPatch">_shallPatch</a></td>
<td>Function to determine, if the multiprocessing patches should be done.</td>
@@ -119,15 +117,16 @@
<td>Function to patch the process creation functions to support multiprocess debugging.</td>
</tr>
</table>
+
<hr />
<hr />
<a NAME="_shallPatch" ID="_shallPatch"></a>
<h2>_shallPatch</h2>
<b>_shallPatch</b>(<i></i>)
-
<p>
Function to determine, if the multiprocessing patches should be done.
</p>
+
<dl>
<dt>Return:</dt>
<dd>
@@ -146,11 +145,11 @@
<a NAME="createCreateProcess" ID="createCreateProcess"></a>
<h2>createCreateProcess</h2>
<b>createCreateProcess</b>(<i>originalName</i>)
-
<p>
Function to patch the 'CreateProcess' process creation function of
Windows.
</p>
+
<dl>
<dt><i>originalName</i> (str)</dt>
@@ -176,7 +175,6 @@
<a NAME="createExecl" ID="createExecl"></a>
<h2>createExecl</h2>
<b>createExecl</b>(<i>originalName</i>)
-
<p>
Function to patch the 'execl' process creation functions.
</p>
@@ -188,6 +186,7 @@
<li>os.execlpe(file, arg0, arg1, ..., env)</li>
</ul>
</p>
+
<dl>
<dt><i>originalName</i> (str)</dt>
@@ -213,7 +212,6 @@
<a NAME="createExecv" ID="createExecv"></a>
<h2>createExecv</h2>
<b>createExecv</b>(<i>originalName</i>)
-
<p>
Function to patch the 'execv' process creation functions.
</p>
@@ -223,6 +221,7 @@
<li>os.execvp(file, args)</li>
</ul>
</p>
+
<dl>
<dt><i>originalName</i> (str)</dt>
@@ -248,7 +247,6 @@
<a NAME="createExecve" ID="createExecve"></a>
<h2>createExecve</h2>
<b>createExecve</b>(<i>originalName</i>)
-
<p>
Function to patch the 'execve' process creation functions.
</p>
@@ -258,6 +256,7 @@
<li>os.execvpe(file, args, env)</li>
</ul>
</p>
+
<dl>
<dt><i>originalName</i> (str)</dt>
@@ -283,7 +282,6 @@
<a NAME="createFork" ID="createFork"></a>
<h2>createFork</h2>
<b>createFork</b>(<i>originalName</i>)
-
<p>
Function to patch the 'fork' process creation functions.
</p>
@@ -292,6 +290,7 @@
<li>os.fork()</li>
</ul>
</p>
+
<dl>
<dt><i>originalName</i> (str)</dt>
@@ -317,7 +316,6 @@
<a NAME="createForkExec" ID="createForkExec"></a>
<h2>createForkExec</h2>
<b>createForkExec</b>(<i>originalName</i>)
-
<p>
Function to patch the 'fork_exec' process creation functions.
</p>
@@ -327,6 +325,7 @@
... (13 more))</li>
</ul>
</p>
+
<dl>
<dt><i>originalName</i> (str)</dt>
@@ -352,7 +351,6 @@
<a NAME="createPosixSpawn" ID="createPosixSpawn"></a>
<h2>createPosixSpawn</h2>
<b>createPosixSpawn</b>(<i>originalName</i>)
-
<p>
Function to patch the 'posix_spawn' process creation functions.
</p>
@@ -364,6 +362,7 @@
(6 more))</li>
</ul>
</p>
+
<dl>
<dt><i>originalName</i> (str)</dt>
@@ -389,7 +388,6 @@
<a NAME="createSpawnl" ID="createSpawnl"></a>
<h2>createSpawnl</h2>
<b>createSpawnl</b>(<i>originalName</i>)
-
<p>
Function to patch the 'spawnl' process creation functions.
</p>
@@ -399,6 +397,7 @@
<li>os.spawnlp(mode, file, arg0, arg1, ...)</li>
</ul>
</p>
+
<dl>
<dt><i>originalName</i> (str)</dt>
@@ -424,7 +423,6 @@
<a NAME="createSpawnv" ID="createSpawnv"></a>
<h2>createSpawnv</h2>
<b>createSpawnv</b>(<i>originalName</i>)
-
<p>
Function to patch the 'spawnv' process creation functions.
</p>
@@ -434,6 +432,7 @@
<li>os.spawnvp(mode, file, args)</li>
</ul>
</p>
+
<dl>
<dt><i>originalName</i> (str)</dt>
@@ -459,7 +458,6 @@
<a NAME="createSpawnve" ID="createSpawnve"></a>
<h2>createSpawnve</h2>
<b>createSpawnve</b>(<i>originalName</i>)
-
<p>
Function to patch the 'spawnve' process creation functions.
</p>
@@ -469,6 +467,7 @@
<li>os.spawnvpe(mode, file, args, env)</li>
</ul>
</p>
+
<dl>
<dt><i>originalName</i> (str)</dt>
@@ -494,112 +493,112 @@
<a NAME="newCreateProcess" ID="newCreateProcess"></a>
<h2>newCreateProcess</h2>
<b>newCreateProcess</b>(<i>appName, cmdline, *args</i>)
-
<p>
Function replacing the 'CreateProcess' function of the _subprocess
or _winapi module.
</p>
+
<div align="right"><a href="#top">Up</a></div>
<hr />
<hr />
<a NAME="newExecl" ID="newExecl"></a>
<h2>newExecl</h2>
<b>newExecl</b>(<i>path, *args</i>)
-
<p>
Function replacing the 'execl' functions of the os module.
</p>
+
<div align="right"><a href="#top">Up</a></div>
<hr />
<hr />
<a NAME="newExecv" ID="newExecv"></a>
<h2>newExecv</h2>
<b>newExecv</b>(<i>path, args</i>)
-
<p>
Function replacing the 'execv' functions of the os module.
</p>
+
<div align="right"><a href="#top">Up</a></div>
<hr />
<hr />
<a NAME="newExecve" ID="newExecve"></a>
<h2>newExecve</h2>
<b>newExecve</b>(<i>path, args, env</i>)
-
<p>
Function replacing the 'execve' functions of the os module.
</p>
+
<div align="right"><a href="#top">Up</a></div>
<hr />
<hr />
<a NAME="newFork" ID="newFork"></a>
<h2>newFork</h2>
<b>newFork</b>(<i></i>)
-
<p>
Function replacing the 'fork' function of the os module.
</p>
+
<div align="right"><a href="#top">Up</a></div>
<hr />
<hr />
<a NAME="newForkExec" ID="newForkExec"></a>
<h2>newForkExec</h2>
<b>newForkExec</b>(<i>args, *other_args</i>)
-
<p>
Function replacing the 'fork_exec' functions of the _posixsubprocess
module.
</p>
+
<div align="right"><a href="#top">Up</a></div>
<hr />
<hr />
<a NAME="newPosixSpawn" ID="newPosixSpawn"></a>
<h2>newPosixSpawn</h2>
<b>newPosixSpawn</b>(<i>path, argv, env, **kwargs</i>)
-
<p>
Function replacing the 'posix_spawn' functions of the os module.
</p>
+
<div align="right"><a href="#top">Up</a></div>
<hr />
<hr />
<a NAME="newSpawnl" ID="newSpawnl"></a>
<h2>newSpawnl</h2>
<b>newSpawnl</b>(<i>mode, path, *args</i>)
-
<p>
Function replacing the 'spawnl' functions of the os module.
</p>
+
<div align="right"><a href="#top">Up</a></div>
<hr />
<hr />
<a NAME="newSpawnv" ID="newSpawnv"></a>
<h2>newSpawnv</h2>
<b>newSpawnv</b>(<i>mode, path, args</i>)
-
<p>
Function replacing the 'spawnv' functions of the os module.
</p>
+
<div align="right"><a href="#top">Up</a></div>
<hr />
<hr />
<a NAME="newSpawnve" ID="newSpawnve"></a>
<h2>newSpawnve</h2>
<b>newSpawnve</b>(<i>mode, path, args, env</i>)
-
<p>
Function replacing the 'spawnve' functions of the os module.
</p>
+
<div align="right"><a href="#top">Up</a></div>
<hr />
<hr />
<a NAME="patchModule" ID="patchModule"></a>
<h2>patchModule</h2>
<b>patchModule</b>(<i>module, functionName, createFunction</i>)
-
<p>
Function to replace a function of a module with a modified one.
</p>
+
<dl>
<dt><i>module</i> (types.ModuleType)</dt>
@@ -621,11 +620,11 @@
<a NAME="patchNewProcessFunctions" ID="patchNewProcessFunctions"></a>
<h2>patchNewProcessFunctions</h2>
<b>patchNewProcessFunctions</b>(<i>multiprocessEnabled, debugClient</i>)
-
<p>
Function to patch the process creation functions to support multiprocess
debugging.
</p>
+
<dl>
<dt><i>multiprocessEnabled</i> (bool)</dt>
@@ -639,4 +638,4 @@
</dl>
<div align="right"><a href="#top">Up</a></div>
<hr />
-</body></html>
\ No newline at end of file
+</body></html>
