Andreas/evennia
1
0
Fork 0
mirror of https://github.com/evennia/evennia.git synced 2026-03-31 04:57:16 +02:00
Code Issues Projects Releases Packages Wiki Activity Actions 1

Updated HTML docs

Browse source
This commit is contained in:
Evennia docbuilder action 2022-09-24 22:43:24 +00:00
parent b7d9669083
commit c98863a897
51 changed files with 275 additions and 152 deletions
Download patch file Download diff file Expand all files Collapse all files

24
docs/1.0-dev/_modules/evennia/contrib/rpg/traits/tests.html
View file

@ -49,9 +49,12 @@
<span class="sd">&quot;&quot;&quot;</span>
<span class="kn">from</span> <span class="nn">copy</span> <span class="kn">import</span> <span class="n">copy</span>
<span class="kn">from</span> <span class="nn">anything</span> <span class="kn">import</span> <span class="n">Something</span>
<span class="kn">from</span> <span class="nn">evennia.objects.objects</span> <span class="kn">import</span> <span class="n">DefaultCharacter</span>
<span class="kn">from</span> <span class="nn">evennia.utils.test_resources</span> <span class="kn">import</span> <span class="n">BaseEvenniaTestCase</span><span class="p">,</span> <span class="n">EvenniaTest</span>
<span class="kn">from</span> <span class="nn">mock</span> <span class="kn">import</span> <span class="n">MagicMock</span><span class="p">,</span> <span class="n">patch</span>
<span class="kn">from</span> <span class="nn">evennia.utils.test_resources</span> <span class="kn">import</span> <span class="n">BaseEvenniaTestCase</span>
<span class="kn">from</span> <span class="nn">.</span> <span class="kn">import</span> <span class="n">traits</span>
@ -1082,6 +1085,25 @@
<span class="bp">self</span><span class="o">.</span><span class="n">assertEqual</span><span class="p">(</span><span class="mi">13</span><span class="p">,</span> <span class="n">obj2</span><span class="o">.</span><span class="n">strength</span><span class="o">.</span><span class="n">value</span><span class="p">)</span>
<span class="bp">self</span><span class="o">.</span><span class="n">assertEqual</span><span class="p">(</span><span class="mi">20</span><span class="p">,</span> <span class="n">obj</span><span class="o">.</span><span class="n">strength</span><span class="o">.</span><span class="n">value</span><span class="p">)</span></div></div>
<div class="viewcode-block" id="TraitContribTestingChar"><a class="viewcode-back" href="../../../../../api/evennia.contrib.rpg.traits.tests.html#evennia.contrib.rpg.traits.tests.TraitContribTestingChar">[docs]</a><span class="k">class</span> <span class="nc">TraitContribTestingChar</span><span class="p">(</span><span class="n">DefaultCharacter</span><span class="p">):</span>
<span class="n">HP</span> <span class="o">=</span> <span class="n">traits</span><span class="o">.</span><span class="n">TraitProperty</span><span class="p">(</span><span class="s2">&quot;health&quot;</span><span class="p">,</span> <span class="n">trait_type</span><span class="o">=</span><span class="s2">&quot;trait&quot;</span><span class="p">,</span> <span class="n">value</span><span class="o">=</span><span class="mi">5</span><span class="p">)</span></div>
<div class="viewcode-block" id="TraitPropertyTestCase"><a class="viewcode-back" href="../../../../../api/evennia.contrib.rpg.traits.tests.html#evennia.contrib.rpg.traits.tests.TraitPropertyTestCase">[docs]</a><span class="k">class</span> <span class="nc">TraitPropertyTestCase</span><span class="p">(</span><span class="n">EvenniaTest</span><span class="p">):</span>
<span class="sd">&quot;&quot;&quot;</span>
<span class="sd"> Test atomic updating.</span>
<span class="sd"> &quot;&quot;&quot;</span>
<span class="n">character_typeclass</span> <span class="o">=</span> <span class="n">TraitContribTestingChar</span>
<div class="viewcode-block" id="TraitPropertyTestCase.test_round1"><a class="viewcode-back" href="../../../../../api/evennia.contrib.rpg.traits.tests.html#evennia.contrib.rpg.traits.tests.TraitPropertyTestCase.test_round1">[docs]</a> <span class="k">def</span> <span class="nf">test_round1</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
<span class="bp">self</span><span class="o">.</span><span class="n">char1</span><span class="o">.</span><span class="n">HP</span><span class="o">.</span><span class="n">value</span> <span class="o">=</span> <span class="mi">1</span></div>
<div class="viewcode-block" id="TraitPropertyTestCase.test_round2"><a class="viewcode-back" href="../../../../../api/evennia.contrib.rpg.traits.tests.html#evennia.contrib.rpg.traits.tests.TraitPropertyTestCase.test_round2">[docs]</a> <span class="k">def</span> <span class="nf">test_round2</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
<span class="bp">self</span><span class="o">.</span><span class="n">char1</span><span class="o">.</span><span class="n">HP</span><span class="o">.</span><span class="n">value</span> <span class="o">=</span> <span class="mi">2</span></div></div>
</pre></div>
<div class="clearer"></div>

