Deployed 4ba7990 to v0.12-dev with MkDocs 1.6.1 and mike 2.1.3

Author: github-actions[bot]

v0.12-dev/reference/frequenz/client/dispatch/recurrence/index.html

@@ -2099,7 +2099,13 @@ <h4 id="frequenz.client.dispatch.recurrence.RecurrenceRule" class="doc doc-headi
 <span class="normal"><a href="#__codelineno-0-221">221</a></span>
 <span class="normal"><a href="#__codelineno-0-222">222</a></span>
 <span class="normal"><a href="#__codelineno-0-223">223</a></span>
-<span class="normal"><a href="#__codelineno-0-224">224</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">@dataclass</span><span class="p">(</span><span class="n">kw_only</span><span class="o">=</span><span class="kc">True</span><span class="p">)</span>
+<span class="normal"><a href="#__codelineno-0-224">224</a></span>
+<span class="normal"><a href="#__codelineno-0-225">225</a></span>
+<span class="normal"><a href="#__codelineno-0-226">226</a></span>
+<span class="normal"><a href="#__codelineno-0-227">227</a></span>
+<span class="normal"><a href="#__codelineno-0-228">228</a></span>
+<span class="normal"><a href="#__codelineno-0-229">229</a></span>
+<span class="normal"><a href="#__codelineno-0-230">230</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">@dataclass</span><span class="p">(</span><span class="n">kw_only</span><span class="o">=</span><span class="kc">True</span><span class="p">)</span>
 </span><span id="__span-0-113"><a id="__codelineno-0-113" name="__codelineno-0-113"></a><span class="k">class</span><span class="w"> </span><span class="nc">RecurrenceRule</span><span class="p">:</span>
 </span><span id="__span-0-114"><a id="__codelineno-0-114" name="__codelineno-0-114"></a><span class="w">    </span><span class="sd">&quot;&quot;&quot;Ruleset governing when and how a dispatch should re-occur.</span>
 </span><span id="__span-0-115"><a id="__codelineno-0-115" name="__codelineno-0-115"></a>
@@ -2187,31 +2193,37 @@ <h4 id="frequenz.client.dispatch.recurrence.RecurrenceRule" class="doc doc-headi
 </span><span id="__span-0-197"><a id="__codelineno-0-197" name="__codelineno-0-197"></a><span class="sd">            The rrule object.</span>
 </span><span id="__span-0-198"><a id="__codelineno-0-198" name="__codelineno-0-198"></a>
 </span><span id="__span-0-199"><a id="__codelineno-0-199" name="__codelineno-0-199"></a><span class="sd">        Raises:</span>
-</span><span id="__span-0-200"><a id="__codelineno-0-200" name="__codelineno-0-200"></a><span class="sd">            ValueError: If the interval is 0.</span>
+</span><span id="__span-0-200"><a id="__codelineno-0-200" name="__codelineno-0-200"></a><span class="sd">            ValueError: If the interval is 0 or the frequency is UNSPECIFIED.</span>
 </span><span id="__span-0-201"><a id="__codelineno-0-201" name="__codelineno-0-201"></a><span class="sd">        &quot;&quot;&quot;</span>
-</span><span id="__span-0-202"><a id="__codelineno-0-202" name="__codelineno-0-202"></a>        <span class="k">if</span> <span class="bp">self</span><span class="o">.</span><span class="n">interval</span> <span class="o">==</span> <span class="mi">0</span><span class="p">:</span>
-</span><span id="__span-0-203"><a id="__codelineno-0-203" name="__codelineno-0-203"></a>            <span class="k">raise</span> <span class="ne">ValueError</span><span class="p">(</span><span class="s2">&quot;Interval must be greater than 0&quot;</span><span class="p">)</span>
+</span><span id="__span-0-202"><a id="__codelineno-0-202" name="__codelineno-0-202"></a>        <span class="k">if</span> <span class="bp">self</span><span class="o">.</span><span class="n">frequency</span> <span class="o">==</span> <span class="n">Frequency</span><span class="o">.</span><span class="n">UNSPECIFIED</span><span class="p">:</span>
+</span><span id="__span-0-203"><a id="__codelineno-0-203" name="__codelineno-0-203"></a>            <span class="k">raise</span> <span class="ne">ValueError</span><span class="p">(</span><span class="s2">&quot;Frequency must be specified&quot;</span><span class="p">)</span>
 </span><span id="__span-0-204"><a id="__codelineno-0-204" name="__codelineno-0-204"></a>
