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