Skip to content

Commit a25b149

Browse files
authored
feat!: enable resource population by default (#151)
1 parent 5b77a55 commit a25b149

File tree

15 files changed

+45
-114
lines changed

15 files changed

+45
-114
lines changed

docs/html/.buildinfo

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
11
# Sphinx build info version 1
22
# This file records the configuration used when building these files. When it is not found, a full rebuild will be done.
3-
config: ec069b93d02ecd85de7d7cee84c8e8ad
3+
config: 3b32c8e50bd7943facb198d2c4932387
44
tags: 645f666f9bcd5a90fca523b33c5a78b7

docs/html/.buildinfo.bak

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
11
# Sphinx build info version 1
22
# This file records the configuration used when building these files. When it is not found, a full rebuild will be done.
3-
config: a5e8f79f249a3478231c88d6f5755ce4
3+
config: ec069b93d02ecd85de7d7cee84c8e8ad
44
tags: 645f666f9bcd5a90fca523b33c5a78b7

docs/html/_sources/autoapi/algokit_utils/applications/enums/index.rst.txt

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -17,7 +17,7 @@ Classes
1717
Module Contents
1818
---------------
1919

20-
.. py:class:: OnSchemaBreak
20+
.. py:class:: OnSchemaBreak(*args, **kwds)
2121
2222
Bases: :py:obj:`enum.Enum`
2323

@@ -49,7 +49,7 @@ Module Contents
4949

5050

5151

52-
.. py:class:: OnUpdate
52+
.. py:class:: OnUpdate(*args, **kwds)
5353
5454
Bases: :py:obj:`enum.Enum`
5555

@@ -89,7 +89,7 @@ Module Contents
8989

9090

9191

92-
.. py:class:: OperationPerformed
92+
.. py:class:: OperationPerformed(*args, **kwds)
9393
9494
Bases: :py:obj:`enum.Enum`
9595

docs/html/_sources/autoapi/algokit_utils/config/index.rst.txt

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -127,7 +127,7 @@ Module Contents
127127

128128

129129

130-
.. py:method:: configure(*, debug: bool | None = None, project_root: pathlib.Path | None = None, trace_all: bool = False, trace_buffer_size_mb: float = 256, max_search_depth: int = 10, populate_app_call_resources: bool = False, logger: logging.Logger | None = None) -> None
130+
.. py:method:: configure(*, debug: bool | None = None, project_root: pathlib.Path | None = None, trace_all: bool = False, trace_buffer_size_mb: float = 256, max_search_depth: int = 10, populate_app_call_resources: bool = True, logger: logging.Logger | None = None) -> None
131131
132132
Configures various settings for the application.
133133

@@ -136,7 +136,7 @@ Module Contents
136136
:param trace_all: Whether to trace all operations. Defaults to False.
137137
:param trace_buffer_size_mb: The trace buffer size in megabytes. Defaults to 256.
138138
:param max_search_depth: The maximum depth to search for a specific file. Defaults to 10.
139-
:param populate_app_call_resources: Whether to populate app call resources. Defaults to False.
139+
:param populate_app_call_resources: Whether to populate app call resources. Defaults to True.
140140
:param logger: A custom logger to use. Defaults to AlgoKitLogger instance.
141141

142142

docs/html/_sources/autoapi/algokit_utils/protocols/typed_clients/index.rst.txt

Lines changed: 8 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -30,7 +30,9 @@ Module Contents
3030
...
3131

3232
Such classes are primarily used with static type checkers that recognize
33-
structural subtyping (static duck-typing), for example::
33+
structural subtyping (static duck-typing).
34+
35+
For example::
3436

3537
class C:
3638
def meth(self) -> int:
@@ -46,7 +48,7 @@ Module Contents
4648
only the presence of given attributes, ignoring their type signatures.
4749
Protocol classes can be generic, they are defined as::
4850

49-
class GenProto(Protocol[T]):
51+
class GenProto[T](Protocol):
5052
def meth(self) -> T:
5153
...
5254

@@ -75,7 +77,9 @@ Module Contents
7577
...
7678

7779
Such classes are primarily used with static type checkers that recognize
78-
structural subtyping (static duck-typing), for example::
80+
structural subtyping (static duck-typing).
81+
82+
For example::
7983

8084
class C:
8185
def meth(self) -> int:
@@ -91,7 +95,7 @@ Module Contents
9195
only the presence of given attributes, ignoring their type signatures.
9296
Protocol classes can be generic, they are defined as::
9397

94-
class GenProto(Protocol[T]):
98+
class GenProto[T](Protocol):
9599
def meth(self) -> T:
96100
...
97101

docs/html/autoapi/algokit_utils/applications/enums/index.html

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -342,7 +342,7 @@ <h2>Classes<a class="headerlink" href="#classes" title="Link to this heading">¶
342342
<h2>Module Contents<a class="headerlink" href="#module-contents" title="Link to this heading"></a></h2>
343343
<dl class="py class">
344344
<dt class="sig sig-object py" id="algokit_utils.applications.enums.OnSchemaBreak">
345-
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">algokit_utils.applications.enums.</span></span><span class="sig-name descname"><span class="pre">OnSchemaBreak</span></span><a class="headerlink" href="#algokit_utils.applications.enums.OnSchemaBreak" title="Link to this definition"></a></dt>
345+
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">algokit_utils.applications.enums.</span></span><span class="sig-name descname"><span class="pre">OnSchemaBreak</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="o"><span class="pre">*</span></span><span class="n"><span class="pre">args</span></span></em>, <em class="sig-param"><span class="o"><span class="pre">**</span></span><span class="n"><span class="pre">kwds</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#algokit_utils.applications.enums.OnSchemaBreak" title="Link to this definition"></a></dt>
346346
<dd><p>Bases: <code class="xref py py-obj docutils literal notranslate"><span class="pre">enum.Enum</span></code></p>
347347
<p>Action to take if an Application’s schema has breaking changes</p>
348348
<dl class="py attribute">
@@ -367,7 +367,7 @@ <h2>Module Contents<a class="headerlink" href="#module-contents" title="Link to
367367

368368
<dl class="py class">
369369
<dt class="sig sig-object py" id="algokit_utils.applications.enums.OnUpdate">
370-
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">algokit_utils.applications.enums.</span></span><span class="sig-name descname"><span class="pre">OnUpdate</span></span><a class="headerlink" href="#algokit_utils.applications.enums.OnUpdate" title="Link to this definition"></a></dt>
370+
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">algokit_utils.applications.enums.</span></span><span class="sig-name descname"><span class="pre">OnUpdate</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="o"><span class="pre">*</span></span><span class="n"><span class="pre">args</span></span></em>, <em class="sig-param"><span class="o"><span class="pre">**</span></span><span class="n"><span class="pre">kwds</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#algokit_utils.applications.enums.OnUpdate" title="Link to this definition"></a></dt>
371371
<dd><p>Bases: <code class="xref py py-obj docutils literal notranslate"><span class="pre">enum.Enum</span></code></p>
372372
<p>Action to take if an Application has been updated</p>
373373
<dl class="py attribute">
@@ -398,7 +398,7 @@ <h2>Module Contents<a class="headerlink" href="#module-contents" title="Link to
398398

399399
<dl class="py class">
400400
<dt class="sig sig-object py" id="algokit_utils.applications.enums.OperationPerformed">
401-
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">algokit_utils.applications.enums.</span></span><span class="sig-name descname"><span class="pre">OperationPerformed</span></span><a class="headerlink" href="#algokit_utils.applications.enums.OperationPerformed" title="Link to this definition"></a></dt>
401+
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">algokit_utils.applications.enums.</span></span><span class="sig-name descname"><span class="pre">OperationPerformed</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="o"><span class="pre">*</span></span><span class="n"><span class="pre">args</span></span></em>, <em class="sig-param"><span class="o"><span class="pre">**</span></span><span class="n"><span class="pre">kwds</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#algokit_utils.applications.enums.OperationPerformed" title="Link to this definition"></a></dt>
402402
<dd><p>Bases: <code class="xref py py-obj docutils literal notranslate"><span class="pre">enum.Enum</span></code></p>
403403
<p>Describes the actions taken during deployment</p>
404404
<dl class="py attribute">

docs/html/autoapi/algokit_utils/config/index.html

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -447,7 +447,7 @@ <h2>Module Contents<a class="headerlink" href="#module-contents" title="Link to
447447

448448
<dl class="py method">
449449
<dt class="sig sig-object py" id="algokit_utils.config.UpdatableConfig.configure">
450-
<span class="sig-name descname"><span class="pre">configure</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="o"><span class="pre">*</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">debug</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">bool</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">None</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">project_root</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">pathlib.Path</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">None</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">trace_all</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">bool</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">False</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">trace_buffer_size_mb</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">float</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">256</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">max_search_depth</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">int</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">10</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">populate_app_call_resources</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">bool</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">False</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">logger</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">logging.Logger</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">None</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">&#x2192;</span> <span class="sig-return-typehint"><span class="pre">None</span></span></span><a class="headerlink" href="#algokit_utils.config.UpdatableConfig.configure" title="Link to this definition"></a></dt>
450+
<span class="sig-name descname"><span class="pre">configure</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="o"><span class="pre">*</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">debug</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">bool</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">None</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">project_root</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">pathlib.Path</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">None</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">trace_all</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">bool</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">False</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">trace_buffer_size_mb</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">float</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">256</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">max_search_depth</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">int</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">10</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">populate_app_call_resources</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">bool</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">True</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">logger</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">logging.Logger</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">None</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">&#x2192;</span> <span class="sig-return-typehint"><span class="pre">None</span></span></span><a class="headerlink" href="#algokit_utils.config.UpdatableConfig.configure" title="Link to this definition"></a></dt>
451451
<dd><p>Configures various settings for the application.</p>
452452
<dl class="field-list simple">
453453
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
@@ -457,7 +457,7 @@ <h2>Module Contents<a class="headerlink" href="#module-contents" title="Link to
457457
<li><p><strong>trace_all</strong> – Whether to trace all operations. Defaults to False.</p></li>
458458
<li><p><strong>trace_buffer_size_mb</strong> – The trace buffer size in megabytes. Defaults to 256.</p></li>
459459
<li><p><strong>max_search_depth</strong> – The maximum depth to search for a specific file. Defaults to 10.</p></li>
460-
<li><p><strong>populate_app_call_resources</strong> – Whether to populate app call resources. Defaults to False.</p></li>
460+
<li><p><strong>populate_app_call_resources</strong> – Whether to populate app call resources. Defaults to True.</p></li>
461461
<li><p><strong>logger</strong> – A custom logger to use. Defaults to AlgoKitLogger instance.</p></li>
462462
</ul>
463463
</dd>

docs/html/autoapi/algokit_utils/protocols/typed_clients/index.html

Lines changed: 6 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -349,7 +349,8 @@ <h2>Module Contents<a class="headerlink" href="#module-contents" title="Link to
349349
</pre></div>
350350
</div>
351351
<p>Such classes are primarily used with static type checkers that recognize
352-
structural subtyping (static duck-typing), for example:</p>
352+
structural subtyping (static duck-typing).</p>
353+
<p>For example:</p>
353354
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="k">class</span><span class="w"> </span><span class="nc">C</span><span class="p">:</span>
354355
<span class="k">def</span><span class="w"> </span><span class="nf">meth</span><span class="p">(</span><span class="bp">self</span><span class="p">)</span> <span class="o">-&gt;</span> <span class="nb">int</span><span class="p">:</span>
355356
<span class="k">return</span> <span class="mi">0</span>
@@ -364,7 +365,7 @@ <h2>Module Contents<a class="headerlink" href="#module-contents" title="Link to
364365
&#64;typing.runtime_checkable act as simple-minded runtime protocols that check
365366
only the presence of given attributes, ignoring their type signatures.
366367
Protocol classes can be generic, they are defined as:</p>
367-
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="k">class</span><span class="w"> </span><span class="nc">GenProto</span><span class="p">(</span><span class="n">Protocol</span><span class="p">[</span><span class="n">T</span><span class="p">]):</span>
368+
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="k">class</span><span class="w"> </span><span class="nc">GenProto</span><span class="p">[</span><span class="n">T</span><span class="p">](</span><span class="n">Protocol</span><span class="p">):</span>
368369
<span class="k">def</span><span class="w"> </span><span class="nf">meth</span><span class="p">(</span><span class="bp">self</span><span class="p">)</span> <span class="o">-&gt;</span> <span class="n">T</span><span class="p">:</span>
369370
<span class="o">...</span>
370371
</pre></div>
@@ -393,7 +394,8 @@ <h2>Module Contents<a class="headerlink" href="#module-contents" title="Link to
393394
</pre></div>
394395
</div>
395396
<p>Such classes are primarily used with static type checkers that recognize
396-
structural subtyping (static duck-typing), for example:</p>
397+
structural subtyping (static duck-typing).</p>
398+
<p>For example:</p>
397399
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="k">class</span><span class="w"> </span><span class="nc">C</span><span class="p">:</span>
398400
<span class="k">def</span><span class="w"> </span><span class="nf">meth</span><span class="p">(</span><span class="bp">self</span><span class="p">)</span> <span class="o">-&gt;</span> <span class="nb">int</span><span class="p">:</span>
399401
<span class="k">return</span> <span class="mi">0</span>
@@ -408,7 +410,7 @@ <h2>Module Contents<a class="headerlink" href="#module-contents" title="Link to
408410
&#64;typing.runtime_checkable act as simple-minded runtime protocols that check
409411
only the presence of given attributes, ignoring their type signatures.
410412
Protocol classes can be generic, they are defined as:</p>
411-
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="k">class</span><span class="w"> </span><span class="nc">GenProto</span><span class="p">(</span><span class="n">Protocol</span><span class="p">[</span><span class="n">T</span><span class="p">]):</span>
413+
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="k">class</span><span class="w"> </span><span class="nc">GenProto</span><span class="p">[</span><span class="n">T</span><span class="p">](</span><span class="n">Protocol</span><span class="p">):</span>
412414
<span class="k">def</span><span class="w"> </span><span class="nf">meth</span><span class="p">(</span><span class="bp">self</span><span class="p">)</span> <span class="o">-&gt;</span> <span class="n">T</span><span class="p">:</span>
413415
<span class="o">...</span>
414416
</pre></div>

docs/html/searchindex.js

Lines changed: 1 addition & 1 deletion
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

0 commit comments

Comments
 (0)