1 <!DOCTYPE html> |
|
2 <html><head> |
|
3 <title>eric6.DebugClients.Python.DebugThread</title> |
|
4 <meta charset="UTF-8"> |
|
5 <style> |
|
6 body { |
|
7 background: #EDECE6; |
|
8 margin: 0em 1em 10em 1em; |
|
9 color: black; |
|
10 } |
|
11 |
|
12 h1 { color: white; background: #85774A; } |
|
13 h2 { color: white; background: #85774A; } |
|
14 h3 { color: white; background: #9D936E; } |
|
15 h4 { color: white; background: #9D936E; } |
|
16 |
|
17 a { color: #BA6D36; } |
|
18 |
|
19 </style> |
|
20 </head> |
|
21 <body><a NAME="top" ID="top"></a> |
|
22 <h1>eric6.DebugClients.Python.DebugThread</h1> |
|
23 <p> |
|
24 Module implementing the debug thread. |
|
25 </p> |
|
26 <h3>Global Attributes</h3> |
|
27 <table> |
|
28 <tr><td>None</td></tr> |
|
29 </table> |
|
30 <h3>Classes</h3> |
|
31 <table> |
|
32 <tr> |
|
33 <td><a href="#DebugThread">DebugThread</a></td> |
|
34 <td>Class implementing a debug thread.</td> |
|
35 </tr> |
|
36 </table> |
|
37 <h3>Functions</h3> |
|
38 <table> |
|
39 <tr><td>None</td></tr> |
|
40 </table> |
|
41 <hr /><hr /> |
|
42 <a NAME="DebugThread" ID="DebugThread"></a> |
|
43 <h2>DebugThread</h2> |
|
44 <p> |
|
45 Class implementing a debug thread. |
|
46 </p><p> |
|
47 It represents a thread in the python interpreter that we are tracing. |
|
48 </p><p> |
|
49 Provides simple wrapper methods around bdb for the 'owning' client to |
|
50 call to step etc. |
|
51 </p> |
|
52 <h3>Derived from</h3> |
|
53 DebugBase |
|
54 <h3>Class Attributes</h3> |
|
55 <table> |
|
56 <tr><td>None</td></tr> |
|
57 </table> |
|
58 <h3>Class Methods</h3> |
|
59 <table> |
|
60 <tr><td>None</td></tr> |
|
61 </table> |
|
62 <h3>Methods</h3> |
|
63 <table> |
|
64 <tr> |
|
65 <td><a href="#DebugThread.__init__">DebugThread</a></td> |
|
66 <td>Constructor</td> |
|
67 </tr><tr> |
|
68 <td><a href="#DebugThread.bootstrap">bootstrap</a></td> |
|
69 <td>Public method to bootstrap the thread.</td> |
|
70 </tr><tr> |
|
71 <td><a href="#DebugThread.get_ident">get_ident</a></td> |
|
72 <td>Public method to return the id of this thread.</td> |
|
73 </tr><tr> |
|
74 <td><a href="#DebugThread.get_name">get_name</a></td> |
|
75 <td>Public method to return the name of this thread.</td> |
|
76 </tr><tr> |
|
77 <td><a href="#DebugThread.set_ident">set_ident</a></td> |
|
78 <td>Public method to set the id for this thread.</td> |
|
79 </tr><tr> |
|
80 <td><a href="#DebugThread.traceThread">traceThread</a></td> |
|
81 <td>Public method to setup tracing for this thread.</td> |
|
82 </tr><tr> |
|
83 <td><a href="#DebugThread.trace_dispatch">trace_dispatch</a></td> |
|
84 <td>Public method wrapping the trace_dispatch of bdb.py.</td> |
|
85 </tr> |
|
86 </table> |
|
87 <h3>Static Methods</h3> |
|
88 <table> |
|
89 <tr><td>None</td></tr> |
|
90 </table> |
|
91 <a NAME="DebugThread.__init__" ID="DebugThread.__init__"></a> |
|
92 <h4>DebugThread (Constructor)</h4> |
|
93 <b>DebugThread</b>(<i>dbgClient, targ=None, args=None, kwargs=None, mainThread=0</i>) |
|
94 <p> |
|
95 Constructor |
|
96 </p><dl> |
|
97 <dt><i>dbgClient</i></dt> |
|
98 <dd> |
|
99 the owning client |
|
100 </dd><dt><i>targ</i></dt> |
|
101 <dd> |
|
102 the target method in the run thread |
|
103 </dd><dt><i>args</i></dt> |
|
104 <dd> |
|
105 arguments to be passed to the thread |
|
106 </dd><dt><i>kwargs</i></dt> |
|
107 <dd> |
|
108 arguments to be passed to the thread |
|
109 </dd><dt><i>mainThread</i></dt> |
|
110 <dd> |
|
111 0 if this thread is not the mainscripts thread |
|
112 </dd> |
|
113 </dl><a NAME="DebugThread.bootstrap" ID="DebugThread.bootstrap"></a> |
|
114 <h4>DebugThread.bootstrap</h4> |
|
115 <b>bootstrap</b>(<i></i>) |
|
116 <p> |
|
117 Public method to bootstrap the thread. |
|
118 </p><p> |
|
119 It wraps the call to the user function to enable tracing |
|
120 before hand. |
|
121 </p><a NAME="DebugThread.get_ident" ID="DebugThread.get_ident"></a> |
|
122 <h4>DebugThread.get_ident</h4> |
|
123 <b>get_ident</b>(<i></i>) |
|
124 <p> |
|
125 Public method to return the id of this thread. |
|
126 </p><dl> |
|
127 <dt>Returns:</dt> |
|
128 <dd> |
|
129 the id of this thread (int) |
|
130 </dd> |
|
131 </dl><a NAME="DebugThread.get_name" ID="DebugThread.get_name"></a> |
|
132 <h4>DebugThread.get_name</h4> |
|
133 <b>get_name</b>(<i></i>) |
|
134 <p> |
|
135 Public method to return the name of this thread. |
|
136 </p><dl> |
|
137 <dt>Returns:</dt> |
|
138 <dd> |
|
139 name of this thread (string) |
|
140 </dd> |
|
141 </dl><a NAME="DebugThread.set_ident" ID="DebugThread.set_ident"></a> |
|
142 <h4>DebugThread.set_ident</h4> |
|
143 <b>set_ident</b>(<i>id</i>) |
|
144 <p> |
|
145 Public method to set the id for this thread. |
|
146 </p><dl> |
|
147 <dt><i>id</i></dt> |
|
148 <dd> |
|
149 id for this thread (int) |
|
150 </dd> |
|
151 </dl><a NAME="DebugThread.traceThread" ID="DebugThread.traceThread"></a> |
|
152 <h4>DebugThread.traceThread</h4> |
|
153 <b>traceThread</b>(<i></i>) |
|
154 <p> |
|
155 Public method to setup tracing for this thread. |
|
156 </p><a NAME="DebugThread.trace_dispatch" ID="DebugThread.trace_dispatch"></a> |
|
157 <h4>DebugThread.trace_dispatch</h4> |
|
158 <b>trace_dispatch</b>(<i>frame, event, arg</i>) |
|
159 <p> |
|
160 Public method wrapping the trace_dispatch of bdb.py. |
|
161 </p><p> |
|
162 It wraps the call to dispatch tracing into |
|
163 bdb to make sure we have locked the client to prevent multiple |
|
164 threads from entering the client event loop. |
|
165 </p><dl> |
|
166 <dt><i>frame</i></dt> |
|
167 <dd> |
|
168 The current stack frame. |
|
169 </dd><dt><i>event</i></dt> |
|
170 <dd> |
|
171 The trace event (string) |
|
172 </dd><dt><i>arg</i></dt> |
|
173 <dd> |
|
174 The arguments |
|
175 </dd> |
|
176 </dl><dl> |
|
177 <dt>Returns:</dt> |
|
178 <dd> |
|
179 local trace function |
|
180 </dd> |
|
181 </dl> |
|
182 <div align="right"><a href="#top">Up</a></div> |
|
183 <hr /> |
|
184 </body></html> |
|