-</span><span id="__span-0-205"><a id="__codelineno-0-205" name="__codelineno-0-205"></a>        <span class="n">count</span><span class="p">,</span> <span class="n">until</span> <span class="o">=</span> <span class="p">(</span><span class="kc">None</span><span class="p">,</span> <span class="kc">None</span><span class="p">)</span>
-</span><span id="__span-0-206"><a id="__codelineno-0-206" name="__codelineno-0-206"></a>        <span class="k">if</span> <span class="n">end</span> <span class="o">:=</span> <span class="bp">self</span><span class="o">.</span><span class="n">end_criteria</span><span class="p">:</span>
-</span><span id="__span-0-207"><a id="__codelineno-0-207" name="__codelineno-0-207"></a>            <span class="n">count</span> <span class="o">=</span> <span class="n">end</span><span class="o">.</span><span class="n">count</span>
-</span><span id="__span-0-208"><a id="__codelineno-0-208" name="__codelineno-0-208"></a>            <span class="n">until</span> <span class="o">=</span> <span class="n">end</span><span class="o">.</span><span class="n">until</span>
-</span><span id="__span-0-209"><a id="__codelineno-0-209" name="__codelineno-0-209"></a>
-</span><span id="__span-0-210"><a id="__codelineno-0-210" name="__codelineno-0-210"></a>        <span class="n">rrule_obj</span> <span class="o">=</span> <span class="n">rrule</span><span class="o">.</span><span class="n">rrule</span><span class="p">(</span>
-</span><span id="__span-0-211"><a id="__codelineno-0-211" name="__codelineno-0-211"></a>            <span class="n">freq</span><span class="o">=</span><span class="n">_RRULE_FREQ_MAP</span><span class="p">[</span><span class="bp">self</span><span class="o">.</span><span class="n">frequency</span><span class="p">],</span>
-</span><span id="__span-0-212"><a id="__codelineno-0-212" name="__codelineno-0-212"></a>            <span class="n">dtstart</span><span class="o">=</span><span class="n">start_time</span><span class="p">,</span>
-</span><span id="__span-0-213"><a id="__codelineno-0-213" name="__codelineno-0-213"></a>            <span class="n">count</span><span class="o">=</span><span class="n">count</span><span class="p">,</span>
-</span><span id="__span-0-214"><a id="__codelineno-0-214" name="__codelineno-0-214"></a>            <span class="n">until</span><span class="o">=</span><span class="n">until</span><span class="p">,</span>
-</span><span id="__span-0-215"><a id="__codelineno-0-215" name="__codelineno-0-215"></a>            <span class="n">byminute</span><span class="o">=</span><span class="bp">self</span><span class="o">.</span><span class="n">byminutes</span> <span class="ow">or</span> <span class="kc">None</span><span class="p">,</span>
-</span><span id="__span-0-216"><a id="__codelineno-0-216" name="__codelineno-0-216"></a>            <span class="n">byhour</span><span class="o">=</span><span class="bp">self</span><span class="o">.</span><span class="n">byhours</span> <span class="ow">or</span> <span class="kc">None</span><span class="p">,</span>
-</span><span id="__span-0-217"><a id="__codelineno-0-217" name="__codelineno-0-217"></a>            <span class="n">byweekday</span><span class="o">=</span><span class="p">[</span><span class="n">_RRULE_WEEKDAY_MAP</span><span class="p">[</span><span class="n">weekday</span><span class="p">]</span> <span class="k">for</span> <span class="n">weekday</span> <span class="ow">in</span> <span class="bp">self</span><span class="o">.</span><span class="n">byweekdays</span><span class="p">]</span>
-</span><span id="__span-0-218"><a id="__codelineno-0-218" name="__codelineno-0-218"></a>            <span class="ow">or</span> <span class="kc">None</span><span class="p">,</span>
-</span><span id="__span-0-219"><a id="__codelineno-0-219" name="__codelineno-0-219"></a>            <span class="n">bymonthday</span><span class="o">=</span><span class="bp">self</span><span class="o">.</span><span class="n">bymonthdays</span> <span class="ow">or</span> <span class="kc">None</span><span class="p">,</span>
-</span><span id="__span-0-220"><a id="__codelineno-0-220" name="__codelineno-0-220"></a>            <span class="n">bymonth</span><span class="o">=</span><span class="bp">self</span><span class="o">.</span><span class="n">bymonths</span> <span class="ow">or</span> <span class="kc">None</span><span class="p">,</span>
-</span><span id="__span-0-221"><a id="__codelineno-0-221" name="__codelineno-0-221"></a>            <span class="n">interval</span><span class="o">=</span><span class="bp">self</span><span class="o">.</span><span class="n">interval</span><span class="p">,</span>
-</span><span id="__span-0-222"><a id="__codelineno-0-222" name="__codelineno-0-222"></a>        <span class="p">)</span>
-</span><span id="__span-0-223"><a id="__codelineno-0-223" name="__codelineno-0-223"></a>
-</span><span id="__span-0-224"><a id="__codelineno-0-224" name="__codelineno-0-224"></a>        <span class="k">return</span> <span class="n">rrule_obj</span>
+</span><span id="__span-0-205"><a id="__codelineno-0-205" name="__codelineno-0-205"></a>        <span class="k">if</span> <span class="bp">self</span><span class="o">.</span><span class="n">interval</span> <span class="o">==</span> <span class="mi">0</span><span class="p">:</span>
+</span><span id="__span-0-206"><a id="__codelineno-0-206" name="__codelineno-0-206"></a>            <span class="k">raise</span> <span class="ne">ValueError</span><span class="p">(</span><span class="s2">&quot;Interval must be greater than 0&quot;</span><span class="p">)</span>
+</span><span id="__span-0-207"><a id="__codelineno-0-207" name="__codelineno-0-207"></a>
+</span><span id="__span-0-208"><a id="__codelineno-0-208" name="__codelineno-0-208"></a>        <span class="n">count</span><span class="p">,</span> <span class="n">until</span> <span class="o">=</span> <span class="p">(</span><span class="kc">None</span><span class="p">,</span> <span class="kc">None</span><span class="p">)</span>
+</span><span id="__span-0-209"><a id="__codelineno-0-209" name="__codelineno-0-209"></a>        <span class="k">if</span> <span class="n">end</span> <span class="o">:=</span> <span class="bp">self</span><span class="o">.</span><span class="n">end_criteria</span><span class="p">:</span>
+</span><span id="__span-0-210"><a id="__codelineno-0-210" name="__codelineno-0-210"></a>            <span class="n">count</span> <span class="o">=</span> <span class="n">end</span><span class="o">.</span><span class="n">count</span>
+</span><span id="__span-0-211"><a id="__codelineno-0-211" name="__codelineno-0-211"></a>            <span class="n">until</span> <span class="o">=</span> <span class="n">end</span><span class="o">.</span><span class="n">until</span>
+</span><span id="__span-0-212"><a id="__codelineno-0-212" name="__codelineno-0-212"></a>
+</span><span id="__span-0-213"><a id="__codelineno-0-213" name="__codelineno-0-213"></a>        <span class="n">rrule_obj</span> <span class="o">=</span> <span class="n">rrule</span><span class="o">.</span><span class="n">rrule</span><span class="p">(</span>
+</span><span id="__span-0-214"><a id="__codelineno-0-214" name="__codelineno-0-214"></a>            <span class="c1"># Mypy expects a Literal for the `freq` argument, but it can&#39;t infer</span>
+</span><span id="__span-0-215"><a id="__codelineno-0-215" name="__codelineno-0-215"></a>            <span class="c1"># that the values from the `_RRULE_FREQ_MAP` dictionary are of the</span>
+</span><span id="__span-0-216"><a id="__codelineno-0-216" name="__codelineno-0-216"></a>            <span class="c1"># correct type.</span>
+</span><span id="__span-0-217"><a id="__codelineno-0-217" name="__codelineno-0-217"></a>            <span class="n">freq</span><span class="o">=</span><span class="n">_RRULE_FREQ_MAP</span><span class="p">[</span><span class="bp">self</span><span class="o">.</span><span class="n">frequency</span><span class="p">],</span>  <span class="c1"># type: ignore[arg-type]</span>
+</span><span id="__span-0-218"><a id="__codelineno-0-218" name="__codelineno-0-218"></a>            <span class="n">dtstart</span><span class="o">=</span><span class="n">start_time</span><span class="p">,</span>
+</span><span id="__span-0-219"><a id="__codelineno-0-219" name="__codelineno-0-219"></a>            <span class="n">count</span><span class="o">=</span><span class="n">count</span><span class="p">,</span>
+</span><span id="__span-0-220"><a id="__codelineno-0-220" name="__codelineno-0-220"></a>            <span class="n">until</span><span class="o">=</span><span class="n">until</span><span class="p">,</span>
+</span><span id="__span-0-221"><a id="__codelineno-0-221" name="__codelineno-0-221"></a>            <span class="n">byminute</span><span class="o">=</span><span class="bp">self</span><span class="o">.</span><span class="n">byminutes</span> <span class="ow">or</span> <span class="kc">None</span><span class="p">,</span>
+</span><span id="__span-0-222"><a id="__codelineno-0-222" name="__codelineno-0-222"></a>            <span class="n">byhour</span><span class="o">=</span><span class="bp">self</span><span class="o">.</span><span class="n">byhours</span> <span class="ow">or</span> <span class="kc">None</span><span class="p">,</span>
+</span><span id="__span-0-223"><a id="__codelineno-0-223" name="__codelineno-0-223"></a>            <span class="n">byweekday</span><span class="o">=</span><span class="p">[</span><span class="n">_RRULE_WEEKDAY_MAP</span><span class="p">[</span><span class="n">weekday</span><span class="p">]</span> <span class="k">for</span> <span class="n">weekday</span> <span class="ow">in</span> <span class="bp">self</span><span class="o">.</span><span class="n">byweekdays</span><span class="p">]</span>
+</span><span id="__span-0-224"><a id="__codelineno-0-224" name="__codelineno-0-224"></a>            <span class="ow">or</span> <span class="kc">None</span><span class="p">,</span>
+</span><span id="__span-0-225"><a id="__codelineno-0-225" name="__codelineno-0-225"></a>            <span class="n">bymonthday</span><span class="o">=</span><span class="bp">self</span><span class="o">.</span><span class="n">bymonthdays</span> <span class="ow">or</span> <span class="kc">None</span><span class="p">,</span>
+</span><span id="__span-0-226"><a id="__codelineno-0-226" name="__codelineno-0-226"></a>            <span class="n">bymonth</span><span class="o">=</span><span class="bp">self</span><span class="o">.</span><span class="n">bymonths</span> <span class="ow">or</span> <span class="kc">None</span><span class="p">,</span>
+</span><span id="__span-0-227"><a id="__codelineno-0-227" name="__codelineno-0-227"></a>            <span class="n">interval</span><span class="o">=</span><span class="bp">self</span><span class="o">.</span><span class="n">interval</span><span class="p">,</span>
+</span><span id="__span-0-228"><a id="__codelineno-0-228" name="__codelineno-0-228"></a>        <span class="p">)</span>
+</span><span id="__span-0-229"><a id="__codelineno-0-229" name="__codelineno-0-229"></a>
+</span><span id="__span-0-230"><a id="__codelineno-0-230" name="__codelineno-0-230"></a>        <span class="k">return</span> <span class="n">rrule_obj</span>
 </span></code></pre></div></td></tr></table></div>
               </details>
 

