Skip to content

Commit

Permalink
update docs
Browse files Browse the repository at this point in the history
  • Loading branch information
@barnjamin
barnjamin committed Sep 21, 2022
1 parent 60f0502 commit cd5a65f
Show file tree
Hide file tree
Showing 11 changed files with 57 additions and 20 deletions.
Binary file modified docs/doctrees/decorators.doctree
View file
Binary file not shown.
Binary file modified docs/doctrees/environment.pickle
View file
Binary file not shown.
Binary file modified docs/doctrees/state.doctree
View file
Binary file not shown.
24 changes: 23 additions & 1 deletion docs/html/_modules/beaker/application.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -373,7 +373,29 @@ <h1>Source code for beaker.application</h1><div class="highlight"><pre>

<div class="viewcode-block" id="Application.create"><a class="viewcode-back" href="../../application.html#beaker.application.Application.create">[docs]</a> <span class="nd">@create</span>
<span class="k">def</span> <span class="nf">create</span><span class="p">(</span><span class="bp">self</span><span class="p">)</span> <span class="o">-&gt;</span> <span class="n">Expr</span><span class="p">:</span>
<span class="k">return</span> <span class="n">Approve</span><span class="p">()</span></div></div>
<span class="k">return</span> <span class="n">Approve</span><span class="p">()</span></div>

<span class="k">def</span> <span class="nf">dump</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">directory</span><span class="p">:</span> <span class="nb">str</span> <span class="o">=</span> <span class="s2">&quot;.&quot;</span><span class="p">):</span>
<span class="kn">import</span> <span class="nn">json</span>
<span class="kn">import</span> <span class="nn">os.path</span>

<span class="k">with</span> <span class="nb">open</span><span class="p">(</span><span class="n">os</span><span class="o">.</span><span class="n">path</span><span class="o">.</span><span class="n">join</span><span class="p">(</span><span class="n">directory</span><span class="p">,</span> <span class="s2">&quot;approval.teal&quot;</span><span class="p">),</span> <span class="s2">&quot;w&quot;</span><span class="p">)</span> <span class="k">as</span> <span class="n">f</span><span class="p">:</span>
<span class="k">if</span> <span class="bp">self</span><span class="o">.</span><span class="n">approval_program</span> <span class="ow">is</span> <span class="kc">None</span><span class="p">:</span>
<span class="k">raise</span> <span class="ne">Exception</span><span class="p">(</span><span class="s2">&quot;Approval program empty&quot;</span><span class="p">)</span>
<span class="n">f</span><span class="o">.</span><span class="n">write</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">approval_program</span><span class="p">)</span>

<span class="k">with</span> <span class="nb">open</span><span class="p">(</span><span class="n">os</span><span class="o">.</span><span class="n">path</span><span class="o">.</span><span class="n">join</span><span class="p">(</span><span class="n">directory</span><span class="p">,</span> <span class="s2">&quot;clear.teal&quot;</span><span class="p">),</span> <span class="s2">&quot;w&quot;</span><span class="p">)</span> <span class="k">as</span> <span class="n">f</span><span class="p">:</span>
<span class="k">if</span> <span class="bp">self</span><span class="o">.</span><span class="n">clear_program</span> <span class="ow">is</span> <span class="kc">None</span><span class="p">:</span>
<span class="k">raise</span> <span class="ne">Exception</span><span class="p">(</span><span class="s2">&quot;Clear program empty&quot;</span><span class="p">)</span>
<span class="n">f</span><span class="o">.</span><span class="n">write</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">clear_program</span><span class="p">)</span>

