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