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

changeset 5964
066e6c78a367
parent 5651
982465f8389c
child 5966
3325ecd87c7c
--- a/Documentation/Source/eric6.DebugClients.Python.DebugClientBase.html	Tue Nov 07 19:37:17 2017 +0100
+++ b/Documentation/Source/eric6.DebugClients.Python.DebugClientBase.html	Wed Nov 08 19:05:55 2017 +0100
@@ -274,43 +274,48 @@
 </dd>
 </dl><a NAME="DebugClientBase.__dumpVariable" ID="DebugClientBase.__dumpVariable"></a>
 <h4>DebugClientBase.__dumpVariable</h4>
-<b>__dumpVariable</b>(<i>var, frmnr, scope, filterList</i>)
+<b>__dumpVariable</b>(<i>var, frmnr, scope, filterList, maxSize</i>)
 <p>
         Private method to return the variables of a frame to the debug server.
 </p><dl>
-<dt><i>var</i></dt>
+<dt><i>var</i> (list of strings)</dt>
 <dd>
 list encoded name of the requested variable
-            (list of strings)
-</dd><dt><i>frmnr</i></dt>
+</dd><dt><i>frmnr</i> (int)</dt>
 <dd>
 distance of frame reported on. 0 is the current frame
-            (int)
 </dd><dt><i>scope</i></dt>
 <dd>
 1 to report global variables, 0 for local variables (int)
-</dd><dt><i>filterList</i></dt>
+</dd><dt><i>filterList</i> (list of int)</dt>
 <dd>
 the indices of variable types to be filtered
-            (list of int)
+</dd><dt><i>maxSize</i> (int)</dt>
+<dd>
+maximum size the formatted value of a variable will
+            be shown. If it is bigger than that, a 'too big' indication will
+            be given.
 </dd>
 </dl><a NAME="DebugClientBase.__dumpVariables" ID="DebugClientBase.__dumpVariables"></a>
 <h4>DebugClientBase.__dumpVariables</h4>
-<b>__dumpVariables</b>(<i>frmnr, scope, filterList</i>)
+<b>__dumpVariables</b>(<i>frmnr, scope, filterList, maxSize</i>)
 <p>
         Private method to return the variables of a frame to the debug server.
 </p><dl>
-<dt><i>frmnr</i></dt>
+<dt><i>frmnr</i> (int)</dt>
 <dd>
 distance of frame reported on. 0 is the current frame
-            (int)
-</dd><dt><i>scope</i></dt>
+</dd><dt><i>scope</i> (int)</dt>
 <dd>
-1 to report global variables, 0 for local variables (int)
-</dd><dt><i>filterList</i></dt>
+1 to report global variables, 0 for local variables
+</dd><dt><i>filterList</i> (list of int)</dt>
 <dd>
 the indices of variable types to be filtered
-            (list of int)
+</dd><dt><i>maxSize</i> (int)</dt>
+<dd>
+maximum size the formatted value of a variable will
+            be shown. If it is bigger than that, a 'too big' indication will
+            be given.
 </dd>
 </dl><a NAME="DebugClientBase.__extractIndicators" ID="DebugClientBase.__extractIndicators"></a>
 <h4>DebugClientBase.__extractIndicators</h4>
@@ -355,7 +360,7 @@
 </dd>
 </dl><a NAME="DebugClientBase.__formatVariablesList" ID="DebugClientBase.__formatVariablesList"></a>
 <h4>DebugClientBase.__formatVariablesList</h4>
-<b>__formatVariablesList</b>(<i>keylist, dict_, scope, filterList=None, formatSequences=False</i>)
+<b>__formatVariablesList</b>(<i>keylist, dict_, scope, filterList=None, formatSequences=False, maxSize=0</i>)
 <p>
         Private method to produce a formated variables list.
 </p><p>
@@ -365,28 +370,33 @@
         expressions. The formated variables list (a list of tuples of 3
         values) is returned.
 </p><dl>
-<dt><i>keylist</i></dt>
+<dt><i>keylist</i> (list of str)</dt>
 <dd>
-keys of the dictionary
-</dd><dt><i>dict_</i></dt>
+keys of the dictionary to be formatted
+</dd><dt><i>dict_</i> (dict)</dt>
 <dd>
 the dictionary to be scanned
-</dd><dt><i>scope</i></dt>
+</dd><dt><i>scope</i> (int)</dt>
 <dd>
 1 to filter using the globals filter, 0 using the locals
-            filter (int).
+            filter.
             Variables are only added to the list, if their name do not match
             any of the filter expressions.
-</dd><dt><i>filterList</i></dt>
+</dd><dt><i>filterList</i> (list of int)</dt>
 <dd>
 the indices of variable types to be filtered.
             Variables are only added to the list, if their type is not
             contained in the filter list.
-</dd><dt><i>formatSequences</i></dt>
+</dd><dt><i>formatSequences</i> (bool)</dt>
 <dd>
 flag indicating, that sequence or dictionary
             variables should be formatted. If it is 0 (or false), just the
-            number of items contained in these variables is returned. (boolean)
+            number of items contained in these variables is returned.
+</dd><dt><i>maxSize</i> (int)</dt>
+<dd>
+maximum size the formatted value of a variable will
+            be shown. If it is bigger than that, a 'too big' indication will
+            be placed in the value field.
 </dd>
 </dl><dl>
 <dt>Returns:</dt>
@@ -395,6 +405,11 @@
             variable entry is a tuple of three elements, the variable name,
             its type and value.
 </dd>
+</dl><dl>
+<dt>Return Type:</dt>
+<dd>
+list of tuple of (str, str, str)
+</dd>
 </dl><a NAME="DebugClientBase.__generateFilterObjects" ID="DebugClientBase.__generateFilterObjects"></a>
 <h4>DebugClientBase.__generateFilterObjects</h4>
 <b>__generateFilterObjects</b>(<i>scope, filterString</i>)

eric ide

mercurial