<span class="k">with</span> <span class="nb">open</span><span class="p">(</span><span class="n">os</span><span class="o">.</span><span class="n">path</span><span class="o">.</span><span class="n">join</span><span class="p">(</span><span class="n">directory</span><span class="p">,</span> <span class="s2">&quot;contract.json&quot;</span><span class="p">),</span> <span class="s2">&quot;w&quot;</span><span class="p">)</span> <span class="k">as</span> <span class="n">f</span><span class="p">:</span>
<span class="k">if</span> <span class="bp">self</span><span class="o">.</span><span class="n">contract</span> <span class="ow">is</span> <span class="kc">None</span><span class="p">:</span>
<span class="k">raise</span> <span class="ne">Exception</span><span class="p">(</span><span class="s2">&quot;Contract empty&quot;</span><span class="p">)</span>
<span class="n">f</span><span class="o">.</span><span class="n">write</span><span class="p">(</span><span class="n">json</span><span class="o">.</span><span class="n">dumps</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">contract</span><span class="o">.</span><span class="n">dictify</span><span class="p">()))</span>

<span class="k">with</span> <span class="nb">open</span><span class="p">(</span><span class="n">os</span><span class="o">.</span><span class="n">path</span><span class="o">.</span><span class="n">join</span><span class="p">(</span><span class="n">directory</span><span class="p">,</span> <span class="sa">f</span><span class="s2">&quot;</span><span class="si">{</span><span class="bp">self</span><span class="o">.</span><span class="vm">__class__</span><span class="o">.</span><span class="vm">__name__</span><span class="si">}</span><span class="s2">.json&quot;</span><span class="p">),</span> <span class="s2">&quot;w&quot;</span><span class="p">)</span> <span class="k">as</span> <span class="n">f</span><span class="p">:</span>
<span class="n">f</span><span class="o">.</span><span class="n">write</span><span class="p">(</span><span class="n">json</span><span class="o">.</span><span class="n">dumps</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">application_spec</span><span class="p">()))</span></div>
</pre></div>

</div>
Expand Down
10 changes: 4 additions & 6 deletions docs/html/_modules/beaker/client/application_client.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -789,14 +789,12 @@ <h1>Source code for beaker.client.application_client</h1><div class="highlight">
<span class="k">return</span> <span class="n">to_resolve</span><span class="o">.</span><span class="n">resolve_hint</span><span class="p">()</span>
<span class="k">elif</span> <span class="n">to_resolve</span><span class="o">.</span><span class="n">resolvable_class</span> <span class="o">==</span> <span class="n">DefaultArgumentClass</span><span class="o">.</span><span class="n">GlobalState</span><span class="p">:</span>
<span class="n">key</span> <span class="o">=</span> <span class="n">to_resolve</span><span class="o">.</span><span class="n">resolve_hint</span><span class="p">()</span>
<span class="n">app_state</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">get_application_state</span><span class="p">()</span>
<span class="k">return</span> <span class="n">app_state</span><span class="p">[</span><span class="n">key</span><span class="p">]</span>
<span class="n">app_state</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">get_application_state</span><span class="p">(</span><span class="n">raw</span><span class="o">=</span><span class="kc">True</span><span class="p">)</span>
<span class="k">return</span> <span class="n">app_state</span><span class="p">[</span><span class="n">key</span><span class="o">.</span><span class="n">encode</span><span class="p">()]</span>
<span class="k">elif</span> <span class="n">to_resolve</span><span class="o">.</span><span class="n">resolvable_class</span> <span class="o">==</span> <span class="n">DefaultArgumentClass</span><span class="o">.</span><span class="n">LocalState</span><span class="p">:</span>
<span class="n">key</span> <span class="o">=</span> <span class="n">to_resolve</span><span class="o">.</span><span class="n">resolve_hint</span><span class="p">()</span>
<span class="n">acct_state</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">get_account_state</span><span class="p">(</span>
<span class="bp">self</span><span class="o">.</span><span class="n">get_sender</span><span class="p">(),</span>
<span class="p">)</span>
<span class="k">return</span> <span class="n">acct_state</span><span class="p">[</span><span class="n">key</span><span class="p">]</span>
<span class="n">acct_state</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">get_account_state</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">get_sender</span><span class="p">(),</span> <span class="n">raw</span><span class="o">=</span><span class="kc">True</span><span class="p">)</span>
<span class="k">return</span> <span class="n">acct_state</span><span class="p">[</span><span class="n">key</span><span class="o">.</span><span class="n">encode</span><span class="p">()]</span>
<span class="k">elif</span> <span class="n">to_resolve</span><span class="o">.</span><span class="n">resolvable_class</span> <span class="o">==</span> <span class="n">DefaultArgumentClass</span><span class="o">.</span><span class="n">ABIMethod</span><span class="p">:</span>
<span class="n">method</span> <span class="o">=</span> <span class="n">abi</span><span class="o">.</span><span class="n">Method</span><span class="o">.</span><span class="n">undictify</span><span class="p">(</span><span class="n">to_resolve</span><span class="o">.</span><span class="n">resolve_hint</span><span class="p">())</span>
<span class="n">result</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">call</span><span class="p">(</span><span class="n">method</span><span class="p">)</span>
Expand Down
12 changes: 6 additions & 6 deletions docs/html/_modules/beaker/decorators.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -361,7 +361,7 @@ <h1>Source code for beaker.decorators</h1><div class="highlight"><pre>
<span class="k">return</span> <span class="n">_impl</span></div></div>


<span class="k">def</span> <span class="nf">_authorize</span><span class="p">(</span><span class="n">allowed</span><span class="p">:</span> <span class="n">SubroutineFnWrapper</span><span class="p">):</span>
<span class="k">def</span> <span class="nf">_authorize</span><span class="p">(</span><span class="n">allowed</span><span class="p">:</span> <span class="n">SubroutineFnWrapper</span><span class="p">)</span> <span class="o">-&gt;</span> <span class="n">Callable</span><span class="p">[</span><span class="o">...</span><span class="p">,</span> <span class="n">HandlerFunc</span><span class="p">]:</span>
<span class="n">args</span> <span class="o">=</span> <span class="n">allowed</span><span class="o">.</span><span class="n">subroutine</span><span class="o">.</span><span class="n">expected_arg_types</span>

