Documentation/Source/eric6.DebugClients.Python.DebugClientBase.html

changeset 5964
066e6c78a367
parent 5651
982465f8389c
child 5966
3325ecd87c7c
equal deleted inserted replaced
5963:14522ec8cd08 5964:066e6c78a367
272 <dd> 272 <dd>
273 the text to be completed (string) 273 the text to be completed (string)
274 </dd> 274 </dd>
275 </dl><a NAME="DebugClientBase.__dumpVariable" ID="DebugClientBase.__dumpVariable"></a> 275 </dl><a NAME="DebugClientBase.__dumpVariable" ID="DebugClientBase.__dumpVariable"></a>
276 <h4>DebugClientBase.__dumpVariable</h4> 276 <h4>DebugClientBase.__dumpVariable</h4>
277 <b>__dumpVariable</b>(<i>var, frmnr, scope, filterList</i>) 277 <b>__dumpVariable</b>(<i>var, frmnr, scope, filterList, maxSize</i>)
278 <p> 278 <p>
279 Private method to return the variables of a frame to the debug server. 279 Private method to return the variables of a frame to the debug server.
280 </p><dl> 280 </p><dl>
281 <dt><i>var</i></dt> 281 <dt><i>var</i> (list of strings)</dt>
282 <dd> 282 <dd>
283 list encoded name of the requested variable 283 list encoded name of the requested variable
284 (list of strings) 284 </dd><dt><i>frmnr</i> (int)</dt>
285 </dd><dt><i>frmnr</i></dt>
286 <dd> 285 <dd>
287 distance of frame reported on. 0 is the current frame 286 distance of frame reported on. 0 is the current frame
288 (int)
289 </dd><dt><i>scope</i></dt> 287 </dd><dt><i>scope</i></dt>
290 <dd> 288 <dd>
291 1 to report global variables, 0 for local variables (int) 289 1 to report global variables, 0 for local variables (int)
292 </dd><dt><i>filterList</i></dt> 290 </dd><dt><i>filterList</i> (list of int)</dt>
293 <dd> 291 <dd>
294 the indices of variable types to be filtered 292 the indices of variable types to be filtered
295 (list of int) 293 </dd><dt><i>maxSize</i> (int)</dt>
294 <dd>
295 maximum size the formatted value of a variable will
296 be shown. If it is bigger than that, a 'too big' indication will
297 be given.
296 </dd> 298 </dd>
297 </dl><a NAME="DebugClientBase.__dumpVariables" ID="DebugClientBase.__dumpVariables"></a> 299 </dl><a NAME="DebugClientBase.__dumpVariables" ID="DebugClientBase.__dumpVariables"></a>
298 <h4>DebugClientBase.__dumpVariables</h4> 300 <h4>DebugClientBase.__dumpVariables</h4>
299 <b>__dumpVariables</b>(<i>frmnr, scope, filterList</i>) 301 <b>__dumpVariables</b>(<i>frmnr, scope, filterList, maxSize</i>)
300 <p> 302 <p>
301 Private method to return the variables of a frame to the debug server. 303 Private method to return the variables of a frame to the debug server.
302 </p><dl> 304 </p><dl>
303 <dt><i>frmnr</i></dt> 305 <dt><i>frmnr</i> (int)</dt>
304 <dd> 306 <dd>
305 distance of frame reported on. 0 is the current frame 307 distance of frame reported on. 0 is the current frame
306 (int) 308 </dd><dt><i>scope</i> (int)</dt>
307 </dd><dt><i>scope</i></dt> 309 <dd>
308 <dd> 310 1 to report global variables, 0 for local variables
309 1 to report global variables, 0 for local variables (int) 311 </dd><dt><i>filterList</i> (list of int)</dt>
310 </dd><dt><i>filterList</i></dt>
311 <dd> 312 <dd>
312 the indices of variable types to be filtered 313 the indices of variable types to be filtered
313 (list of int) 314 </dd><dt><i>maxSize</i> (int)</dt>
315 <dd>
316 maximum size the formatted value of a variable will
317 be shown. If it is bigger than that, a 'too big' indication will
318 be given.
314 </dd> 319 </dd>
315 </dl><a NAME="DebugClientBase.__extractIndicators" ID="DebugClientBase.__extractIndicators"></a> 320 </dl><a NAME="DebugClientBase.__extractIndicators" ID="DebugClientBase.__extractIndicators"></a>
316 <h4>DebugClientBase.__extractIndicators</h4> 321 <h4>DebugClientBase.__extractIndicators</h4>
317 <b>__extractIndicators</b>(<i>var</i>) 322 <b>__extractIndicators</b>(<i>var</i>)
318 <p> 323 <p>
353 variable entry is a tuple of three elements, the variable name, 358 variable entry is a tuple of three elements, the variable name,
354 its type and value. 359 its type and value.
355 </dd> 360 </dd>
356 </dl><a NAME="DebugClientBase.__formatVariablesList" ID="DebugClientBase.__formatVariablesList"></a> 361 </dl><a NAME="DebugClientBase.__formatVariablesList" ID="DebugClientBase.__formatVariablesList"></a>
357 <h4>DebugClientBase.__formatVariablesList</h4> 362 <h4>DebugClientBase.__formatVariablesList</h4>
358 <b>__formatVariablesList</b>(<i>keylist, dict_, scope, filterList=None, formatSequences=False</i>) 363 <b>__formatVariablesList</b>(<i>keylist, dict_, scope, filterList=None, formatSequences=False, maxSize=0</i>)
359 <p> 364 <p>
360 Private method to produce a formated variables list. 365 Private method to produce a formated variables list.
361 </p><p> 366 </p><p>
362 The dictionary passed in to it is scanned. Variables are 367 The dictionary passed in to it is scanned. Variables are
363 only added to the list, if their type is not contained 368 only added to the list, if their type is not contained
364 in the filter list and their name doesn't match any of the filter 369 in the filter list and their name doesn't match any of the filter
365 expressions. The formated variables list (a list of tuples of 3 370 expressions. The formated variables list (a list of tuples of 3
366 values) is returned. 371 values) is returned.
367 </p><dl> 372 </p><dl>
368 <dt><i>keylist</i></dt> 373 <dt><i>keylist</i> (list of str)</dt>
369 <dd> 374 <dd>
370 keys of the dictionary 375 keys of the dictionary to be formatted
371 </dd><dt><i>dict_</i></dt> 376 </dd><dt><i>dict_</i> (dict)</dt>
372 <dd> 377 <dd>
373 the dictionary to be scanned 378 the dictionary to be scanned
374 </dd><dt><i>scope</i></dt> 379 </dd><dt><i>scope</i> (int)</dt>
375 <dd> 380 <dd>
376 1 to filter using the globals filter, 0 using the locals 381 1 to filter using the globals filter, 0 using the locals
377 filter (int). 382 filter.
378 Variables are only added to the list, if their name do not match 383 Variables are only added to the list, if their name do not match
379 any of the filter expressions. 384 any of the filter expressions.
380 </dd><dt><i>filterList</i></dt> 385 </dd><dt><i>filterList</i> (list of int)</dt>
381 <dd> 386 <dd>
382 the indices of variable types to be filtered. 387 the indices of variable types to be filtered.
383 Variables are only added to the list, if their type is not 388 Variables are only added to the list, if their type is not
384 contained in the filter list. 389 contained in the filter list.
385 </dd><dt><i>formatSequences</i></dt> 390 </dd><dt><i>formatSequences</i> (bool)</dt>
386 <dd> 391 <dd>
387 flag indicating, that sequence or dictionary 392 flag indicating, that sequence or dictionary
388 variables should be formatted. If it is 0 (or false), just the 393 variables should be formatted. If it is 0 (or false), just the
389 number of items contained in these variables is returned. (boolean) 394 number of items contained in these variables is returned.
395 </dd><dt><i>maxSize</i> (int)</dt>
396 <dd>
397 maximum size the formatted value of a variable will
398 be shown. If it is bigger than that, a 'too big' indication will
399 be placed in the value field.
390 </dd> 400 </dd>
391 </dl><dl> 401 </dl><dl>
392 <dt>Returns:</dt> 402 <dt>Returns:</dt>
393 <dd> 403 <dd>
394 A tuple consisting of a list of formatted variables. Each 404 A tuple consisting of a list of formatted variables. Each
395 variable entry is a tuple of three elements, the variable name, 405 variable entry is a tuple of three elements, the variable name,
396 its type and value. 406 its type and value.
407 </dd>
408 </dl><dl>
409 <dt>Return Type:</dt>
410 <dd>
411 list of tuple of (str, str, str)
397 </dd> 412 </dd>
398 </dl><a NAME="DebugClientBase.__generateFilterObjects" ID="DebugClientBase.__generateFilterObjects"></a> 413 </dl><a NAME="DebugClientBase.__generateFilterObjects" ID="DebugClientBase.__generateFilterObjects"></a>
399 <h4>DebugClientBase.__generateFilterObjects</h4> 414 <h4>DebugClientBase.__generateFilterObjects</h4>
400 <b>__generateFilterObjects</b>(<i>scope, filterString</i>) 415 <b>__generateFilterObjects</b>(<i>scope, filterString</i>)
401 <p> 416 <p>

eric ide

mercurial