Mercurial Repositories > eric / file comparison
comparison: eric7/Documentation/Source/eric7.DebugClients.Python.eric7dbgstub.html
eric7/Documentation/Source/eric7.DebugClients.Python.eric7dbgstub.html
- branch
- eric7
- changeset 8372
- e0227a7c850e
- child 8596
- d64760b2da50
equal
deleted
inserted
replaced
| 8371:d6062691d424 | 8372:e0227a7c850e |
|---|---|
| 1 <!DOCTYPE html> | |
| 2 <html><head> | |
| 3 <title>eric7.DebugClients.Python.eric7dbgstub</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> | |
| 22 <a NAME="top" ID="top"></a> | |
| 23 <h1>eric7.DebugClients.Python.eric7dbgstub</h1> | |
| 24 | |
| 25 <p> | |
| 26 Module implementing a debugger stub for remote debugging. | |
| 27 </p> | |
| 28 <h3>Global Attributes</h3> | |
| 29 | |
| 30 <table> | |
| 31 <tr><td>__scriptname</td></tr><tr><td>debugger</td></tr><tr><td>ericpath</td></tr><tr><td>modDir</td></tr> | |
| 32 </table> | |
| 33 <h3>Classes</h3> | |
| 34 | |
| 35 <table> | |
| 36 <tr><td>None</td></tr> | |
| 37 </table> | |
| 38 <h3>Functions</h3> | |
| 39 | |
| 40 <table> | |
| 41 | |
| 42 <tr> | |
| 43 <td><a href="#initDebugger">initDebugger</a></td> | |
| 44 <td>Module function to initialize a debugger for remote debugging.</td> | |
| 45 </tr> | |
| 46 <tr> | |
| 47 <td><a href="#runcall">runcall</a></td> | |
| 48 <td>Module function mimicing the Pdb interface.</td> | |
| 49 </tr> | |
| 50 <tr> | |
| 51 <td><a href="#setScriptname">setScriptname</a></td> | |
| 52 <td>Module function to set the scriptname to be reported back to the IDE.</td> | |
| 53 </tr> | |
| 54 <tr> | |
| 55 <td><a href="#startDebugger">startDebugger</a></td> | |
| 56 <td>Module function used to start the remote debugger.</td> | |
| 57 </tr> | |
| 58 </table> | |
| 59 <hr /> | |
| 60 <hr /> | |
| 61 <a NAME="initDebugger" ID="initDebugger"></a> | |
| 62 <h2>initDebugger</h2> | |
| 63 <b>initDebugger</b>(<i>kind="standard"</i>) | |
| 64 | |
| 65 <p> | |
| 66 Module function to initialize a debugger for remote debugging. | |
| 67 </p> | |
| 68 <dl> | |
| 69 | |
| 70 <dt><i>kind</i></dt> | |
| 71 <dd> | |
| 72 type of debugger ("standard" or "threads") | |
| 73 </dd> | |
| 74 </dl> | |
| 75 <dl> | |
| 76 <dt>Return:</dt> | |
| 77 <dd> | |
| 78 flag indicating success (boolean) | |
| 79 </dd> | |
| 80 </dl> | |
| 81 <dl> | |
| 82 | |
| 83 <dt>Raises <b>ValueError</b>:</dt> | |
| 84 <dd> | |
| 85 raised to indicate a wrong debugger kind | |
| 86 </dd> | |
| 87 </dl> | |
| 88 <div align="right"><a href="#top">Up</a></div> | |
| 89 <hr /> | |
| 90 <hr /> | |
| 91 <a NAME="runcall" ID="runcall"></a> | |
| 92 <h2>runcall</h2> | |
| 93 <b>runcall</b>(<i>func, *args</i>) | |
| 94 | |
| 95 <p> | |
| 96 Module function mimicing the Pdb interface. | |
| 97 </p> | |
| 98 <dl> | |
| 99 | |
| 100 <dt><i>func</i></dt> | |
| 101 <dd> | |
| 102 function to be called (function object) | |
| 103 </dd> | |
| 104 <dt><i>*args</i></dt> | |
| 105 <dd> | |
| 106 arguments being passed to func | |
| 107 </dd> | |
| 108 </dl> | |
| 109 <dl> | |
| 110 <dt>Return:</dt> | |
| 111 <dd> | |
| 112 the function result | |
| 113 </dd> | |
| 114 </dl> | |
| 115 <div align="right"><a href="#top">Up</a></div> | |
| 116 <hr /> | |
| 117 <hr /> | |
| 118 <a NAME="setScriptname" ID="setScriptname"></a> | |
| 119 <h2>setScriptname</h2> | |
| 120 <b>setScriptname</b>(<i>name</i>) | |
| 121 | |
| 122 <p> | |
| 123 Module function to set the scriptname to be reported back to the IDE. | |
| 124 </p> | |
| 125 <dl> | |
| 126 | |
| 127 <dt><i>name</i></dt> | |
| 128 <dd> | |
| 129 absolute pathname of the script (string) | |
| 130 </dd> | |
| 131 </dl> | |
| 132 <div align="right"><a href="#top">Up</a></div> | |
| 133 <hr /> | |
| 134 <hr /> | |
| 135 <a NAME="startDebugger" ID="startDebugger"></a> | |
| 136 <h2>startDebugger</h2> | |
| 137 <b>startDebugger</b>(<i>enableTrace=True, exceptions=True, tracePython=False, redirect=True</i>) | |
| 138 | |
| 139 <p> | |
| 140 Module function used to start the remote debugger. | |
| 141 </p> | |
| 142 <dl> | |
| 143 | |
| 144 <dt><i>enableTrace</i></dt> | |
| 145 <dd> | |
| 146 flag to enable the tracing function (boolean) | |
| 147 </dd> | |
| 148 <dt><i>exceptions</i></dt> | |
| 149 <dd> | |
| 150 flag to enable exception reporting of the IDE | |
| 151 (boolean) | |
| 152 </dd> | |
| 153 <dt><i>tracePython</i></dt> | |
| 154 <dd> | |
| 155 flag to enable tracing into the Python library | |
| 156 (boolean) | |
| 157 </dd> | |
| 158 <dt><i>redirect</i></dt> | |
| 159 <dd> | |
| 160 flag indicating redirection of stdin, stdout and | |
| 161 stderr (boolean) | |
| 162 </dd> | |
| 163 </dl> | |
| 164 <div align="right"><a href="#top">Up</a></div> | |
| 165 <hr /> | |
| 166 </body></html> |
