Mercurial Repositories > eric / file comparison
comparison: src/eric7/Documentation/Source/eric7.Debugger.DebuggerInterfacePython.html
src/eric7/Documentation/Source/eric7.Debugger.DebuggerInterfacePython.html
- branch
- eric7
- changeset 10784
- 521fd465b048
- parent 10684
- 58c7f23ae1cb
- child 10987
- ee81b245ae2c
equal
deleted
inserted
replaced
| 10783:ccf28bec1227 | 10784:521fd465b048 |
|---|---|
| 70 <tr> | 70 <tr> |
| 71 <td><a href="#DebuggerInterfacePython.__determineDebugClient">__determineDebugClient</a></td> | 71 <td><a href="#DebuggerInterfacePython.__determineDebugClient">__determineDebugClient</a></td> |
| 72 <td>Private method to determine the debug client to be started.</td> | 72 <td>Private method to determine the debug client to be started.</td> |
| 73 </tr> | 73 </tr> |
| 74 <tr> | 74 <tr> |
| 75 <td><a href="#DebuggerInterfacePython.__ericServerTranslation">__ericServerTranslation</a></td> | |
| 76 <td>Private method to perform the eric-ide server path translation.</td> | |
| 77 </tr> | |
| 78 <tr> | |
| 75 <td><a href="#DebuggerInterfacePython.__flush">__flush</a></td> | 79 <td><a href="#DebuggerInterfacePython.__flush">__flush</a></td> |
| 76 <td>Private slot to flush the queue.</td> | 80 <td>Private slot to flush the queue.</td> |
| 77 </tr> | 81 </tr> |
| 78 <tr> | 82 <tr> |
| 79 <td><a href="#DebuggerInterfacePython.__handleJsonCommand">__handleJsonCommand</a></td> | 83 <td><a href="#DebuggerInterfacePython.__handleServerDebugClientDisconnected">__handleServerDebugClientDisconnected</a></td> |
| 80 <td>Private method to handle a command or response serialized as a JSON string.</td> | 84 <td>Private slot handling the disconnect of a debug client.</td> |
| 85 </tr> | |
| 86 <tr> | |
| 87 <td><a href="#DebuggerInterfacePython.__handleServerLastClientExited">__handleServerLastClientExited</a></td> | |
| 88 <td>Private slot to handle the exit of the last debug client connected.</td> | |
| 81 </tr> | 89 </tr> |
| 82 <tr> | 90 <tr> |
| 83 <td><a href="#DebuggerInterfacePython.__identityTranslation">__identityTranslation</a></td> | 91 <td><a href="#DebuggerInterfacePython.__identityTranslation">__identityTranslation</a></td> |
| 84 <td>Private method to perform the identity path translation.</td> | 92 <td>Private method to perform the identity path translation.</td> |
| 85 </tr> | 93 </tr> |
| 86 <tr> | 94 <tr> |
| 87 <td><a href="#DebuggerInterfacePython.__parseClientLine">__parseClientLine</a></td> | 95 <td><a href="#DebuggerInterfacePython.__receiveJson">__receiveJson</a></td> |
| 88 <td>Private method to handle data from the client.</td> | 96 <td>Private method to handle data from the client.</td> |
| 89 </tr> | 97 </tr> |
| 90 <tr> | 98 <tr> |
| 91 <td><a href="#DebuggerInterfacePython.__remoteTranslation">__remoteTranslation</a></td> | 99 <td><a href="#DebuggerInterfacePython.__remoteTranslation">__remoteTranslation</a></td> |
| 92 <td>Private method to perform the path translation.</td> | 100 <td>Private method to perform the path translation.</td> |
| 116 <td>Public method to retrieve the debug clients capabilities.</td> | 124 <td>Public method to retrieve the debug clients capabilities.</td> |
| 117 </tr> | 125 </tr> |
| 118 <tr> | 126 <tr> |
| 119 <td><a href="#DebuggerInterfacePython.getDebuggerIds">getDebuggerIds</a></td> | 127 <td><a href="#DebuggerInterfacePython.getDebuggerIds">getDebuggerIds</a></td> |
| 120 <td>Public method to return the IDs of the connected debugger backends.</td> | 128 <td>Public method to return the IDs of the connected debugger backends.</td> |
| 129 </tr> | |
| 130 <tr> | |
| 131 <td><a href="#DebuggerInterfacePython.handleJsonCommand">handleJsonCommand</a></td> | |
| 132 <td>Public method to handle a command or response serialized as a JSON string.</td> | |
| 121 </tr> | 133 </tr> |
| 122 <tr> | 134 <tr> |
| 123 <td><a href="#DebuggerInterfacePython.isConnected">isConnected</a></td> | 135 <td><a href="#DebuggerInterfacePython.isConnected">isConnected</a></td> |
| 124 <td>Public method to test, if a debug client has connected.</td> | 136 <td>Public method to test, if a debug client has connected.</td> |
| 125 </tr> | 137 </tr> |
| 329 <dt>Return Type:</dt> | 341 <dt>Return Type:</dt> |
| 330 <dd> | 342 <dd> |
| 331 str | 343 str |
| 332 </dd> | 344 </dd> |
| 333 </dl> | 345 </dl> |
| 346 <a NAME="DebuggerInterfacePython.__ericServerTranslation" ID="DebuggerInterfacePython.__ericServerTranslation"></a> | |
| 347 <h4>DebuggerInterfacePython.__ericServerTranslation</h4> | |
| 348 <b>__ericServerTranslation</b>(<i>fn, remote2local=True</i>) | |
| 349 <p> | |
| 350 Private method to perform the eric-ide server path translation. | |
| 351 </p> | |
| 352 | |
| 353 <dl> | |
| 354 | |
| 355 <dt><i>fn</i> (str)</dt> | |
| 356 <dd> | |
| 357 filename to be translated | |
| 358 </dd> | |
| 359 <dt><i>remote2local</i> (bool (optional))</dt> | |
| 360 <dd> | |
| 361 flag indicating the direction of translation | |
| 362 (False = local to remote, True = remote to local) (defaults to True) | |
| 363 </dd> | |
| 364 </dl> | |
| 365 <dl> | |
| 366 <dt>Return:</dt> | |
| 367 <dd> | |
| 368 translated filename | |
| 369 </dd> | |
| 370 </dl> | |
| 371 <dl> | |
| 372 <dt>Return Type:</dt> | |
| 373 <dd> | |
| 374 str | |
| 375 </dd> | |
| 376 </dl> | |
| 334 <a NAME="DebuggerInterfacePython.__flush" ID="DebuggerInterfacePython.__flush"></a> | 377 <a NAME="DebuggerInterfacePython.__flush" ID="DebuggerInterfacePython.__flush"></a> |
| 335 <h4>DebuggerInterfacePython.__flush</h4> | 378 <h4>DebuggerInterfacePython.__flush</h4> |
| 336 <b>__flush</b>(<i></i>) | 379 <b>__flush</b>(<i></i>) |
| 337 <p> | 380 <p> |
| 338 Private slot to flush the queue. | 381 Private slot to flush the queue. |
| 339 </p> | 382 </p> |
| 340 | 383 |
| 341 <a NAME="DebuggerInterfacePython.__handleJsonCommand" ID="DebuggerInterfacePython.__handleJsonCommand"></a> | 384 <a NAME="DebuggerInterfacePython.__handleServerDebugClientDisconnected" ID="DebuggerInterfacePython.__handleServerDebugClientDisconnected"></a> |
| 342 <h4>DebuggerInterfacePython.__handleJsonCommand</h4> | 385 <h4>DebuggerInterfacePython.__handleServerDebugClientDisconnected</h4> |
| 343 <b>__handleJsonCommand</b>(<i>jsonStr, sock</i>) | 386 <b>__handleServerDebugClientDisconnected</b>(<i>debuggerId</i>) |
| 344 <p> | 387 <p> |
| 345 Private method to handle a command or response serialized as a | 388 Private slot handling the disconnect of a debug client. |
| 346 JSON string. | 389 </p> |
| 347 </p> | 390 |
| 348 | 391 <dl> |
| 349 <dl> | 392 |
| 350 | 393 <dt><i>debuggerId</i> (str)</dt> |
| 351 <dt><i>jsonStr</i> (str)</dt> | 394 <dd> |
| 352 <dd> | 395 ID of the disconnected debugger |
| 353 string containing the command or response received | 396 </dd> |
| 354 from the debug backend | 397 </dl> |
| 355 </dd> | 398 <a NAME="DebuggerInterfacePython.__handleServerLastClientExited" ID="DebuggerInterfacePython.__handleServerLastClientExited"></a> |
| 356 <dt><i>sock</i> (QTcpSocket)</dt> | 399 <h4>DebuggerInterfacePython.__handleServerLastClientExited</h4> |
| 357 <dd> | 400 <b>__handleServerLastClientExited</b>(<i></i>) |
| 358 reference to the socket the data was received from | 401 <p> |
| 359 </dd> | 402 Private slot to handle the exit of the last debug client connected. |
| 360 </dl> | 403 </p> |
| 404 | |
| 361 <a NAME="DebuggerInterfacePython.__identityTranslation" ID="DebuggerInterfacePython.__identityTranslation"></a> | 405 <a NAME="DebuggerInterfacePython.__identityTranslation" ID="DebuggerInterfacePython.__identityTranslation"></a> |
| 362 <h4>DebuggerInterfacePython.__identityTranslation</h4> | 406 <h4>DebuggerInterfacePython.__identityTranslation</h4> |
| 363 <b>__identityTranslation</b>(<i>fn, remote2local=True</i>) | 407 <b>__identityTranslation</b>(<i>fn, remote2local=True</i>) |
| 364 <p> | 408 <p> |
| 365 Private method to perform the identity path translation. | 409 Private method to perform the identity path translation. |
| 369 | 413 |
| 370 <dt><i>fn</i> (str)</dt> | 414 <dt><i>fn</i> (str)</dt> |
| 371 <dd> | 415 <dd> |
| 372 filename to be translated | 416 filename to be translated |
| 373 </dd> | 417 </dd> |
| 374 <dt><i>remote2local</i> (bool)</dt> | 418 <dt><i>remote2local</i> (bool (optional))</dt> |
| 375 <dd> | 419 <dd> |
| 376 flag indicating the direction of translation | 420 flag indicating the direction of translation |
| 377 (False = local to remote, True = remote to local [default]) (unused) | 421 (False = local to remote, True = remote to local) (defaults to True) |
| 422 (unused) | |
| 378 </dd> | 423 </dd> |
| 379 </dl> | 424 </dl> |
| 380 <dl> | 425 <dl> |
| 381 <dt>Return:</dt> | 426 <dt>Return:</dt> |
| 382 <dd> | 427 <dd> |
| 387 <dt>Return Type:</dt> | 432 <dt>Return Type:</dt> |
| 388 <dd> | 433 <dd> |
| 389 str | 434 str |
| 390 </dd> | 435 </dd> |
| 391 </dl> | 436 </dl> |
| 392 <a NAME="DebuggerInterfacePython.__parseClientLine" ID="DebuggerInterfacePython.__parseClientLine"></a> | 437 <a NAME="DebuggerInterfacePython.__receiveJson" ID="DebuggerInterfacePython.__receiveJson"></a> |
| 393 <h4>DebuggerInterfacePython.__parseClientLine</h4> | 438 <h4>DebuggerInterfacePython.__receiveJson</h4> |
| 394 <b>__parseClientLine</b>(<i>sock</i>) | 439 <b>__receiveJson</b>(<i>sock</i>) |
| 395 <p> | 440 <p> |
| 396 Private method to handle data from the client. | 441 Private method to handle data from the client. |
| 397 </p> | 442 </p> |
| 398 | 443 |
| 399 <dl> | 444 <dl> |
| 414 | 459 |
| 415 <dt><i>fn</i> (str)</dt> | 460 <dt><i>fn</i> (str)</dt> |
| 416 <dd> | 461 <dd> |
| 417 filename to be translated | 462 filename to be translated |
| 418 </dd> | 463 </dd> |
| 419 <dt><i>remote2local</i> (bool)</dt> | 464 <dt><i>remote2local</i> (bool (optional))</dt> |
| 420 <dd> | 465 <dd> |
| 421 flag indicating the direction of translation | 466 flag indicating the direction of translation |
| 422 (False = local to remote, True = remote to local [default]) | 467 (False = local to remote, True = remote to local) (defaults to True) |
| 423 </dd> | 468 </dd> |
| 424 </dl> | 469 </dl> |
| 425 <dl> | 470 <dl> |
| 426 <dt>Return:</dt> | 471 <dt>Return:</dt> |
| 427 <dd> | 472 <dd> |
| 489 reference to the disconnected socket | 534 reference to the disconnected socket |
| 490 </dd> | 535 </dd> |
| 491 </dl> | 536 </dl> |
| 492 <a NAME="DebuggerInterfacePython.__startProcess" ID="DebuggerInterfacePython.__startProcess"></a> | 537 <a NAME="DebuggerInterfacePython.__startProcess" ID="DebuggerInterfacePython.__startProcess"></a> |
| 493 <h4>DebuggerInterfacePython.__startProcess</h4> | 538 <h4>DebuggerInterfacePython.__startProcess</h4> |
| 494 <b>__startProcess</b>(<i>program, arguments, environment=None, workingDir=None</i>) | 539 <b>__startProcess</b>(<i>program, arguments, environment=None, workingDir=""</i>) |
| 495 <p> | 540 <p> |
| 496 Private method to start the debugger client process. | 541 Private method to start the debugger client process. |
| 497 </p> | 542 </p> |
| 498 | 543 |
| 499 <dl> | 544 <dl> |
| 581 <dt>Return Type:</dt> | 626 <dt>Return Type:</dt> |
| 582 <dd> | 627 <dd> |
| 583 list of str | 628 list of str |
| 584 </dd> | 629 </dd> |
| 585 </dl> | 630 </dl> |
| 631 <a NAME="DebuggerInterfacePython.handleJsonCommand" ID="DebuggerInterfacePython.handleJsonCommand"></a> | |
| 632 <h4>DebuggerInterfacePython.handleJsonCommand</h4> | |
| 633 <b>handleJsonCommand</b>(<i>jsonStr, sock</i>) | |
| 634 <p> | |
| 635 Public method to handle a command or response serialized as a | |
| 636 JSON string. | |
| 637 </p> | |
| 638 | |
| 639 <dl> | |
| 640 | |
| 641 <dt><i>jsonStr</i> (str)</dt> | |
| 642 <dd> | |
| 643 string containing the command or response received | |
| 644 from the debug backend | |
| 645 </dd> | |
| 646 <dt><i>sock</i> (QTcpSocket)</dt> | |
| 647 <dd> | |
| 648 reference to the socket the data was received from | |
| 649 </dd> | |
| 650 </dl> | |
| 586 <a NAME="DebuggerInterfacePython.isConnected" ID="DebuggerInterfacePython.isConnected"></a> | 651 <a NAME="DebuggerInterfacePython.isConnected" ID="DebuggerInterfacePython.isConnected"></a> |
| 587 <h4>DebuggerInterfacePython.isConnected</h4> | 652 <h4>DebuggerInterfacePython.isConnected</h4> |
| 588 <b>isConnected</b>(<i></i>) | 653 <b>isConnected</b>(<i></i>) |
| 589 <p> | 654 <p> |
| 590 Public method to test, if a debug client has connected. | 655 Public method to test, if a debug client has connected. |
| 1305 (Needed on Win OS) | 1370 (Needed on Win OS) |
| 1306 </p> | 1371 </p> |
| 1307 | 1372 |
| 1308 <a NAME="DebuggerInterfacePython.startRemote" ID="DebuggerInterfacePython.startRemote"></a> | 1373 <a NAME="DebuggerInterfacePython.startRemote" ID="DebuggerInterfacePython.startRemote"></a> |
| 1309 <h4>DebuggerInterfacePython.startRemote</h4> | 1374 <h4>DebuggerInterfacePython.startRemote</h4> |
| 1310 <b>startRemote</b>(<i>port, runInConsole, venvName, originalPathString, workingDir=None, configOverride=None, </i>) | 1375 <b>startRemote</b>(<i>port, runInConsole, venvName, originalPathString, workingDir="", configOverride=None, startRemote=None, </i>) |
| 1311 <p> | 1376 <p> |
| 1312 Public method to start a remote Python interpreter. | 1377 Public method to start a remote Python interpreter. |
| 1313 </p> | 1378 </p> |
| 1314 | 1379 |
| 1315 <dl> | 1380 <dl> |
| 1329 </dd> | 1394 </dd> |
| 1330 <dt><i>originalPathString</i> (str)</dt> | 1395 <dt><i>originalPathString</i> (str)</dt> |
| 1331 <dd> | 1396 <dd> |
| 1332 original PATH environment variable | 1397 original PATH environment variable |
| 1333 </dd> | 1398 </dd> |
| 1399 <dt><i>workingDir</i> (str (optional))</dt> | |
| 1400 <dd> | |
| 1401 directory to start the debugger client in (defaults to "") | |
| 1402 </dd> | |
| 1403 <dt><i>configOverride</i> (dict (optional))</dt> | |
| 1404 <dd> | |
| 1405 dictionary containing the global config override data | |
| 1406 (defaults to None) | |
| 1407 </dd> | |
| 1408 <dt><i>startRemote</i> (bool (optional))</dt> | |
| 1409 <dd> | |
| 1410 flag indicating to start the client via an eric-ide server | |
| 1411 (defaults to None) | |
| 1412 </dd> | |
| 1413 </dl> | |
| 1414 <dl> | |
| 1415 <dt>Return:</dt> | |
| 1416 <dd> | |
| 1417 client process object, a flag to indicate a network connection | |
| 1418 and the name of the interpreter in case of a local execution | |
| 1419 </dd> | |
| 1420 </dl> | |
| 1421 <dl> | |
| 1422 <dt>Return Type:</dt> | |
| 1423 <dd> | |
| 1424 tuple of (QProcess, bool, str) | |
| 1425 </dd> | |
| 1426 </dl> | |
| 1427 <a NAME="DebuggerInterfacePython.startRemoteForProject" ID="DebuggerInterfacePython.startRemoteForProject"></a> | |
| 1428 <h4>DebuggerInterfacePython.startRemoteForProject</h4> | |
| 1429 <b>startRemoteForProject</b>(<i>port, runInConsole, venvName, originalPathString, workingDir=None, configOverride=None, startRemote=False, </i>) | |
| 1430 <p> | |
| 1431 Public method to start a remote Python interpreter for a project. | |
| 1432 </p> | |
| 1433 | |
| 1434 <dl> | |
| 1435 | |
| 1436 <dt><i>port</i> (int)</dt> | |
| 1437 <dd> | |
| 1438 port number the debug server is listening on | |
| 1439 </dd> | |
| 1440 <dt><i>runInConsole</i> (bool)</dt> | |
| 1441 <dd> | |
| 1442 flag indicating to start the debugger in a | |
| 1443 console window | |
| 1444 </dd> | |
| 1445 <dt><i>venvName</i> (str)</dt> | |
| 1446 <dd> | |
| 1447 name of the virtual environment to be used | |
| 1448 </dd> | |
| 1449 <dt><i>originalPathString</i> (str)</dt> | |
| 1450 <dd> | |
| 1451 original PATH environment variable | |
| 1452 </dd> | |
| 1334 <dt><i>workingDir</i> (str)</dt> | 1453 <dt><i>workingDir</i> (str)</dt> |
| 1335 <dd> | 1454 <dd> |
| 1336 directory to start the debugger client in | 1455 directory to start the debugger client in |
| 1337 </dd> | 1456 </dd> |
| 1338 <dt><i>configOverride</i> (dict)</dt> | 1457 <dt><i>configOverride</i> (dict)</dt> |
| 1339 <dd> | 1458 <dd> |
| 1340 dictionary containing the global config override | 1459 dictionary containing the global config override |
| 1341 data | 1460 data |
| 1342 </dd> | 1461 </dd> |
| 1343 </dl> | 1462 <dt><i>startRemote</i> (bool (optional))</dt> |
| 1344 <dl> | 1463 <dd> |
| 1345 <dt>Return:</dt> | 1464 flag indicating to start the client via an eric-ide server |
| 1346 <dd> | 1465 (defaults to False) |
| 1347 client process object, a flag to indicate a network connection | |
| 1348 and the name of the interpreter in case of a local execution | |
| 1349 </dd> | |
| 1350 </dl> | |
| 1351 <dl> | |
| 1352 <dt>Return Type:</dt> | |
| 1353 <dd> | |
| 1354 tuple of (QProcess, bool, str) | |
| 1355 </dd> | |
| 1356 </dl> | |
| 1357 <a NAME="DebuggerInterfacePython.startRemoteForProject" ID="DebuggerInterfacePython.startRemoteForProject"></a> | |
| 1358 <h4>DebuggerInterfacePython.startRemoteForProject</h4> | |
| 1359 <b>startRemoteForProject</b>(<i>port, runInConsole, venvName, originalPathString, workingDir=None, configOverride=None, </i>) | |
| 1360 <p> | |
| 1361 Public method to start a remote Python interpreter for a project. | |
| 1362 </p> | |
| 1363 | |
| 1364 <dl> | |
| 1365 | |
| 1366 <dt><i>port</i> (int)</dt> | |
| 1367 <dd> | |
| 1368 port number the debug server is listening on | |
| 1369 </dd> | |
| 1370 <dt><i>runInConsole</i> (bool)</dt> | |
| 1371 <dd> | |
| 1372 flag indicating to start the debugger in a | |
| 1373 console window | |
| 1374 </dd> | |
| 1375 <dt><i>venvName</i> (str)</dt> | |
| 1376 <dd> | |
| 1377 name of the virtual environment to be used | |
| 1378 </dd> | |
| 1379 <dt><i>originalPathString</i> (str)</dt> | |
| 1380 <dd> | |
| 1381 original PATH environment variable | |
| 1382 </dd> | |
| 1383 <dt><i>workingDir</i> (str)</dt> | |
| 1384 <dd> | |
| 1385 directory to start the debugger client in | |
| 1386 </dd> | |
| 1387 <dt><i>configOverride</i> (dict)</dt> | |
| 1388 <dd> | |
| 1389 dictionary containing the global config override | |
| 1390 data | |
| 1391 </dd> | 1466 </dd> |
| 1392 </dl> | 1467 </dl> |
| 1393 <dl> | 1468 <dl> |
| 1394 <dt>Return:</dt> | 1469 <dt>Return:</dt> |
| 1395 <dd> | 1470 <dd> |
