Skip to content

Commit

Permalink
Deployed 7ef9b4b with MkDocs version: 1.6.1
Browse files Browse the repository at this point in the history
  • Loading branch information
Unknown committed Nov 24, 2024
1 parent fe7ce4f commit bc13a1c
Show file tree
Hide file tree
Showing 4 changed files with 31 additions and 35 deletions.
40 changes: 18 additions & 22 deletions reference/task_broker/index.html
Original file line number Diff line number Diff line change
Expand Up @@ -1501,7 +1501,7 @@ <h3 id="fluid.scheduler.TaskBroker.enable_task" class="doc doc-heading">
</span>

<a href="#fluid.scheduler.TaskBroker.enable_task" class="headerlink" title="Permanent link">&para;</a></h3>
<div class="language-python doc-signature highlight"><pre><span></span><code><span id="__span-0-1"><a id="__codelineno-0-1" name="__codelineno-0-1" href="#__codelineno-0-1"></a><span class="nf">enable_task</span><span class="p">(</span><span class="n">task_name</span><span class="p">,</span> <span class="n">enable</span><span class="o">=</span><span class="kc">True</span><span class="p">)</span>
<div class="language-python doc-signature highlight"><pre><span></span><code><span id="__span-0-1"><a id="__codelineno-0-1" name="__codelineno-0-1" href="#__codelineno-0-1"></a><span class="nf">enable_task</span><span class="p">(</span><span class="n">task</span><span class="p">,</span> <span class="n">enable</span><span class="o">=</span><span class="kc">True</span><span class="p">)</span>
</span></code></pre></div>

<div class="doc doc-contents ">
Expand All @@ -1513,14 +1513,10 @@ <h3 id="fluid.scheduler.TaskBroker.enable_task" class="doc doc-heading">
<div class="language-python highlight"><table class="highlighttable"><tr><td class="linenos"><div class="linenodiv"><pre><span></span><span class="normal"><a href="#__codelineno-0-105">105</a></span>
<span class="normal"><a href="#__codelineno-0-106">106</a></span>
<span class="normal"><a href="#__codelineno-0-107">107</a></span>
<span class="normal"><a href="#__codelineno-0-108">108</a></span>
<span class="normal"><a href="#__codelineno-0-109">109</a></span>
<span class="normal"><a href="#__codelineno-0-110">110</a></span></pre></div></td><td class="code"><div><pre><span></span><code><span id="__span-0-105"><a id="__codelineno-0-105" name="__codelineno-0-105"></a><span class="k">async</span> <span class="k">def</span> <span class="nf">enable_task</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">task_name</span><span class="p">:</span> <span class="nb">str</span><span class="p">,</span> <span class="n">enable</span><span class="p">:</span> <span class="nb">bool</span> <span class="o">=</span> <span class="kc">True</span><span class="p">)</span> <span class="o">-&gt;</span> <span class="n">TaskInfo</span><span class="p">:</span>
<span class="normal"><a href="#__codelineno-0-108">108</a></span></pre></div></td><td class="code"><div><pre><span></span><code><span id="__span-0-105"><a id="__codelineno-0-105" name="__codelineno-0-105"></a><span class="k">async</span> <span class="k">def</span> <span class="nf">enable_task</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">task</span><span class="p">:</span> <span class="nb">str</span> <span class="o">|</span> <span class="n">Task</span><span class="p">,</span> <span class="n">enable</span><span class="p">:</span> <span class="nb">bool</span> <span class="o">=</span> <span class="kc">True</span><span class="p">)</span> <span class="o">-&gt;</span> <span class="n">TaskInfo</span><span class="p">:</span>
</span><span id="__span-0-106"><a id="__codelineno-0-106" name="__codelineno-0-106"></a><span class="w"> </span><span class="sd">&quot;&quot;&quot;Enable or disable a registered task&quot;&quot;&quot;</span>
</span><span id="__span-0-107"><a id="__codelineno-0-107" name="__codelineno-0-107"></a> <span class="n">task</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">registry</span><span class="o">.</span><span class="n">get</span><span class="p">(</span><span class="n">task_name</span><span class="p">)</span>
</span><span id="__span-0-108"><a id="__codelineno-0-108" name="__codelineno-0-108"></a> <span class="k">if</span> <span class="ow">not</span> <span class="n">task</span><span class="p">:</span>
</span><span id="__span-0-109"><a id="__codelineno-0-109" name="__codelineno-0-109"></a> <span class="k">raise</span> <span class="n">UnknownTaskError</span><span class="p">(</span><span class="n">task_name</span><span class="p">)</span>
</span><span id="__span-0-110"><a id="__codelineno-0-110" name="__codelineno-0-110"></a> <span class="k">return</span> <span class="k">await</span> <span class="bp">self</span><span class="o">.</span><span class="n">update_task</span><span class="p">(</span><span class="n">task</span><span class="p">,</span> <span class="nb">dict</span><span class="p">(</span><span class="n">enabled</span><span class="o">=</span><span class="n">enable</span><span class="p">))</span>
</span><span id="__span-0-107"><a id="__codelineno-0-107" name="__codelineno-0-107"></a> <span class="n">task_</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">task_from_registry</span><span class="p">(</span><span class="n">task</span><span class="p">)</span>
</span><span id="__span-0-108"><a id="__codelineno-0-108" name="__codelineno-0-108"></a> <span class="k">return</span> <span class="k">await</span> <span class="bp">self</span><span class="o">.</span><span class="n">update_task</span><span class="p">(</span><span class="n">task_</span><span class="p">,</span> <span class="nb">dict</span><span class="p">(</span><span class="n">enabled</span><span class="o">=</span><span class="n">enable</span><span class="p">))</span>
</span></code></pre></div></td></tr></table></div>
</details>
</div>
Expand All @@ -1546,17 +1542,17 @@ <h3 id="fluid.scheduler.TaskBroker.from_url" class="doc doc-heading">

