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