mirror of
https://github.com/evennia/evennia.git
synced 2026-04-05 15:37:17 +02:00
Updated HTML docs.
This commit is contained in:
Evennia docbuilder action
parent
dbae67275a
commit
76d95c253e
87 changed files with 922 additions and 850 deletions
|
|
@ -470,92 +470,6 @@ or the key of such a command.</p>
|
|||
<p>No cmdsets found. Critical error.</p>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py class">
|
||||
<dt class="sig sig-object py" id="evennia.commands.cmdhandler.WeakValueDictionary">
|
||||
<em class="property"><span class="k"><span class="pre">class</span></span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">evennia.commands.cmdhandler.</span></span><span class="sig-name descname"><span class="pre">WeakValueDictionary</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">other</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">()</span></span></em>, <em class="sig-param"><span class="positional-only-separator o"><abbr title="Positional-only parameter separator (PEP 570)"><span class="pre">/</span></abbr></span></em>, <em class="sig-param"><span class="o"><span class="pre">**</span></span><span class="n"><span class="pre">kw</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/weakref.html#WeakValueDictionary"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#evennia.commands.cmdhandler.WeakValueDictionary" title="Link to this definition">¶</a></dt>
|
||||
<dd><p>Bases: <a class="reference internal" href="evennia.utils.dbserialize.html#evennia.utils.dbserialize.MutableMapping" title="collections.abc.MutableMapping"><code class="xref py py-class docutils literal notranslate"><span class="pre">MutableMapping</span></code></a></p>
|
||||
<p>Mapping class that references values weakly.</p>
|
||||
<p>Entries in the dictionary will be discarded when no strong
|
||||
reference to the value exists anymore</p>
|
||||
<dl class="py method">
|
||||
<dt class="sig sig-object py" id="evennia.commands.cmdhandler.WeakValueDictionary.__init__">
|
||||
<span class="sig-name descname"><span class="pre">__init__</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">other</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">()</span></span></em>, <em class="sig-param"><span class="positional-only-separator o"><abbr title="Positional-only parameter separator (PEP 570)"><span class="pre">/</span></abbr></span></em>, <em class="sig-param"><span class="o"><span class="pre">**</span></span><span class="n"><span class="pre">kw</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/weakref.html#WeakValueDictionary.__init__"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#evennia.commands.cmdhandler.WeakValueDictionary.__init__" title="Link to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
<dl class="py method">
|
||||
<dt class="sig sig-object py" id="evennia.commands.cmdhandler.WeakValueDictionary.copy">
|
||||
<span class="sig-name descname"><span class="pre">copy</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="../_modules/weakref.html#WeakValueDictionary.copy"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#evennia.commands.cmdhandler.WeakValueDictionary.copy" title="Link to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
<dl class="py method">
|
||||
<dt class="sig sig-object py" id="evennia.commands.cmdhandler.WeakValueDictionary.get">
|
||||
<span class="sig-name descname"><span class="pre">get</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">k</span></span></em><span class="optional">[</span>, <em class="sig-param"><span class="n"><span class="pre">d</span></span></em><span class="optional">]</span><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><span class="pre">D[k]</span> <span class="pre">if</span> <span class="pre">k</span> <span class="pre">in</span> <span class="pre">D,</span> <span class="pre">else</span> <span class="pre">d.</span>  <span class="pre">d</span> <span class="pre">defaults</span> <span class="pre">to</span> <span class="pre">None.</span></span></span><a class="reference internal" href="../_modules/weakref.html#WeakValueDictionary.get"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#evennia.commands.cmdhandler.WeakValueDictionary.get" title="Link to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
<dl class="py method">
|
||||
<dt class="sig sig-object py" id="evennia.commands.cmdhandler.WeakValueDictionary.items">
|
||||
<span class="sig-name descname"><span class="pre">items</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><span class="pre">a</span> <span class="pre">set-like</span> <span class="pre">object</span> <span class="pre">providing</span> <span class="pre">a</span> <span class="pre">view</span> <span class="pre">on</span> <span class="pre">D's</span> <span class="pre">items</span></span></span><a class="reference internal" href="../_modules/weakref.html#WeakValueDictionary.items"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#evennia.commands.cmdhandler.WeakValueDictionary.items" title="Link to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
<dl class="py method">
|
||||
<dt class="sig sig-object py" id="evennia.commands.cmdhandler.WeakValueDictionary.itervaluerefs">
|
||||
<span class="sig-name descname"><span class="pre">itervaluerefs</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="../_modules/weakref.html#WeakValueDictionary.itervaluerefs"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#evennia.commands.cmdhandler.WeakValueDictionary.itervaluerefs" title="Link to this definition">¶</a></dt>
|
||||
<dd><p>Return an iterator that yields the weak references to the values.</p>
|
||||
<p>The references are not guaranteed to be ‘live’ at the time
|
||||
they are used, so the result of calling the references needs
|
||||
to be checked before being used. This can be used to avoid
|
||||
creating references that will cause the garbage collector to
|
||||
keep the values around longer than needed.</p>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py method">
|
||||
<dt class="sig sig-object py" id="evennia.commands.cmdhandler.WeakValueDictionary.keys">
|
||||
<span class="sig-name descname"><span class="pre">keys</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><span class="pre">a</span> <span class="pre">set-like</span> <span class="pre">object</span> <span class="pre">providing</span> <span class="pre">a</span> <span class="pre">view</span> <span class="pre">on</span> <span class="pre">D's</span> <span class="pre">keys</span></span></span><a class="reference internal" href="../_modules/weakref.html#WeakValueDictionary.keys"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#evennia.commands.cmdhandler.WeakValueDictionary.keys" title="Link to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
<dl class="py method">
|
||||
<dt class="sig sig-object py" id="evennia.commands.cmdhandler.WeakValueDictionary.pop">
|
||||
<span class="sig-name descname"><span class="pre">pop</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">k</span></span></em><span class="optional">[</span>, <em class="sig-param"><span class="n"><span class="pre">d</span></span></em><span class="optional">]</span><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><span class="pre">v,</span> <span class="pre">remove</span> <span class="pre">specified</span> <span class="pre">key</span> <span class="pre">and</span> <span class="pre">return</span> <span class="pre">the</span> <span class="pre">corresponding</span> <span class="pre">value.</span></span></span><a class="reference internal" href="../_modules/weakref.html#WeakValueDictionary.pop"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#evennia.commands.cmdhandler.WeakValueDictionary.pop" title="Link to this definition">¶</a></dt>
|
||||
<dd><p>If key is not found, d is returned if given, otherwise KeyError is raised.</p>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py method">
|
||||
<dt class="sig sig-object py" id="evennia.commands.cmdhandler.WeakValueDictionary.popitem">
|
||||
<span class="sig-name descname"><span class="pre">popitem</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><span class="pre">(k,</span> <span class="pre">v),</span> <span class="pre">remove</span> <span class="pre">and</span> <span class="pre">return</span> <span class="pre">some</span> <span class="pre">(key,</span> <span class="pre">value)</span> <span class="pre">pair</span></span></span><a class="reference internal" href="../_modules/weakref.html#WeakValueDictionary.popitem"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#evennia.commands.cmdhandler.WeakValueDictionary.popitem" title="Link to this definition">¶</a></dt>
|
||||
<dd><p>as a 2-tuple; but raise KeyError if D is empty.</p>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py method">
|
||||
<dt class="sig sig-object py" id="evennia.commands.cmdhandler.WeakValueDictionary.setdefault">
|
||||
<span class="sig-name descname"><span class="pre">setdefault</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">k</span></span></em><span class="optional">[</span>, <em class="sig-param"><span class="n"><span class="pre">d</span></span></em><span class="optional">]</span><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><span class="pre">D.get(k,d),</span> <span class="pre">also</span> <span class="pre">set</span> <span class="pre">D[k]=d</span> <span class="pre">if</span> <span class="pre">k</span> <span class="pre">not</span> <span class="pre">in</span> <span class="pre">D</span></span></span><a class="reference internal" href="../_modules/weakref.html#WeakValueDictionary.setdefault"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#evennia.commands.cmdhandler.WeakValueDictionary.setdefault" title="Link to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
<dl class="py method">
|
||||
<dt class="sig sig-object py" id="evennia.commands.cmdhandler.WeakValueDictionary.update">
|
||||
<span class="sig-name descname"><span class="pre">update</span></span><span class="sig-paren">(</span><span class="optional">[</span><em class="sig-param"><span class="n"><span class="pre">E</span></span></em>, <span class="optional">]</span><em class="sig-param"><span class="n"><span class="pre">**F</span></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><span class="pre">None.</span>  <span class="pre">Update</span> <span class="pre">D</span> <span class="pre">from</span> <span class="pre">mapping/iterable</span> <span class="pre">E</span> <span class="pre">and</span> <span class="pre">F.</span></span></span><a class="reference internal" href="../_modules/weakref.html#WeakValueDictionary.update"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#evennia.commands.cmdhandler.WeakValueDictionary.update" title="Link to this definition">¶</a></dt>
|
||||
<dd><p>If E present and has a .keys() method, does: for k in E.keys(): D[k] = E[k]
|
||||
If E present and lacks .keys() method, does: for (k, v) in E: D[k] = v
|
||||
In either case, this is followed by: for k, v in F.items(): D[k] = v</p>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py method">
|
||||
<dt class="sig sig-object py" id="evennia.commands.cmdhandler.WeakValueDictionary.valuerefs">
|
||||
<span class="sig-name descname"><span class="pre">valuerefs</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="../_modules/weakref.html#WeakValueDictionary.valuerefs"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#evennia.commands.cmdhandler.WeakValueDictionary.valuerefs" title="Link to this definition">¶</a></dt>
|
||||
<dd><p>Return a list of weak references to the values.</p>
|
||||
<p>The references are not guaranteed to be ‘live’ at the time
|
||||
they are used, so the result of calling the references needs
|
||||
to be checked before being used. This can be used to avoid
|
||||
creating references that will cause the garbage collector to
|
||||
keep the values around longer than needed.</p>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py method">
|
||||
<dt class="sig sig-object py" id="evennia.commands.cmdhandler.WeakValueDictionary.values">
|
||||
<span class="sig-name descname"><span class="pre">values</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><span class="pre">an</span> <span class="pre">object</span> <span class="pre">providing</span> <span class="pre">a</span> <span class="pre">view</span> <span class="pre">on</span> <span class="pre">D's</span> <span class="pre">values</span></span></span><a class="reference internal" href="../_modules/weakref.html#WeakValueDictionary.values"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#evennia.commands.cmdhandler.WeakValueDictionary.values" title="Link to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py class">
|
||||
<dt class="sig sig-object py" id="evennia.commands.cmdhandler.chain">
|
||||
<em class="property"><span class="k"><span class="pre">class</span></span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">evennia.commands.cmdhandler.</span></span><span class="sig-name descname"><span class="pre">chain</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="o"><span class="pre">*</span></span><span class="n"><span class="pre">iterables</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#evennia.commands.cmdhandler.chain" title="Link to this definition">¶</a></dt>
|
||||
|
|
@ -811,21 +725,6 @@ Could be empty if there are no matches.</p>
|
|||
</ul>
|
||||
</li>
|
||||
<li><a class="reference internal" href="#evennia.commands.cmdhandler.NoCmdSets"><code class="docutils literal notranslate"><span class="pre">NoCmdSets</span></code></a></li>
|
||||
<li><a class="reference internal" href="#evennia.commands.cmdhandler.WeakValueDictionary"><code class="docutils literal notranslate"><span class="pre">WeakValueDictionary</span></code></a><ul>
|
||||
<li><a class="reference internal" href="#evennia.commands.cmdhandler.WeakValueDictionary.__init__"><code class="docutils literal notranslate"><span class="pre">WeakValueDictionary.__init__()</span></code></a></li>
|
||||
<li><a class="reference internal" href="#evennia.commands.cmdhandler.WeakValueDictionary.copy"><code class="docutils literal notranslate"><span class="pre">WeakValueDictionary.copy()</span></code></a></li>
|
||||
<li><a class="reference internal" href="#evennia.commands.cmdhandler.WeakValueDictionary.get"><code class="docutils literal notranslate"><span class="pre">WeakValueDictionary.get()</span></code></a></li>
|
||||
<li><a class="reference internal" href="#evennia.commands.cmdhandler.WeakValueDictionary.items"><code class="docutils literal notranslate"><span class="pre">WeakValueDictionary.items()</span></code></a></li>
|
||||
<li><a class="reference internal" href="#evennia.commands.cmdhandler.WeakValueDictionary.itervaluerefs"><code class="docutils literal notranslate"><span class="pre">WeakValueDictionary.itervaluerefs()</span></code></a></li>
|
||||
<li><a class="reference internal" href="#evennia.commands.cmdhandler.WeakValueDictionary.keys"><code class="docutils literal notranslate"><span class="pre">WeakValueDictionary.keys()</span></code></a></li>
|
||||
<li><a class="reference internal" href="#evennia.commands.cmdhandler.WeakValueDictionary.pop"><code class="docutils literal notranslate"><span class="pre">WeakValueDictionary.pop()</span></code></a></li>
|
||||
<li><a class="reference internal" href="#evennia.commands.cmdhandler.WeakValueDictionary.popitem"><code class="docutils literal notranslate"><span class="pre">WeakValueDictionary.popitem()</span></code></a></li>
|
||||
<li><a class="reference internal" href="#evennia.commands.cmdhandler.WeakValueDictionary.setdefault"><code class="docutils literal notranslate"><span class="pre">WeakValueDictionary.setdefault()</span></code></a></li>
|
||||
<li><a class="reference internal" href="#evennia.commands.cmdhandler.WeakValueDictionary.update"><code class="docutils literal notranslate"><span class="pre">WeakValueDictionary.update()</span></code></a></li>
|
||||
<li><a class="reference internal" href="#evennia.commands.cmdhandler.WeakValueDictionary.valuerefs"><code class="docutils literal notranslate"><span class="pre">WeakValueDictionary.valuerefs()</span></code></a></li>
|
||||
<li><a class="reference internal" href="#evennia.commands.cmdhandler.WeakValueDictionary.values"><code class="docutils literal notranslate"><span class="pre">WeakValueDictionary.values()</span></code></a></li>
|
||||
</ul>
|
||||
</li>
|
||||
<li><a class="reference internal" href="#evennia.commands.cmdhandler.chain"><code class="docutils literal notranslate"><span class="pre">chain</span></code></a><ul>
|
||||
<li><a class="reference internal" href="#evennia.commands.cmdhandler.chain.from_iterable"><code class="docutils literal notranslate"><span class="pre">chain.from_iterable()</span></code></a></li>
|
||||
</ul>
|
||||
|
|
|
|||
Loading…
Add table
Add a link
Reference in a new issue