Mercurial Repositories > eric / file comparison
comparison: src/eric7/Documentation/Source/eric7.DebugClients.Python.DebugUtilities.html
src/eric7/Documentation/Source/eric7.DebugClients.Python.DebugUtilities.html
- branch
- eric7
- changeset 10479
- 856476537696
- parent 10478
- de9106c55c3d
- child 11088
- 0299c9ba1c6f
equal
deleted
inserted
replaced
| 10478:de9106c55c3d | 10479:856476537696 |
|---|---|
| 5 <link rel="stylesheet" href="styles.css"> | 5 <link rel="stylesheet" href="styles.css"> |
| 6 </head> | 6 </head> |
| 7 <body> | 7 <body> |
| 8 <a NAME="top" ID="top"></a> | 8 <a NAME="top" ID="top"></a> |
| 9 <h1>eric7.DebugClients.Python.DebugUtilities</h1> | 9 <h1>eric7.DebugClients.Python.DebugUtilities</h1> |
| 10 | |
| 11 <p> | 10 <p> |
| 12 Module implementing utilities functions for the debug client. | 11 Module implementing utilities functions for the debug client. |
| 13 </p> | 12 </p> |
| 13 | |
| 14 <h3>Global Attributes</h3> | 14 <h3>Global Attributes</h3> |
| 15 | |
| 16 <table> | 15 <table> |
| 17 <tr><td>ArgInfo</td></tr><tr><td>PYTHON_NAMES</td></tr><tr><td>mod_dict</td></tr> | 16 <tr><td>ArgInfo</td></tr> |
| 17 <tr><td>PYTHON_NAMES</td></tr> | |
| 18 <tr><td>mod_dict</td></tr> | |
| 18 </table> | 19 </table> |
| 20 | |
| 19 <h3>Classes</h3> | 21 <h3>Classes</h3> |
| 20 | |
| 21 <table> | 22 <table> |
| 22 <tr><td>None</td></tr> | 23 <tr><td>None</td></tr> |
| 23 </table> | 24 </table> |
| 25 | |
| 24 <h3>Functions</h3> | 26 <h3>Functions</h3> |
| 25 | |
| 26 <table> | 27 <table> |
| 27 | |
| 28 <tr> | 28 <tr> |
| 29 <td><a href="#_getfullargs">_getfullargs</a></td> | 29 <td><a href="#_getfullargs">_getfullargs</a></td> |
| 30 <td>Protected function to get information about the arguments accepted by a code object.</td> | 30 <td>Protected function to get information about the arguments accepted by a code object.</td> |
| 31 </tr> | 31 </tr> |
| 32 <tr> | 32 <tr> |
| 76 <tr> | 76 <tr> |
| 77 <td><a href="#stringToArgumentsWindows">stringToArgumentsWindows</a></td> | 77 <td><a href="#stringToArgumentsWindows">stringToArgumentsWindows</a></td> |
| 78 <td>Function to prepare a string of arguments for Windows platform.</td> | 78 <td>Function to prepare a string of arguments for Windows platform.</td> |
| 79 </tr> | 79 </tr> |
| 80 </table> | 80 </table> |
| 81 | |
| 81 <hr /> | 82 <hr /> |
| 82 <hr /> | 83 <hr /> |
| 83 <a NAME="_getfullargs" ID="_getfullargs"></a> | 84 <a NAME="_getfullargs" ID="_getfullargs"></a> |
| 84 <h2>_getfullargs</h2> | 85 <h2>_getfullargs</h2> |
| 85 <b>_getfullargs</b>(<i>co</i>) | 86 <b>_getfullargs</b>(<i>co</i>) |
| 86 | |
| 87 <p> | 87 <p> |
| 88 Protected function to get information about the arguments accepted | 88 Protected function to get information about the arguments accepted |
| 89 by a code object. | 89 by a code object. |
| 90 </p> | 90 </p> |
| 91 | |
| 91 <dl> | 92 <dl> |
| 92 | 93 |
| 93 <dt><i>co</i> (code)</dt> | 94 <dt><i>co</i> (code)</dt> |
| 94 <dd> | 95 <dd> |
| 95 reference to a code object to be processed | 96 reference to a code object to be processed |
| 120 <hr /> | 121 <hr /> |
| 121 <hr /> | 122 <hr /> |
| 122 <a NAME="formatargvalues" ID="formatargvalues"></a> | 123 <a NAME="formatargvalues" ID="formatargvalues"></a> |
| 123 <h2>formatargvalues</h2> | 124 <h2>formatargvalues</h2> |
| 124 <b>formatargvalues</b>(<i>args, varargs, varkw, localsDict, formatarg=str, formatvarargs=lambda name: "*" + name, formatvarkw=lambda name: "**" + name, formatvalue=lambda value: "=" + repr(value), </i>) | 125 <b>formatargvalues</b>(<i>args, varargs, varkw, localsDict, formatarg=str, formatvarargs=lambda name: "*" + name, formatvarkw=lambda name: "**" + name, formatvalue=lambda value: "=" + repr(value), </i>) |
| 125 | |
| 126 <p> | 126 <p> |
| 127 Function to format an argument spec from the 4 values returned | 127 Function to format an argument spec from the 4 values returned |
| 128 by getargvalues. | 128 by getargvalues. |
| 129 </p> | 129 </p> |
| 130 | |
| 130 <dl> | 131 <dl> |
| 131 | 132 |
| 132 <dt><i>args</i> (list of str)</dt> | 133 <dt><i>args</i> (list of str)</dt> |
| 133 <dd> | 134 <dd> |
| 134 list of argument names | 135 list of argument names |
| 178 <hr /> | 179 <hr /> |
| 179 <hr /> | 180 <hr /> |
| 180 <a NAME="getargvalues" ID="getargvalues"></a> | 181 <a NAME="getargvalues" ID="getargvalues"></a> |
| 181 <h2>getargvalues</h2> | 182 <h2>getargvalues</h2> |
| 182 <b>getargvalues</b>(<i>frame</i>) | 183 <b>getargvalues</b>(<i>frame</i>) |
| 183 | |
| 184 <p> | 184 <p> |
| 185 Function to get information about arguments passed into a | 185 Function to get information about arguments passed into a |
| 186 particular frame. | 186 particular frame. |
| 187 </p> | 187 </p> |
| 188 | |
| 188 <dl> | 189 <dl> |
| 189 | 190 |
| 190 <dt><i>frame</i> (frame)</dt> | 191 <dt><i>frame</i> (frame)</dt> |
| 191 <dd> | 192 <dd> |
| 192 reference to a frame object to be processed | 193 reference to a frame object to be processed |
| 217 <hr /> | 218 <hr /> |
| 218 <hr /> | 219 <hr /> |
| 219 <a NAME="isExecutable" ID="isExecutable"></a> | 220 <a NAME="isExecutable" ID="isExecutable"></a> |
| 220 <h2>isExecutable</h2> | 221 <h2>isExecutable</h2> |
| 221 <b>isExecutable</b>(<i>program</i>) | 222 <b>isExecutable</b>(<i>program</i>) |
| 222 | |
| 223 <p> | 223 <p> |
| 224 Function to check, if the given program is executable. | 224 Function to check, if the given program is executable. |
| 225 </p> | 225 </p> |
| 226 | |
| 226 <dl> | 227 <dl> |
| 227 | 228 |
| 228 <dt><i>program</i> (str)</dt> | 229 <dt><i>program</i> (str)</dt> |
| 229 <dd> | 230 <dd> |
| 230 program path to be checked | 231 program path to be checked |
| 246 <hr /> | 247 <hr /> |
| 247 <hr /> | 248 <hr /> |
| 248 <a NAME="isPythonProgram" ID="isPythonProgram"></a> | 249 <a NAME="isPythonProgram" ID="isPythonProgram"></a> |
| 249 <h2>isPythonProgram</h2> | 250 <h2>isPythonProgram</h2> |
| 250 <b>isPythonProgram</b>(<i>program</i>) | 251 <b>isPythonProgram</b>(<i>program</i>) |
| 251 | |
| 252 <p> | 252 <p> |
| 253 Function to check, if the given program is a Python interpreter or | 253 Function to check, if the given program is a Python interpreter or |
| 254 program. | 254 program. |
| 255 </p> | 255 </p> |
| 256 | |
| 256 <dl> | 257 <dl> |
| 257 | 258 |
| 258 <dt><i>program</i> (str)</dt> | 259 <dt><i>program</i> (str)</dt> |
| 259 <dd> | 260 <dd> |
| 260 program to be checked | 261 program to be checked |
| 276 <hr /> | 277 <hr /> |
| 277 <hr /> | 278 <hr /> |
| 278 <a NAME="isWindowsPlatform" ID="isWindowsPlatform"></a> | 279 <a NAME="isWindowsPlatform" ID="isWindowsPlatform"></a> |
| 279 <h2>isWindowsPlatform</h2> | 280 <h2>isWindowsPlatform</h2> |
| 280 <b>isWindowsPlatform</b>(<i></i>) | 281 <b>isWindowsPlatform</b>(<i></i>) |
| 281 | |
| 282 <p> | 282 <p> |
| 283 Function to check, if this is a Windows platform. | 283 Function to check, if this is a Windows platform. |
| 284 </p> | 284 </p> |
| 285 | |
| 285 <dl> | 286 <dl> |
| 286 <dt>Return:</dt> | 287 <dt>Return:</dt> |
| 287 <dd> | 288 <dd> |
| 288 flag indicating Windows platform | 289 flag indicating Windows platform |
| 289 </dd> | 290 </dd> |
| 298 <hr /> | 299 <hr /> |
| 299 <hr /> | 300 <hr /> |
| 300 <a NAME="patchArgumentStringWindows" ID="patchArgumentStringWindows"></a> | 301 <a NAME="patchArgumentStringWindows" ID="patchArgumentStringWindows"></a> |
| 301 <h2>patchArgumentStringWindows</h2> | 302 <h2>patchArgumentStringWindows</h2> |
| 302 <b>patchArgumentStringWindows</b>(<i>debugClient, argStr</i>) | 303 <b>patchArgumentStringWindows</b>(<i>debugClient, argStr</i>) |
| 303 | |
| 304 <p> | 304 <p> |
| 305 Function to patch an argument string for Windows. | 305 Function to patch an argument string for Windows. |
| 306 </p> | 306 </p> |
| 307 | |
| 307 <dl> | 308 <dl> |
| 308 | 309 |
| 309 <dt><i>debugClient</i> (DebugClient)</dt> | 310 <dt><i>debugClient</i> (DebugClient)</dt> |
| 310 <dd> | 311 <dd> |
| 311 reference to the debug client object | 312 reference to the debug client object |
| 331 <hr /> | 332 <hr /> |
| 332 <hr /> | 333 <hr /> |
| 333 <a NAME="patchArguments" ID="patchArguments"></a> | 334 <a NAME="patchArguments" ID="patchArguments"></a> |
| 334 <h2>patchArguments</h2> | 335 <h2>patchArguments</h2> |
| 335 <b>patchArguments</b>(<i>debugClient, arguments, noRedirect=False</i>) | 336 <b>patchArguments</b>(<i>debugClient, arguments, noRedirect=False</i>) |
| 336 | |
| 337 <p> | 337 <p> |
| 338 Function to patch the arguments given to start a program in order to | 338 Function to patch the arguments given to start a program in order to |
| 339 execute it in our debugger. | 339 execute it in our debugger. |
| 340 </p> | 340 </p> |
| 341 | |
| 341 <dl> | 342 <dl> |
| 342 | 343 |
| 343 <dt><i>debugClient</i> (DebugClient)</dt> | 344 <dt><i>debugClient</i> (DebugClient)</dt> |
| 344 <dd> | 345 <dd> |
| 345 reference to the debug client object | 346 reference to the debug client object |
| 369 <hr /> | 370 <hr /> |
| 370 <hr /> | 371 <hr /> |
| 371 <a NAME="prepareJsonCommand" ID="prepareJsonCommand"></a> | 372 <a NAME="prepareJsonCommand" ID="prepareJsonCommand"></a> |
| 372 <h2>prepareJsonCommand</h2> | 373 <h2>prepareJsonCommand</h2> |
| 373 <b>prepareJsonCommand</b>(<i>method, params</i>) | 374 <b>prepareJsonCommand</b>(<i>method, params</i>) |
| 374 | |
| 375 <p> | 375 <p> |
| 376 Function to prepare a single command or response for transmission to | 376 Function to prepare a single command or response for transmission to |
| 377 the IDE. | 377 the IDE. |
| 378 </p> | 378 </p> |
| 379 | |
| 379 <dl> | 380 <dl> |
| 380 | 381 |
| 381 <dt><i>method</i> (str)</dt> | 382 <dt><i>method</i> (str)</dt> |
| 382 <dd> | 383 <dd> |
| 383 command or response name to be sent | 384 command or response name to be sent |
| 403 <hr /> | 404 <hr /> |
| 404 <hr /> | 405 <hr /> |
| 405 <a NAME="quoteArgs" ID="quoteArgs"></a> | 406 <a NAME="quoteArgs" ID="quoteArgs"></a> |
| 406 <h2>quoteArgs</h2> | 407 <h2>quoteArgs</h2> |
| 407 <b>quoteArgs</b>(<i>args</i>) | 408 <b>quoteArgs</b>(<i>args</i>) |
| 408 | |
| 409 <p> | 409 <p> |
| 410 Function to quote the given list of arguments. | 410 Function to quote the given list of arguments. |
| 411 </p> | 411 </p> |
| 412 | |
| 412 <dl> | 413 <dl> |
| 413 | 414 |
| 414 <dt><i>args</i> (list of str)</dt> | 415 <dt><i>args</i> (list of str)</dt> |
| 415 <dd> | 416 <dd> |
| 416 list of arguments to be quoted | 417 list of arguments to be quoted |
| 432 <hr /> | 433 <hr /> |
| 433 <hr /> | 434 <hr /> |
| 434 <a NAME="removeQuotesFromArgs" ID="removeQuotesFromArgs"></a> | 435 <a NAME="removeQuotesFromArgs" ID="removeQuotesFromArgs"></a> |
| 435 <h2>removeQuotesFromArgs</h2> | 436 <h2>removeQuotesFromArgs</h2> |
| 436 <b>removeQuotesFromArgs</b>(<i>args</i>) | 437 <b>removeQuotesFromArgs</b>(<i>args</i>) |
| 437 | |
| 438 <p> | 438 <p> |
| 439 Function to remove quotes from the arguments list. | 439 Function to remove quotes from the arguments list. |
| 440 </p> | 440 </p> |
| 441 | |
| 441 <dl> | 442 <dl> |
| 442 | 443 |
| 443 <dt><i>args</i> (list of str)</dt> | 444 <dt><i>args</i> (list of str)</dt> |
| 444 <dd> | 445 <dd> |
| 445 list of arguments | 446 list of arguments |
| 461 <hr /> | 462 <hr /> |
| 462 <hr /> | 463 <hr /> |
| 463 <a NAME="startsWithShebang" ID="startsWithShebang"></a> | 464 <a NAME="startsWithShebang" ID="startsWithShebang"></a> |
| 464 <h2>startsWithShebang</h2> | 465 <h2>startsWithShebang</h2> |
| 465 <b>startsWithShebang</b>(<i>program</i>) | 466 <b>startsWithShebang</b>(<i>program</i>) |
| 466 | |
| 467 <p> | 467 <p> |
| 468 Function to check, if the given program start with a Shebang line. | 468 Function to check, if the given program start with a Shebang line. |
| 469 </p> | 469 </p> |
| 470 | |
| 470 <dl> | 471 <dl> |
| 471 | 472 |
| 472 <dt><i>program</i> (str)</dt> | 473 <dt><i>program</i> (str)</dt> |
| 473 <dd> | 474 <dd> |
| 474 program path to be checked | 475 program path to be checked |
| 490 <hr /> | 491 <hr /> |
| 491 <hr /> | 492 <hr /> |
| 492 <a NAME="stringToArgumentsWindows" ID="stringToArgumentsWindows"></a> | 493 <a NAME="stringToArgumentsWindows" ID="stringToArgumentsWindows"></a> |
| 493 <h2>stringToArgumentsWindows</h2> | 494 <h2>stringToArgumentsWindows</h2> |
| 494 <b>stringToArgumentsWindows</b>(<i>args</i>) | 495 <b>stringToArgumentsWindows</b>(<i>args</i>) |
| 495 | |
| 496 <p> | 496 <p> |
| 497 Function to prepare a string of arguments for Windows platform. | 497 Function to prepare a string of arguments for Windows platform. |
| 498 </p> | 498 </p> |
| 499 | |
| 499 <dl> | 500 <dl> |
| 500 | 501 |
| 501 <dt><i>args</i> (str)</dt> | 502 <dt><i>args</i> (str)</dt> |
| 502 <dd> | 503 <dd> |
| 503 list of command arguments | 504 list of command arguments |
