eric7/Documentation/Source/eric7.Debugger.DebugServer.html

branch
eric7
changeset 9097
213951c41dcd
parent 8596
d64760b2da50
equal deleted inserted replaced
9096:f6f7d8f364c3 9097:213951c41dcd
206 <dt>passiveDebugStarted(str, bool)</dt> 206 <dt>passiveDebugStarted(str, bool)</dt>
207 <dd> 207 <dd>
208 emitted after the debug client has 208 emitted after the debug client has
209 connected in passive debug mode 209 connected in passive debug mode
210 </dd> 210 </dd>
211 <dt>utDiscovered(testCases, exc_type, exc_value)</dt>
212 <dd>
213 emitted after the
214 client has performed a test case discovery action
215 </dd>
216 <dt>utFinished()</dt>
217 <dd>
218 emitted after the client signalled the end of the
219 unittest
220 </dd>
221 <dt>utPrepared(nrTests, exc_type, exc_value)</dt>
222 <dd>
223 emitted after the client
224 has loaded a unittest suite
225 </dd>
226 <dt>utStartTest(testname, testdocu)</dt>
227 <dd>
228 emitted after the client has
229 started a test
230 </dd>
231 <dt>utStopTest()</dt>
232 <dd>
233 emitted after the client has finished a test
234 </dd>
235 <dt>utTestErrored(testname, exc_info, id)</dt>
236 <dd>
237 emitted after the client
238 reported an errored test
239 </dd>
240 <dt>utTestFailed(testname, exc_info, id)</dt>
241 <dd>
242 emitted after the client
243 reported a failed test
244 </dd>
245 <dt>utTestFailedExpected(testname, exc_info, id)</dt>
246 <dd>
247 emitted after the
248 client reported an expected test failure
249 </dd>
250 <dt>utTestSkipped(testname, reason, id)</dt>
251 <dd>
252 emitted after the client
253 reported a skipped test
254 </dd>
255 <dt>utTestSucceededUnexpected(testname, id)</dt>
256 <dd>
257 emitted after the client
258 reported an unexpected test success
259 </dd>
260 </dl> 211 </dl>
261 <h3>Derived from</h3> 212 <h3>Derived from</h3>
262 QTcpServer 213 QTcpServer
263 <h3>Class Attributes</h3> 214 <h3>Class Attributes</h3>
264 215
393 <tr> 344 <tr>
394 <td><a href="#DebugServer.__watchPointDataAboutToBeChanged">__watchPointDataAboutToBeChanged</a></td> 345 <td><a href="#DebugServer.__watchPointDataAboutToBeChanged">__watchPointDataAboutToBeChanged</a></td>
395 <td>Private slot to handle the dataAboutToBeChanged signal of the watch expression model.</td> 346 <td>Private slot to handle the dataAboutToBeChanged signal of the watch expression model.</td>
396 </tr> 347 </tr>
397 <tr> 348 <tr>
398 <td><a href="#DebugServer.clientUtDiscovered">clientUtDiscovered</a></td>
399 <td>Public method to process the client unittest discover info.</td>
400 </tr>
401 <tr>
402 <td><a href="#DebugServer.clientUtFinished">clientUtFinished</a></td>
403 <td>Public method to process the client unit test finished info.</td>
404 </tr>
405 <tr>
406 <td><a href="#DebugServer.clientUtPrepared">clientUtPrepared</a></td>
407 <td>Public method to process the client unittest prepared info.</td>
408 </tr>
409 <tr>
410 <td><a href="#DebugServer.clientUtStartTest">clientUtStartTest</a></td>
411 <td>Public method to process the client start test info.</td>
412 </tr>
413 <tr>
414 <td><a href="#DebugServer.clientUtStopTest">clientUtStopTest</a></td>
415 <td>Public method to process the client stop test info.</td>
416 </tr>
417 <tr>
418 <td><a href="#DebugServer.clientUtTestErrored">clientUtTestErrored</a></td>
419 <td>Public method to process the client test errored info.</td>
420 </tr>
421 <tr>
422 <td><a href="#DebugServer.clientUtTestFailed">clientUtTestFailed</a></td>
423 <td>Public method to process the client test failed info.</td>
424 </tr>
425 <tr>
426 <td><a href="#DebugServer.clientUtTestFailedExpected">clientUtTestFailedExpected</a></td>
427 <td>Public method to process the client test failed expected info.</td>
428 </tr>
429 <tr>
430 <td><a href="#DebugServer.clientUtTestSkipped">clientUtTestSkipped</a></td>
431 <td>Public method to process the client test skipped info.</td>
432 </tr>
433 <tr>
434 <td><a href="#DebugServer.clientUtTestSucceededUnexpected">clientUtTestSucceededUnexpected</a></td>
435 <td>Public method to process the client test succeeded unexpected info.</td>
436 </tr>
437 <tr>
438 <td><a href="#DebugServer.getBreakPointModel">getBreakPointModel</a></td> 349 <td><a href="#DebugServer.getBreakPointModel">getBreakPointModel</a></td>
439 <td>Public slot to get a reference to the breakpoint model object.</td> 350 <td>Public slot to get a reference to the breakpoint model object.</td>
440 </tr> 351 </tr>
441 <tr> 352 <tr>
442 <td><a href="#DebugServer.getClientCapabilities">getClientCapabilities</a></td> 353 <td><a href="#DebugServer.getClientCapabilities">getClientCapabilities</a></td>
599 <td>Public method to stop the debugged program.</td> 510 <td>Public method to stop the debugged program.</td>
600 </tr> 511 </tr>
601 <tr> 512 <tr>
602 <td><a href="#DebugServer.remoteThreadList">remoteThreadList</a></td> 513 <td><a href="#DebugServer.remoteThreadList">remoteThreadList</a></td>
603 <td>Public method to request the list of threads from the client.</td> 514 <td>Public method to request the list of threads from the client.</td>
604 </tr>
605 <tr>
606 <td><a href="#DebugServer.remoteUTDiscover">remoteUTDiscover</a></td>
607 <td>Public method to perform a test case discovery.</td>
608 </tr>
609 <tr>
610 <td><a href="#DebugServer.remoteUTPrepare">remoteUTPrepare</a></td>
611 <td>Public method to prepare a new unittest run.</td>
612 </tr>
613 <tr>
614 <td><a href="#DebugServer.remoteUTRun">remoteUTRun</a></td>
615 <td>Public method to start a unittest run.</td>
616 </tr>
617 <tr>
618 <td><a href="#DebugServer.remoteUTStop">remoteUTStop</a></td>
619 <td>public method to stop a unittest run.</td>
620 </tr> 515 </tr>
621 <tr> 516 <tr>
622 <td><a href="#DebugServer.setCallTraceEnabled">setCallTraceEnabled</a></td> 517 <td><a href="#DebugServer.setCallTraceEnabled">setCallTraceEnabled</a></td>
623 <td>Public method to set the call trace state.</td> 518 <td>Public method to set the call trace state.</td>
624 </tr> 519 </tr>
1317 start index of the rows to be changed 1212 start index of the rows to be changed
1318 </dd> 1213 </dd>
1319 <dt><i>endIndex</i> (QModelIndex)</dt> 1214 <dt><i>endIndex</i> (QModelIndex)</dt>
1320 <dd> 1215 <dd>
1321 end index of the rows to be changed 1216 end index of the rows to be changed
1322 </dd>
1323 </dl>
1324 <a NAME="DebugServer.clientUtDiscovered" ID="DebugServer.clientUtDiscovered"></a>
1325 <h4>DebugServer.clientUtDiscovered</h4>
1326 <b>clientUtDiscovered</b>(<i>testCases, exceptionType, exceptionValue</i>)
1327
1328 <p>
1329 Public method to process the client unittest discover info.
1330 </p>
1331 <dl>
1332
1333 <dt><i>testCases</i> (str)</dt>
1334 <dd>
1335 list of detected test cases
1336 </dd>
1337 <dt><i>exceptionType</i> (str)</dt>
1338 <dd>
1339 exception type
1340 </dd>
1341 <dt><i>exceptionValue</i> (str)</dt>
1342 <dd>
1343 exception message
1344 </dd>
1345 </dl>
1346 <a NAME="DebugServer.clientUtFinished" ID="DebugServer.clientUtFinished"></a>
1347 <h4>DebugServer.clientUtFinished</h4>
1348 <b>clientUtFinished</b>(<i>status</i>)
1349
1350 <p>
1351 Public method to process the client unit test finished info.
1352 </p>
1353 <dl>
1354
1355 <dt><i>status</i> (int)</dt>
1356 <dd>
1357 exit status of the unit test
1358 </dd>
1359 </dl>
1360 <a NAME="DebugServer.clientUtPrepared" ID="DebugServer.clientUtPrepared"></a>
1361 <h4>DebugServer.clientUtPrepared</h4>
1362 <b>clientUtPrepared</b>(<i>result, exceptionType, exceptionValue</i>)
1363
1364 <p>
1365 Public method to process the client unittest prepared info.
1366 </p>
1367 <dl>
1368
1369 <dt><i>result</i> (int)</dt>
1370 <dd>
1371 number of test cases (0 = error)
1372 </dd>
1373 <dt><i>exceptionType</i> (str)</dt>
1374 <dd>
1375 exception type
1376 </dd>
1377 <dt><i>exceptionValue</i> (str)</dt>
1378 <dd>
1379 exception message
1380 </dd>
1381 </dl>
1382 <a NAME="DebugServer.clientUtStartTest" ID="DebugServer.clientUtStartTest"></a>
1383 <h4>DebugServer.clientUtStartTest</h4>
1384 <b>clientUtStartTest</b>(<i>testname, doc</i>)
1385
1386 <p>
1387 Public method to process the client start test info.
1388 </p>
1389 <dl>
1390
1391 <dt><i>testname</i> (str)</dt>
1392 <dd>
1393 name of the test
1394 </dd>
1395 <dt><i>doc</i> (str)</dt>
1396 <dd>
1397 short description of the test
1398 </dd>
1399 </dl>
1400 <a NAME="DebugServer.clientUtStopTest" ID="DebugServer.clientUtStopTest"></a>
1401 <h4>DebugServer.clientUtStopTest</h4>
1402 <b>clientUtStopTest</b>(<i></i>)
1403
1404 <p>
1405 Public method to process the client stop test info.
1406 </p>
1407 <a NAME="DebugServer.clientUtTestErrored" ID="DebugServer.clientUtTestErrored"></a>
1408 <h4>DebugServer.clientUtTestErrored</h4>
1409 <b>clientUtTestErrored</b>(<i>testname, traceback, testId</i>)
1410
1411 <p>
1412 Public method to process the client test errored info.
1413 </p>
1414 <dl>
1415
1416 <dt><i>testname</i> (str)</dt>
1417 <dd>
1418 name of the test
1419 </dd>
1420 <dt><i>traceback</i> (list of str)</dt>
1421 <dd>
1422 lines of traceback info
1423 </dd>
1424 <dt><i>testId</i> (str)</dt>
1425 <dd>
1426 id of the test
1427 </dd>
1428 </dl>
1429 <a NAME="DebugServer.clientUtTestFailed" ID="DebugServer.clientUtTestFailed"></a>
1430 <h4>DebugServer.clientUtTestFailed</h4>
1431 <b>clientUtTestFailed</b>(<i>testname, traceback, testId</i>)
1432
1433 <p>
1434 Public method to process the client test failed info.
1435 </p>
1436 <dl>
1437
1438 <dt><i>testname</i> (str)</dt>
1439 <dd>
1440 name of the test
1441 </dd>
1442 <dt><i>traceback</i> (list of str)</dt>
1443 <dd>
1444 lines of traceback info
1445 </dd>
1446 <dt><i>testId</i> (str)</dt>
1447 <dd>
1448 id of the test
1449 </dd>
1450 </dl>
1451 <a NAME="DebugServer.clientUtTestFailedExpected" ID="DebugServer.clientUtTestFailedExpected"></a>
1452 <h4>DebugServer.clientUtTestFailedExpected</h4>
1453 <b>clientUtTestFailedExpected</b>(<i>testname, traceback, testId</i>)
1454
1455 <p>
1456 Public method to process the client test failed expected info.
1457 </p>
1458 <dl>
1459
1460 <dt><i>testname</i> (str)</dt>
1461 <dd>
1462 name of the test
1463 </dd>
1464 <dt><i>traceback</i> (list of str)</dt>
1465 <dd>
1466 lines of traceback info
1467 </dd>
1468 <dt><i>testId</i> (str)</dt>
1469 <dd>
1470 id of the test
1471 </dd>
1472 </dl>
1473 <a NAME="DebugServer.clientUtTestSkipped" ID="DebugServer.clientUtTestSkipped"></a>
1474 <h4>DebugServer.clientUtTestSkipped</h4>
1475 <b>clientUtTestSkipped</b>(<i>testname, reason, testId</i>)
1476
1477 <p>
1478 Public method to process the client test skipped info.
1479 </p>
1480 <dl>
1481
1482 <dt><i>testname</i> (str)</dt>
1483 <dd>
1484 name of the test
1485 </dd>
1486 <dt><i>reason</i> (str)</dt>
1487 <dd>
1488 reason for skipping the test
1489 </dd>
1490 <dt><i>testId</i> (str)</dt>
1491 <dd>
1492 id of the test
1493 </dd>
1494 </dl>
1495 <a NAME="DebugServer.clientUtTestSucceededUnexpected" ID="DebugServer.clientUtTestSucceededUnexpected"></a>
1496 <h4>DebugServer.clientUtTestSucceededUnexpected</h4>
1497 <b>clientUtTestSucceededUnexpected</b>(<i>testname, testId</i>)
1498
1499 <p>
1500 Public method to process the client test succeeded unexpected info.
1501 </p>
1502 <dl>
1503
1504 <dt><i>testname</i> (str)</dt>
1505 <dd>
1506 name of the test
1507 </dd>
1508 <dt><i>testId</i> (str)</dt>
1509 <dd>
1510 id of the test
1511 </dd> 1217 </dd>
1512 </dl> 1218 </dl>
1513 <a NAME="DebugServer.getBreakPointModel" ID="DebugServer.getBreakPointModel"></a> 1219 <a NAME="DebugServer.getBreakPointModel" ID="DebugServer.getBreakPointModel"></a>
1514 <h4>DebugServer.getBreakPointModel</h4> 1220 <h4>DebugServer.getBreakPointModel</h4>
1515 <b>getBreakPointModel</b>(<i></i>) 1221 <b>getBreakPointModel</b>(<i></i>)
2462 <dt><i>debuggerId</i> (str)</dt> 2168 <dt><i>debuggerId</i> (str)</dt>
2463 <dd> 2169 <dd>
2464 ID of the debugger backend 2170 ID of the debugger backend
2465 </dd> 2171 </dd>
2466 </dl> 2172 </dl>
2467 <a NAME="DebugServer.remoteUTDiscover" ID="DebugServer.remoteUTDiscover"></a>
2468 <h4>DebugServer.remoteUTDiscover</h4>
2469 <b>remoteUTDiscover</b>(<i>clientType, forProject, venvName, syspath, workdir, discoveryStart</i>)
2470
2471 <p>
2472 Public method to perform a test case discovery.
2473 </p>
2474 <dl>
2475
2476 <dt><i>clientType</i> (str)</dt>
2477 <dd>
2478 client type to be used
2479 </dd>
2480 <dt><i>forProject</i> (bool)</dt>
2481 <dd>
2482 flag indicating a project related action
2483 </dd>
2484 <dt><i>venvName</i> (str)</dt>
2485 <dd>
2486 name of a virtual environment
2487 </dd>
2488 <dt><i>syspath</i> (list of str)</dt>
2489 <dd>
2490 list of directories to be added to sys.path on the
2491 remote side
2492 </dd>
2493 <dt><i>workdir</i> (str)</dt>
2494 <dd>
2495 path name of the working directory
2496 </dd>
2497 <dt><i>discoveryStart</i> (str)</dt>
2498 <dd>
2499 directory to start auto-discovery at
2500 </dd>
2501 </dl>
2502 <a NAME="DebugServer.remoteUTPrepare" ID="DebugServer.remoteUTPrepare"></a>
2503 <h4>DebugServer.remoteUTPrepare</h4>
2504 <b>remoteUTPrepare</b>(<i>fn, tn, tfn, failed, cov, covname, coverase, clientType="", forProject=False, venvName="", syspath=None, workdir="", discover=False, discoveryStart="", testCases=None, debug=False</i>)
2505
2506 <p>
2507 Public method to prepare a new unittest run.
2508 </p>
2509 <dl>
2510
2511 <dt><i>fn</i> (str)</dt>
2512 <dd>
2513 the filename to load
2514 </dd>
2515 <dt><i>tn</i> (str)</dt>
2516 <dd>
2517 the testname to load
2518 </dd>
2519 <dt><i>tfn</i> (str)</dt>
2520 <dd>
2521 the test function name to load tests from
2522 </dd>
2523 <dt><i>failed</i> (list of str)</dt>
2524 <dd>
2525 list of failed test, if only failed test should be run
2526 </dd>
2527 <dt><i>cov</i> (bool)</dt>
2528 <dd>
2529 flag indicating collection of coverage data is requested
2530 </dd>
2531 <dt><i>covname</i> (str)</dt>
2532 <dd>
2533 filename to be used to assemble the coverage caches
2534 filename
2535 </dd>
2536 <dt><i>coverase</i> (bool)</dt>
2537 <dd>
2538 flag indicating erasure of coverage data is requested
2539 </dd>
2540 <dt><i>clientType</i> (str)</dt>
2541 <dd>
2542 client type to be used
2543 </dd>
2544 <dt><i>forProject</i> (bool)</dt>
2545 <dd>
2546 flag indicating a project related action
2547 </dd>
2548 <dt><i>venvName</i> (str)</dt>
2549 <dd>
2550 name of a virtual environment
2551 </dd>
2552 <dt><i>syspath</i> (list of str)</dt>
2553 <dd>
2554 list of directories to be added to sys.path on the
2555 remote side
2556 </dd>
2557 <dt><i>workdir</i> (str)</dt>
2558 <dd>
2559 path name of the working directory
2560 </dd>
2561 <dt><i>discover</i> (bool)</dt>
2562 <dd>
2563 flag indicating to discover the tests automatically
2564 </dd>
2565 <dt><i>discoveryStart</i> (str)</dt>
2566 <dd>
2567 directory to start auto-discovery at
2568 </dd>
2569 <dt><i>testCases</i> (list of str)</dt>
2570 <dd>
2571 list of test cases to be loaded
2572 </dd>
2573 <dt><i>debug</i> (bool)</dt>
2574 <dd>
2575 flag indicating to run unittest with debugging
2576 </dd>
2577 </dl>
2578 <a NAME="DebugServer.remoteUTRun" ID="DebugServer.remoteUTRun"></a>
2579 <h4>DebugServer.remoteUTRun</h4>
2580 <b>remoteUTRun</b>(<i>debug=False, failfast=False</i>)
2581
2582 <p>
2583 Public method to start a unittest run.
2584 </p>
2585 <dl>
2586
2587 <dt><i>debug</i> (bool)</dt>
2588 <dd>
2589 flag indicating to run unittest with debugging
2590 </dd>
2591 <dt><i>failfast</i> (bool)</dt>
2592 <dd>
2593 flag indicating to stop at the first error
2594 </dd>
2595 </dl>
2596 <a NAME="DebugServer.remoteUTStop" ID="DebugServer.remoteUTStop"></a>
2597 <h4>DebugServer.remoteUTStop</h4>
2598 <b>remoteUTStop</b>(<i></i>)
2599
2600 <p>
2601 public method to stop a unittest run.
2602 </p>
2603 <a NAME="DebugServer.setCallTraceEnabled" ID="DebugServer.setCallTraceEnabled"></a> 2173 <a NAME="DebugServer.setCallTraceEnabled" ID="DebugServer.setCallTraceEnabled"></a>
2604 <h4>DebugServer.setCallTraceEnabled</h4> 2174 <h4>DebugServer.setCallTraceEnabled</h4>
2605 <b>setCallTraceEnabled</b>(<i>debuggerId, on</i>) 2175 <b>setCallTraceEnabled</b>(<i>debuggerId, on</i>)
2606 2176
2607 <p> 2177 <p>

eric ide

mercurial