13
docs/1.0-dev/_modules/evennia/utils/evtable.html
View file

@ -156,11 +156,13 @@
<span class="sd">&quot;&quot;&quot;</span>
<span class="kn">from</span> <span class="nn">django.conf</span> <span class="kn">import</span> <span class="n">settings</span>
<span class="kn">from</span> <span class="nn">copy</span> <span class="kn">import</span> <span class="n">copy</span><span class="p">,</span> <span class="n">deepcopy</span>
<span class="kn">from</span> <span class="nn">textwrap</span> <span class="kn">import</span> <span class="n">TextWrapper</span>
<span class="kn">from</span> <span class="nn">copy</span> <span class="kn">import</span> <span class="n">deepcopy</span><span class="p">,</span> <span class="n">copy</span>
<span class="kn">from</span> <span class="nn">evennia.utils.utils</span> <span class="kn">import</span> <span class="n">is_iter</span><span class="p">,</span> <span class="n">display_len</span> <span class="k">as</span> <span class="n">d_len</span>
<span class="kn">from</span> <span class="nn">django.conf</span> <span class="kn">import</span> <span class="n">settings</span>
<span class="kn">from</span> <span class="nn">evennia.utils.ansi</span> <span class="kn">import</span> <span class="n">ANSIString</span>
<span class="kn">from</span> <span class="nn">evennia.utils.utils</span> <span class="kn">import</span> <span class="n">display_len</span> <span class="k">as</span> <span class="n">d_len</span>
<span class="kn">from</span> <span class="nn">evennia.utils.utils</span> <span class="kn">import</span> <span class="n">is_iter</span>
<span class="n">_DEFAULT_WIDTH</span> <span class="o">=</span> <span class="n">settings</span><span class="o">.</span><span class="n">CLIENT_DEFAULT_WIDTH</span>
@ -1070,7 +1072,7 @@
<span class="bp">self</span><span class="o">.</span><span class="n">column</span><span class="p">[</span><span class="n">index</span><span class="p">]</span><span class="o">.</span><span class="n">reformat</span><span class="p">(</span><span class="o">**</span><span class="n">kwargs</span><span class="p">)</span></div>
<span class="k">def</span> <span class="fm">__repr__</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
<span class="k">return</span> <span class="s2">&quot;&lt;EvColumn</span><span class="se">\n</span><span class="s2"> </span><span class="si">%s</span><span class="s2">&gt;&quot;</span> <span class="o">%</span> <span class="p">(</span><span class="s2">&quot;</span><span class="se">\n</span><span class="s2"> &quot;</span><span class="o">.</span><span class="n">join</span><span class="p">([</span><span class="nb">repr</span><span class="p">(</span><span class="n">cell</span><span class="p">)</span> <span class="k">for</span> <span class="n">cell</span> <span class="ow">in</span> <span class="bp">self</span><span class="o">.</span><span class="n">column</span><span class="p">]))</span>
<span class="k">return</span> <span class="s2">&quot;&lt;EvColumn</span><span class="se">\n</span><span class="s2"> </span><span class="si">%s</span><span class="s2">&gt;&quot;</span> <span class="o">%</span> <span class="s2">&quot;</span><span class="se">\n</span><span class="s2"> &quot;</span><span class="o">.</span><span class="n">join</span><span class="p">([</span><span class="nb">repr</span><span class="p">(</span><span class="n">cell</span><span class="p">)</span> <span class="k">for</span> <span class="n">cell</span> <span class="ow">in</span> <span class="bp">self</span><span class="o">.</span><span class="n">column</span><span class="p">])</span>
<span class="k">def</span> <span class="fm">__len__</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
<span class="k">return</span> <span class="nb">len</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">column</span><span class="p">)</span>
@ -1673,11 +1675,10 @@
<span class="c1"># we need to add new empty columns to table</span>
<span class="n">empty_rows</span> <span class="o">=</span> <span class="p">[</span><span class="s2">&quot;&quot;</span> <span class="k">for</span> <span class="n">_</span> <span class="ow">in</span> <span class="nb">range</span><span class="p">(</span><span class="n">htable</span><span class="p">)]</span>
<span class="bp">self</span><span class="o">.</span><span class="n">table</span><span class="o">.</span><span class="n">extend</span><span class="p">([</span><span class="n">EvColumn</span><span class="p">(</span><span class="o">*</span><span class="n">empty_rows</span><span class="p">,</span> <span class="o">**</span><span class="n">options</span><span class="p">)</span> <span class="k">for</span> <span class="n">_</span> <span class="ow">in</span> <span class="nb">range</span><span class="p">(</span><span class="n">excess</span><span class="p">)])</span>
<span class="bp">self</span><span class="o">.</span><span class="n">ncols</span> <span class="o">+=</span> <span class="n">excess</span>
<span class="k">elif</span> <span class="n">excess</span> <span class="o">&lt;</span> <span class="mi">0</span><span class="p">:</span>
<span class="c1"># we need to add more cells to row</span>
<span class="n">row</span><span class="o">.</span><span class="n">extend</span><span class="p">([</span><span class="s2">&quot;&quot;</span> <span class="k">for</span> <span class="n">_</span> <span class="ow">in</span> <span class="nb">range</span><span class="p">(</span><span class="nb">abs</span><span class="p">(</span><span class="n">excess</span><span class="p">))])</span>
<span class="bp">self</span><span class="o">.</span><span class="n">ncols</span> <span class="o">-=</span> <span class="n">excess</span>
<span class="bp">self</span><span class="o">.</span><span class="n">ncols</span> <span class="o">=</span> <span class="nb">len</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">table</span><span class="p">)</span>
<span class="k">if</span> <span class="n">ypos</span> <span class="ow">is</span> <span class="kc">None</span> <span class="ow">or</span> <span class="n">ypos</span> <span class="o">&gt;</span> <span class="n">htable</span> <span class="o">-</span> <span class="mi">1</span><span class="p">:</span>
<span class="c1"># add new row to the end</span>