<span class="k">if</span> <span class="nb">len</span><span class="p">(</span><span class="n">args</span><span class="p">)</span> <span class="o">!=</span> <span class="mi">1</span> <span class="ow">or</span> <span class="n">args</span><span class="p">[</span><span class="mi">0</span><span class="p">]</span> <span class="ow">is</span> <span class="ow">not</span> <span class="n">Expr</span><span class="p">:</span>
Expand All @@ -372,9 +372,9 @@ <h1>Source code for beaker.decorators</h1><div class="highlight"><pre>
<span class="k">if</span> <span class="n">allowed</span><span class="o">.</span><span class="n">type_of</span><span class="p">()</span> <span class="o">!=</span> <span class="n">TealType</span><span class="o">.</span><span class="n">uint64</span><span class="p">:</span>
<span class="k">raise</span> <span class="n">TealTypeError</span><span class="p">(</span><span class="n">allowed</span><span class="o">.</span><span class="n">type_of</span><span class="p">(),</span> <span class="n">TealType</span><span class="o">.</span><span class="n">uint64</span><span class="p">)</span>

<span class="k">def</span> <span class="nf">_decorate</span><span class="p">(</span><span class="n">fn</span><span class="p">:</span> <span class="n">HandlerFunc</span><span class="p">):</span>
<span class="k">def</span> <span class="nf">_decorate</span><span class="p">(</span><span class="n">fn</span><span class="p">:</span> <span class="n">HandlerFunc</span><span class="p">)</span> <span class="o">-&gt;</span> <span class="n">HandlerFunc</span><span class="p">:</span>
<span class="nd">@wraps</span><span class="p">(</span><span class="n">fn</span><span class="p">)</span>
<span class="k">def</span> <span class="nf">_impl</span><span class="p">(</span><span class="o">*</span><span class="n">args</span><span class="p">,</span> <span class="o">**</span><span class="n">kwargs</span><span class="p">):</span>
<span class="k">def</span> <span class="nf">_impl</span><span class="p">(</span><span class="o">*</span><span class="n">args</span><span class="p">,</span> <span class="o">**</span><span class="n">kwargs</span><span class="p">)</span> <span class="o">-&gt;</span> <span class="n">Expr</span><span class="p">:</span>
<span class="k">return</span> <span class="n">Seq</span><span class="p">(</span>
<span class="n">Assert</span><span class="p">(</span><span class="n">allowed</span><span class="p">(</span><span class="n">Txn</span><span class="o">.</span><span class="n">sender</span><span class="p">()),</span> <span class="n">comment</span><span class="o">=</span><span class="s2">&quot;unauthorized&quot;</span><span class="p">),</span>
<span class="n">fn</span><span class="p">(</span><span class="o">*</span><span class="n">args</span><span class="p">,</span> <span class="o">**</span><span class="n">kwargs</span><span class="p">),</span>
Expand All @@ -385,13 +385,13 @@ <h1>Source code for beaker.decorators</h1><div class="highlight"><pre>
<span class="k">return</span> <span class="n">_decorate</span>


<span class="k">def</span> <span class="nf">_readonly</span><span class="p">(</span><span class="n">fn</span><span class="p">:</span> <span class="n">HandlerFunc</span><span class="p">):</span>
<span class="k">def</span> <span class="nf">_readonly</span><span class="p">(</span><span class="n">fn</span><span class="p">:</span> <span class="n">HandlerFunc</span><span class="p">)</span> <span class="o">-&gt;</span> <span class="n">HandlerFunc</span><span class="p">:</span>
<span class="n">set_handler_config</span><span class="p">(</span><span class="n">fn</span><span class="p">,</span> <span class="n">read_only</span><span class="o">=</span><span class="kc">True</span><span class="p">)</span>
<span class="k">return</span> <span class="n">fn</span>


<span class="k">def</span> <span class="nf">_on_complete</span><span class="p">(</span><span class="n">mc</span><span class="p">:</span> <span class="n">MethodConfig</span><span class="p">):</span>
<span class="k">def</span> <span class="nf">_impl</span><span class="p">(</span><span class="n">fn</span><span class="p">:</span> <span class="n">HandlerFunc</span><span class="p">):</span>
<span class="k">def</span> <span class="nf">_on_complete</span><span class="p">(</span><span class="n">mc</span><span class="p">:</span> <span class="n">MethodConfig</span><span class="p">)</span> <span class="o">-&gt;</span> <span class="n">Callable</span><span class="p">[</span><span class="o">...</span><span class="p">,</span> <span class="n">HandlerFunc</span><span class="p">]:</span>
<span class="k">def</span> <span class="nf">_impl</span><span class="p">(</span><span class="n">fn</span><span class="p">:</span> <span class="n">HandlerFunc</span><span class="p">)</span> <span class="o">-&gt;</span> <span class="n">HandlerFunc</span><span class="p">:</span>
<span class="n">set_handler_config</span><span class="p">(</span><span class="n">fn</span><span class="p">,</span> <span class="n">method_config</span><span class="o">=</span><span class="n">mc</span><span class="p">)</span>
<span class="k">return</span> <span class="n">fn</span>

Expand Down
Loading

0 comments on commit cd5a65f

Please sign in to comment.