Documentation/Source/eric6.Debugger.DebugServer.html

changeset 6352
4bdc6503df81
parent 5899
0516f6548ca6
child 6374
fcd97204ff16
equal deleted inserted replaced
6351:27ce01e44a5f 6352:4bdc6503df81
1224 <dd> 1224 <dd>
1225 flag indicating a special continue operation 1225 flag indicating a special continue operation
1226 </dd> 1226 </dd>
1227 </dl><a NAME="DebugServer.remoteCoverage" ID="DebugServer.remoteCoverage"></a> 1227 </dl><a NAME="DebugServer.remoteCoverage" ID="DebugServer.remoteCoverage"></a>
1228 <h4>DebugServer.remoteCoverage</h4> 1228 <h4>DebugServer.remoteCoverage</h4>
1229 <b>remoteCoverage</b>(<i>interpreter, fn, argv, wd, env, autoClearShell=True, erase=False, forProject=False, runInConsole=False, clientType=""</i>) 1229 <b>remoteCoverage</b>(<i>venvName, fn, argv, wd, env, autoClearShell=True, erase=False, forProject=False, runInConsole=False, clientType=""</i>)
1230 <p> 1230 <p>
1231 Public method to load a new program to collect coverage data. 1231 Public method to load a new program to collect coverage data.
1232 </p><dl> 1232 </p><dl>
1233 <dt><i>interpreter</i></dt> 1233 <dt><i>venvName</i> (str)</dt>
1234 <dd> 1234 <dd>
1235 interpreter to be used to execute the remote 1235 name of the virtual environment to be used
1236 side (string) 1236 </dd><dt><i>fn</i> (str)</dt>
1237 </dd><dt><i>fn</i></dt> 1237 <dd>
1238 <dd> 1238 the filename to debug
1239 the filename to run (string) 1239 </dd><dt><i>argv</i> (str)</dt>
1240 </dd><dt><i>argv</i></dt> 1240 <dd>
1241 <dd> 1241 the command line arguments to pass to the program
1242 the commandline arguments to pass to the program (string) 1242 </dd><dt><i>wd</i> (str)</dt>
1243 </dd><dt><i>wd</i></dt> 1243 <dd>
1244 <dd> 1244 the working directory for the program
1245 the working directory for the program (string) 1245 </dd><dt><i>env</i> (str)</dt>
1246 </dd><dt><i>env</i></dt> 1246 <dd>
1247 <dd> 1247 environment parameter settings
1248 environment settings (string) 1248 </dd><dt><i>autoClearShell=</i> (bool)</dt>
1249 </dd><dt><i>autoClearShell=</i></dt>
1250 <dd> 1249 <dd>
1251 flag indicating, that the interpreter window 1250 flag indicating, that the interpreter window
1252 should be cleared (boolean) 1251 should be cleared
1253 </dd><dt><i>erase=</i></dt> 1252 </dd><dt><i>erase=</i> (bool)</dt>
1254 <dd> 1253 <dd>
1255 flag indicating that coverage info should be 1254 flag indicating that coverage info should be
1256 cleared first (boolean) 1255 cleared first
1257 </dd><dt><i>forProject=</i></dt> 1256 </dd><dt><i>forProject=</i> (bool)</dt>
1258 <dd> 1257 <dd>
1259 flag indicating a project related action (boolean) 1258 flag indicating a project related action
1260 </dd><dt><i>runInConsole=</i></dt> 1259 </dd><dt><i>runInConsole=</i> (bool)</dt>
1261 <dd> 1260 <dd>
1262 flag indicating to start the debugger in a 1261 flag indicating to start the debugger in a
1263 console window (boolean) 1262 console window
1264 </dd><dt><i>clientType=</i></dt> 1263 </dd><dt><i>clientType=</i> (str)</dt>
1265 <dd> 1264 <dd>
1266 client type to be used (string) 1265 client type to be used
1267 </dd> 1266 </dd>
1268 </dl><a NAME="DebugServer.remoteEnvironment" ID="DebugServer.remoteEnvironment"></a> 1267 </dl><a NAME="DebugServer.remoteEnvironment" ID="DebugServer.remoteEnvironment"></a>
1269 <h4>DebugServer.remoteEnvironment</h4> 1268 <h4>DebugServer.remoteEnvironment</h4>
1270 <b>remoteEnvironment</b>(<i>env</i>) 1269 <b>remoteEnvironment</b>(<i>env</i>)
1271 <p> 1270 <p>
1275 <dd> 1274 <dd>
1276 environment settings (string) 1275 environment settings (string)
1277 </dd> 1276 </dd>
1278 </dl><a NAME="DebugServer.remoteLoad" ID="DebugServer.remoteLoad"></a> 1277 </dl><a NAME="DebugServer.remoteLoad" ID="DebugServer.remoteLoad"></a>
1279 <h4>DebugServer.remoteLoad</h4> 1278 <h4>DebugServer.remoteLoad</h4>
1280 <b>remoteLoad</b>(<i>interpreter, fn, argv, wd, env, autoClearShell=True, tracePython=False, autoContinue=True, forProject=False, runInConsole=False, autoFork=False, forkChild=False, clientType="", enableCallTrace=False</i>) 1279 <b>remoteLoad</b>(<i>venvName, fn, argv, wd, env, autoClearShell=True, tracePython=False, autoContinue=True, forProject=False, runInConsole=False, autoFork=False, forkChild=False, clientType="", enableCallTrace=False</i>)
1281 <p> 1280 <p>
1282 Public method to load a new program to debug. 1281 Public method to load a new program to debug.
1283 </p><dl> 1282 </p><dl>
1284 <dt><i>interpreter</i></dt> 1283 <dt><i>venvName</i> (str)</dt>
1285 <dd> 1284 <dd>
1286 interpreter to be used to execute the remote 1285 name of the virtual environment to be used
1287 side (string) 1286 </dd><dt><i>fn</i> (str)</dt>
1288 </dd><dt><i>fn</i></dt> 1287 <dd>
1289 <dd> 1288 the filename to debug
1290 the filename to debug (string) 1289 </dd><dt><i>argv</i> (str)</dt>
1291 </dd><dt><i>argv</i></dt> 1290 <dd>
1292 <dd> 1291 the command line arguments to pass to the program
1293 the commandline arguments to pass to the program (string) 1292 </dd><dt><i>wd</i> (str)</dt>
1294 </dd><dt><i>wd</i></dt> 1293 <dd>
1295 <dd> 1294 the working directory for the program
1296 the working directory for the program (string) 1295 </dd><dt><i>env</i> (str)</dt>
1297 </dd><dt><i>env</i></dt> 1296 <dd>
1298 <dd> 1297 environment parameter settings
1299 environment settings (string) 1298 </dd><dt><i>autoClearShell=</i> (bool)</dt>
1300 </dd><dt><i>autoClearShell=</i></dt>
1301 <dd> 1299 <dd>
1302 flag indicating, that the interpreter window 1300 flag indicating, that the interpreter window
1303 should be cleared (boolean) 1301 should be cleared
1304 </dd><dt><i>tracePython=</i></dt> 1302 </dd><dt><i>tracePython=</i> (bool)</dt>
1305 <dd> 1303 <dd>
1306 flag indicating if the Python library should be 1304 flag indicating if the Python library should be
1307 traced as well (boolean) 1305 traced as well
1308 </dd><dt><i>autoContinue=</i></dt> 1306 </dd><dt><i>autoContinue=</i> (bool)</dt>
1309 <dd> 1307 <dd>
1310 flag indicating, that the debugger should not 1308 flag indicating, that the debugger should not
1311 stop at the first executable line (boolean) 1309 stop at the first executable line
1312 </dd><dt><i>forProject=</i></dt> 1310 </dd><dt><i>forProject=</i> (bool)</dt>
1313 <dd> 1311 <dd>
1314 flag indicating a project related action (boolean) 1312 flag indicating a project related action
1315 </dd><dt><i>runInConsole=</i></dt> 1313 </dd><dt><i>runInConsole=</i> (bool)</dt>
1316 <dd> 1314 <dd>
1317 flag indicating to start the debugger in a 1315 flag indicating to start the debugger in a
1318 console window (boolean) 1316 console window
1319 </dd><dt><i>autoFork=</i></dt> 1317 </dd><dt><i>autoFork=</i> (bool)</dt>
1320 <dd> 1318 <dd>
1321 flag indicating the automatic fork mode (boolean) 1319 flag indicating the automatic fork mode
1322 </dd><dt><i>forkChild=</i></dt> 1320 </dd><dt><i>forkChild=</i> (bool)</dt>
1323 <dd> 1321 <dd>
1324 flag indicating to debug the child after forking 1322 flag indicating to debug the child after forking
1325 (boolean) 1323 </dd><dt><i>clientType=</i> (str)</dt>
1326 </dd><dt><i>clientType=</i></dt> 1324 <dd>
1327 <dd> 1325 client type to be used
1328 client type to be used (string) 1326 </dd><dt><i>enableCallTrace=</i> (bool)</dt>
1329 </dd><dt><i>enableCallTrace=</i></dt>
1330 <dd> 1327 <dd>
1331 flag indicating to enable the call trace 1328 flag indicating to enable the call trace
1332 function (boolean) 1329 function
1333 </dd> 1330 </dd>
1334 </dl><a NAME="DebugServer.remoteMoveIP" ID="DebugServer.remoteMoveIP"></a> 1331 </dl><a NAME="DebugServer.remoteMoveIP" ID="DebugServer.remoteMoveIP"></a>
1335 <h4>DebugServer.remoteMoveIP</h4> 1332 <h4>DebugServer.remoteMoveIP</h4>
1336 <b>remoteMoveIP</b>(<i>line</i>) 1333 <b>remoteMoveIP</b>(<i>line</i>)
1337 <p> 1334 <p>
1341 <dd> 1338 <dd>
1342 the new line, where execution should be continued 1339 the new line, where execution should be continued
1343 </dd> 1340 </dd>
1344 </dl><a NAME="DebugServer.remoteProfile" ID="DebugServer.remoteProfile"></a> 1341 </dl><a NAME="DebugServer.remoteProfile" ID="DebugServer.remoteProfile"></a>
1345 <h4>DebugServer.remoteProfile</h4> 1342 <h4>DebugServer.remoteProfile</h4>
1346 <b>remoteProfile</b>(<i>interpreter, fn, argv, wd, env, autoClearShell=True, erase=False, forProject=False, runInConsole=False, clientType=""</i>) 1343 <b>remoteProfile</b>(<i>venvName, fn, argv, wd, env, autoClearShell=True, erase=False, forProject=False, runInConsole=False, clientType=""</i>)
1347 <p> 1344 <p>
1348 Public method to load a new program to collect profiling data. 1345 Public method to load a new program to collect profiling data.
1349 </p><dl> 1346 </p><dl>
1350 <dt><i>interpreter</i></dt> 1347 <dt><i>venvName</i> (str)</dt>
1351 <dd> 1348 <dd>
1352 interpreter to be used to execute the remote 1349 name of the virtual environment to be used
1353 side (string) 1350 </dd><dt><i>fn</i> (str)</dt>
1354 </dd><dt><i>fn</i></dt> 1351 <dd>
1355 <dd> 1352 the filename to debug
1356 the filename to run (string) 1353 </dd><dt><i>argv</i> (str)</dt>
1357 </dd><dt><i>argv</i></dt> 1354 <dd>
1358 <dd> 1355 the command line arguments to pass to the program
1359 the commandline arguments to pass to the program (string) 1356 </dd><dt><i>wd</i> (str)</dt>
1360 </dd><dt><i>wd</i></dt> 1357 <dd>
1361 <dd> 1358 the working directory for the program
1362 the working directory for the program (string) 1359 </dd><dt><i>env</i> (str)</dt>
1363 </dd><dt><i>env</i></dt> 1360 <dd>
1364 <dd> 1361 environment parameter settings
1365 environment settings (string) 1362 </dd><dt><i>autoClearShell=</i> (bool)</dt>
1366 </dd><dt><i>autoClearShell=</i></dt>
1367 <dd> 1363 <dd>
1368 flag indicating, that the interpreter window 1364 flag indicating, that the interpreter window
1369 should be cleared (boolean) 1365 should be cleared
1370 </dd><dt><i>erase=</i></dt> 1366 </dd><dt><i>erase=</i> (bool)</dt>
1371 <dd> 1367 <dd>
1372 flag indicating that timing info should be cleared 1368 flag indicating that coverage info should be
1373 first (boolean) 1369 cleared first
1374 </dd><dt><i>forProject=</i></dt> 1370 </dd><dt><i>forProject=</i> (bool)</dt>
1375 <dd> 1371 <dd>
1376 flag indicating a project related action (boolean) 1372 flag indicating a project related action
1377 </dd><dt><i>runInConsole=</i></dt> 1373 </dd><dt><i>runInConsole=</i> (bool)</dt>
1378 <dd> 1374 <dd>
1379 flag indicating to start the debugger in a 1375 flag indicating to start the debugger in a
1380 console window (boolean) 1376 console window
1381 </dd><dt><i>clientType=</i></dt> 1377 </dd><dt><i>clientType=</i> (str)</dt>
1382 <dd> 1378 <dd>
1383 client type to be used (string) 1379 client type to be used
1384 </dd> 1380 </dd>
1385 </dl><a NAME="DebugServer.remoteRawInput" ID="DebugServer.remoteRawInput"></a> 1381 </dl><a NAME="DebugServer.remoteRawInput" ID="DebugServer.remoteRawInput"></a>
1386 <h4>DebugServer.remoteRawInput</h4> 1382 <h4>DebugServer.remoteRawInput</h4>
1387 <b>remoteRawInput</b>(<i>s</i>) 1383 <b>remoteRawInput</b>(<i>s</i>)
1388 <p> 1384 <p>
1392 <dd> 1388 <dd>
1393 the raw input (string) 1389 the raw input (string)
1394 </dd> 1390 </dd>
1395 </dl><a NAME="DebugServer.remoteRun" ID="DebugServer.remoteRun"></a> 1391 </dl><a NAME="DebugServer.remoteRun" ID="DebugServer.remoteRun"></a>
1396 <h4>DebugServer.remoteRun</h4> 1392 <h4>DebugServer.remoteRun</h4>
1397 <b>remoteRun</b>(<i>interpreter, fn, argv, wd, env, autoClearShell=True, forProject=False, runInConsole=False, autoFork=False, forkChild=False, clientType=""</i>) 1393 <b>remoteRun</b>(<i>venvName, fn, argv, wd, env, autoClearShell=True, forProject=False, runInConsole=False, autoFork=False, forkChild=False, clientType=""</i>)
1398 <p> 1394 <p>
1399 Public method to load a new program to run. 1395 Public method to load a new program to run.
1400 </p><dl> 1396 </p><dl>
1401 <dt><i>interpreter</i></dt> 1397 <dt><i>venvName</i> (str)</dt>
1402 <dd> 1398 <dd>
1403 interpreter to be used to execute the remote 1399 name of the virtual environment to be used
1404 side (string) 1400 </dd><dt><i>fn</i> (str)</dt>
1405 </dd><dt><i>fn</i></dt> 1401 <dd>
1406 <dd> 1402 the filename to debug
1407 the filename to run (string) 1403 </dd><dt><i>argv</i> (str)</dt>
1408 </dd><dt><i>argv</i></dt> 1404 <dd>
1409 <dd> 1405 the command line arguments to pass to the program
1410 the commandline arguments to pass to the program (string) 1406 </dd><dt><i>wd</i> (str)</dt>
1411 </dd><dt><i>wd</i></dt> 1407 <dd>
1412 <dd> 1408 the working directory for the program
1413 the working directory for the program (string) 1409 </dd><dt><i>env</i> (str)</dt>
1414 </dd><dt><i>env</i></dt> 1410 <dd>
1415 <dd> 1411 environment parameter settings
1416 environment settings (string) 1412 </dd><dt><i>autoClearShell=</i> (bool)</dt>
1417 </dd><dt><i>autoClearShell=</i></dt>
1418 <dd> 1413 <dd>
1419 flag indicating, that the interpreter window 1414 flag indicating, that the interpreter window
1420 should be cleared (boolean) 1415 should be cleared
1421 </dd><dt><i>forProject=</i></dt> 1416 </dd><dt><i>forProject=</i> (bool)</dt>
1422 <dd> 1417 <dd>
1423 flag indicating a project related action (boolean) 1418 flag indicating a project related action
1424 </dd><dt><i>runInConsole=</i></dt> 1419 </dd><dt><i>runInConsole=</i> (bool)</dt>
1425 <dd> 1420 <dd>
1426 flag indicating to start the debugger in a 1421 flag indicating to start the debugger in a
1427 console window (boolean) 1422 console window
1428 </dd><dt><i>autoFork=</i></dt> 1423 </dd><dt><i>autoFork=</i> (bool)</dt>
1429 <dd> 1424 <dd>
1430 flag indicating the automatic fork mode (boolean) 1425 flag indicating the automatic fork mode
1431 </dd><dt><i>forkChild=</i></dt> 1426 </dd><dt><i>forkChild=</i> (bool)</dt>
1432 <dd> 1427 <dd>
1433 flag indicating to debug the child after forking 1428 flag indicating to debug the child after forking
1434 (boolean) 1429 </dd><dt><i>clientType=</i> (str)</dt>
1435 </dd><dt><i>clientType=</i></dt> 1430 <dd>
1436 <dd> 1431 client type to be used
1437 client type to be used (string)
1438 </dd> 1432 </dd>
1439 </dl><a NAME="DebugServer.remoteSetThread" ID="DebugServer.remoteSetThread"></a> 1433 </dl><a NAME="DebugServer.remoteSetThread" ID="DebugServer.remoteSetThread"></a>
1440 <h4>DebugServer.remoteSetThread</h4> 1434 <h4>DebugServer.remoteSetThread</h4>
1441 <b>remoteSetThread</b>(<i>tid</i>) 1435 <b>remoteSetThread</b>(<i>tid</i>)
1442 <p> 1436 <p>
1842 <dd> 1836 <dd>
1843 expression of watch expression to clear (string) 1837 expression of watch expression to clear (string)
1844 </dd> 1838 </dd>
1845 </dl><a NAME="DebugServer.startClient" ID="DebugServer.startClient"></a> 1839 </dl><a NAME="DebugServer.startClient" ID="DebugServer.startClient"></a>
1846 <h4>DebugServer.startClient</h4> 1840 <h4>DebugServer.startClient</h4>
1847 <b>startClient</b>(<i>unplanned=True, clType=None, forProject=False, runInConsole=False, interpreter=""</i>) 1841 <b>startClient</b>(<i>unplanned=True, clType=None, forProject=False, runInConsole=False, venvName=""</i>)
1848 <p> 1842 <p>
1849 Public method to start a debug client. 1843 Public method to start a debug client.
1850 </p><dl> 1844 </p><dl>
1851 <dt><i>unplanned=</i></dt> 1845 <dt><i>unplanned=</i> (bool)</dt>
1852 <dd> 1846 <dd>
1853 flag indicating that the client has died (boolean) 1847 flag indicating that the client has died
1854 </dd><dt><i>clType=</i></dt> 1848 </dd><dt><i>clType=</i> (str)</dt>
1855 <dd> 1849 <dd>
1856 type of client to be started (string) 1850 type of client to be started
1857 </dd><dt><i>forProject=</i></dt> 1851 </dd><dt><i>forProject=</i> (bool)</dt>
1858 <dd> 1852 <dd>
1859 flag indicating a project related action (boolean) 1853 flag indicating a project related action
1860 </dd><dt><i>runInConsole=</i></dt> 1854 </dd><dt><i>runInConsole=</i> (bool)</dt>
1861 <dd> 1855 <dd>
1862 flag indicating to start the debugger in a 1856 flag indicating to start the debugger in a
1863 console window (boolean) 1857 console window
1864 </dd><dt><i>interpreter=</i></dt> 1858 </dd><dt><i>venvName=</i> (str)</dt>
1865 <dd> 1859 <dd>
1866 interpreter to be used to execute the remote 1860 name of the virtual environment to be used
1867 side (string)
1868 </dd> 1861 </dd>
1869 </dl><a NAME="DebugServer.unregisterDebuggerInterface" ID="DebugServer.unregisterDebuggerInterface"></a> 1862 </dl><a NAME="DebugServer.unregisterDebuggerInterface" ID="DebugServer.unregisterDebuggerInterface"></a>
1870 <h4>DebugServer.unregisterDebuggerInterface</h4> 1863 <h4>DebugServer.unregisterDebuggerInterface</h4>
1871 <b>unregisterDebuggerInterface</b>(<i>interfaceName</i>) 1864 <b>unregisterDebuggerInterface</b>(<i>interfaceName</i>)
1872 <p> 1865 <p>

eric ide

mercurial