21
docs/1.0-dev/_modules/evennia/utils/idmapper/models.html
View file

@ -49,19 +49,20 @@
<span class="sd">Also adds `cache_size()` for monitoring the size of the cache.</span>
<span class="sd">&quot;&quot;&quot;</span>
<span class="kn">import</span> <span class="nn">gc</span>
<span class="kn">import</span> <span class="nn">os</span>
<span class="kn">import</span> <span class="nn">threading</span>
<span class="kn">import</span> <span class="nn">gc</span>
<span class="kn">import</span> <span class="nn">time</span>
<span class="kn">from</span> <span class="nn">weakref</span> <span class="kn">import</span> <span class="n">WeakValueDictionary</span>
<span class="kn">from</span> <span class="nn">twisted.internet.reactor</span> <span class="kn">import</span> <span class="n">callFromThread</span>
<span class="kn">from</span> <span class="nn">django.core.exceptions</span> <span class="kn">import</span> <span class="n">ObjectDoesNotExist</span><span class="p">,</span> <span class="n">FieldError</span>
<span class="kn">from</span> <span class="nn">django.db.models.signals</span> <span class="kn">import</span> <span class="n">post_save</span>
<span class="kn">from</span> <span class="nn">django.core.exceptions</span> <span class="kn">import</span> <span class="n">FieldError</span><span class="p">,</span> <span class="n">ObjectDoesNotExist</span>
<span class="kn">from</span> <span class="nn">django.db.models.base</span> <span class="kn">import</span> <span class="n">Model</span><span class="p">,</span> <span class="n">ModelBase</span>
<span class="kn">from</span> <span class="nn">django.db.models.signals</span> <span class="kn">import</span> <span class="n">pre_delete</span><span class="p">,</span> <span class="n">post_migrate</span>
<span class="kn">from</span> <span class="nn">django.db.models.signals</span> <span class="kn">import</span> <span class="n">post_migrate</span><span class="p">,</span> <span class="n">post_save</span><span class="p">,</span> <span class="n">pre_delete</span>
<span class="kn">from</span> <span class="nn">django.db.transaction</span> <span class="kn">import</span> <span class="n">atomic</span>
<span class="kn">from</span> <span class="nn">django.db.utils</span> <span class="kn">import</span> <span class="n">DatabaseError</span>
<span class="kn">from</span> <span class="nn">evennia.utils</span> <span class="kn">import</span> <span class="n">logger</span>
<span class="kn">from</span> <span class="nn">evennia.utils.utils</span> <span class="kn">import</span> <span class="n">dbref</span><span class="p">,</span> <span class="n">get_evennia_pids</span><span class="p">,</span> <span class="n">to_str</span>
<span class="kn">from</span> <span class="nn">twisted.internet.reactor</span> <span class="kn">import</span> <span class="n">callFromThread</span>
<span class="kn">from</span> <span class="nn">.manager</span> <span class="kn">import</span> <span class="n">SharedMemoryManager</span>
@ -486,13 +487,15 @@
<span class="k">if</span> <span class="n">_IS_MAIN_THREAD</span><span class="p">:</span>
<span class="c1"># in main thread - normal operation</span>
<span class="k">try</span><span class="p">:</span>
<span class="nb">super</span><span class="p">()</span><span class="o">.</span><span class="n">save</span><span class="p">(</span><span class="o">*</span><span class="n">args</span><span class="p">,</span> <span class="o">**</span><span class="n">kwargs</span><span class="p">)</span>
<span class="k">with</span> <span class="n">atomic</span><span class="p">():</span>
<span class="nb">super</span><span class="p">()</span><span class="o">.</span><span class="n">save</span><span class="p">(</span><span class="o">*</span><span class="n">args</span><span class="p">,</span> <span class="o">**</span><span class="n">kwargs</span><span class="p">)</span>
<span class="k">except</span> <span class="n">DatabaseError</span><span class="p">:</span>
<span class="c1"># we handle the &#39;update_fields did not update any rows&#39; error that</span>
<span class="c1"># may happen due to timing issues with attributes</span>
<span class="n">ufields_removed</span> <span class="o">=</span> <span class="n">kwargs</span><span class="o">.</span><span class="n">pop</span><span class="p">(</span><span class="s2">&quot;update_fields&quot;</span><span class="p">,</span> <span class="kc">None</span><span class="p">)</span>
<span class="k">if</span> <span class="n">ufields_removed</span><span class="p">:</span>
<span class="nb">super</span><span class="p">()</span><span class="o">.</span><span class="n">save</span><span class="p">(</span><span class="o">*</span><span class="n">args</span><span class="p">,</span> <span class="o">**</span><span class="n">kwargs</span><span class="p">)</span>
<span class="k">with</span> <span class="n">atomic</span><span class="p">():</span>
<span class="nb">super</span><span class="p">()</span><span class="o">.</span><span class="n">save</span><span class="p">(</span><span class="o">*</span><span class="n">args</span><span class="p">,</span> <span class="o">**</span><span class="n">kwargs</span><span class="p">)</span>
<span class="k">else</span><span class="p">:</span>
<span class="k">raise</span>
<span class="k">else</span><span class="p">:</span>
@ -665,8 +668,8 @@
<span class="k">if</span> <span class="p">((</span><span class="n">now</span> <span class="o">-</span> <span class="n">LAST_FLUSH</span><span class="p">)</span> <span class="o">&lt;</span> <span class="n">AUTO_FLUSH_MIN_INTERVAL</span><span class="p">)</span> <span class="ow">and</span> <span class="ow">not</span> <span class="n">force</span><span class="p">:</span>
<span class="c1"># too soon after last flush.</span>
<span class="n">logger</span><span class="o">.</span><span class="n">log_warn</span><span class="p">(</span>
<span class="s2">&quot;Warning: Idmapper flush called more than &quot;</span>
<span class="s2">&quot;once in </span><span class="si">%s</span><span class="s2"> min interval. Check memory usage.&quot;</span> <span class="o">%</span> <span class="p">(</span><span class="n">AUTO_FLUSH_MIN_INTERVAL</span> <span class="o">/</span> <span class="mf">60.0</span><span class="p">)</span>
<span class="s2">&quot;Warning: Idmapper flush called more than once in </span><span class="si">%s</span><span class="s2"> min interval. Check memory usage.&quot;</span>
<span class="o">%</span> <span class="p">(</span><span class="n">AUTO_FLUSH_MIN_INTERVAL</span> <span class="o">/</span> <span class="mf">60.0</span><span class="p">)</span>
<span class="p">)</span>
<span class="k">return</span>