--- a/src/eric7/Documentation/Source/eric7.EricUtilities.EricCache.html Thu Jan 04 17:16:15 2024 +0100
+++ b/src/eric7/Documentation/Source/eric7.EricUtilities.EricCache.html Thu Jan 04 18:02:25 2024 +0100
@@ -7,34 +7,32 @@
<body>
<a NAME="top" ID="top"></a>
<h1>eric7.EricUtilities.EricCache</h1>
-
<p>
Module implementing classes used for caching objects.
</p>
+
<h3>Global Attributes</h3>
-
<table>
<tr><td>None</td></tr>
</table>
+
<h3>Classes</h3>
-
<table>
-
<tr>
<td><a href="#EricCache">EricCache</a></td>
<td>Class implementing a LRU cache of a specific size.</td>
</tr>
</table>
+
<h3>Functions</h3>
-
<table>
<tr><td>None</td></tr>
</table>
+
<hr />
<hr />
<a NAME="EricCache" ID="EricCache"></a>
<h2>EricCache</h2>
-
<p>
Class implementing a LRU cache of a specific size.
</p>
@@ -43,22 +41,21 @@
is removed from the cache. A cache hit moves the entry to the front of the
cache.
</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="#EricCache.__init__">EricCache</a></td>
<td>Constructor</td>
@@ -120,19 +117,20 @@
<td>Public method to change the maximum size of the cache.</td>
</tr>
</table>
+
<h3>Static Methods</h3>
-
<table>
<tr><td>None</td></tr>
</table>
+
<a NAME="EricCache.__init__" ID="EricCache.__init__"></a>
<h4>EricCache (Constructor)</h4>
<b>EricCache</b>(<i>size=100</i>)
-
<p>
Constructor
</p>
+
<dl>
<dt><i>size</i> (int)</dt>
@@ -150,17 +148,17 @@
<a NAME="EricCache.__adjustToSize" ID="EricCache.__adjustToSize"></a>
<h4>EricCache.__adjustToSize</h4>
<b>__adjustToSize</b>(<i></i>)
-
<p>
Private method to adjust the cache to its size.
</p>
+
<a NAME="EricCache.__moveLast" ID="EricCache.__moveLast"></a>
<h4>EricCache.__moveLast</h4>
<b>__moveLast</b>(<i>key</i>)
-
<p>
Private method to move a cached item to the MRU position.
</p>
+
<dl>
<dt><i>key</i> (any hashable type that can be used as a dict key)</dt>
@@ -171,14 +169,13 @@
<a NAME="EricCache.__pruneCache" ID="EricCache.__pruneCache"></a>
<h4>EricCache.__pruneCache</h4>
<b>__pruneCache</b>(<i></i>)
-
<p>
Private slot to prune outdated cache entries and restart the timer.
</p>
+
<a NAME="EricCache.add" ID="EricCache.add"></a>
<h4>EricCache.add</h4>
<b>add</b>(<i>key, item</i>)
-
<p>
Public method to add an item to the cache.
</p>
@@ -186,6 +183,7 @@
If the key is already in use, the cached item is replaced by the new
one given and is moved to the MRU position
</p>
+
<dl>
<dt><i>key</i> (any hashable type that can be used as a dict key)</dt>
@@ -200,20 +198,20 @@
<a NAME="EricCache.clear" ID="EricCache.clear"></a>
<h4>EricCache.clear</h4>
<b>clear</b>(<i></i>)
-
<p>
Public method to clear the cache.
</p>
+
<a NAME="EricCache.get" ID="EricCache.get"></a>
<h4>EricCache.get</h4>
<b>get</b>(<i>key</i>)
-
<p>
Public method to get an entry from the cache given its key.
</p>
<p>
If the key is present in the cache, it is moved to the MRU position.
</p>
+
<dl>
<dt><i>key</i> (any hashable type that can be used as a dict key)</dt>
@@ -237,10 +235,10 @@
<a NAME="EricCache.getMaximumCacheTime" ID="EricCache.getMaximumCacheTime"></a>
<h4>EricCache.getMaximumCacheTime</h4>
<b>getMaximumCacheTime</b>(<i></i>)
-
<p>
Public method to get the maximum time entries may exist in the cache.
</p>
+
<dl>
<dt>Return:</dt>
<dd>
@@ -256,10 +254,10 @@
<a NAME="EricCache.getSize" ID="EricCache.getSize"></a>
<h4>EricCache.getSize</h4>
<b>getSize</b>(<i></i>)
-
<p>
Public method to get the maximum size of the cache.
</p>
+
<dl>
<dt>Return:</dt>
<dd>
@@ -275,10 +273,10 @@
<a NAME="EricCache.info" ID="EricCache.info"></a>
<h4>EricCache.info</h4>
<b>info</b>(<i></i>)
-
<p>
Public method to get some information about the cache.
</p>
+
<dl>
<dt>Return:</dt>
<dd>
@@ -294,10 +292,10 @@
<a NAME="EricCache.length" ID="EricCache.length"></a>
<h4>EricCache.length</h4>
<b>length</b>(<i></i>)
-
<p>
Public method to get the current length of the cache.
</p>
+
<dl>
<dt>Return:</dt>
<dd>
@@ -313,10 +311,10 @@
<a NAME="EricCache.remove" ID="EricCache.remove"></a>
<h4>EricCache.remove</h4>
<b>remove</b>(<i>key</i>)
-
<p>
Public method to remove an item from the cache.
</p>
+
<dl>
<dt><i>key</i> (any hashable type that can be used as a dict key)</dt>
@@ -327,7 +325,6 @@
<a NAME="EricCache.reset" ID="EricCache.reset"></a>
<h4>EricCache.reset</h4>
<b>reset</b>(<i></i>)
-
<p>
Public method to reset the cache.
</p>
@@ -335,13 +332,14 @@
This is like clear() but sets the various counters to their initial
value as well.
</p>
+
<a NAME="EricCache.setMaximumCacheTime" ID="EricCache.setMaximumCacheTime"></a>
<h4>EricCache.setMaximumCacheTime</h4>
<b>setMaximumCacheTime</b>(<i>time</i>)
-
<p>
Public method to set the maximum time entries may exist in the cache.
</p>
+
<dl>
<dt><i>time</i> (int)</dt>
@@ -352,10 +350,10 @@
<a NAME="EricCache.setSize" ID="EricCache.setSize"></a>
<h4>EricCache.setSize</h4>
<b>setSize</b>(<i>newSize</i>)
-
<p>
Public method to change the maximum size of the cache.
</p>
+
<dl>
<dt><i>newSize</i> (int)</dt>
@@ -366,4 +364,4 @@
</dl>
<div align="right"><a href="#top">Up</a></div>
<hr />
-</body></html>
\ No newline at end of file
+</body></html>
