Andreas/evennia
1
0
Fork 0
mirror of https://github.com/evennia/evennia.git synced 2026-03-29 03:57:17 +02:00
Code Issues Projects Releases Packages Wiki Activity Actions
evennia/docs/1.0-dev/_modules/evennia/comms/managers.html
Griatch 3ba4299df6 Updated HTML docs
2022-01-09 17:24:06 +01:00

611 lines
No EOL
61 KiB
HTML
Raw Blame History

<!DOCTYPE html>
<html>
<head>
<meta charset="utf-8" />
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
<title>evennia.comms.managers &#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" />
<script id="documentation_options" data-url_root="../../../" src="../../../_static/documentation_options.js"></script>
<script src="../../../_static/jquery.js"></script>
<script src="../../../_static/underscore.js"></script>
<script src="../../../_static/doctools.js"></script>
<script src="../../../_static/language_data.js"></script>
<script async="async" src="https://cdnjs.cloudflare.com/ajax/libs/mathjax/2.7.7/latest.js?config=TeX-AMS-MML_HTMLorMML"></script>
<script type="text/x-mathjax-config">MathJax.Hub.Config({"tex2jax": {"processClass": "tex2jax_process|mathjax_process|math|output_area"}})</script>
<link rel="shortcut icon" href="../../../_static/favicon.ico"/>
<link rel="index" title="Index" href="../../../genindex.html" />
<link rel="search" title="Search" href="../../../search.html" />
</head><body>
<div class="related" role="navigation" aria-label="related navigation">
<h3>Navigation</h3>
<ul>
<li class="right" style="margin-right: 10px">
<a href="../../../genindex.html" title="General Index"
accesskey="I">index</a></li>
<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-1"><a href="../../index.html" >Module code</a> &#187;</li>
<li class="nav-item nav-item-2"><a href="../../evennia.html" accesskey="U">evennia</a> &#187;</li>
<li class="nav-item nav-item-this"><a href="">evennia.comms.managers</a></li>
</ul>
<div class="develop">develop branch</div>
</div>
<div class="document">
<div class="documentwrapper">
<div class="bodywrapper">
<div class="body" role="main">
<h1>Source code for evennia.comms.managers</h1><div class="highlight"><pre>
<span></span><span class="sd">&quot;&quot;&quot;</span>
<span class="sd">These managers define helper methods for accessing the database from</span>
<span class="sd">Comm system components.</span>
<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">django.db.models</span> <span class="kn">import</span> <span class="n">Q</span>
<span class="kn">from</span> <span class="nn">evennia.typeclasses.managers</span> <span class="kn">import</span> <span class="n">TypedObjectManager</span><span class="p">,</span> <span class="n">TypeclassManager</span>
<span class="kn">from</span> <span class="nn">evennia.server</span> <span class="kn">import</span> <span class="n">signals</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">make_iter</span><span class="p">,</span> <span class="n">class_from_module</span>
<span class="n">_GA</span> <span class="o">=</span> <span class="nb">object</span><span class="o">.</span><span class="fm">__getattribute__</span>
<span class="n">_AccountDB</span> <span class="o">=</span> <span class="kc">None</span>
<span class="n">_ObjectDB</span> <span class="o">=</span> <span class="kc">None</span>
<span class="n">_ChannelDB</span> <span class="o">=</span> <span class="kc">None</span>
<span class="n">_ScriptDB</span> <span class="o">=</span> <span class="kc">None</span>
<span class="n">_SESSIONS</span> <span class="o">=</span> <span class="kc">None</span>
<span class="c1"># error class</span>
<div class="viewcode-block" id="CommError"><a class="viewcode-back" href="../../../api/evennia.comms.managers.html#evennia.comms.comms.CommError">[docs]</a><span class="k">class</span> <span class="nc">CommError</span><span class="p">(</span><span class="ne">Exception</span><span class="p">):</span>
<span class="sd">&quot;&quot;&quot;</span>
<span class="sd"> Raised by comm system, to allow feedback to player when caught.</span>
<span class="sd"> &quot;&quot;&quot;</span>
<span class="k">pass</span></div>
<span class="c1">#</span>
<span class="c1"># helper functions</span>
<span class="c1">#</span>
<div class="viewcode-block" id="identify_object"><a class="viewcode-back" href="../../../api/evennia.comms.managers.html#evennia.comms.comms.identify_object">[docs]</a><span class="k">def</span> <span class="nf">identify_object</span><span class="p">(</span><span class="n">inp</span><span class="p">):</span>
<span class="sd">&quot;&quot;&quot;</span>
<span class="sd"> Helper function. Identifies if an object is an account or an object;</span>
<span class="sd"> return its database model</span>
<span class="sd"> Args:</span>
<span class="sd"> inp (any): Entity to be idtified.</span>
<span class="sd"> Returns:</span>
<span class="sd"> identified (tuple): This is a tuple with (`inp`, identifier)</span>
<span class="sd"> where `identifier` is one of &quot;account&quot;, &quot;object&quot;, &quot;channel&quot;,</span>
<span class="sd"> &quot;string&quot;, &quot;dbref&quot; or None.</span>
<span class="sd"> &quot;&quot;&quot;</span>
<span class="k">if</span> <span class="nb">hasattr</span><span class="p">(</span><span class="n">inp</span><span class="p">,</span> <span class="s2">&quot;__dbclass__&quot;</span><span class="p">):</span>
<span class="n">clsname</span> <span class="o">=</span> <span class="n">inp</span><span class="o">.</span><span class="n">__dbclass__</span><span class="o">.</span><span class="vm">__name__</span>
<span class="k">if</span> <span class="n">clsname</span> <span class="o">==</span> <span class="s2">&quot;AccountDB&quot;</span><span class="p">:</span>
<span class="k">return</span> <span class="n">inp</span><span class="p">,</span> <span class="s2">&quot;account&quot;</span>
<span class="k">elif</span> <span class="n">clsname</span> <span class="o">==</span> <span class="s2">&quot;ObjectDB&quot;</span><span class="p">:</span>
<span class="k">return</span> <span class="n">inp</span><span class="p">,</span> <span class="s2">&quot;object&quot;</span>
<span class="k">elif</span> <span class="n">clsname</span> <span class="o">==</span> <span class="s2">&quot;ChannelDB&quot;</span><span class="p">:</span>
<span class="k">return</span> <span class="n">inp</span><span class="p">,</span> <span class="s2">&quot;channel&quot;</span>
<span class="k">elif</span> <span class="n">clsname</span> <span class="o">==</span> <span class="s2">&quot;ScriptDB&quot;</span><span class="p">:</span>
<span class="k">return</span> <span class="n">inp</span><span class="p">,</span> <span class="s2">&quot;script&quot;</span>
<span class="k">if</span> <span class="nb">isinstance</span><span class="p">(</span><span class="n">inp</span><span class="p">,</span> <span class="nb">str</span><span class="p">):</span>
<span class="k">return</span> <span class="n">inp</span><span class="p">,</span> <span class="s2">&quot;string&quot;</span>
<span class="k">elif</span> <span class="n">dbref</span><span class="p">(</span><span class="n">inp</span><span class="p">):</span>
<span class="k">return</span> <span class="n">dbref</span><span class="p">(</span><span class="n">inp</span><span class="p">),</span> <span class="s2">&quot;dbref&quot;</span>
<span class="k">else</span><span class="p">:</span>
<span class="k">return</span> <span class="n">inp</span><span class="p">,</span> <span class="kc">None</span></div>
<div class="viewcode-block" id="to_object"><a class="viewcode-back" href="../../../api/evennia.comms.managers.html#evennia.comms.comms.to_object">[docs]</a><span class="k">def</span> <span class="nf">to_object</span><span class="p">(</span><span class="n">inp</span><span class="p">,</span> <span class="n">objtype</span><span class="o">=</span><span class="s2">&quot;account&quot;</span><span class="p">):</span>
<span class="sd">&quot;&quot;&quot;</span>
<span class="sd"> Locates the object related to the given accountname or channel key.</span>
<span class="sd"> If input was already the correct object, return it.</span>
<span class="sd"> Args:</span>
<span class="sd"> inp (any): The input object/string</span>
<span class="sd"> objtype (str): Either &#39;account&#39; or &#39;channel&#39;.</span>
<span class="sd"> Returns:</span>
<span class="sd"> obj (object): The correct object related to `inp`.</span>
<span class="sd"> &quot;&quot;&quot;</span>
<span class="n">obj</span><span class="p">,</span> <span class="n">typ</span> <span class="o">=</span> <span class="n">identify_object</span><span class="p">(</span><span class="n">inp</span><span class="p">)</span>
<span class="k">if</span> <span class="n">typ</span> <span class="o">==</span> <span class="n">objtype</span><span class="p">:</span>
<span class="k">return</span> <span class="n">obj</span>
<span class="k">if</span> <span class="n">objtype</span> <span class="o">==</span> <span class="s2">&quot;account&quot;</span><span class="p">:</span>
<span class="k">if</span> <span class="n">typ</span> <span class="o">==</span> <span class="s2">&quot;object&quot;</span><span class="p">:</span>
<span class="k">return</span> <span class="n">obj</span><span class="o">.</span><span class="n">account</span>
<span class="k">if</span> <span class="n">typ</span> <span class="o">==</span> <span class="s2">&quot;string&quot;</span><span class="p">:</span>
<span class="k">return</span> <span class="n">_AccountDB</span><span class="o">.</span><span class="n">objects</span><span class="o">.</span><span class="n">get</span><span class="p">(</span><span class="n">user_username__iexact</span><span class="o">=</span><span class="n">obj</span><span class="p">)</span>
<span class="k">if</span> <span class="n">typ</span> <span class="o">==</span> <span class="s2">&quot;dbref&quot;</span><span class="p">:</span>
<span class="k">return</span> <span class="n">_AccountDB</span><span class="o">.</span><span class="n">objects</span><span class="o">.</span><span class="n">get</span><span class="p">(</span><span class="nb">id</span><span class="o">=</span><span class="n">obj</span><span class="p">)</span>
<span class="n">logger</span><span class="o">.</span><span class="n">log_err</span><span class="p">(</span><span class="s2">&quot;</span><span class="si">%s</span><span class="s2"> </span><span class="si">%s</span><span class="s2"> </span><span class="si">%s</span><span class="s2"> </span><span class="si">%s</span><span class="s2"> </span><span class="si">%s</span><span class="s2">&quot;</span> <span class="o">%</span> <span class="p">(</span><span class="n">objtype</span><span class="p">,</span> <span class="n">inp</span><span class="p">,</span> <span class="n">obj</span><span class="p">,</span> <span class="n">typ</span><span class="p">,</span> <span class="nb">type</span><span class="p">(</span><span class="n">inp</span><span class="p">)))</span>
<span class="k">raise</span> <span class="n">CommError</span><span class="p">()</span>
<span class="k">elif</span> <span class="n">objtype</span> <span class="o">==</span> <span class="s2">&quot;object&quot;</span><span class="p">:</span>
<span class="k">if</span> <span class="n">typ</span> <span class="o">==</span> <span class="s2">&quot;account&quot;</span><span class="p">:</span>
<span class="k">return</span> <span class="n">obj</span><span class="o">.</span><span class="n">obj</span>
<span class="k">if</span> <span class="n">typ</span> <span class="o">==</span> <span class="s2">&quot;string&quot;</span><span class="p">:</span>
<span class="k">return</span> <span class="n">_ObjectDB</span><span class="o">.</span><span class="n">objects</span><span class="o">.</span><span class="n">get</span><span class="p">(</span><span class="n">db_key__iexact</span><span class="o">=</span><span class="n">obj</span><span class="p">)</span>
<span class="k">if</span> <span class="n">typ</span> <span class="o">==</span> <span class="s2">&quot;dbref&quot;</span><span class="p">:</span>
<span class="k">return</span> <span class="n">_ObjectDB</span><span class="o">.</span><span class="n">objects</span><span class="o">.</span><span class="n">get</span><span class="p">(</span><span class="nb">id</span><span class="o">=</span><span class="n">obj</span><span class="p">)</span>
<span class="n">logger</span><span class="o">.</span><span class="n">log_err</span><span class="p">(</span><span class="s2">&quot;</span><span class="si">%s</span><span class="s2"> </span><span class="si">%s</span><span class="s2"> </span><span class="si">%s</span><span class="s2"> </span><span class="si">%s</span><span class="s2"> </span><span class="si">%s</span><span class="s2">&quot;</span> <span class="o">%</span> <span class="p">(</span><span class="n">objtype</span><span class="p">,</span> <span class="n">inp</span><span class="p">,</span> <span class="n">obj</span><span class="p">,</span> <span class="n">typ</span><span class="p">,</span> <span class="nb">type</span><span class="p">(</span><span class="n">inp</span><span class="p">)))</span>
<span class="k">raise</span> <span class="n">CommError</span><span class="p">()</span>
<span class="k">elif</span> <span class="n">objtype</span> <span class="o">==</span> <span class="s2">&quot;channel&quot;</span><span class="p">:</span>
<span class="k">if</span> <span class="n">typ</span> <span class="o">==</span> <span class="s2">&quot;string&quot;</span><span class="p">:</span>
<span class="k">return</span> <span class="n">_ChannelDB</span><span class="o">.</span><span class="n">objects</span><span class="o">.</span><span class="n">get</span><span class="p">(</span><span class="n">db_key__iexact</span><span class="o">=</span><span class="n">obj</span><span class="p">)</span>
<span class="k">if</span> <span class="n">typ</span> <span class="o">==</span> <span class="s2">&quot;dbref&quot;</span><span class="p">:</span>
<span class="k">return</span> <span class="n">_ChannelDB</span><span class="o">.</span><span class="n">objects</span><span class="o">.</span><span class="n">get</span><span class="p">(</span><span class="nb">id</span><span class="o">=</span><span class="n">obj</span><span class="p">)</span>
<span class="n">logger</span><span class="o">.</span><span class="n">log_err</span><span class="p">(</span><span class="s2">&quot;</span><span class="si">%s</span><span class="s2"> </span><span class="si">%s</span><span class="s2"> </span><span class="si">%s</span><span class="s2"> </span><span class="si">%s</span><span class="s2"> </span><span class="si">%s</span><span class="s2">&quot;</span> <span class="o">%</span> <span class="p">(</span><span class="n">objtype</span><span class="p">,</span> <span class="n">inp</span><span class="p">,</span> <span class="n">obj</span><span class="p">,</span> <span class="n">typ</span><span class="p">,</span> <span class="nb">type</span><span class="p">(</span><span class="n">inp</span><span class="p">)))</span>
<span class="k">raise</span> <span class="n">CommError</span><span class="p">()</span>
<span class="k">elif</span> <span class="n">objtype</span> <span class="o">==</span> <span class="s2">&quot;script&quot;</span><span class="p">:</span>
<span class="k">if</span> <span class="n">typ</span> <span class="o">==</span> <span class="s2">&quot;string&quot;</span><span class="p">:</span>
<span class="k">return</span> <span class="n">_ScriptDB</span><span class="o">.</span><span class="n">objects</span><span class="o">.</span><span class="n">get</span><span class="p">(</span><span class="n">db_key__iexact</span><span class="o">=</span><span class="n">obj</span><span class="p">)</span>
<span class="k">if</span> <span class="n">typ</span> <span class="o">==</span> <span class="s2">&quot;dbref&quot;</span><span class="p">:</span>
<span class="k">return</span> <span class="n">_ScriptDB</span><span class="o">.</span><span class="n">objects</span><span class="o">.</span><span class="n">get</span><span class="p">(</span><span class="nb">id</span><span class="o">=</span><span class="n">obj</span><span class="p">)</span>
<span class="n">logger</span><span class="o">.</span><span class="n">log_err</span><span class="p">(</span><span class="s2">&quot;</span><span class="si">%s</span><span class="s2"> </span><span class="si">%s</span><span class="s2"> </span><span class="si">%s</span><span class="s2"> </span><span class="si">%s</span><span class="s2"> </span><span class="si">%s</span><span class="s2">&quot;</span> <span class="o">%</span> <span class="p">(</span><span class="n">objtype</span><span class="p">,</span> <span class="n">inp</span><span class="p">,</span> <span class="n">obj</span><span class="p">,</span> <span class="n">typ</span><span class="p">,</span> <span class="nb">type</span><span class="p">(</span><span class="n">inp</span><span class="p">)))</span>
<span class="k">raise</span> <span class="n">CommError</span><span class="p">()</span>
<span class="c1"># an unknown</span>
<span class="k">return</span> <span class="kc">None</span></div>
<span class="c1">#</span>
<span class="c1"># Msg manager</span>
<span class="c1">#</span>
<div class="viewcode-block" id="MsgManager"><a class="viewcode-back" href="../../../api/evennia.comms.managers.html#evennia.comms.comms.MsgManager">[docs]</a><span class="k">class</span> <span class="nc">MsgManager</span><span class="p">(</span><span class="n">TypedObjectManager</span><span class="p">):</span>
<span class="sd">&quot;&quot;&quot;</span>
<span class="sd"> This MsgManager implements methods for searching and manipulating</span>
<span class="sd"> Messages directly from the database.</span>
<span class="sd"> These methods will all return database objects (or QuerySets)</span>
<span class="sd"> directly.</span>
<span class="sd"> A Message represents one unit of communication, be it over a</span>
<span class="sd"> Channel or via some form of in-game mail system. Like an e-mail,</span>
<span class="sd"> it always has a sender and can have any number of receivers (some</span>
<span class="sd"> of which may be Channels).</span>
<span class="sd"> &quot;&quot;&quot;</span>
<div class="viewcode-block" id="MsgManager.identify_object"><a class="viewcode-back" href="../../../api/evennia.comms.managers.html#evennia.comms.comms.MsgManager.identify_object">[docs]</a> <span class="k">def</span> <span class="nf">identify_object</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">inp</span><span class="p">):</span>
<span class="sd">&quot;&quot;&quot;</span>
<span class="sd"> Wrapper to identify_object if accessing via the manager directly.</span>
<span class="sd"> Args:</span>
<span class="sd"> inp (any): Entity to be idtified.</span>
<span class="sd"> Returns:</span>
<span class="sd"> identified (tuple): This is a tuple with (`inp`, identifier)</span>
<span class="sd"> where `identifier` is one of &quot;account&quot;, &quot;object&quot;, &quot;channel&quot;,</span>
<span class="sd"> &quot;string&quot;, &quot;dbref&quot; or None.</span>
<span class="sd"> &quot;&quot;&quot;</span>
<span class="k">return</span> <span class="n">identify_object</span><span class="p">(</span><span class="n">inp</span><span class="p">)</span></div>
<div class="viewcode-block" id="MsgManager.get_message_by_id"><a class="viewcode-back" href="../../../api/evennia.comms.managers.html#evennia.comms.comms.MsgManager.get_message_by_id">[docs]</a> <span class="k">def</span> <span class="nf">get_message_by_id</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">idnum</span><span class="p">):</span>
<span class="sd">&quot;&quot;&quot;</span>
<span class="sd"> Retrieve message by its id.</span>
<span class="sd"> Args:</span>
<span class="sd"> idnum (int or str): The dbref to retrieve.</span>
<span class="sd"> Returns:</span>
<span class="sd"> message (Msg): The message.</span>
<span class="sd"> &quot;&quot;&quot;</span>
<span class="k">try</span><span class="p">:</span>
<span class="k">return</span> <span class="bp">self</span><span class="o">.</span><span class="n">get</span><span class="p">(</span><span class="nb">id</span><span class="o">=</span><span class="bp">self</span><span class="o">.</span><span class="n">dbref</span><span class="p">(</span><span class="n">idnum</span><span class="p">,</span> <span class="n">reqhash</span><span class="o">=</span><span class="kc">False</span><span class="p">))</span>
<span class="k">except</span> <span class="ne">Exception</span><span class="p">:</span>
<span class="k">return</span> <span class="kc">None</span></div>
<div class="viewcode-block" id="MsgManager.get_messages_by_sender"><a class="viewcode-back" href="../../../api/evennia.comms.managers.html#evennia.comms.comms.MsgManager.get_messages_by_sender">[docs]</a> <span class="k">def</span> <span class="nf">get_messages_by_sender</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">sender</span><span class="p">):</span>
<span class="sd">&quot;&quot;&quot;</span>
<span class="sd"> Get all messages sent by one entity - this could be either a</span>
<span class="sd"> account or an object</span>
<span class="sd"> Args:</span>
<span class="sd"> sender (Account or Object): The sender of the message.</span>
<span class="sd"> Returns:</span>
<span class="sd"> QuerySet: Matching messages.</span>
<span class="sd"> Raises:</span>
<span class="sd"> CommError: For incorrect sender types.</span>
<span class="sd"> &quot;&quot;&quot;</span>
<span class="n">obj</span><span class="p">,</span> <span class="n">typ</span> <span class="o">=</span> <span class="n">identify_object</span><span class="p">(</span><span class="n">sender</span><span class="p">)</span>
<span class="k">if</span> <span class="n">typ</span> <span class="o">==</span> <span class="s2">&quot;account&quot;</span><span class="p">:</span>
<span class="k">return</span> <span class="bp">self</span><span class="o">.</span><span class="n">filter</span><span class="p">(</span><span class="n">db_sender_accounts</span><span class="o">=</span><span class="n">obj</span><span class="p">)</span><span class="o">.</span><span class="n">exclude</span><span class="p">(</span><span class="n">db_hide_from_accounts</span><span class="o">=</span><span class="n">obj</span><span class="p">)</span>
<span class="k">elif</span> <span class="n">typ</span> <span class="o">==</span> <span class="s2">&quot;object&quot;</span><span class="p">:</span>
<span class="k">return</span> <span class="bp">self</span><span class="o">.</span><span class="n">filter</span><span class="p">(</span><span class="n">db_sender_objects</span><span class="o">=</span><span class="n">obj</span><span class="p">)</span><span class="o">.</span><span class="n">exclude</span><span class="p">(</span><span class="n">db_hide_from_objects</span><span class="o">=</span><span class="n">obj</span><span class="p">)</span>
<span class="k">elif</span> <span class="n">typ</span> <span class="o">==</span> <span class="s2">&quot;script&quot;</span><span class="p">:</span>
<span class="k">return</span> <span class="bp">self</span><span class="o">.</span><span class="n">filter</span><span class="p">(</span><span class="n">db_sender_scripts</span><span class="o">=</span><span class="n">obj</span><span class="p">)</span>
<span class="k">else</span><span class="p">:</span>
<span class="k">raise</span> <span class="n">CommError</span></div>
<div class="viewcode-block" id="MsgManager.get_messages_by_receiver"><a class="viewcode-back" href="../../../api/evennia.comms.managers.html#evennia.comms.comms.MsgManager.get_messages_by_receiver">[docs]</a> <span class="k">def</span> <span class="nf">get_messages_by_receiver</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">recipient</span><span class="p">):</span>
<span class="sd">&quot;&quot;&quot;</span>
<span class="sd"> Get all messages sent to one given recipient.</span>
<span class="sd"> Args:</span>
<span class="sd"> recipient (Object, Account or Channel): The recipient of the messages to search for.</span>
<span class="sd"> Returns:</span>
<span class="sd"> Queryset: Matching messages.</span>
<span class="sd"> Raises:</span>
<span class="sd"> CommError: If the `recipient` is not of a valid type.</span>
<span class="sd"> &quot;&quot;&quot;</span>
<span class="n">obj</span><span class="p">,</span> <span class="n">typ</span> <span class="o">=</span> <span class="n">identify_object</span><span class="p">(</span><span class="n">recipient</span><span class="p">)</span>
<span class="k">if</span> <span class="n">typ</span> <span class="o">==</span> <span class="s2">&quot;account&quot;</span><span class="p">:</span>
<span class="k">return</span> <span class="bp">self</span><span class="o">.</span><span class="n">filter</span><span class="p">(</span><span class="n">db_receivers_accounts</span><span class="o">=</span><span class="n">obj</span><span class="p">)</span><span class="o">.</span><span class="n">exclude</span><span class="p">(</span><span class="n">db_hide_from_accounts</span><span class="o">=</span><span class="n">obj</span><span class="p">)</span>
<span class="k">elif</span> <span class="n">typ</span> <span class="o">==</span> <span class="s2">&quot;object&quot;</span><span class="p">:</span>
<span class="k">return</span> <span class="bp">self</span><span class="o">.</span><span class="n">filter</span><span class="p">(</span><span class="n">db_receivers_objects</span><span class="o">=</span><span class="n">obj</span><span class="p">)</span><span class="o">.</span><span class="n">exclude</span><span class="p">(</span><span class="n">db_hide_from_objects</span><span class="o">=</span><span class="n">obj</span><span class="p">)</span>
<span class="k">elif</span> <span class="n">typ</span> <span class="o">==</span> <span class="s1">&#39;script&#39;</span><span class="p">:</span>
<span class="k">return</span> <span class="bp">self</span><span class="o">.</span><span class="n">filter</span><span class="p">(</span><span class="n">db_receivers_scripts</span><span class="o">=</span><span class="n">obj</span><span class="p">)</span>
<span class="k">else</span><span class="p">:</span>
<span class="k">raise</span> <span class="n">CommError</span></div>
<div class="viewcode-block" id="MsgManager.search_message"><a class="viewcode-back" href="../../../api/evennia.comms.managers.html#evennia.comms.comms.MsgManager.search_message">[docs]</a> <span class="k">def</span> <span class="nf">search_message</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">sender</span><span class="o">=</span><span class="kc">None</span><span class="p">,</span> <span class="n">receiver</span><span class="o">=</span><span class="kc">None</span><span class="p">,</span> <span class="n">freetext</span><span class="o">=</span><span class="kc">None</span><span class="p">,</span> <span class="n">dbref</span><span class="o">=</span><span class="kc">None</span><span class="p">):</span>
<span class="sd">&quot;&quot;&quot;</span>
<span class="sd"> Search the message database for particular messages. At least</span>
<span class="sd"> one of the arguments must be given to do a search.</span>
<span class="sd"> Args:</span>
<span class="sd"> sender (Object, Account or Script, optional): Get messages sent by a particular sender.</span>
<span class="sd"> receiver (Object, Account or Channel, optional): Get messages</span>
<span class="sd"> received by a certain account,object or channel</span>
<span class="sd"> freetext (str): Search for a text string in a message. NOTE:</span>
<span class="sd"> This can potentially be slow, so make sure to supply one of</span>
<span class="sd"> the other arguments to limit the search.</span>
<span class="sd"> dbref (int): The exact database id of the message. This will override</span>
<span class="sd"> all other search criteria since it&#39;s unique and</span>
<span class="sd"> always gives only one match.</span>
<span class="sd"> Returns:</span>
<span class="sd"> Queryset: Iterable with 0, 1 or more matches.</span>
<span class="sd"> &quot;&quot;&quot;</span>
<span class="c1"># unique msg id</span>
<span class="k">if</span> <span class="n">dbref</span><span class="p">:</span>
<span class="k">return</span> <span class="bp">self</span><span class="o">.</span><span class="n">objects</span><span class="o">.</span><span class="n">filter</span><span class="p">(</span><span class="nb">id</span><span class="o">=</span><span class="n">dbref</span><span class="p">)</span>
<span class="c1"># We use Q objects to gradually build up the query - this way we only</span>
<span class="c1"># need to do one database lookup at the end rather than gradually</span>
<span class="c1"># refining with multiple filter:s. Django Note: Q objects can be</span>
<span class="c1"># combined with &amp; and | (=AND,OR). ~ negates the queryset</span>
<span class="c1"># filter by sender (we need __pk to avoid an error with empty Q() objects)</span>
<span class="n">sender</span><span class="p">,</span> <span class="n">styp</span> <span class="o">=</span> <span class="n">identify_object</span><span class="p">(</span><span class="n">sender</span><span class="p">)</span>
<span class="k">if</span> <span class="n">sender</span><span class="p">:</span>
<span class="n">spk</span> <span class="o">=</span> <span class="n">sender</span><span class="o">.</span><span class="n">pk</span>
<span class="k">if</span> <span class="n">styp</span> <span class="o">==</span> <span class="s2">&quot;account&quot;</span><span class="p">:</span>
<span class="n">sender_restrict</span> <span class="o">=</span> <span class="n">Q</span><span class="p">(</span><span class="n">db_sender_accounts__pk</span><span class="o">=</span><span class="n">spk</span><span class="p">)</span> <span class="o">&amp;</span> <span class="o">~</span><span class="n">Q</span><span class="p">(</span><span class="n">db_hide_from_accounts__pk</span><span class="o">=</span><span class="n">spk</span><span class="p">)</span>
<span class="k">elif</span> <span class="n">styp</span> <span class="o">==</span> <span class="s2">&quot;object&quot;</span><span class="p">:</span>
<span class="n">sender_restrict</span> <span class="o">=</span> <span class="n">Q</span><span class="p">(</span><span class="n">db_sender_objects__pk</span><span class="o">=</span><span class="n">spk</span><span class="p">)</span> <span class="o">&amp;</span> <span class="o">~</span><span class="n">Q</span><span class="p">(</span><span class="n">db_hide_from_objects__pk</span><span class="o">=</span><span class="n">spk</span><span class="p">)</span>
<span class="k">elif</span> <span class="n">styp</span> <span class="o">==</span> <span class="s1">&#39;script&#39;</span><span class="p">:</span>
<span class="n">sender_restrict</span> <span class="o">=</span> <span class="n">Q</span><span class="p">(</span><span class="n">db_sender_scripts__pk</span><span class="o">=</span><span class="n">spk</span><span class="p">)</span>
<span class="k">else</span><span class="p">:</span>
<span class="n">sender_restrict</span> <span class="o">=</span> <span class="n">Q</span><span class="p">()</span>
<span class="c1"># filter by receiver</span>
<span class="n">receiver</span><span class="p">,</span> <span class="n">rtyp</span> <span class="o">=</span> <span class="n">identify_object</span><span class="p">(</span><span class="n">receiver</span><span class="p">)</span>
<span class="k">if</span> <span class="n">receiver</span><span class="p">:</span>
<span class="n">rpk</span> <span class="o">=</span> <span class="n">receiver</span><span class="o">.</span><span class="n">pk</span>
<span class="k">if</span> <span class="n">rtyp</span> <span class="o">==</span> <span class="s2">&quot;account&quot;</span><span class="p">:</span>
<span class="n">receiver_restrict</span> <span class="o">=</span> <span class="p">(</span>
<span class="n">Q</span><span class="p">(</span><span class="n">db_receivers_accounts__pk</span><span class="o">=</span><span class="n">rpk</span><span class="p">)</span> <span class="o">&amp;</span> <span class="o">~</span><span class="n">Q</span><span class="p">(</span><span class="n">db_hide_from_accounts__pk</span><span class="o">=</span><span class="n">rpk</span><span class="p">))</span>
<span class="k">elif</span> <span class="n">rtyp</span> <span class="o">==</span> <span class="s2">&quot;object&quot;</span><span class="p">:</span>
<span class="n">receiver_restrict</span> <span class="o">=</span> <span class="n">Q</span><span class="p">(</span><span class="n">db_receivers_objects__pk</span><span class="o">=</span><span class="n">rpk</span><span class="p">)</span> <span class="o">&amp;</span> <span class="o">~</span><span class="n">Q</span><span class="p">(</span><span class="n">db_hide_from_objects__pk</span><span class="o">=</span><span class="n">rpk</span><span class="p">)</span>
<span class="k">elif</span> <span class="n">rtyp</span> <span class="o">==</span> <span class="s1">&#39;script&#39;</span><span class="p">:</span>
<span class="n">receiver_restrict</span> <span class="o">=</span> <span class="n">Q</span><span class="p">(</span><span class="n">db_receivers_scripts__pk</span><span class="o">=</span><span class="n">rpk</span><span class="p">)</span>
<span class="k">elif</span> <span class="n">rtyp</span> <span class="o">==</span> <span class="s2">&quot;channel&quot;</span><span class="p">:</span>
<span class="k">raise</span> <span class="ne">DeprecationWarning</span><span class="p">(</span>
<span class="s2">&quot;Msg.objects.search don&#39;t accept channel recipients since &quot;</span>
<span class="s2">&quot;Channels no longer accepts Msg objects.&quot;</span><span class="p">)</span>
<span class="k">else</span><span class="p">:</span>
<span class="n">receiver_restrict</span> <span class="o">=</span> <span class="n">Q</span><span class="p">()</span>
<span class="c1"># filter by full text</span>
<span class="k">if</span> <span class="n">freetext</span><span class="p">:</span>
<span class="n">fulltext_restrict</span> <span class="o">=</span> <span class="n">Q</span><span class="p">(</span><span class="n">db_header__icontains</span><span class="o">=</span><span class="n">freetext</span><span class="p">)</span> <span class="o">|</span> <span class="n">Q</span><span class="p">(</span><span class="n">db_message__icontains</span><span class="o">=</span><span class="n">freetext</span><span class="p">)</span>
<span class="k">else</span><span class="p">:</span>
<span class="n">fulltext_restrict</span> <span class="o">=</span> <span class="n">Q</span><span class="p">()</span>
<span class="c1"># execute the query</span>
<span class="k">return</span> <span class="bp">self</span><span class="o">.</span><span class="n">filter</span><span class="p">(</span><span class="n">sender_restrict</span> <span class="o">&amp;</span> <span class="n">receiver_restrict</span> <span class="o">&amp;</span> <span class="n">fulltext_restrict</span><span class="p">)</span></div>
<span class="c1"># back-compatibility alias</span>
<span class="n">message_search</span> <span class="o">=</span> <span class="n">search_message</span>
<div class="viewcode-block" id="MsgManager.create_message"><a class="viewcode-back" href="../../../api/evennia.comms.managers.html#evennia.comms.comms.MsgManager.create_message">[docs]</a> <span class="k">def</span> <span class="nf">create_message</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">senderobj</span><span class="p">,</span> <span class="n">message</span><span class="p">,</span> <span class="n">receivers</span><span class="o">=</span><span class="kc">None</span><span class="p">,</span> <span class="n">locks</span><span class="o">=</span><span class="kc">None</span><span class="p">,</span> <span class="n">tags</span><span class="o">=</span><span class="kc">None</span><span class="p">,</span>
<span class="n">header</span><span class="o">=</span><span class="kc">None</span><span class="p">,</span> <span class="o">**</span><span class="n">kwargs</span><span class="p">):</span>
<span class="sd">&quot;&quot;&quot;</span>
<span class="sd"> Create a new communication Msg. Msgs represent a unit of</span>
<span class="sd"> database-persistent communication between entites.</span>
<span class="sd"> Args:</span>
<span class="sd"> senderobj (Object, Account, Script, str or list): The entity (or</span>
<span class="sd"> entities) sending the Msg. If a `str`, this is the id-string</span>
<span class="sd"> for an external sender type.</span>
<span class="sd"> message (str): Text with the message. Eventual headers, titles</span>
<span class="sd"> etc should all be included in this text string. Formatting</span>
<span class="sd"> will be retained.</span>
<span class="sd"> receivers (Object, Account, Script, str or list): An Account/Object to send</span>
<span class="sd"> to, or a list of them. If a string, it&#39;s an identifier for an external</span>
<span class="sd"> receiver.</span>
<span class="sd"> locks (str): Lock definition string.</span>
<span class="sd"> tags (list): A list of tags or tuples `(tag, category)`.</span>
<span class="sd"> header (str): Mime-type or other optional information for the message</span>
<span class="sd"> Notes:</span>
<span class="sd"> The Comm system is created to be very open-ended, so it&#39;s fully</span>
<span class="sd"> possible to let a message both go several receivers at the same time,</span>
<span class="sd"> it&#39;s up to the command definitions to limit this as desired.</span>
<span class="sd"> &quot;&quot;&quot;</span>
<span class="k">if</span> <span class="s1">&#39;channels&#39;</span> <span class="ow">in</span> <span class="n">kwargs</span><span class="p">:</span>
<span class="k">raise</span> <span class="ne">DeprecationWarning</span><span class="p">(</span>
<span class="s2">&quot;create_message() does not accept &#39;channel&#39; kwarg anymore &quot;</span>
<span class="s2">&quot;- channels no longer accept Msg objects.&quot;</span>
<span class="p">)</span>
<span class="k">if</span> <span class="ow">not</span> <span class="n">message</span><span class="p">:</span>
<span class="c1"># we don&#39;t allow empty messages.</span>
<span class="k">return</span> <span class="kc">None</span>
<span class="n">new_message</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">model</span><span class="p">(</span><span class="n">db_message</span><span class="o">=</span><span class="n">message</span><span class="p">)</span>
<span class="n">new_message</span><span class="o">.</span><span class="n">save</span><span class="p">()</span>
<span class="k">for</span> <span class="n">sender</span> <span class="ow">in</span> <span class="n">make_iter</span><span class="p">(</span><span class="n">senderobj</span><span class="p">):</span>
<span class="n">new_message</span><span class="o">.</span><span class="n">senders</span> <span class="o">=</span> <span class="n">sender</span>
<span class="n">new_message</span><span class="o">.</span><span class="n">header</span> <span class="o">=</span> <span class="n">header</span>
<span class="k">for</span> <span class="n">receiver</span> <span class="ow">in</span> <span class="n">make_iter</span><span class="p">(</span><span class="n">receivers</span><span class="p">):</span>
<span class="n">new_message</span><span class="o">.</span><span class="n">receivers</span> <span class="o">=</span> <span class="n">receiver</span>
<span class="k">if</span> <span class="n">locks</span><span class="p">:</span>
<span class="n">new_message</span><span class="o">.</span><span class="n">locks</span><span class="o">.</span><span class="n">add</span><span class="p">(</span><span class="n">locks</span><span class="p">)</span>
<span class="k">if</span> <span class="n">tags</span><span class="p">:</span>
<span class="n">new_message</span><span class="o">.</span><span class="n">tags</span><span class="o">.</span><span class="n">batch_add</span><span class="p">(</span><span class="o">*</span><span class="n">tags</span><span class="p">)</span>
<span class="n">new_message</span><span class="o">.</span><span class="n">save</span><span class="p">()</span>
<span class="k">return</span> <span class="n">new_message</span></div></div>
<span class="c1">#</span>
<span class="c1"># Channel manager</span>
<span class="c1">#</span>
<div class="viewcode-block" id="ChannelDBManager"><a class="viewcode-back" href="../../../api/evennia.comms.managers.html#evennia.comms.comms.ChannelDBManager">[docs]</a><span class="k">class</span> <span class="nc">ChannelDBManager</span><span class="p">(</span><span class="n">TypedObjectManager</span><span class="p">):</span>
<span class="sd">&quot;&quot;&quot;</span>
<span class="sd"> This ChannelManager implements methods for searching and</span>
<span class="sd"> manipulating Channels directly from the database.</span>
<span class="sd"> These methods will all return database objects (or QuerySets)</span>
<span class="sd"> directly.</span>
<span class="sd"> A Channel is an in-game venue for communication. It&#39;s essentially</span>
<span class="sd"> representation of a re-sender: Users sends Messages to the</span>
<span class="sd"> Channel, and the Channel re-sends those messages to all users</span>
<span class="sd"> subscribed to the Channel.</span>
<span class="sd"> &quot;&quot;&quot;</span>
<div class="viewcode-block" id="ChannelDBManager.get_all_channels"><a class="viewcode-back" href="../../../api/evennia.comms.managers.html#evennia.comms.comms.ChannelDBManager.get_all_channels">[docs]</a> <span class="k">def</span> <span class="nf">get_all_channels</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
<span class="sd">&quot;&quot;&quot;</span>
<span class="sd"> Get all channels.</span>
<span class="sd"> Returns:</span>
<span class="sd"> channels (list): All channels in game.</span>
<span class="sd"> &quot;&quot;&quot;</span>
<span class="k">return</span> <span class="bp">self</span><span class="o">.</span><span class="n">all</span><span class="p">()</span></div>
<div class="viewcode-block" id="ChannelDBManager.get_channel"><a class="viewcode-back" href="../../../api/evennia.comms.managers.html#evennia.comms.comms.ChannelDBManager.get_channel">[docs]</a> <span class="k">def</span> <span class="nf">get_channel</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">channelkey</span><span class="p">):</span>
<span class="sd">&quot;&quot;&quot;</span>
<span class="sd"> Return the channel object if given its key.</span>
<span class="sd"> Also searches its aliases.</span>
<span class="sd"> Args:</span>
<span class="sd"> channelkey (str): Channel key to search for.</span>
<span class="sd"> Returns:</span>
<span class="sd"> channel (Channel or None): A channel match.</span>
<span class="sd"> &quot;&quot;&quot;</span>
<span class="n">dbref</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">dbref</span><span class="p">(</span><span class="n">channelkey</span><span class="p">)</span>
<span class="k">if</span> <span class="n">dbref</span><span class="p">:</span>
<span class="k">try</span><span class="p">:</span>
<span class="k">return</span> <span class="bp">self</span><span class="o">.</span><span class="n">get</span><span class="p">(</span><span class="nb">id</span><span class="o">=</span><span class="n">dbref</span><span class="p">)</span>
<span class="k">except</span> <span class="bp">self</span><span class="o">.</span><span class="n">model</span><span class="o">.</span><span class="n">DoesNotExist</span><span class="p">:</span>
<span class="k">pass</span>
<span class="n">results</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">filter</span><span class="p">(</span>
<span class="n">Q</span><span class="p">(</span><span class="n">db_key__iexact</span><span class="o">=</span><span class="n">channelkey</span><span class="p">)</span>
<span class="o">|</span> <span class="n">Q</span><span class="p">(</span><span class="n">db_tags__db_tagtype__iexact</span><span class="o">=</span><span class="s2">&quot;alias&quot;</span><span class="p">,</span> <span class="n">db_tags__db_key__iexact</span><span class="o">=</span><span class="n">channelkey</span><span class="p">)</span>
<span class="p">)</span><span class="o">.</span><span class="n">distinct</span><span class="p">()</span>
<span class="k">return</span> <span class="n">results</span><span class="p">[</span><span class="mi">0</span><span class="p">]</span> <span class="k">if</span> <span class="n">results</span> <span class="k">else</span> <span class="kc">None</span></div>
<div class="viewcode-block" id="ChannelDBManager.get_subscriptions"><a class="viewcode-back" href="../../../api/evennia.comms.managers.html#evennia.comms.comms.ChannelDBManager.get_subscriptions">[docs]</a> <span class="k">def</span> <span class="nf">get_subscriptions</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">subscriber</span><span class="p">):</span>
<span class="sd">&quot;&quot;&quot;</span>
<span class="sd"> Return all channels a given entity is subscribed to.</span>
<span class="sd"> Args:</span>
<span class="sd"> subscriber (Object or Account): The one subscribing.</span>
<span class="sd"> Returns:</span>
<span class="sd"> subscriptions (list): Channel subscribed to.</span>
<span class="sd"> &quot;&quot;&quot;</span>
<span class="n">clsname</span> <span class="o">=</span> <span class="n">subscriber</span><span class="o">.</span><span class="n">__dbclass__</span><span class="o">.</span><span class="vm">__name__</span>
<span class="k">if</span> <span class="n">clsname</span> <span class="o">==</span> <span class="s2">&quot;AccountDB&quot;</span><span class="p">:</span>
<span class="k">return</span> <span class="n">subscriber</span><span class="o">.</span><span class="n">account_subscription_set</span><span class="o">.</span><span class="n">all</span><span class="p">()</span>
<span class="k">if</span> <span class="n">clsname</span> <span class="o">==</span> <span class="s2">&quot;ObjectDB&quot;</span><span class="p">:</span>
<span class="k">return</span> <span class="n">subscriber</span><span class="o">.</span><span class="n">object_subscription_set</span><span class="o">.</span><span class="n">all</span><span class="p">()</span>
<span class="k">return</span> <span class="p">[]</span></div>
<div class="viewcode-block" id="ChannelDBManager.search_channel"><a class="viewcode-back" href="../../../api/evennia.comms.managers.html#evennia.comms.comms.ChannelDBManager.search_channel">[docs]</a> <span class="k">def</span> <span class="nf">search_channel</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">ostring</span><span class="p">,</span> <span class="n">exact</span><span class="o">=</span><span class="kc">True</span><span class="p">):</span>
<span class="sd">&quot;&quot;&quot;</span>
<span class="sd"> Search the channel database for a particular channel.</span>
<span class="sd"> Args:</span>
<span class="sd"> ostring (str): The key or database id of the channel.</span>
<span class="sd"> exact (bool, optional): Require an exact (but not</span>
<span class="sd"> case sensitive) match.</span>
<span class="sd"> Returns:</span>
<span class="sd"> Queryset: Iterable with 0, 1 or more matches.</span>
<span class="sd"> &quot;&quot;&quot;</span>
<span class="n">dbref</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">dbref</span><span class="p">(</span><span class="n">ostring</span><span class="p">)</span>
<span class="k">if</span> <span class="n">dbref</span><span class="p">:</span>
<span class="n">dbref_match</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">search_dbref</span><span class="p">(</span><span class="n">dbref</span><span class="p">)</span>
<span class="k">if</span> <span class="n">dbref_match</span><span class="p">:</span>
<span class="k">return</span> <span class="n">dbref_match</span>
<span class="k">if</span> <span class="n">exact</span><span class="p">:</span>
<span class="n">channels</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">filter</span><span class="p">(</span>
<span class="n">Q</span><span class="p">(</span><span class="n">db_key__iexact</span><span class="o">=</span><span class="n">ostring</span><span class="p">)</span>
<span class="o">|</span> <span class="n">Q</span><span class="p">(</span><span class="n">db_tags__db_tagtype__iexact</span><span class="o">=</span><span class="s2">&quot;alias&quot;</span><span class="p">,</span> <span class="n">db_tags__db_key__iexact</span><span class="o">=</span><span class="n">ostring</span><span class="p">)</span>
<span class="p">)</span><span class="o">.</span><span class="n">distinct</span><span class="p">()</span>
<span class="k">else</span><span class="p">:</span>
<span class="n">channels</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">filter</span><span class="p">(</span>
<span class="n">Q</span><span class="p">(</span><span class="n">db_key__icontains</span><span class="o">=</span><span class="n">ostring</span><span class="p">)</span>
<span class="o">|</span> <span class="n">Q</span><span class="p">(</span><span class="n">db_tags__db_tagtype__iexact</span><span class="o">=</span><span class="s2">&quot;alias&quot;</span><span class="p">,</span> <span class="n">db_tags__db_key__icontains</span><span class="o">=</span><span class="n">ostring</span><span class="p">)</span>
<span class="p">)</span><span class="o">.</span><span class="n">distinct</span><span class="p">()</span>
<span class="k">return</span> <span class="n">channels</span></div>
<div class="viewcode-block" id="ChannelDBManager.create_channel"><a class="viewcode-back" href="../../../api/evennia.comms.managers.html#evennia.comms.comms.ChannelDBManager.create_channel">[docs]</a> <span class="k">def</span> <span class="nf">create_channel</span><span class="p">(</span>
<span class="bp">self</span><span class="p">,</span> <span class="n">key</span><span class="p">,</span> <span class="n">aliases</span><span class="o">=</span><span class="kc">None</span><span class="p">,</span> <span class="n">desc</span><span class="o">=</span><span class="kc">None</span><span class="p">,</span> <span class="n">locks</span><span class="o">=</span><span class="kc">None</span><span class="p">,</span> <span class="n">keep_log</span><span class="o">=</span><span class="kc">True</span><span class="p">,</span> <span class="n">typeclass</span><span class="o">=</span><span class="kc">None</span><span class="p">,</span> <span class="n">tags</span><span class="o">=</span><span class="kc">None</span>
<span class="p">):</span>
<span class="sd">&quot;&quot;&quot;</span>
<span class="sd"> Create A communication Channel. A Channel serves as a central hub</span>
<span class="sd"> for distributing Msgs to groups of people without specifying the</span>
<span class="sd"> receivers explicitly. Instead accounts may &#39;connect&#39; to the channel</span>
<span class="sd"> and follow the flow of messages. By default the channel allows</span>
<span class="sd"> access to all old messages, but this can be turned off with the</span>
<span class="sd"> keep_log switch.</span>
<span class="sd"> Args:</span>
<span class="sd"> key (str): This must be unique.</span>
<span class="sd"> Keyword Args:</span>
<span class="sd"> aliases (list of str): List of alternative (likely shorter) keynames.</span>
<span class="sd"> desc (str): A description of the channel, for use in listings.</span>
<span class="sd"> locks (str): Lockstring.</span>
<span class="sd"> keep_log (bool): Log channel throughput.</span>
<span class="sd"> typeclass (str or class): The typeclass of the Channel (not</span>
<span class="sd"> often used).</span>
<span class="sd"> tags (list): A list of tags or tuples `(tag, category)`.</span>
<span class="sd"> Returns:</span>
<span class="sd"> channel (Channel): A newly created channel.</span>
<span class="sd"> &quot;&quot;&quot;</span>
<span class="n">typeclass</span> <span class="o">=</span> <span class="n">typeclass</span> <span class="k">if</span> <span class="n">typeclass</span> <span class="k">else</span> <span class="n">settings</span><span class="o">.</span><span class="n">BASE_CHANNEL_TYPECLASS</span>
<span class="k">if</span> <span class="nb">isinstance</span><span class="p">(</span><span class="n">typeclass</span><span class="p">,</span> <span class="nb">str</span><span class="p">):</span>
<span class="c1"># a path is given. Load the actual typeclass</span>
<span class="n">typeclass</span> <span class="o">=</span> <span class="n">class_from_module</span><span class="p">(</span><span class="n">typeclass</span><span class="p">,</span> <span class="n">settings</span><span class="o">.</span><span class="n">TYPECLASS_PATHS</span><span class="p">)</span>
<span class="c1"># create new instance</span>
<span class="n">new_channel</span> <span class="o">=</span> <span class="n">typeclass</span><span class="p">(</span><span class="n">db_key</span><span class="o">=</span><span class="n">key</span><span class="p">)</span>
<span class="c1"># store call signature for the signal</span>
<span class="n">new_channel</span><span class="o">.</span><span class="n">_createdict</span> <span class="o">=</span> <span class="nb">dict</span><span class="p">(</span>
<span class="n">key</span><span class="o">=</span><span class="n">key</span><span class="p">,</span> <span class="n">aliases</span><span class="o">=</span><span class="n">aliases</span><span class="p">,</span> <span class="n">desc</span><span class="o">=</span><span class="n">desc</span><span class="p">,</span> <span class="n">locks</span><span class="o">=</span><span class="n">locks</span><span class="p">,</span> <span class="n">keep_log</span><span class="o">=</span><span class="n">keep_log</span><span class="p">,</span> <span class="n">tags</span><span class="o">=</span><span class="n">tags</span>
<span class="p">)</span>
<span class="c1"># this will trigger the save signal which in turn calls the</span>
<span class="c1"># at_first_save hook on the typeclass, where the _createdict can be</span>
<span class="c1"># used.</span>
<span class="n">new_channel</span><span class="o">.</span><span class="n">save</span><span class="p">()</span>
<span class="n">signals</span><span class="o">.</span><span class="n">SIGNAL_CHANNEL_POST_CREATE</span><span class="o">.</span><span class="n">send</span><span class="p">(</span><span class="n">sender</span><span class="o">=</span><span class="n">new_channel</span><span class="p">)</span>
<span class="k">return</span> <span class="n">new_channel</span></div>
<span class="c1"># back-compatibility alias</span>
<span class="n">channel_search</span> <span class="o">=</span> <span class="n">search_channel</span></div>
<div class="viewcode-block" id="ChannelManager"><a class="viewcode-back" href="../../../api/evennia.comms.managers.html#evennia.comms.comms.ChannelManager">[docs]</a><span class="k">class</span> <span class="nc">ChannelManager</span><span class="p">(</span><span class="n">ChannelDBManager</span><span class="p">,</span> <span class="n">TypeclassManager</span><span class="p">):</span>
<span class="sd">&quot;&quot;&quot;</span>
<span class="sd"> Wrapper to group the typeclass manager to a consistent name.</span>
<span class="sd"> &quot;&quot;&quot;</span>
<span class="k">pass</span></div>
</pre></div>
<div class="clearer"></div>
</div>
</div>
</div>
<div class="sphinxsidebar" role="navigation" aria-label="main navigation">
<div class="sphinxsidebarwrapper">
<p class="logo"><a href="../../../index.html">
<img class="logo" src="../../../_static/evennia_logo.png" alt="Logo"/>
</a></p>
<div id="searchbox" style="display: none" role="search">
<h3 id="searchlabel">Quick search</h3>
<div class="searchformwrapper">
<form class="search" action="../../../search.html" method="get">
<input type="text" name="q" aria-labelledby="searchlabel" />
<input type="submit" value="Go" />
</form>
</div>
</div>
<script>$('#searchbox').show(0);</script><h3>Links</h3>
<ul>
<li><a href="https://www.evennia.com">Home page</a> </li>
<li><a href="https://github.com/evennia/evennia">Evennia Github</a> </li>
<li><a href="http://games.evennia.com">Game Index</a> </li>
<li>
<a href="https://discord.gg/AJJpcRUhtF">Discord</a> -
<a href="https://github.com/evennia/evennia/discussions">Discussions</a> -
<a href="https://evennia.blogspot.com/">Blog</a>
</li>
</ul>
<h3>Versions</h3>
<ul>
<li><a href="managers.html">1.0-dev (develop branch)</a></li>
<li><a href="../../../../0.9.5/index.html">0.9.5 (v0.9.5 branch)</a></li>
</ul>
</div>
</div>
<div class="clearer"></div>
</div>
<div class="related" role="navigation" aria-label="related navigation">
<h3>Navigation</h3>
<ul>
<li class="right" style="margin-right: 10px">
<a href="../../../genindex.html" title="General Index"
>index</a></li>
<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-1"><a href="../../index.html" >Module code</a> &#187;</li>
<li class="nav-item nav-item-2"><a href="../../evennia.html" >evennia</a> &#187;</li>
<li class="nav-item nav-item-this"><a href="">evennia.comms.managers</a></li>
</ul>
<div class="develop">develop branch</div>
</div>
<div class="footer" role="contentinfo">
&#169; Copyright 2020, The Evennia developer community.
Created using <a href="https://www.sphinx-doc.org/">Sphinx</a> 3.2.1.
</div>
</body>
</html>
Reference in a new issue View git blame Copy permalink