--- /dev/null Thu Jan 01 00:00:00 1970 +0000 +++ b/eric7/Documentation/Source/eric7.DebugClients.Python.DebugVariables.html Mon May 24 11:19:57 2021 +0200 @@ -0,0 +1,1024 @@ +<!DOCTYPE html> +<html><head> +<title>eric7.DebugClients.Python.DebugVariables</title> +<meta charset="UTF-8"> +<style> +body { + background: #EDECE6; + margin: 0em 1em 10em 1em; + color: black; +} + +h1 { color: white; background: #85774A; } +h2 { color: white; background: #85774A; } +h3 { color: white; background: #9D936E; } +h4 { color: white; background: #9D936E; } + +a { color: #BA6D36; } + +</style> +</head> +<body> +<a NAME="top" ID="top"></a> +<h1>eric7.DebugClients.Python.DebugVariables</h1> + +<p> +Module implementing classes and functions to dump variable contents. +</p> +<h3>Global Attributes</h3> + +<table> +<tr><td>_TypeMap</td></tr><tr><td>arrayResolver</td></tr><tr><td>defaultResolver</td></tr><tr><td>dictResolver</td></tr><tr><td>dictViewResolver</td></tr><tr><td>listResolver</td></tr><tr><td>multiValueDictResolver</td></tr><tr><td>ndarrayResolver</td></tr><tr><td>setResolver</td></tr> +</table> +<h3>Classes</h3> + +<table> + +<tr> +<td><a href="#ArrayResolver">ArrayResolver</a></td> +<td>Class used to resolve from array.array including some meta data.</td> +</tr> +<tr> +<td><a href="#BaseResolver">BaseResolver</a></td> +<td>Base class of the resolver class tree.</td> +</tr> +<tr> +<td><a href="#DefaultResolver">DefaultResolver</a></td> +<td>Class used to resolve the default way.</td> +</tr> +<tr> +<td><a href="#DictResolver">DictResolver</a></td> +<td>Class used to resolve from a dictionary.</td> +</tr> +<tr> +<td><a href="#DictViewResolver">DictViewResolver</a></td> +<td>Class used to resolve from dict views.</td> +</tr> +<tr> +<td><a href="#ListResolver">ListResolver</a></td> +<td>Class used to resolve from a tuple or list.</td> +</tr> +<tr> +<td><a href="#MultiValueDictResolver">MultiValueDictResolver</a></td> +<td>Class used to resolve from Django multi value dictionaries.</td> +</tr> +<tr> +<td><a href="#NdArrayResolver">NdArrayResolver</a></td> +<td>Class used to resolve from numpy ndarray including some meta data.</td> +</tr> +<tr> +<td><a href="#SetResolver">SetResolver</a></td> +<td>Class used to resolve from a set or frozenset.</td> +</tr> +</table> +<h3>Functions</h3> + +<table> + +<tr> +<td><a href="#_initTypeMap">_initTypeMap</a></td> +<td>Protected function to initialize the type map.</td> +</tr> +<tr> +<td><a href="#getType">getType</a></td> +<td>Public method to get the type information for an object.</td> +</tr> +</table> +<hr /> +<hr /> +<a NAME="ArrayResolver" ID="ArrayResolver"></a> +<h2>ArrayResolver</h2> + +<p> + Class used to resolve from array.array including some meta data. +</p> +<h3>Derived from</h3> +BaseResolver +<h3>Class Attributes</h3> + +<table> +<tr><td>TypeCodeMap</td></tr> +</table> +<h3>Class Methods</h3> + +<table> +<tr><td>None</td></tr> +</table> +<h3>Methods</h3> + +<table> + +<tr> +<td><a href="#ArrayResolver.getDictionary">getDictionary</a></td> +<td>Public method to get the attributes of a variable as a dictionary.</td> +</tr> +<tr> +<td><a href="#ArrayResolver.resolve">resolve</a></td> +<td>Public method to get an attribute from a variable.</td> +</tr> +</table> +<h3>Static Methods</h3> + +<table> +<tr><td>None</td></tr> +</table> + +<a NAME="ArrayResolver.getDictionary" ID="ArrayResolver.getDictionary"></a> +<h4>ArrayResolver.getDictionary</h4> +<b>getDictionary</b>(<i>var</i>) + +<p> + Public method to get the attributes of a variable as a dictionary. +</p> +<dl> + +<dt><i>var</i> (any)</dt> +<dd> +variable to be converted +</dd> +</dl> +<dl> +<dt>Yield:</dt> +<dd> +tuple containing the batch start index and a dictionary + containing the variable attributes +</dd> +</dl> +<dl> +<dt>Yield Type:</dt> +<dd> +tuple of (int, dict) +</dd> +</dl> +<a NAME="ArrayResolver.resolve" ID="ArrayResolver.resolve"></a> +<h4>ArrayResolver.resolve</h4> +<b>resolve</b>(<i>var, attribute</i>) + +<p> + Public method to get an attribute from a variable. +</p> +<dl> + +<dt><i>var</i> (tuple or list)</dt> +<dd> +variable to extract an attribute or value from +</dd> +<dt><i>attribute</i> (str)</dt> +<dd> +id of the value to extract +</dd> +</dl> +<dl> +<dt>Return:</dt> +<dd> +value of the attribute +</dd> +</dl> +<dl> +<dt>Return Type:</dt> +<dd> +any +</dd> +</dl> +<div align="right"><a href="#top">Up</a></div> +<hr /> +<hr /> +<a NAME="BaseResolver" ID="BaseResolver"></a> +<h2>BaseResolver</h2> + +<p> + Base class of the resolver class tree. +</p> +<h3>Derived from</h3> +None +<h3>Class Attributes</h3> + +<table> +<tr><td>None</td></tr> +</table> +<h3>Class Methods</h3> + +<table> +<tr><td>None</td></tr> +</table> +<h3>Methods</h3> + +<table> + +<tr> +<td><a href="#BaseResolver.getDictionary">getDictionary</a></td> +<td>Public method to get the attributes of a variable as a dictionary.</td> +</tr> +<tr> +<td><a href="#BaseResolver.resolve">resolve</a></td> +<td>Public method to get an attribute from a variable.</td> +</tr> +</table> +<h3>Static Methods</h3> + +<table> +<tr><td>None</td></tr> +</table> + +<a NAME="BaseResolver.getDictionary" ID="BaseResolver.getDictionary"></a> +<h4>BaseResolver.getDictionary</h4> +<b>getDictionary</b>(<i>var</i>) + +<p> + Public method to get the attributes of a variable as a dictionary. +</p> +<dl> + +<dt><i>var</i> (any)</dt> +<dd> +variable to be converted +</dd> +</dl> +<dl> +<dt>Return:</dt> +<dd> +dictionary containing the variable attributes +</dd> +</dl> +<dl> +<dt>Return Type:</dt> +<dd> +dict +</dd> +</dl> +<a NAME="BaseResolver.resolve" ID="BaseResolver.resolve"></a> +<h4>BaseResolver.resolve</h4> +<b>resolve</b>(<i>var, attribute</i>) + +<p> + Public method to get an attribute from a variable. +</p> +<dl> + +<dt><i>var</i> (any)</dt> +<dd> +variable to extract an attribute or value from +</dd> +<dt><i>attribute</i> (str)</dt> +<dd> +name of the attribute to extract +</dd> +</dl> +<dl> +<dt>Return:</dt> +<dd> +value of the attribute +</dd> +</dl> +<dl> +<dt>Return Type:</dt> +<dd> +any +</dd> +</dl> +<div align="right"><a href="#top">Up</a></div> +<hr /> +<hr /> +<a NAME="DefaultResolver" ID="DefaultResolver"></a> +<h2>DefaultResolver</h2> + +<p> + Class used to resolve the default way. +</p> +<h3>Derived from</h3> +BaseResolver +<h3>Class Attributes</h3> + +<table> +<tr><td>None</td></tr> +</table> +<h3>Class Methods</h3> + +<table> +<tr><td>None</td></tr> +</table> +<h3>Methods</h3> + +<table> + +<tr> +<td><a href="#DefaultResolver.getDictionary">getDictionary</a></td> +<td>Public method to get the attributes of a variable as a dictionary.</td> +</tr> +</table> +<h3>Static Methods</h3> + +<table> +<tr><td>None</td></tr> +</table> + +<a NAME="DefaultResolver.getDictionary" ID="DefaultResolver.getDictionary"></a> +<h4>DefaultResolver.getDictionary</h4> +<b>getDictionary</b>(<i>var</i>) + +<p> + Public method to get the attributes of a variable as a dictionary. +</p> +<dl> + +<dt><i>var</i> (any)</dt> +<dd> +variable to be converted +</dd> +</dl> +<dl> +<dt>Yield:</dt> +<dd> +tuple containing the batch start index and a dictionary + containing the variable attributes +</dd> +</dl> +<dl> +<dt>Yield Type:</dt> +<dd> +tuple of (int, dict) +</dd> +</dl> +<div align="right"><a href="#top">Up</a></div> +<hr /> +<hr /> +<a NAME="DictResolver" ID="DictResolver"></a> +<h2>DictResolver</h2> + +<p> + Class used to resolve from a dictionary. +</p> +<h3>Derived from</h3> +BaseResolver +<h3>Class Attributes</h3> + +<table> +<tr><td>None</td></tr> +</table> +<h3>Class Methods</h3> + +<table> +<tr><td>None</td></tr> +</table> +<h3>Methods</h3> + +<table> + +<tr> +<td><a href="#DictResolver.getDictionary">getDictionary</a></td> +<td>Public method to get the attributes of a variable as a dictionary.</td> +</tr> +<tr> +<td><a href="#DictResolver.keyToStr">keyToStr</a></td> +<td>Public method to get a string representation for a key.</td> +</tr> +<tr> +<td><a href="#DictResolver.resolve">resolve</a></td> +<td>Public method to get an attribute from a variable.</td> +</tr> +</table> +<h3>Static Methods</h3> + +<table> +<tr><td>None</td></tr> +</table> + +<a NAME="DictResolver.getDictionary" ID="DictResolver.getDictionary"></a> +<h4>DictResolver.getDictionary</h4> +<b>getDictionary</b>(<i>var</i>) + +<p> + Public method to get the attributes of a variable as a dictionary. +</p> +<dl> + +<dt><i>var</i> (any)</dt> +<dd> +variable to be converted +</dd> +</dl> +<dl> +<dt>Yield:</dt> +<dd> +tuple containing the batch start index and a dictionary + containing the variable attributes +</dd> +</dl> +<dl> +<dt>Yield Type:</dt> +<dd> +tuple of (int, dict) +</dd> +</dl> +<a NAME="DictResolver.keyToStr" ID="DictResolver.keyToStr"></a> +<h4>DictResolver.keyToStr</h4> +<b>keyToStr</b>(<i>key</i>) + +<p> + Public method to get a string representation for a key. +</p> +<dl> + +<dt><i>key</i> (any)</dt> +<dd> +key to be converted +</dd> +</dl> +<dl> +<dt>Return:</dt> +<dd> +string representation of the given key +</dd> +</dl> +<dl> +<dt>Return Type:</dt> +<dd> +str +</dd> +</dl> +<a NAME="DictResolver.resolve" ID="DictResolver.resolve"></a> +<h4>DictResolver.resolve</h4> +<b>resolve</b>(<i>var, attribute</i>) + +<p> + Public method to get an attribute from a variable. +</p> +<dl> + +<dt><i>var</i> (dict)</dt> +<dd> +variable to extract an attribute or value from +</dd> +<dt><i>attribute</i> (str)</dt> +<dd> +name of the attribute to extract +</dd> +</dl> +<dl> +<dt>Return:</dt> +<dd> +value of the attribute +</dd> +</dl> +<dl> +<dt>Return Type:</dt> +<dd> +any +</dd> +</dl> +<div align="right"><a href="#top">Up</a></div> +<hr /> +<hr /> +<a NAME="DictViewResolver" ID="DictViewResolver"></a> +<h2>DictViewResolver</h2> + +<p> + Class used to resolve from dict views. +</p> +<h3>Derived from</h3> +ListResolver +<h3>Class Attributes</h3> + +<table> +<tr><td>None</td></tr> +</table> +<h3>Class Methods</h3> + +<table> +<tr><td>None</td></tr> +</table> +<h3>Methods</h3> + +<table> + +<tr> +<td><a href="#DictViewResolver.getDictionary">getDictionary</a></td> +<td>Public method to get the attributes of a variable as a dictionary.</td> +</tr> +<tr> +<td><a href="#DictViewResolver.resolve">resolve</a></td> +<td>Public method to get an attribute from a variable.</td> +</tr> +</table> +<h3>Static Methods</h3> + +<table> +<tr><td>None</td></tr> +</table> + +<a NAME="DictViewResolver.getDictionary" ID="DictViewResolver.getDictionary"></a> +<h4>DictViewResolver.getDictionary</h4> +<b>getDictionary</b>(<i>var</i>) + +<p> + Public method to get the attributes of a variable as a dictionary. +</p> +<dl> + +<dt><i>var</i> (any)</dt> +<dd> +variable to be converted +</dd> +</dl> +<dl> +<dt>Return:</dt> +<dd> +dictionary containing the variable attributes +</dd> +</dl> +<dl> +<dt>Return Type:</dt> +<dd> +dict +</dd> +</dl> +<a NAME="DictViewResolver.resolve" ID="DictViewResolver.resolve"></a> +<h4>DictViewResolver.resolve</h4> +<b>resolve</b>(<i>var, attribute</i>) + +<p> + Public method to get an attribute from a variable. +</p> +<dl> + +<dt><i>var</i> (tuple or list)</dt> +<dd> +variable to extract an attribute or value from +</dd> +<dt><i>attribute</i> (str)</dt> +<dd> +id of the value to extract +</dd> +</dl> +<dl> +<dt>Return:</dt> +<dd> +value of the attribute +</dd> +</dl> +<dl> +<dt>Return Type:</dt> +<dd> +any +</dd> +</dl> +<div align="right"><a href="#top">Up</a></div> +<hr /> +<hr /> +<a NAME="ListResolver" ID="ListResolver"></a> +<h2>ListResolver</h2> + +<p> + Class used to resolve from a tuple or list. +</p> +<h3>Derived from</h3> +BaseResolver +<h3>Class Attributes</h3> + +<table> +<tr><td>None</td></tr> +</table> +<h3>Class Methods</h3> + +<table> +<tr><td>None</td></tr> +</table> +<h3>Methods</h3> + +<table> + +<tr> +<td><a href="#ListResolver.getDictionary">getDictionary</a></td> +<td>Public method to get the attributes of a variable as a dictionary.</td> +</tr> +<tr> +<td><a href="#ListResolver.resolve">resolve</a></td> +<td>Public method to get an attribute from a variable.</td> +</tr> +</table> +<h3>Static Methods</h3> + +<table> +<tr><td>None</td></tr> +</table> + +<a NAME="ListResolver.getDictionary" ID="ListResolver.getDictionary"></a> +<h4>ListResolver.getDictionary</h4> +<b>getDictionary</b>(<i>var</i>) + +<p> + Public method to get the attributes of a variable as a dictionary. +</p> +<dl> + +<dt><i>var</i> (any)</dt> +<dd> +variable to be converted +</dd> +</dl> +<dl> +<dt>Yield:</dt> +<dd> +tuple containing the batch start index and a dictionary + containing the variable attributes +</dd> +</dl> +<dl> +<dt>Yield Type:</dt> +<dd> +tuple of (int, dict) +</dd> +</dl> +<a NAME="ListResolver.resolve" ID="ListResolver.resolve"></a> +<h4>ListResolver.resolve</h4> +<b>resolve</b>(<i>var, attribute</i>) + +<p> + Public method to get an attribute from a variable. +</p> +<dl> + +<dt><i>var</i> (tuple or list)</dt> +<dd> +variable to extract an attribute or value from +</dd> +<dt><i>attribute</i> (str)</dt> +<dd> +name of the attribute to extract +</dd> +</dl> +<dl> +<dt>Return:</dt> +<dd> +value of the attribute +</dd> +</dl> +<dl> +<dt>Return Type:</dt> +<dd> +any +</dd> +</dl> +<div align="right"><a href="#top">Up</a></div> +<hr /> +<hr /> +<a NAME="MultiValueDictResolver" ID="MultiValueDictResolver"></a> +<h2>MultiValueDictResolver</h2> + +<p> + Class used to resolve from Django multi value dictionaries. +</p> +<h3>Derived from</h3> +DictResolver +<h3>Class Attributes</h3> + +<table> +<tr><td>None</td></tr> +</table> +<h3>Class Methods</h3> + +<table> +<tr><td>None</td></tr> +</table> +<h3>Methods</h3> + +<table> + +<tr> +<td><a href="#MultiValueDictResolver.getDictionary">getDictionary</a></td> +<td>Public method to get the attributes of a variable as a dictionary.</td> +</tr> +<tr> +<td><a href="#MultiValueDictResolver.resolve">resolve</a></td> +<td>Public method to get an attribute from a variable.</td> +</tr> +</table> +<h3>Static Methods</h3> + +<table> +<tr><td>None</td></tr> +</table> + +<a NAME="MultiValueDictResolver.getDictionary" ID="MultiValueDictResolver.getDictionary"></a> +<h4>MultiValueDictResolver.getDictionary</h4> +<b>getDictionary</b>(<i>var</i>) + +<p> + Public method to get the attributes of a variable as a dictionary. +</p> +<dl> + +<dt><i>var</i> (any)</dt> +<dd> +variable to be converted +</dd> +</dl> +<dl> +<dt>Yield:</dt> +<dd> +tuple containing the batch start index and a dictionary + containing the variable attributes +</dd> +</dl> +<dl> +<dt>Yield Type:</dt> +<dd> +tuple of (int, dict) +</dd> +</dl> +<a NAME="MultiValueDictResolver.resolve" ID="MultiValueDictResolver.resolve"></a> +<h4>MultiValueDictResolver.resolve</h4> +<b>resolve</b>(<i>var, attribute</i>) + +<p> + Public method to get an attribute from a variable. +</p> +<dl> + +<dt><i>var</i> (dict)</dt> +<dd> +variable to extract an attribute or value from +</dd> +<dt><i>attribute</i> (str)</dt> +<dd> +name of the attribute to extract +</dd> +</dl> +<dl> +<dt>Return:</dt> +<dd> +value of the attribute +</dd> +</dl> +<dl> +<dt>Return Type:</dt> +<dd> +any +</dd> +</dl> +<div align="right"><a href="#top">Up</a></div> +<hr /> +<hr /> +<a NAME="NdArrayResolver" ID="NdArrayResolver"></a> +<h2>NdArrayResolver</h2> + +<p> + Class used to resolve from numpy ndarray including some meta data. +</p> +<h3>Derived from</h3> +BaseResolver +<h3>Class Attributes</h3> + +<table> +<tr><td>None</td></tr> +</table> +<h3>Class Methods</h3> + +<table> +<tr><td>None</td></tr> +</table> +<h3>Methods</h3> + +<table> + +<tr> +<td><a href="#NdArrayResolver.__isNumeric">__isNumeric</a></td> +<td>Private method to check, if an array is of a numeric type.</td> +</tr> +<tr> +<td><a href="#NdArrayResolver.getDictionary">getDictionary</a></td> +<td>Public method to get the attributes of a variable as a dictionary.</td> +</tr> +<tr> +<td><a href="#NdArrayResolver.resolve">resolve</a></td> +<td>Public method to get an attribute from a variable.</td> +</tr> +</table> +<h3>Static Methods</h3> + +<table> +<tr><td>None</td></tr> +</table> + +<a NAME="NdArrayResolver.__isNumeric" ID="NdArrayResolver.__isNumeric"></a> +<h4>NdArrayResolver.__isNumeric</h4> +<b>__isNumeric</b>(<i>arr</i>) + +<p> + Private method to check, if an array is of a numeric type. +</p> +<dl> + +<dt><i>arr</i> (ndarray)</dt> +<dd> +array to check +</dd> +</dl> +<dl> +<dt>Return:</dt> +<dd> +flag indicating a numeric array +</dd> +</dl> +<dl> +<dt>Return Type:</dt> +<dd> +bool +</dd> +</dl> +<a NAME="NdArrayResolver.getDictionary" ID="NdArrayResolver.getDictionary"></a> +<h4>NdArrayResolver.getDictionary</h4> +<b>getDictionary</b>(<i>var</i>) + +<p> + Public method to get the attributes of a variable as a dictionary. +</p> +<dl> + +<dt><i>var</i> (any)</dt> +<dd> +variable to be converted +</dd> +</dl> +<dl> +<dt>Yield:</dt> +<dd> +tuple containing the batch start index and a dictionary + containing the variable attributes +</dd> +</dl> +<dl> +<dt>Yield Type:</dt> +<dd> +tuple of (int, dict) +</dd> +</dl> +<a NAME="NdArrayResolver.resolve" ID="NdArrayResolver.resolve"></a> +<h4>NdArrayResolver.resolve</h4> +<b>resolve</b>(<i>var, attribute</i>) + +<p> + Public method to get an attribute from a variable. +</p> +<dl> + +<dt><i>var</i> (tuple or list)</dt> +<dd> +variable to extract an attribute or value from +</dd> +<dt><i>attribute</i> (str)</dt> +<dd> +id of the value to extract +</dd> +</dl> +<dl> +<dt>Return:</dt> +<dd> +value of the attribute +</dd> +</dl> +<dl> +<dt>Return Type:</dt> +<dd> +any +</dd> +</dl> +<div align="right"><a href="#top">Up</a></div> +<hr /> +<hr /> +<a NAME="SetResolver" ID="SetResolver"></a> +<h2>SetResolver</h2> + +<p> + Class used to resolve from a set or frozenset. +</p> +<h3>Derived from</h3> +BaseResolver +<h3>Class Attributes</h3> + +<table> +<tr><td>None</td></tr> +</table> +<h3>Class Methods</h3> + +<table> +<tr><td>None</td></tr> +</table> +<h3>Methods</h3> + +<table> + +<tr> +<td><a href="#SetResolver.getDictionary">getDictionary</a></td> +<td>Public method to get the attributes of a variable as a dictionary.</td> +</tr> +<tr> +<td><a href="#SetResolver.resolve">resolve</a></td> +<td>Public method to get an attribute from a variable.</td> +</tr> +</table> +<h3>Static Methods</h3> + +<table> +<tr><td>None</td></tr> +</table> + +<a NAME="SetResolver.getDictionary" ID="SetResolver.getDictionary"></a> +<h4>SetResolver.getDictionary</h4> +<b>getDictionary</b>(<i>var</i>) + +<p> + Public method to get the attributes of a variable as a dictionary. +</p> +<dl> + +<dt><i>var</i> (any)</dt> +<dd> +variable to be converted +</dd> +</dl> +<dl> +<dt>Yield:</dt> +<dd> +tuple containing the batch start index and a dictionary + containing the variable attributes +</dd> +</dl> +<dl> +<dt>Yield Type:</dt> +<dd> +tuple of (int, dict) +</dd> +</dl> +<a NAME="SetResolver.resolve" ID="SetResolver.resolve"></a> +<h4>SetResolver.resolve</h4> +<b>resolve</b>(<i>var, attribute</i>) + +<p> + Public method to get an attribute from a variable. +</p> +<dl> + +<dt><i>var</i> (tuple or list)</dt> +<dd> +variable to extract an attribute or value from +</dd> +<dt><i>attribute</i> (str)</dt> +<dd> +id of the value to extract +</dd> +</dl> +<dl> +<dt>Return:</dt> +<dd> +value of the attribute +</dd> +</dl> +<dl> +<dt>Return Type:</dt> +<dd> +any +</dd> +</dl> +<div align="right"><a href="#top">Up</a></div> +<hr /> +<hr /> +<a NAME="_initTypeMap" ID="_initTypeMap"></a> +<h2>_initTypeMap</h2> +<b>_initTypeMap</b>(<i></i>) + +<p> + Protected function to initialize the type map. +</p> +<div align="right"><a href="#top">Up</a></div> +<hr /> +<hr /> +<a NAME="getType" ID="getType"></a> +<h2>getType</h2> +<b>getType</b>(<i>obj</i>) + +<p> + Public method to get the type information for an object. +</p> +<dl> + +<dt><i>obj</i> (any)</dt> +<dd> +object to get type information for +</dd> +</dl> +<dl> +<dt>Return:</dt> +<dd> +tuple containing the type name, type string and resolver +</dd> +</dl> +<dl> +<dt>Return Type:</dt> +<dd> +tuple of str, str, BaseResolver +</dd> +</dl> +<div align="right"><a href="#top">Up</a></div> +<hr /> +</body></html> \ No newline at end of file