v0.12-dev/search/search_index.json

@@ -1 +1,123 @@
-[{"version":"v0.12-dev","title":"v0.12-dev (5b19025)","aliases":["v0-dev","latest-dev"]},{"version":"v0.11-dev","title":"v0.11-dev (727f451)","aliases":[]},{"version":"v0.11","title":"v0.11.2","aliases":["v0","latest"]},{"version":"v0.10-dev","title":"v0.10-dev (02a3d6d)","aliases":[]},{"version":"v0.10","title":"v0.10.2","aliases":[]},{"version":"v0.9-dev","title":"v0.9-dev (207b4e9)","aliases":[]},{"version":"v0.9","title":"v0.9.0","aliases":[]},{"version":"v0.8-dev","title":"v0.8-dev (eb35d0d)","aliases":[]},{"version":"v0.8","title":"v0.8.5","aliases":[]},{"version":"v0.7-dev","title":"v0.7-dev (66c64a9)","aliases":[]},{"version":"v0.7","title":"v0.7.1","aliases":[]},{"version":"v0.6-dev","title":"v0.6-dev (232b3f3)","aliases":[]},{"version":"v0.6","title":"v0.6.0","aliases":[]},{"version":"v0.5-dev","title":"v0.5-dev (21f972f)","aliases":[]},{"version":"v0.5","title":"v0.5.0","aliases":[]},{"version":"v0.4-dev","title":"v0.4-dev (3c3cc8c)","aliases":[]},{"version":"v0.4","title":"v0.4.0","aliases":[]},{"version":"v0.3","title":"v0.3.0","aliases":[]},{"version":"v0.2-dev","title":"v0.2-dev (93a38b1)","aliases":[]},{"version":"v0.2","title":"v0.2.0","aliases":[]},{"version":"v0.1-dev","title":"v0.1-dev","aliases":[]},{"version":"v0.1","title":"v0.1.0","aliases":[]},{"version":"v0.0-dev","title":"v0.0-dev (df5f983)","aliases":[]}]
+[
+  {
+    "version": "v0.12-dev",
+    "title": "v0.12-dev (4ba7990)",
+    "aliases": [
+      "latest-dev",
+      "v0-dev"
+    ]
+  },
+  {
+    "version": "v0.11",
+    "title": "v0.11.2",
+    "aliases": [
+      "v0",
+      "latest"
+    ]
+  },
+  {
+    "version": "v0.11-dev",
+    "title": "v0.11-dev (727f451)",
+    "aliases": []
+  },
+  {
+    "version": "v0.10",
+    "title": "v0.10.2",
+    "aliases": []
+  },
+  {
+    "version": "v0.10-dev",
+    "title": "v0.10-dev (02a3d6d)",
+    "aliases": []
+  },
+  {
+    "version": "v0.9",
+    "title": "v0.9.0",
+    "aliases": []
+  },
+  {
+    "version": "v0.9-dev",
+    "title": "v0.9-dev (207b4e9)",
+    "aliases": []
+  },
+  {
+    "version": "v0.8",
+    "title": "v0.8.5",
+    "aliases": []
+  },
+  {
+    "version": "v0.8-dev",
+    "title": "v0.8-dev (eb35d0d)",
+    "aliases": []
+  },
+  {
+    "version": "v0.7",
+    "title": "v0.7.1",
+    "aliases": []
+  },
+  {
+    "version": "v0.7-dev",
+    "title": "v0.7-dev (66c64a9)",
+    "aliases": []
+  },
+  {
+    "version": "v0.6",
+    "title": "v0.6.0",
+    "aliases": []
+  },
+  {
+    "version": "v0.6-dev",
+    "title": "v0.6-dev (232b3f3)",
+    "aliases": []
+  },
+  {
+    "version": "v0.5",
+    "title": "v0.5.0",
+    "aliases": []
+  },
+  {
+    "version": "v0.5-dev",
+    "title": "v0.5-dev (21f972f)",
+    "aliases": []
+  },
+  {
+    "version": "v0.4",
+    "title": "v0.4.0",
+    "aliases": []
+  },
+  {
+    "version": "v0.4-dev",
+    "title": "v0.4-dev (3c3cc8c)",
+    "aliases": []
+  },
+  {
+    "version": "v0.3",
+    "title": "v0.3.0",
+    "aliases": []
+  },
+  {
+    "version": "v0.2",
+    "title": "v0.2.0",
+    "aliases": []
+  },
+  {
+    "version": "v0.2-dev",
+    "title": "v0.2-dev (93a38b1)",
+    "aliases": []
+  },
+  {
+    "version": "v0.1",
+    "title": "v0.1.0",
+    "aliases": []
+  },
+  {
+    "version": "v0.1-dev",
+    "title": "v0.1-dev",
+    "aliases": []
+  },
+  {
+    "version": "v0.0-dev",
+    "title": "v0.0-dev (df5f983)",
+    "aliases": []
+  }
+]