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

Fri, 22 Jan 2021 16:48:43 +0100

author
Detlev Offenbach <detlev@die-offenbachs.de>
date
Fri, 22 Jan 2021 16:48:43 +0100
changeset 7998
cd41c844862f
parent 7890
c7b98271f551
permissions
-rw-r--r--

Editor
- added functionality to insert docstring templates via the context menu (cursor placed on first line of function definition) or after entering the docstring start string (e.g. """ for Python)

7890
c7b98271f551 Updated the source documentation.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
1 <!DOCTYPE html>
c7b98271f551 Updated the source documentation.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
2 <html><head>
c7b98271f551 Updated the source documentation.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
3 <title>eric6.DebugClients.Python.SubprocessExtension</title>
c7b98271f551 Updated the source documentation.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
4 <meta charset="UTF-8">
c7b98271f551 Updated the source documentation.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
5 <style>
c7b98271f551 Updated the source documentation.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
6 body {
c7b98271f551 Updated the source documentation.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
7 background: #EDECE6;
c7b98271f551 Updated the source documentation.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
8 margin: 0em 1em 10em 1em;
c7b98271f551 Updated the source documentation.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
9 color: black;
c7b98271f551 Updated the source documentation.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
10 }
c7b98271f551 Updated the source documentation.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
11
c7b98271f551 Updated the source documentation.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
12 h1 { color: white; background: #85774A; }
c7b98271f551 Updated the source documentation.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
13 h2 { color: white; background: #85774A; }
c7b98271f551 Updated the source documentation.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
14 h3 { color: white; background: #9D936E; }
c7b98271f551 Updated the source documentation.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
15 h4 { color: white; background: #9D936E; }
c7b98271f551 Updated the source documentation.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
16
c7b98271f551 Updated the source documentation.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
17 a { color: #BA6D36; }
c7b98271f551 Updated the source documentation.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
18
c7b98271f551 Updated the source documentation.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
19 </style>
c7b98271f551 Updated the source documentation.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
20 </head>
c7b98271f551 Updated the source documentation.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
21 <body>
c7b98271f551 Updated the source documentation.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
22 <a NAME="top" ID="top"></a>
c7b98271f551 Updated the source documentation.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
23 <h1>eric6.DebugClients.Python.SubprocessExtension</h1>
c7b98271f551 Updated the source documentation.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
24
c7b98271f551 Updated the source documentation.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
25 <p>
c7b98271f551 Updated the source documentation.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
26 Module implementing a function to patch subprocess.Popen to support debugging
c7b98271f551 Updated the source documentation.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
27 of the process.
c7b98271f551 Updated the source documentation.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
28 </p>
c7b98271f551 Updated the source documentation.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
29 <h3>Global Attributes</h3>
c7b98271f551 Updated the source documentation.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
30
c7b98271f551 Updated the source documentation.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
31 <table>
c7b98271f551 Updated the source documentation.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
32 <tr><td>_debugClient</td></tr>
c7b98271f551 Updated the source documentation.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
33 </table>
c7b98271f551 Updated the source documentation.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
34 <h3>Classes</h3>
c7b98271f551 Updated the source documentation.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
35
c7b98271f551 Updated the source documentation.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
36 <table>
c7b98271f551 Updated the source documentation.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
37
c7b98271f551 Updated the source documentation.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
38 <tr>
c7b98271f551 Updated the source documentation.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
39 <td><a href="#PopenWrapper">PopenWrapper</a></td>
c7b98271f551 Updated the source documentation.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
40 <td>Wrapper class for subprocess.Popen.</td>
c7b98271f551 Updated the source documentation.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
41 </tr>
c7b98271f551 Updated the source documentation.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
42 </table>
c7b98271f551 Updated the source documentation.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
43 <h3>Functions</h3>
c7b98271f551 Updated the source documentation.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
44
c7b98271f551 Updated the source documentation.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
45 <table>
c7b98271f551 Updated the source documentation.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
46
c7b98271f551 Updated the source documentation.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
47 <tr>
c7b98271f551 Updated the source documentation.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
48 <td><a href="#patchSubprocess">patchSubprocess</a></td>
c7b98271f551 Updated the source documentation.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
49 <td>Function to patch the subprocess module.</td>
c7b98271f551 Updated the source documentation.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
50 </tr>
c7b98271f551 Updated the source documentation.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
51 </table>
c7b98271f551 Updated the source documentation.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
52 <hr />
c7b98271f551 Updated the source documentation.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
53 <hr />
c7b98271f551 Updated the source documentation.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
54 <a NAME="PopenWrapper" ID="PopenWrapper"></a>
c7b98271f551 Updated the source documentation.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
55 <h2>PopenWrapper</h2>
c7b98271f551 Updated the source documentation.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
56
c7b98271f551 Updated the source documentation.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
57 <p>
c7b98271f551 Updated the source documentation.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
58 Wrapper class for subprocess.Popen.
c7b98271f551 Updated the source documentation.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
59 </p>
c7b98271f551 Updated the source documentation.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
60 <h3>Derived from</h3>
c7b98271f551 Updated the source documentation.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
61 module.Popen
c7b98271f551 Updated the source documentation.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
62 <h3>Class Attributes</h3>
c7b98271f551 Updated the source documentation.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
63
c7b98271f551 Updated the source documentation.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
64 <table>
c7b98271f551 Updated the source documentation.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
65 <tr><td>None</td></tr>
c7b98271f551 Updated the source documentation.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
66 </table>
c7b98271f551 Updated the source documentation.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
67 <h3>Class Methods</h3>
c7b98271f551 Updated the source documentation.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
68
c7b98271f551 Updated the source documentation.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
69 <table>
c7b98271f551 Updated the source documentation.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
70 <tr><td>None</td></tr>
c7b98271f551 Updated the source documentation.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
71 </table>
c7b98271f551 Updated the source documentation.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
72 <h3>Methods</h3>
c7b98271f551 Updated the source documentation.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
73
c7b98271f551 Updated the source documentation.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
74 <table>
c7b98271f551 Updated the source documentation.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
75
c7b98271f551 Updated the source documentation.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
76 <tr>
c7b98271f551 Updated the source documentation.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
77 <td><a href="#PopenWrapper.__init__">PopenWrapper</a></td>
c7b98271f551 Updated the source documentation.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
78 <td>Constructor</td>
c7b98271f551 Updated the source documentation.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
79 </tr>
c7b98271f551 Updated the source documentation.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
80 </table>
c7b98271f551 Updated the source documentation.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
81 <h3>Static Methods</h3>
c7b98271f551 Updated the source documentation.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
82
c7b98271f551 Updated the source documentation.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
83 <table>
c7b98271f551 Updated the source documentation.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
84 <tr><td>None</td></tr>
c7b98271f551 Updated the source documentation.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
85 </table>
c7b98271f551 Updated the source documentation.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
86
c7b98271f551 Updated the source documentation.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
87 <a NAME="PopenWrapper.__init__" ID="PopenWrapper.__init__"></a>
c7b98271f551 Updated the source documentation.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
88 <h4>PopenWrapper (Constructor)</h4>
c7b98271f551 Updated the source documentation.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
89 <b>PopenWrapper</b>(<i>arguments, *args, **kwargs</i>)
c7b98271f551 Updated the source documentation.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
90
c7b98271f551 Updated the source documentation.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
91 <p>
c7b98271f551 Updated the source documentation.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
92 Constructor
c7b98271f551 Updated the source documentation.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
93 </p>
c7b98271f551 Updated the source documentation.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
94 <dl>
c7b98271f551 Updated the source documentation.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
95
c7b98271f551 Updated the source documentation.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
96 <dt><i>arguments</i> (list of str or str)</dt>
c7b98271f551 Updated the source documentation.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
97 <dd>
c7b98271f551 Updated the source documentation.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
98 command line arguments for the new process
c7b98271f551 Updated the source documentation.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
99 </dd>
c7b98271f551 Updated the source documentation.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
100 <dt><i>args</i> (list)</dt>
c7b98271f551 Updated the source documentation.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
101 <dd>
c7b98271f551 Updated the source documentation.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
102 constructor arguments of Popen
c7b98271f551 Updated the source documentation.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
103 </dd>
c7b98271f551 Updated the source documentation.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
104 <dt><i>kwargs</i> (dict)</dt>
c7b98271f551 Updated the source documentation.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
105 <dd>
c7b98271f551 Updated the source documentation.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
106 constructor keyword only arguments of Popen
c7b98271f551 Updated the source documentation.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
107 </dd>
c7b98271f551 Updated the source documentation.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
108 </dl>
c7b98271f551 Updated the source documentation.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
109 <div align="right"><a href="#top">Up</a></div>
c7b98271f551 Updated the source documentation.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
110 <hr />
c7b98271f551 Updated the source documentation.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
111 <hr />
c7b98271f551 Updated the source documentation.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
112 <a NAME="patchSubprocess" ID="patchSubprocess"></a>
c7b98271f551 Updated the source documentation.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
113 <h2>patchSubprocess</h2>
c7b98271f551 Updated the source documentation.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
114 <b>patchSubprocess</b>(<i>module, debugClient</i>)
c7b98271f551 Updated the source documentation.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
115
c7b98271f551 Updated the source documentation.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
116 <p>
c7b98271f551 Updated the source documentation.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
117 Function to patch the subprocess module.
c7b98271f551 Updated the source documentation.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
118 </p>
c7b98271f551 Updated the source documentation.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
119 <dl>
c7b98271f551 Updated the source documentation.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
120
c7b98271f551 Updated the source documentation.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
121 <dt><i>module</i> (module)</dt>
c7b98271f551 Updated the source documentation.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
122 <dd>
c7b98271f551 Updated the source documentation.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
123 reference to the imported module to be patched
c7b98271f551 Updated the source documentation.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
124 </dd>
c7b98271f551 Updated the source documentation.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
125 <dt><i>debugClient</i> (DebugClient)</dt>
c7b98271f551 Updated the source documentation.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
126 <dd>
c7b98271f551 Updated the source documentation.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
127 reference to the debug client object
c7b98271f551 Updated the source documentation.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
128 </dd>
c7b98271f551 Updated the source documentation.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
129 </dl>
c7b98271f551 Updated the source documentation.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
130 <div align="right"><a href="#top">Up</a></div>
c7b98271f551 Updated the source documentation.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
131 <hr />
c7b98271f551 Updated the source documentation.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
132 </body></html>

eric ide

mercurial