Andreas/evennia
1
0
Fork 0
mirror of https://github.com/evennia/evennia.git synced 2026-04-05 07:27:17 +02:00
Code Issues Projects Releases Packages Wiki Activity Actions

Updated HTML docs

Browse source
This commit is contained in:
Griatch 2020-10-15 01:31:30 +02:00
parent dc00b6bf65
commit edf9ca4c4b
1252 changed files with 40437 additions and 27044 deletions
Download patch file Download diff file Expand all files Collapse all files

98
docs/1.0-dev/api/evennia.utils.idmapper.models.html
View file

@ -1,9 +1,10 @@
<!DOCTYPE html>
<html xmlns="http://www.w3.org/1999/xhtml">
<html>
<head>
<meta charset="utf-8" />
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
<title>evennia.utils.idmapper.models &#8212; Evennia 1.0-dev documentation</title>
<link rel="stylesheet" href="../_static/nature.css" type="text/css" />
<link rel="stylesheet" href="../_static/pygments.css" type="text/css" />
@ -25,7 +26,8 @@
<li class="right" >
<a href="../py-modindex.html" title="Python Module Index"
>modules</a> |</li>
<li class="nav-item nav-item-0"><a href="../index.html">Evennia 1.0-dev</a> &#187;</li>
<li class="nav-item nav-item-0"><a href="../index.html">Evennia 1.0-dev</a> &#187;</li>
<li class="nav-item nav-item-this"><a href="">evennia.utils.idmapper.models</a></li>
</ul>
</div>
@ -40,45 +42,45 @@
<p>Modified for Evennia by making sure that no model references
leave caching unexpectedly (no use of WeakRefs).</p>
<p>Also adds <strong>cache_size()</strong> for monitoring the size of the cache.</p>
<dl class="class">
<dl class="py class">
<dt id="evennia.utils.idmapper.models.SharedMemoryModelBase">
<em class="property">class </em><code class="sig-prename descclassname">evennia.utils.idmapper.models.</code><code class="sig-name descname">SharedMemoryModelBase</code><a class="reference internal" href="../_modules/evennia/utils/idmapper/models.html#SharedMemoryModelBase"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.utils.idmapper.models.SharedMemoryModelBase" title="Permalink to this definition"></a></dt>
<em class="property">class </em><code class="sig-prename descclassname">evennia.utils.idmapper.models.</code><code class="sig-name descname">SharedMemoryModelBase</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">name</span></em>, <em class="sig-param"><span class="n">bases</span></em>, <em class="sig-param"><span class="n">attrs</span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/utils/idmapper/models.html#SharedMemoryModelBase"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.utils.idmapper.models.SharedMemoryModelBase" title="Permalink to this definition"></a></dt>
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">django.db.models.base.ModelBase</span></code></p>
</dd></dl>
<dl class="class">
<dl class="py class">
<dt id="evennia.utils.idmapper.models.SharedMemoryModel">
<em class="property">class </em><code class="sig-prename descclassname">evennia.utils.idmapper.models.</code><code class="sig-name descname">SharedMemoryModel</code><span class="sig-paren">(</span><em class="sig-param">*args</em>, <em class="sig-param">**kwargs</em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/utils/idmapper/models.html#SharedMemoryModel"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.utils.idmapper.models.SharedMemoryModel" title="Permalink to this definition"></a></dt>
<em class="property">class </em><code class="sig-prename descclassname">evennia.utils.idmapper.models.</code><code class="sig-name descname">SharedMemoryModel</code><span class="sig-paren">(</span><em class="sig-param"><span class="o">*</span><span class="n">args</span></em>, <em class="sig-param"><span class="o">**</span><span class="n">kwargs</span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/utils/idmapper/models.html#SharedMemoryModel"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.utils.idmapper.models.SharedMemoryModel" title="Permalink to this definition"></a></dt>
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">django.db.models.base.Model</span></code></p>
<p>Base class for idmapped objects. Inherit from <strong>this</strong>.</p>
<dl class="attribute">
<dl class="py attribute">
<dt id="evennia.utils.idmapper.models.SharedMemoryModel.objects">
<code class="sig-name descname">objects</code><a class="headerlink" href="#evennia.utils.idmapper.models.SharedMemoryModel.objects" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
<dl class="class">
<dl class="py class">
<dt id="evennia.utils.idmapper.models.SharedMemoryModel.Meta">
<em class="property">class </em><code class="sig-name descname">Meta</code><a class="reference internal" href="../_modules/evennia/utils/idmapper/models.html#SharedMemoryModel.Meta"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.utils.idmapper.models.SharedMemoryModel.Meta" title="Permalink to this definition"></a></dt>
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">object</span></code></p>
<dl class="attribute">
<dl class="py attribute">
<dt id="evennia.utils.idmapper.models.SharedMemoryModel.Meta.abstract">
<code class="sig-name descname">abstract</code><em class="property"> = False</em><a class="headerlink" href="#evennia.utils.idmapper.models.SharedMemoryModel.Meta.abstract" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
</dd></dl>
<dl class="method">
<dl class="py method">
<dt id="evennia.utils.idmapper.models.SharedMemoryModel.get_cached_instance">
<em class="property">classmethod </em><code class="sig-name descname">get_cached_instance</code><span class="sig-paren">(</span><em class="sig-param">id</em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/utils/idmapper/models.html#SharedMemoryModel.get_cached_instance"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.utils.idmapper.models.SharedMemoryModel.get_cached_instance" title="Permalink to this definition"></a></dt>
<em class="property">classmethod </em><code class="sig-name descname">get_cached_instance</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">id</span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/utils/idmapper/models.html#SharedMemoryModel.get_cached_instance"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.utils.idmapper.models.SharedMemoryModel.get_cached_instance" title="Permalink to this definition"></a></dt>
<dd><p>Method to retrieve a cached instance by pk value. Returns None
when not found (which will always be the case when caching is
disabled for this class). Please note that the lookup will be
done even when instance caching is disabled.</p>
</dd></dl>
<dl class="method">
<dl class="py method">
<dt id="evennia.utils.idmapper.models.SharedMemoryModel.cache_instance">
<em class="property">classmethod </em><code class="sig-name descname">cache_instance</code><span class="sig-paren">(</span><em class="sig-param">instance</em>, <em class="sig-param">new=False</em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/utils/idmapper/models.html#SharedMemoryModel.cache_instance"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.utils.idmapper.models.SharedMemoryModel.cache_instance" title="Permalink to this definition"></a></dt>
<em class="property">classmethod </em><code class="sig-name descname">cache_instance</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">instance</span></em>, <em class="sig-param"><span class="n">new</span><span class="o">=</span><span class="default_value">False</span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/utils/idmapper/models.html#SharedMemoryModel.cache_instance"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.utils.idmapper.models.SharedMemoryModel.cache_instance" title="Permalink to this definition"></a></dt>
<dd><p>Method to store an instance in the cache.</p>
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
@ -92,29 +94,29 @@ db save).</p></li>
</dl>
</dd></dl>
<dl class="method">
<dl class="py method">
<dt id="evennia.utils.idmapper.models.SharedMemoryModel.get_all_cached_instances">
<em class="property">classmethod </em><code class="sig-name descname">get_all_cached_instances</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/utils/idmapper/models.html#SharedMemoryModel.get_all_cached_instances"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.utils.idmapper.models.SharedMemoryModel.get_all_cached_instances" title="Permalink to this definition"></a></dt>
<dd><p>Return the objects so far cached by idmapper for this class.</p>
</dd></dl>
<dl class="method">
<dl class="py method">
<dt id="evennia.utils.idmapper.models.SharedMemoryModel.flush_cached_instance">
<em class="property">classmethod </em><code class="sig-name descname">flush_cached_instance</code><span class="sig-paren">(</span><em class="sig-param">instance</em>, <em class="sig-param">force=True</em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/utils/idmapper/models.html#SharedMemoryModel.flush_cached_instance"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.utils.idmapper.models.SharedMemoryModel.flush_cached_instance" title="Permalink to this definition"></a></dt>
<em class="property">classmethod </em><code class="sig-name descname">flush_cached_instance</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">instance</span></em>, <em class="sig-param"><span class="n">force</span><span class="o">=</span><span class="default_value">True</span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/utils/idmapper/models.html#SharedMemoryModel.flush_cached_instance"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.utils.idmapper.models.SharedMemoryModel.flush_cached_instance" title="Permalink to this definition"></a></dt>
<dd><p>Method to flush an instance from the cache. The instance will
always be flushed from the cache, since this is most likely
called from delete(), and we want to make sure we don’t cache
dead objects.</p>
</dd></dl>
<dl class="method">
<dl class="py method">
<dt id="evennia.utils.idmapper.models.SharedMemoryModel.flush_instance_cache">
<em class="property">classmethod </em><code class="sig-name descname">flush_instance_cache</code><span class="sig-paren">(</span><em class="sig-param">force=False</em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/utils/idmapper/models.html#SharedMemoryModel.flush_instance_cache"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.utils.idmapper.models.SharedMemoryModel.flush_instance_cache" title="Permalink to this definition"></a></dt>
<em class="property">classmethod </em><code class="sig-name descname">flush_instance_cache</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">force</span><span class="o">=</span><span class="default_value">False</span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/utils/idmapper/models.html#SharedMemoryModel.flush_instance_cache"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.utils.idmapper.models.SharedMemoryModel.flush_instance_cache" title="Permalink to this definition"></a></dt>
<dd><p>This will clean safe objects from the cache. Use <strong>force</strong>
keyword to remove all objects, safe or not.</p>
</dd></dl>
<dl class="method">
<dl class="py method">
<dt id="evennia.utils.idmapper.models.SharedMemoryModel.at_idmapper_flush">
<code class="sig-name descname">at_idmapper_flush</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/utils/idmapper/models.html#SharedMemoryModel.at_idmapper_flush"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.utils.idmapper.models.SharedMemoryModel.at_idmapper_flush" title="Permalink to this definition"></a></dt>
<dd><p>This is called when the idmapper cache is flushed and
@ -132,22 +134,22 @@ the flushing on its own.</p>
</dl>
</dd></dl>
<dl class="method">
<dl class="py method">
<dt id="evennia.utils.idmapper.models.SharedMemoryModel.flush_from_cache">
<code class="sig-name descname">flush_from_cache</code><span class="sig-paren">(</span><em class="sig-param">force=False</em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/utils/idmapper/models.html#SharedMemoryModel.flush_from_cache"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.utils.idmapper.models.SharedMemoryModel.flush_from_cache" title="Permalink to this definition"></a></dt>
<code class="sig-name descname">flush_from_cache</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">force</span><span class="o">=</span><span class="default_value">False</span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/utils/idmapper/models.html#SharedMemoryModel.flush_from_cache"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.utils.idmapper.models.SharedMemoryModel.flush_from_cache" title="Permalink to this definition"></a></dt>
<dd><p>Flush this instance from the instance cache. Use
<strong>force</strong> to override the result of at_idmapper_flush() for the object.</p>
</dd></dl>
<dl class="method">
<dl class="py method">
<dt id="evennia.utils.idmapper.models.SharedMemoryModel.delete">
<code class="sig-name descname">delete</code><span class="sig-paren">(</span><em class="sig-param">*args</em>, <em class="sig-param">**kwargs</em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/utils/idmapper/models.html#SharedMemoryModel.delete"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.utils.idmapper.models.SharedMemoryModel.delete" title="Permalink to this definition"></a></dt>
<code class="sig-name descname">delete</code><span class="sig-paren">(</span><em class="sig-param"><span class="o">*</span><span class="n">args</span></em>, <em class="sig-param"><span class="o">**</span><span class="n">kwargs</span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/utils/idmapper/models.html#SharedMemoryModel.delete"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.utils.idmapper.models.SharedMemoryModel.delete" title="Permalink to this definition"></a></dt>
<dd><p>Delete the object, clearing cache.</p>
</dd></dl>
<dl class="method">
<dl class="py method">
<dt id="evennia.utils.idmapper.models.SharedMemoryModel.save">
<code class="sig-name descname">save</code><span class="sig-paren">(</span><em class="sig-param">*args</em>, <em class="sig-param">**kwargs</em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/utils/idmapper/models.html#SharedMemoryModel.save"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.utils.idmapper.models.SharedMemoryModel.save" title="Permalink to this definition"></a></dt>
<code class="sig-name descname">save</code><span class="sig-paren">(</span><em class="sig-param"><span class="o">*</span><span class="n">args</span></em>, <em class="sig-param"><span class="o">**</span><span class="n">kwargs</span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/utils/idmapper/models.html#SharedMemoryModel.save"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.utils.idmapper.models.SharedMemoryModel.save" title="Permalink to this definition"></a></dt>
<dd><p>Central database save operation.</p>
<p class="rubric">Notes</p>
<p>Arguments as per Django documentation.
@ -156,77 +158,77 @@ Calls <strong>self.at_&lt;fieldname&gt;_postsave(new)</strong>
self._oob_at_&lt;fieldname&gt;_postsave())</p>
</dd></dl>
<dl class="attribute">
<dl class="py attribute">
<dt id="evennia.utils.idmapper.models.SharedMemoryModel.path">
<code class="sig-name descname">path</code><em class="property"> = 'evennia.utils.idmapper.models.SharedMemoryModel'</em><a class="headerlink" href="#evennia.utils.idmapper.models.SharedMemoryModel.path" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
<dl class="attribute">
<dl class="py attribute">
<dt id="evennia.utils.idmapper.models.SharedMemoryModel.typename">
<code class="sig-name descname">typename</code><em class="property"> = 'SharedMemoryModelBase'</em><a class="headerlink" href="#evennia.utils.idmapper.models.SharedMemoryModel.typename" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
</dd></dl>
<dl class="class">
<dl class="py class">
<dt id="evennia.utils.idmapper.models.WeakSharedMemoryModelBase">
<em class="property">class </em><code class="sig-prename descclassname">evennia.utils.idmapper.models.</code><code class="sig-name descname">WeakSharedMemoryModelBase</code><a class="reference internal" href="../_modules/evennia/utils/idmapper/models.html#WeakSharedMemoryModelBase"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.utils.idmapper.models.WeakSharedMemoryModelBase" title="Permalink to this definition"></a></dt>
<em class="property">class </em><code class="sig-prename descclassname">evennia.utils.idmapper.models.</code><code class="sig-name descname">WeakSharedMemoryModelBase</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">name</span></em>, <em class="sig-param"><span class="n">bases</span></em>, <em class="sig-param"><span class="n">attrs</span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/utils/idmapper/models.html#WeakSharedMemoryModelBase"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.utils.idmapper.models.WeakSharedMemoryModelBase" title="Permalink to this definition"></a></dt>
<dd><p>Bases: <a class="reference internal" href="#evennia.utils.idmapper.models.SharedMemoryModelBase" title="evennia.utils.idmapper.models.SharedMemoryModelBase"><code class="xref py py-class docutils literal notranslate"><span class="pre">evennia.utils.idmapper.models.SharedMemoryModelBase</span></code></a></p>
<p>Uses a WeakValue dictionary for caching instead of a regular one.</p>
</dd></dl>
<dl class="class">
<dl class="py class">
<dt id="evennia.utils.idmapper.models.WeakSharedMemoryModel">
<em class="property">class </em><code class="sig-prename descclassname">evennia.utils.idmapper.models.</code><code class="sig-name descname">WeakSharedMemoryModel</code><span class="sig-paren">(</span><em class="sig-param">*args</em>, <em class="sig-param">**kwargs</em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/utils/idmapper/models.html#WeakSharedMemoryModel"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.utils.idmapper.models.WeakSharedMemoryModel" title="Permalink to this definition"></a></dt>
<em class="property">class </em><code class="sig-prename descclassname">evennia.utils.idmapper.models.</code><code class="sig-name descname">WeakSharedMemoryModel</code><span class="sig-paren">(</span><em class="sig-param"><span class="o">*</span><span class="n">args</span></em>, <em class="sig-param"><span class="o">**</span><span class="n">kwargs</span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/utils/idmapper/models.html#WeakSharedMemoryModel"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.utils.idmapper.models.WeakSharedMemoryModel" title="Permalink to this definition"></a></dt>
<dd><p>Bases: <a class="reference internal" href="#evennia.utils.idmapper.models.SharedMemoryModel" title="evennia.utils.idmapper.models.SharedMemoryModel"><code class="xref py py-class docutils literal notranslate"><span class="pre">evennia.utils.idmapper.models.SharedMemoryModel</span></code></a></p>
<p>Uses a WeakValue dictionary for caching instead of a regular one</p>
<dl class="class">
<dl class="py class">
<dt id="evennia.utils.idmapper.models.WeakSharedMemoryModel.Meta">
<em class="property">class </em><code class="sig-name descname">Meta</code><a class="reference internal" href="../_modules/evennia/utils/idmapper/models.html#WeakSharedMemoryModel.Meta"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.utils.idmapper.models.WeakSharedMemoryModel.Meta" title="Permalink to this definition"></a></dt>
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">object</span></code></p>
<dl class="attribute">
<dl class="py attribute">
<dt id="evennia.utils.idmapper.models.WeakSharedMemoryModel.Meta.abstract">
<code class="sig-name descname">abstract</code><em class="property"> = False</em><a class="headerlink" href="#evennia.utils.idmapper.models.WeakSharedMemoryModel.Meta.abstract" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
</dd></dl>
<dl class="attribute">
<dl class="py attribute">
<dt id="evennia.utils.idmapper.models.WeakSharedMemoryModel.path">
<code class="sig-name descname">path</code><em class="property"> = 'evennia.utils.idmapper.models.WeakSharedMemoryModel'</em><a class="headerlink" href="#evennia.utils.idmapper.models.WeakSharedMemoryModel.path" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
<dl class="attribute">
<dl class="py attribute">
<dt id="evennia.utils.idmapper.models.WeakSharedMemoryModel.typename">
<code class="sig-name descname">typename</code><em class="property"> = 'WeakSharedMemoryModelBase'</em><a class="headerlink" href="#evennia.utils.idmapper.models.WeakSharedMemoryModel.typename" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
</dd></dl>
<dl class="function">
<dl class="py function">
<dt id="evennia.utils.idmapper.models.flush_cache">
<code class="sig-prename descclassname">evennia.utils.idmapper.models.</code><code class="sig-name descname">flush_cache</code><span class="sig-paren">(</span><em class="sig-param">**kwargs</em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/utils/idmapper/models.html#flush_cache"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.utils.idmapper.models.flush_cache" title="Permalink to this definition"></a></dt>
<code class="sig-prename descclassname">evennia.utils.idmapper.models.</code><code class="sig-name descname">flush_cache</code><span class="sig-paren">(</span><em class="sig-param"><span class="o">**</span><span class="n">kwargs</span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/utils/idmapper/models.html#flush_cache"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.utils.idmapper.models.flush_cache" title="Permalink to this definition"></a></dt>
<dd><p>Flush idmapper cache. When doing so the cache will fire the
at_idmapper_flush hook to allow the object to optionally handle
its own flushing.</p>
<p>Uses a signal so we make sure to catch cascades.</p>
</dd></dl>
<dl class="function">
<dl class="py function">
<dt id="evennia.utils.idmapper.models.flush_cached_instance">
<code class="sig-prename descclassname">evennia.utils.idmapper.models.</code><code class="sig-name descname">flush_cached_instance</code><span class="sig-paren">(</span><em class="sig-param">sender</em>, <em class="sig-param">instance</em>, <em class="sig-param">**kwargs</em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/utils/idmapper/models.html#flush_cached_instance"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.utils.idmapper.models.flush_cached_instance" title="Permalink to this definition"></a></dt>
<code class="sig-prename descclassname">evennia.utils.idmapper.models.</code><code class="sig-name descname">flush_cached_instance</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">sender</span></em>, <em class="sig-param"><span class="n">instance</span></em>, <em class="sig-param"><span class="o">**</span><span class="n">kwargs</span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/utils/idmapper/models.html#flush_cached_instance"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.utils.idmapper.models.flush_cached_instance" title="Permalink to this definition"></a></dt>
<dd><p>Flush the idmapper cache only for a given instance.</p>
</dd></dl>
<dl class="function">
<dl class="py function">
<dt id="evennia.utils.idmapper.models.update_cached_instance">
<code class="sig-prename descclassname">evennia.utils.idmapper.models.</code><code class="sig-name descname">update_cached_instance</code><span class="sig-paren">(</span><em class="sig-param">sender</em>, <em class="sig-param">instance</em>, <em class="sig-param">**kwargs</em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/utils/idmapper/models.html#update_cached_instance"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.utils.idmapper.models.update_cached_instance" title="Permalink to this definition"></a></dt>
<code class="sig-prename descclassname">evennia.utils.idmapper.models.</code><code class="sig-name descname">update_cached_instance</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">sender</span></em>, <em class="sig-param"><span class="n">instance</span></em>, <em class="sig-param"><span class="o">**</span><span class="n">kwargs</span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/utils/idmapper/models.html#update_cached_instance"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.utils.idmapper.models.update_cached_instance" title="Permalink to this definition"></a></dt>
<dd><p>Re-cache the given instance in the idmapper cache.</p>
</dd></dl>
<dl class="function">
<dl class="py function">
<dt id="evennia.utils.idmapper.models.conditional_flush">
<code class="sig-prename descclassname">evennia.utils.idmapper.models.</code><code class="sig-name descname">conditional_flush</code><span class="sig-paren">(</span><em class="sig-param">max_rmem</em>, <em class="sig-param">force=False</em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/utils/idmapper/models.html#conditional_flush"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.utils.idmapper.models.conditional_flush" title="Permalink to this definition"></a></dt>
<code class="sig-prename descclassname">evennia.utils.idmapper.models.</code><code class="sig-name descname">conditional_flush</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">max_rmem</span></em>, <em class="sig-param"><span class="n">force</span><span class="o">=</span><span class="default_value">False</span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/utils/idmapper/models.html#conditional_flush"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.utils.idmapper.models.conditional_flush" title="Permalink to this definition"></a></dt>
<dd><p>Flush the cache if the estimated memory usage exceeds <strong>max_rmem</strong>.</p>
<p>The flusher has a timeout to avoid flushing over and over
in particular situations (this means that for some setups
@ -244,9 +246,9 @@ Defaults to <strong>False</strong>.</p></li>
</dl>
</dd></dl>
<dl class="function">
<dl class="py function">
<dt id="evennia.utils.idmapper.models.cache_size">
<code class="sig-prename descclassname">evennia.utils.idmapper.models.</code><code class="sig-name descname">cache_size</code><span class="sig-paren">(</span><em class="sig-param">mb=True</em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/utils/idmapper/models.html#cache_size"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.utils.idmapper.models.cache_size" title="Permalink to this definition"></a></dt>
<code class="sig-prename descclassname">evennia.utils.idmapper.models.</code><code class="sig-name descname">cache_size</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">mb</span><span class="o">=</span><span class="default_value">True</span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/utils/idmapper/models.html#cache_size"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.utils.idmapper.models.cache_size" title="Permalink to this definition"></a></dt>
<dd><p>Calculate statistics about the cache.</p>
<p>Note: we cannot get reliable memory statistics from the cache -
whereas we could do <strong>getsizof</strong> each object in cache, the result is
@ -264,6 +266,7 @@ catch in an easy way here. Ideas are appreciated. /Griatch</p>
</div>
<div class="clearer"></div>
</div>
</div>
</div>
@ -308,12 +311,13 @@ catch in an easy way here. Ideas are appreciated. /Griatch</p>
<li class="right" >
<a href="../py-modindex.html" title="Python Module Index"
>modules</a> |</li>
<li class="nav-item nav-item-0"><a href="../index.html">Evennia 1.0-dev</a> &#187;</li>
<li class="nav-item nav-item-0"><a href="../index.html">Evennia 1.0-dev</a> &#187;</li>
<li class="nav-item nav-item-this"><a href="">evennia.utils.idmapper.models</a></li>
</ul>
</div>
<div class="footer" role="contentinfo">
&#169; Copyright 2020, The Evennia developer community.
Created using <a href="http://sphinx-doc.org/">Sphinx</a> 2.4.4.
Created using <a href="https://www.sphinx-doc.org/">Sphinx</a> 3.2.1.
</div>
</body>
</html>