mirror of
https://github.com/evennia/evennia.git
synced 2026-04-04 06:57:16 +02:00
628 lines
No EOL
50 KiB
HTML
628 lines
No EOL
50 KiB
HTML
|
|
|
|
<!DOCTYPE html>
|
|
<!--[if IE 8]><html class="no-js lt-ie9" lang="en" > <![endif]-->
|
|
<!--[if gt IE 8]><!--> <html class="no-js" lang="en" > <!--<![endif]-->
|
|
<head>
|
|
<meta charset="utf-8">
|
|
|
|
<meta name="viewport" content="width=device-width, initial-scale=1.0">
|
|
|
|
<title>evennia.comms.managers — Evennia 1.0-dev documentation</title>
|
|
|
|
|
|
|
|
|
|
<link rel="shortcut icon" href="../../../_static/favicon.ico"/>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<link rel="stylesheet" href="../../../_static/css/theme.css" type="text/css" />
|
|
|
|
|
|
|
|
|
|
|
|
<link rel="index" title="Index"
|
|
href="../../../genindex.html"/>
|
|
<link rel="search" title="Search" href="../../../search.html"/>
|
|
<link rel="top" title="Evennia 1.0-dev documentation" href="../../../index.html"/>
|
|
<link rel="up" title="evennia" href="../../evennia.html"/>
|
|
|
|
|
|
<script src="../../../_static/js/modernizr.min.js"></script>
|
|
|
|
</head>
|
|
|
|
<body class="wy-body-for-nav" role="document">
|
|
|
|
|
|
<div class="wy-grid-for-nav">
|
|
|
|
|
|
<nav data-toggle="wy-nav-shift" class="wy-nav-side">
|
|
<div class="wy-side-scroll">
|
|
<div class="wy-side-nav-search">
|
|
|
|
|
|
|
|
<a href="../../../index.html" class="icon icon-home"> Evennia
|
|
|
|
|
|
|
|
</a>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<div role="search">
|
|
<form id="rtd-search-form" class="wy-form" action="../../../search.html" method="get">
|
|
<input type="text" name="q" placeholder="Search docs" />
|
|
<input type="hidden" name="check_keywords" value="yes" />
|
|
<input type="hidden" name="area" value="default" />
|
|
</form>
|
|
</div>
|
|
|
|
|
|
</div>
|
|
|
|
<div class="wy-menu wy-menu-vertical" data-spy="affix" role="navigation" aria-label="main navigation">
|
|
|
|
|
|
|
|
<!-- Local TOC -->
|
|
<div class="local-toc"></div>
|
|
|
|
|
|
</div>
|
|
</div>
|
|
</nav>
|
|
|
|
<section data-toggle="wy-nav-shift" class="wy-nav-content-wrap">
|
|
|
|
|
|
<nav class="wy-nav-top" role="navigation" aria-label="top navigation">
|
|
|
|
<i data-toggle="wy-nav-top" class="fa fa-bars"></i>
|
|
<a href="../../../index.html">Evennia</a>
|
|
|
|
</nav>
|
|
|
|
|
|
|
|
<div class="wy-nav-content">
|
|
<div class="rst-content">
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<div role="navigation" aria-label="breadcrumbs navigation">
|
|
|
|
<ul class="wy-breadcrumbs">
|
|
|
|
<li><a href="../../../index.html">Docs</a> »</li>
|
|
|
|
<li><a href="../../index.html">Module code</a> »</li>
|
|
|
|
<li><a href="../../evennia.html">evennia</a> »</li>
|
|
|
|
<li>evennia.comms.managers</li>
|
|
|
|
|
|
<li class="wy-breadcrumbs-aside">
|
|
|
|
|
|
|
|
</li>
|
|
|
|
</ul>
|
|
|
|
|
|
<hr/>
|
|
</div>
|
|
<div role="main" class="document" itemscope="itemscope" itemtype="http://schema.org/Article">
|
|
<div itemprop="articleBody">
|
|
|
|
<h1>Source code for evennia.comms.managers</h1><div class="highlight"><pre>
|
|
<span></span><span class="sd">"""</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">"""</span>
|
|
|
|
|
|
<span class="kn">from</span> <span class="nn">django.db.models</span> <span class="k">import</span> <span class="n">Q</span>
|
|
<span class="kn">from</span> <span class="nn">evennia.typeclasses.managers</span> <span class="k">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.utils</span> <span class="k">import</span> <span class="n">logger</span>
|
|
<span class="kn">from</span> <span class="nn">evennia.utils.utils</span> <span class="k">import</span> <span class="n">dbref</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">_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.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">"""</span>
|
|
<span class="sd"> Raised by comm system, to allow feedback to player when caught.</span>
|
|
<span class="sd"> """</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.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">"""</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 "account", "object", "channel",</span>
|
|
<span class="sd"> "string", "dbref" or None.</span>
|
|
|
|
<span class="sd"> """</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">"__dbclass__"</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">"AccountDB"</span><span class="p">:</span>
|
|
<span class="k">return</span> <span class="n">inp</span><span class="p">,</span> <span class="s2">"account"</span>
|
|
<span class="k">elif</span> <span class="n">clsname</span> <span class="o">==</span> <span class="s2">"ObjectDB"</span><span class="p">:</span>
|
|
<span class="k">return</span> <span class="n">inp</span><span class="p">,</span> <span class="s2">"object"</span>
|
|
<span class="k">elif</span> <span class="n">clsname</span> <span class="o">==</span> <span class="s2">"ChannelDB"</span><span class="p">:</span>
|
|
<span class="k">return</span> <span class="n">inp</span><span class="p">,</span> <span class="s2">"channel"</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">"string"</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">"dbref"</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.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">"account"</span><span class="p">):</span>
|
|
<span class="sd">"""</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 'account' or 'channel'.</span>
|
|
|
|
<span class="sd"> Returns:</span>
|
|
<span class="sd"> obj (object): The correct object related to `inp`.</span>
|
|
|
|
<span class="sd"> """</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">"account"</span><span class="p">:</span>
|
|
<span class="k">if</span> <span class="n">typ</span> <span class="o">==</span> <span class="s2">"object"</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">"string"</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">"dbref"</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">"</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">"</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">"object"</span><span class="p">:</span>
|
|
<span class="k">if</span> <span class="n">typ</span> <span class="o">==</span> <span class="s2">"account"</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">"string"</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">"dbref"</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">"</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">"</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">"channel"</span><span class="p">:</span>
|
|
<span class="k">if</span> <span class="n">typ</span> <span class="o">==</span> <span class="s2">"string"</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">"dbref"</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">"</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">"</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.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">"""</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"> """</span>
|
|
|
|
<div class="viewcode-block" id="MsgManager.identify_object"><a class="viewcode-back" href="../../../api/evennia.comms.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">"""</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 "account", "object", "channel",</span>
|
|
<span class="sd"> "string", "dbref" or None.</span>
|
|
|
|
<span class="sd"> """</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.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">"""</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"> """</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.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="n">exclude_channel_messages</span><span class="o">=</span><span class="kc">False</span><span class="p">):</span>
|
|
<span class="sd">"""</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"> exclude_channel_messages (bool, optional): Only return messages</span>
|
|
<span class="sd"> not aimed at a channel (that is, private tells for example)</span>
|
|
|
|
<span class="sd"> Returns:</span>
|
|
<span class="sd"> messages (list): List of matching messages</span>
|
|
|
|
<span class="sd"> Raises:</span>
|
|
<span class="sd"> CommError: For incorrect sender types.</span>
|
|
|
|
<span class="sd"> """</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">exclude_channel_messages</span><span class="p">:</span>
|
|
<span class="c1"># explicitly exclude channel recipients</span>
|
|
<span class="k">if</span> <span class="n">typ</span> <span class="o">==</span> <span class="s2">"account"</span><span class="p">:</span>
|
|
<span class="k">return</span> <span class="nb">list</span><span class="p">(</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="n">db_receivers_channels__isnull</span><span class="o">=</span><span class="kc">True</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="p">)</span>
|
|
<span class="k">elif</span> <span class="n">typ</span> <span class="o">==</span> <span class="s2">"object"</span><span class="p">:</span>
|
|
<span class="k">return</span> <span class="nb">list</span><span class="p">(</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="n">db_receivers_channels__isnull</span><span class="o">=</span><span class="kc">True</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="p">)</span>
|
|
<span class="k">else</span><span class="p">:</span>
|
|
<span class="k">raise</span> <span class="n">CommError</span>
|
|
<span class="k">else</span><span class="p">:</span>
|
|
<span class="c1"># get everything, channel or not</span>
|
|
<span class="k">if</span> <span class="n">typ</span> <span class="o">==</span> <span class="s2">"account"</span><span class="p">:</span>
|
|
<span class="k">return</span> <span class="nb">list</span><span class="p">(</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">"object"</span><span class="p">:</span>
|
|
<span class="k">return</span> <span class="nb">list</span><span class="p">(</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">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.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">"""</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"> messages (list): 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"> """</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">"account"</span><span class="p">:</span>
|
|
<span class="k">return</span> <span class="nb">list</span><span class="p">(</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">"object"</span><span class="p">:</span>
|
|
<span class="k">return</span> <span class="nb">list</span><span class="p">(</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="s2">"channel"</span><span class="p">:</span>
|
|
<span class="k">return</span> <span class="nb">list</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">filter</span><span class="p">(</span><span class="n">db_receivers_channels</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_channels</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_channel"><a class="viewcode-back" href="../../../api/evennia.comms.html#evennia.comms.comms.MsgManager.get_messages_by_channel">[docs]</a> <span class="k">def</span> <span class="nf">get_messages_by_channel</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">channel</span><span class="p">):</span>
|
|
<span class="sd">"""</span>
|
|
<span class="sd"> Get all persistent messages sent to one channel.</span>
|
|
|
|
<span class="sd"> Args:</span>
|
|
<span class="sd"> channel (Channel): The channel to find messages for.</span>
|
|
|
|
<span class="sd"> Returns:</span>
|
|
<span class="sd"> messages (list): Persistent Msg objects saved for this channel.</span>
|
|
|
|
<span class="sd"> """</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_channels</span><span class="o">=</span><span class="n">channel</span><span class="p">)</span><span class="o">.</span><span class="n">exclude</span><span class="p">(</span><span class="n">db_hide_from_channels</span><span class="o">=</span><span class="n">channel</span><span class="p">)</span></div>
|
|
|
|
<div class="viewcode-block" id="MsgManager.search_message"><a class="viewcode-back" href="../../../api/evennia.comms.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">"""</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 or Account, optional): Get messages sent by a particular account or object</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's unique and</span>
|
|
<span class="sd"> always gives only one match.</span>
|
|
|
|
<span class="sd"> Returns:</span>
|
|
<span class="sd"> messages (list or Msg): A list of message matches or a single match if `dbref` was given.</span>
|
|
|
|
<span class="sd"> """</span>
|
|
<span class="c1"># unique msg id</span>
|
|
<span class="k">if</span> <span class="n">dbref</span><span class="p">:</span>
|
|
<span class="n">msg</span> <span class="o">=</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="k">if</span> <span class="n">msg</span><span class="p">:</span>
|
|
<span class="k">return</span> <span class="n">msg</span><span class="p">[</span><span class="mi">0</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 & and | (=AND,OR). ~ negates the queryset</span>
|
|
|
|
<span class="c1"># filter by sender</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">styp</span> <span class="o">==</span> <span class="s2">"account"</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</span><span class="o">=</span><span class="n">sender</span><span class="p">)</span> <span class="o">&</span> <span class="o">~</span><span class="n">Q</span><span class="p">(</span><span class="n">db_hide_from_accounts</span><span class="o">=</span><span class="n">sender</span><span class="p">)</span>
|
|
<span class="k">elif</span> <span class="n">styp</span> <span class="o">==</span> <span class="s2">"object"</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</span><span class="o">=</span><span class="n">sender</span><span class="p">)</span> <span class="o">&</span> <span class="o">~</span><span class="n">Q</span><span class="p">(</span><span class="n">db_hide_from_objects</span><span class="o">=</span><span class="n">sender</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">rtyp</span> <span class="o">==</span> <span class="s2">"account"</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_accounts</span><span class="o">=</span><span class="n">receiver</span><span class="p">)</span> <span class="o">&</span> <span class="o">~</span><span class="n">Q</span><span class="p">(</span>
|
|
<span class="n">db_hide_from_accounts</span><span class="o">=</span><span class="n">receiver</span>
|
|
<span class="p">)</span>
|
|
<span class="k">elif</span> <span class="n">rtyp</span> <span class="o">==</span> <span class="s2">"object"</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</span><span class="o">=</span><span class="n">receiver</span><span class="p">)</span> <span class="o">&</span> <span class="o">~</span><span class="n">Q</span><span class="p">(</span><span class="n">db_hide_from_objects</span><span class="o">=</span><span class="n">receiver</span><span class="p">)</span>
|
|
<span class="k">elif</span> <span class="n">rtyp</span> <span class="o">==</span> <span class="s2">"channel"</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_channels</span><span class="o">=</span><span class="n">receiver</span><span class="p">)</span> <span class="o">&</span> <span class="o">~</span><span class="n">Q</span><span class="p">(</span>
|
|
<span class="n">db_hide_from_channels</span><span class="o">=</span><span class="n">receiver</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="nb">list</span><span class="p">(</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">&</span> <span class="n">receiver_restrict</span> <span class="o">&</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>
|
|
|
|
|
|
<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.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">"""</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'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"> """</span>
|
|
|
|
<div class="viewcode-block" id="ChannelDBManager.get_all_channels"><a class="viewcode-back" href="../../../api/evennia.comms.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">"""</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"> """</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.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">"""</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"> """</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">"alias"</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.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">"""</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"> """</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">"AccountDB"</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">"ObjectDB"</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.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">"""</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"> """</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="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="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">"alias"</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">"alias"</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>
|
|
|
|
<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.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">"""</span>
|
|
<span class="sd"> Wrapper to group the typeclass manager to a consistent name.</span>
|
|
<span class="sd"> """</span>
|
|
|
|
<span class="k">pass</span></div>
|
|
</pre></div>
|
|
|
|
</div>
|
|
</div>
|
|
<footer>
|
|
|
|
|
|
<hr/>
|
|
|
|
<div role="contentinfo">
|
|
<p>
|
|
© Copyright 2020, The Evennia developer community.
|
|
|
|
</p>
|
|
</div>
|
|
Built with <a href="http://sphinx-doc.org/">Sphinx</a> and ❤️ using a custom <a href="https://github.com/LinxiFan/Sphinx-theme">theme</a> based on <a href="https://readthedocs.org">Read the Docs</a>.
|
|
|
|
</footer>
|
|
|
|
</div>
|
|
</div>
|
|
|
|
</section>
|
|
|
|
</div>
|
|
|
|
|
|
|
|
|
|
|
|
<script type="text/javascript">
|
|
var DOCUMENTATION_OPTIONS = {
|
|
URL_ROOT:'../../../',
|
|
VERSION:'1.0-dev',
|
|
COLLAPSE_INDEX:false,
|
|
FILE_SUFFIX:'.html',
|
|
HAS_SOURCE: true,
|
|
SOURCELINK_SUFFIX: '.txt'
|
|
};
|
|
</script>
|
|
<script type="text/javascript" src="../../../_static/jquery.js"></script>
|
|
<script type="text/javascript" src="../../../_static/underscore.js"></script>
|
|
<script type="text/javascript" src="../../../_static/doctools.js"></script>
|
|
<script type="text/javascript" src="../../../_static/language_data.js"></script>
|
|
|
|
|
|
|
|
|
|
|
|
<script type="text/javascript" src="../../../_static/js/theme.js"></script>
|
|
|
|
|
|
|
|
|
|
<script type="text/javascript">
|
|
jQuery(function () {
|
|
SphinxRtdTheme.StickyNav.enable();
|
|
});
|
|
</script>
|
|
|
|
|
|
</body>
|
|
</html> |