<details class="quote">
<summary>Source code in <code>fluid/scheduler/broker.py</code></summary>
<div class="language-python highlight"><table class="highlighttable"><tr><td class="linenos"><div class="linenodiv"><pre><span></span><span class="normal"><a href="#__codelineno-0-112">112</a></span>
<div class="language-python highlight"><table class="highlighttable"><tr><td class="linenos"><div class="linenodiv"><pre><span></span><span class="normal"><a href="#__codelineno-0-110">110</a></span>
<span class="normal"><a href="#__codelineno-0-111">111</a></span>
<span class="normal"><a href="#__codelineno-0-112">112</a></span>
<span class="normal"><a href="#__codelineno-0-113">113</a></span>
<span class="normal"><a href="#__codelineno-0-114">114</a></span>
<span class="normal"><a href="#__codelineno-0-115">115</a></span>
<span class="normal"><a href="#__codelineno-0-116">116</a></span>
<span class="normal"><a href="#__codelineno-0-117">117</a></span></pre></div></td><td class="code"><div><pre><span></span><code><span id="__span-0-112"><a id="__codelineno-0-112" name="__codelineno-0-112"></a><span class="nd">@classmethod</span>
</span><span id="__span-0-113"><a id="__codelineno-0-113" name="__codelineno-0-113"></a><span class="k">def</span> <span class="nf">from_url</span><span class="p">(</span><span class="bp">cls</span><span class="p">,</span> <span class="n">url</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="o">-&gt;</span> <span class="n">TaskBroker</span><span class="p">:</span>
</span><span id="__span-0-114"><a id="__codelineno-0-114" name="__codelineno-0-114"></a> <span class="n">p</span> <span class="o">=</span> <span class="n">URL</span><span class="p">(</span><span class="n">url</span> <span class="ow">or</span> <span class="n">broker_url_from_env</span><span class="p">())</span>
</span><span id="__span-0-115"><a id="__codelineno-0-115" name="__codelineno-0-115"></a> <span class="k">if</span> <span class="n">factory</span> <span class="o">:=</span> <span class="n">_brokers</span><span class="o">.</span><span class="n">get</span><span class="p">(</span><span class="n">p</span><span class="o">.</span><span class="n">scheme</span><span class="p">):</span>
</span><span id="__span-0-116"><a id="__codelineno-0-116" name="__codelineno-0-116"></a> <span class="k">return</span> <span class="n">factory</span><span class="p">(</span><span class="n">p</span><span class="p">)</span>
</span><span id="__span-0-117"><a id="__codelineno-0-117" name="__codelineno-0-117"></a> <span class="k">raise</span> <span class="ne">RuntimeError</span><span class="p">(</span><span class="sa">f</span><span class="s2">&quot;Invalid broker </span><span class="si">{</span><span class="n">p</span><span class="si">}</span><span class="s2">&quot;</span><span class="p">)</span>
<span class="normal"><a href="#__codelineno-0-115">115</a></span></pre></div></td><td class="code"><div><pre><span></span><code><span id="__span-0-110"><a id="__codelineno-0-110" name="__codelineno-0-110"></a><span class="nd">@classmethod</span>
</span><span id="__span-0-111"><a id="__codelineno-0-111" name="__codelineno-0-111"></a><span class="k">def</span> <span class="nf">from_url</span><span class="p">(</span><span class="bp">cls</span><span class="p">,</span> <span class="n">url</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="o">-&gt;</span> <span class="n">TaskBroker</span><span class="p">:</span>
</span><span id="__span-0-112"><a id="__codelineno-0-112" name="__codelineno-0-112"></a> <span class="n">p</span> <span class="o">=</span> <span class="n">URL</span><span class="p">(</span><span class="n">url</span> <span class="ow">or</span> <span class="n">broker_url_from_env</span><span class="p">())</span>
</span><span id="__span-0-113"><a id="__codelineno-0-113" name="__codelineno-0-113"></a> <span class="k">if</span> <span class="n">factory</span> <span class="o">:=</span> <span class="n">_brokers</span><span class="o">.</span><span class="n">get</span><span class="p">(</span><span class="n">p</span><span class="o">.</span><span class="n">scheme</span><span class="p">):</span>
</span><span id="__span-0-114"><a id="__codelineno-0-114" name="__codelineno-0-114"></a> <span class="k">return</span> <span class="n">factory</span><span class="p">(</span><span class="n">p</span><span class="p">)</span>
</span><span id="__span-0-115"><a id="__codelineno-0-115" name="__codelineno-0-115"></a> <span class="k">raise</span> <span class="ne">RuntimeError</span><span class="p">(</span><span class="sa">f</span><span class="s2">&quot;Invalid broker </span><span class="si">{</span><span class="n">p</span><span class="si">}</span><span class="s2">&quot;</span><span class="p">)</span>
</span></code></pre></div></td></tr></table></div>
</details>
</div>
Expand All @@ -1582,11 +1578,11 @@ <h3 id="fluid.scheduler.TaskBroker.register_broker" class="doc doc-heading">

<details class="quote">
<summary>Source code in <code>fluid/scheduler/broker.py</code></summary>
<div class="language-python highlight"><table class="highlighttable"><tr><td class="linenos"><div class="linenodiv"><pre><span></span><span class="normal"><a href="#__codelineno-0-119">119</a></span>
<span class="normal"><a href="#__codelineno-0-120">120</a></span>
<span class="normal"><a href="#__codelineno-0-121">121</a></span></pre></div></td><td class="code"><div><pre><span></span><code><span id="__span-0-119"><a id="__codelineno-0-119" name="__codelineno-0-119"></a><span class="nd">@classmethod</span>
</span><span id="__span-0-120"><a id="__codelineno-0-120" name="__codelineno-0-120"></a><span class="k">def</span> <span class="nf">register_broker</span><span class="p">(</span><span class="bp">cls</span><span class="p">,</span> <span class="n">name</span><span class="p">:</span> <span class="nb">str</span><span class="p">,</span> <span class="n">factory</span><span class="p">:</span> <span class="nb">type</span><span class="p">[</span><span class="n">TaskBroker</span><span class="p">])</span> <span class="o">-&gt;</span> <span class="kc">None</span><span class="p">:</span>
</span><span id="__span-0-121"><a id="__codelineno-0-121" name="__codelineno-0-121"></a> <span class="n">_brokers</span><span class="p">[</span><span class="n">name</span><span class="p">]</span> <span class="o">=</span> <span class="n">factory</span>
<div class="language-python highlight"><table class="highlighttable"><tr><td class="linenos"><div class="linenodiv"><pre><span></span><span class="normal"><a href="#__codelineno-0-117">117</a></span>
<span class="normal"><a href="#__codelineno-0-118">118</a></span>
<span class="normal"><a href="#__codelineno-0-119">119</a></span></pre></div></td><td class="code"><div><pre><span></span><code><span id="__span-0-117"><a id="__codelineno-0-117" name="__codelineno-0-117"></a><span class="nd">@classmethod</span>
</span><span id="__span-0-118"><a id="__codelineno-0-118" name="__codelineno-0-118"></a><span class="k">def</span> <span class="nf">register_broker</span><span class="p">(</span><span class="bp">cls</span><span class="p">,</span> <span class="n">name</span><span class="p">:</span> <span class="nb">str</span><span class="p">,</span> <span class="n">factory</span><span class="p">:</span> <span class="nb">type</span><span class="p">[</span><span class="n">TaskBroker</span><span class="p">])</span> <span class="o">-&gt;</span> <span class="kc">None</span><span class="p">:</span>
</span><span id="__span-0-119"><a id="__codelineno-0-119" name="__codelineno-0-119"></a> <span class="n">_brokers</span><span class="p">[</span><span class="n">name</span><span class="p">]</span> <span class="o">=</span> <span class="n">factory</span>
</span></code></pre></div></td></tr></table></div>
</details>
</div>
Expand Down
2 changes: 1 addition & 1 deletion search/search_index.json

Large diffs are not rendered by default.

24 changes: 12 additions & 12 deletions sitemap.xml
Original file line number Diff line number Diff line change
Expand Up @@ -2,50 +2,50 @@
<urlset xmlns="http://www.sitemaps.org/schemas/sitemap/0.9">
<url>
<loc>https://aio-fluid.com/</loc>
<lastmod>2024-11-22</lastmod>
<lastmod>2024-11-24</lastmod>
</url>
<url>
<loc>https://aio-fluid.com/reference/</loc>
<lastmod>2024-11-22</lastmod>
<lastmod>2024-11-24</lastmod>
</url>
<url>
<loc>https://aio-fluid.com/reference/dispatchers/</loc>
<lastmod>2024-11-22</lastmod>
<lastmod>2024-11-24</lastmod>
</url>
<url>
<loc>https://aio-fluid.com/reference/task_broker/</loc>
<lastmod>2024-11-22</lastmod>
<lastmod>2024-11-24</lastmod>
</url>
<url>
<loc>https://aio-fluid.com/reference/task_manager/</loc>
<lastmod>2024-11-22</lastmod>
<lastmod>2024-11-24</lastmod>
</url>
<url>
<loc>https://aio-fluid.com/reference/task_run/</loc>
<lastmod>2024-11-22</lastmod>
<lastmod>2024-11-24</lastmod>
</url>
<url>
<loc>https://aio-fluid.com/reference/tast_consumer/</loc>
<lastmod>2024-11-22</lastmod>
<lastmod>2024-11-24</lastmod>
</url>
<url>
<loc>https://aio-fluid.com/reference/workers/</loc>
<lastmod>2024-11-22</lastmod>
<lastmod>2024-11-24</lastmod>
</url>
<url>
<loc>https://aio-fluid.com/tutorials/</loc>
<lastmod>2024-11-22</lastmod>
<lastmod>2024-11-24</lastmod>
</url>
<url>
<loc>https://aio-fluid.com/tutorials/db/</loc>
<lastmod>2024-11-22</lastmod>
<lastmod>2024-11-24</lastmod>
</url>
<url>
<loc>https://aio-fluid.com/tutorials/dispatchers/</loc>
<lastmod>2024-11-22</lastmod>
<lastmod>2024-11-24</lastmod>
</url>
<url>
<loc>https://aio-fluid.com/tutorials/scheduler/</loc>
<lastmod>2024-11-22</lastmod>
<lastmod>2024-11-24</lastmod>
</url>
</urlset>
Binary file modified sitemap.xml.gz
Binary file not shown.

0 comments on commit bc13a1c

Please sign in to comment.