Update docs

Mahi · Apr 5, 2017 · a91c451 · a91c451
1 parent d265e79
commit a91c451
Show file tree

Hide file tree

Showing 16 changed files with 879 additions and 56 deletions.
diff --git a/docs/build/.buildinfo b/docs/build/.buildinfo
@@ -1,4 +1,4 @@
 # Sphinx build info version 1
 # This file hashes the configuration used when building these files. When it is not found, a full rebuild will be done.
-config: 41e993238c625905eaf0426f77797ccf
+config: 578716e15c98e42d3f5dc56171522b2f
 tags: 645f666f9bcd5a90fca523b33c5a78b7
diff --git a/docs/build/.doctrees/environment.pickle b/docs/build/.doctrees/environment.pickle
diff --git a/docs/build/.doctrees/index.doctree b/docs/build/.doctrees/index.doctree
diff --git a/docs/build/_modules/ezpygame.html b/docs/build/_modules/ezpygame.html
@@ -6,15 +6,15 @@
   <head>
     <meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
 
-    <title>ezpygame &#8212; EzPyGame 0.3.0 documentation</title>
+    <title>ezpygame &#8212; EzPyGame 0.3.1 documentation</title>
 
     <link rel="stylesheet" href="../_static/alabaster.css" type="text/css" />
     <link rel="stylesheet" href="../_static/pygments.css" type="text/css" />
 
     <script type="text/javascript">
       var DOCUMENTATION_OPTIONS = {
         URL_ROOT:    '../',
-        VERSION:     '0.3.0',
+        VERSION:     '0.3.1',
         COLLAPSE_INDEX: false,
         FILE_SUFFIX: '.html',
         HAS_SOURCE:  true,

diff --git a/docs/build/_modules/ezpygame/application.html b/docs/build/_modules/ezpygame/application.html
diff --git a/docs/build/_modules/ezpygame/event.html b/docs/build/_modules/ezpygame/event.html
@@ -0,0 +1,189 @@
+<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
+  "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
+
+
+<html xmlns="http://www.w3.org/1999/xhtml">
+  <head>
+    <meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
+
+    <title>ezpygame.event &#8212; EzPyGame 0.3.1 documentation</title>
+
+    <link rel="stylesheet" href="../../_static/alabaster.css" type="text/css" />
+    <link rel="stylesheet" href="../../_static/pygments.css" type="text/css" />
+
+    <script type="text/javascript">
+      var DOCUMENTATION_OPTIONS = {
+        URL_ROOT:    '../../',
+        VERSION:     '0.3.1',
+        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>
+    <link rel="index" title="Index" href="../../genindex.html" />
+    <link rel="search" title="Search" href="../../search.html" />
+
+  <link rel="stylesheet" href="../../_static/custom.css" type="text/css" />
+
+
+  <meta name="viewport" content="width=device-width, initial-scale=0.9, maximum-scale=0.9" />
+
+  </head>
+  <body role="document">
+
+
+    <div class="document">
+      <div class="documentwrapper">
+        <div class="bodywrapper">
+          <div class="body" role="main">
+
+  <h1>Source code for ezpygame.event</h1><div class="highlight"><pre>
+<span></span><span class="kn">import</span> <span class="nn">collections</span>
+<span class="kn">import</span> <span class="nn">functools</span>
+
+
+<div class="viewcode-block" id="handler"><a class="viewcode-back" href="../../index.html#ezpygame.event.handler">[docs]</a><span class="k">def</span> <span class="nf">handler</span><span class="p">(</span><span class="n">event_type</span><span class="p">):</span>
+    <span class="sd">&quot;&quot;&quot;Decorator for registering scene&#39;s methods as event handlers.</span>
+
+<span class="sd">    Tags the scene&#39;s method as an event handler, so when it&#39;s ran,</span>
+<span class="sd">    the application knows how to register and unregister the method</span>
+<span class="sd">    automatically for its :class:`Manager`.</span>
+
+<span class="sd">    For example:</span>
+
+<span class="sd">    .. code-block:: python</span>
+
+<span class="sd">        class Menu(ezpygame.Scene):</span>
+
+<span class="sd">            @ezpygame.event.handler(pygame.MOUSEBUTTONUP)</span>
+<span class="sd">            def select_item(self, event):</span>
+<span class="sd">                if event.key != 1:</span>
+<span class="sd">                    return</span>
+<span class="sd">                item = self.items[index_from_coords(event.pos)]</span>
+<span class="sd">                game = Game(item=item)</span>
+<span class="sd">                self.application.change_scene(game)</span>
+
+<span class="sd">    :param pygame.event.EventType event_type: event type to listen</span>
+<span class="sd">    &quot;&quot;&quot;</span>
+    <span class="k">def</span> <span class="nf">decorator</span><span class="p">(</span><span class="n">handler</span><span class="p">):</span>
+        <span class="n">handler</span><span class="o">.</span><span class="n">_handle_event</span> <span class="o">=</span> <span class="n">event_type</span>
+        <span class="k">return</span> <span class="n">handler</span>
+    <span class="k">return</span> <span class="n">decorator</span></div>
+
+
+<div class="viewcode-block" id="Manager"><a class="viewcode-back" href="../../index.html#ezpygame.event.Manager">[docs]</a><span class="k">class</span> <span class="nc">Manager</span><span class="p">(</span><span class="n">collections</span><span class="o">.</span><span class="n">defaultdict</span><span class="p">):</span>
+    <span class="sd">&quot;&quot;&quot;Class for managing event handlers.</span>
+
+<span class="sd">    Allows handler callbacks to be registered and unregistered with</span>
+<span class="sd">    the :meth:`register` and :meth:`unregister` methods:</span>
+
+<span class="sd">    .. code-block:: python</span>
+
+<span class="sd">        &gt;&gt;&gt; manager = Manager()</span>
+<span class="sd">        &gt;&gt;&gt; manager.register(pygame.KEYDOWN, my_callback1, my_callback2)</span>
+<span class="sd">        &gt;&gt;&gt; manager.register(pygame.KEYDOWN, my_callback3)</span>
+<span class="sd">        &gt;&gt;&gt; manager.unregister(pygame.KEYDOWN, my_callback1)</span>
+<span class="sd">        &gt;&gt;&gt; print(manager[pygame.KEYDOWN])</span>
+<span class="sd">        [&lt;function &#39;my_callback2&#39;&gt;, &lt;function &#39;my_callback3&#39;&gt;]</span>
+<span class="sd">        &gt;&gt;&gt; manager.clear(pygame.KEYDOWN)</span>
+<span class="sd">        &gt;&gt;&gt; print(manager[pygame.KEYDOWN])</span>
+<span class="sd">        []</span>
+<span class="sd">    &quot;&quot;&quot;</span>
+
+<div class="viewcode-block" id="Manager.__init__"><a class="viewcode-back" href="../../index.html#ezpygame.event.Manager.__init__">[docs]</a>    <span class="k">def</span> <span class="nf">__init__</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
+        <span class="sd">&quot;&quot;&quot;Initialize the :attr:`default_factory` to ``list``.&quot;&quot;&quot;</span>
+        <span class="nb">super</span><span class="p">()</span><span class="o">.</span><span class="fm">__init__</span><span class="p">(</span><span class="nb">list</span><span class="p">)</span></div>
+
+<div class="viewcode-block" id="Manager.register"><a class="viewcode-back" href="../../index.html#ezpygame.event.Manager.register">[docs]</a>    <span class="k">def</span> <span class="nf">register</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">event_type</span><span class="p">,</span> <span class="o">*</span><span class="n">handlers</span><span class="p">):</span>
+        <span class="sd">&quot;&quot;&quot;Register handler callback(s) to an event.</span>
+
+<span class="sd">        :param pygame.event.EventType event_type: event type to listen</span>
+<span class="sd">        :param tuple[callable] \*handlers: handler callbacks to register</span>
+<span class="sd">        &quot;&quot;&quot;</span>
+        <span class="k">for</span> <span class="n">handler</span> <span class="ow">in</span> <span class="n">handlers</span><span class="p">:</span>
+            <span class="k">if</span> <span class="n">handler</span> <span class="ow">in</span> <span class="bp">self</span><span class="p">[</span><span class="n">event_type</span><span class="p">]:</span>
+                <span class="k">raise</span> <span class="ne">ValueError</span><span class="p">(</span><span class="s1">&#39;</span><span class="si">{}</span><span class="s1"> already registered&#39;</span><span class="o">.</span><span class="n">format</span><span class="p">(</span><span class="n">handler</span><span class="p">))</span>
+            <span class="bp">self</span><span class="p">[</span><span class="n">event_type</span><span class="p">]</span><span class="o">.</span><span class="n">append</span><span class="p">(</span><span class="n">handler</span><span class="p">)</span></div>
+
+<div class="viewcode-block" id="Manager.unregister"><a class="viewcode-back" href="../../index.html#ezpygame.event.Manager.unregister">[docs]</a>    <span class="k">def</span> <span class="nf">unregister</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">event_type</span><span class="p">,</span> <span class="o">*</span><span class="n">handlers</span><span class="p">):</span>
+        <span class="sd">&quot;&quot;&quot;Unregister handler callback(s) from an event.</span>
+
+<span class="sd">        :param pygame.event.EventType event_type: event type to listen</span>
+<span class="sd">        :param tuple[callable] \*handlers: handler callbacks to register</span>
+<span class="sd">        &quot;&quot;&quot;</span>
+        <span class="k">for</span> <span class="n">handler</span> <span class="ow">in</span> <span class="n">handlers</span><span class="p">:</span>
+            <span class="k">if</span> <span class="n">handler</span> <span class="ow">not</span> <span class="ow">in</span> <span class="bp">self</span><span class="p">[</span><span class="n">event_type</span><span class="p">]:</span>
+                <span class="k">raise</span> <span class="ne">ValueError</span><span class="p">(</span><span class="s1">&#39;</span><span class="si">{}</span><span class="s1"> not registerd&#39;</span><span class="o">.</span><span class="n">format</span><span class="p">(</span><span class="n">handler</span><span class="p">))</span>
+            <span class="bp">self</span><span class="p">[</span><span class="n">event_type</span><span class="p">]</span><span class="o">.</span><span class="n">remove</span><span class="p">(</span><span class="n">handler</span><span class="p">)</span></div>
+
+<div class="viewcode-block" id="Manager.clear"><a class="viewcode-back" href="../../index.html#ezpygame.event.Manager.clear">[docs]</a>    <span class="k">def</span> <span class="nf">clear</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="o">*</span><span class="n">event_types</span><span class="p">):</span>
+        <span class="sd">&quot;&quot;&quot;Unregister all handlers (from event type(s)).</span>
+
+<span class="sd">        If event types are provided as arguments, only listeners of</span>
+<span class="sd">        those types will be cleared. Else all listeners in the manager</span>
+<span class="sd">        will be cleared.</span>
+
+<span class="sd">        :param tuple[pygame.event.EventType] \*event_types: clear types</span>
+<span class="sd">        &quot;&quot;&quot;</span>
+        <span class="k">if</span> <span class="ow">not</span> <span class="n">event_types</span><span class="p">:</span>
+            <span class="nb">super</span><span class="p">()</span><span class="o">.</span><span class="n">clear</span><span class="p">()</span>
+        <span class="k">else</span><span class="p">:</span>
+            <span class="k">for</span> <span class="n">event_type</span> <span class="ow">in</span> <span class="n">event_types</span><span class="p">:</span>
+                <span class="bp">self</span><span class="p">[</span><span class="n">event_type</span><span class="p">]</span><span class="o">.</span><span class="n">clear</span><span class="p">()</span></div>
+
+<div class="viewcode-block" id="Manager.fire"><a class="viewcode-back" href="../../index.html#ezpygame.event.Manager.fire">[docs]</a>    <span class="k">def</span> <span class="nf">fire</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">event</span><span class="p">):</span>
+        <span class="sd">&quot;&quot;&quot;Fire an event, invoking all the handlers.</span>
+
+<span class="sd">        :param pygame.event.Event: event to fire</span>
+<span class="sd">        &quot;&quot;&quot;</span>
+        <span class="k">for</span> <span class="n">handler</span> <span class="ow">in</span> <span class="bp">self</span><span class="p">[</span><span class="n">event</span><span class="o">.</span><span class="n">type</span><span class="p">]:</span>
+            <span class="n">handler</span><span class="p">(</span><span class="n">event</span><span class="p">)</span></div></div>
+</pre></div>
+
+          </div>
+        </div>
+      </div>
+      <div class="sphinxsidebar" role="navigation" aria-label="main navigation">
+        <div class="sphinxsidebarwrapper"><div class="relations">
+<h3>Related Topics</h3>
+<ul>
+  <li><a href="../../index.html">Documentation overview</a><ul>
+  <li><a href="../index.html">Module code</a><ul>
+  <li><a href="../ezpygame.html">ezpygame</a><ul>
+  </ul></li>
+  </ul></li>
+  </ul></li>
+</ul>
+</div>
+<div id="searchbox" style="display: none" role="search">
+  <h3>Quick search</h3>
+    <form class="search" action="../../search.html" method="get">
+      <div><input type="text" name="q" /></div>
+      <div><input type="submit" value="Go" /></div>
+      <input type="hidden" name="check_keywords" value="yes" />
+      <input type="hidden" name="area" value="default" />
+    </form>
+</div>
+<script type="text/javascript">$('#searchbox').show(0);</script>
+        </div>
+      </div>
+      <div class="clearer"></div>
+    </div>
+    <div class="footer">
+      &copy;2017, Markus Meskanen.
+
+      |
+      Powered by <a href="http://sphinx-doc.org/">Sphinx 1.5.3</a>
+      &amp; <a href="https://github.com/bitprophet/alabaster">Alabaster 0.7.10</a>
+
+    </div>
+
+
+
+
+  </body>
+</html>