|
237 | 237 | <dl class="py class">
|
238 | 238 | <dt class="sig sig-object py" id="docker_tag_updater.helpers.regex_rules.RegexRules">
|
239 | 239 | <em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">RegexRules</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">rules</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#docker_tag_updater.helpers.regex_rules.RegexRules" title="Link to this definition">#</a></dt>
|
240 |
| -<dd><p>Bases: <a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#dict" title="(in Python v3.12)"><code class="xref py py-class docutils literal notranslate"><span class="pre">dict</span></code></a></p> |
| 240 | +<dd><p>Bases: <a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#dict" title="(in Python v3.13)"><code class="xref py py-class docutils literal notranslate"><span class="pre">dict</span></code></a></p> |
241 | 241 | <p>An aliased dictionary with defined regex rules for version parsing.</p>
|
242 | 242 | <dl class="field-list simple">
|
243 | 243 | <dt class="field-odd">Parameters<span class="colon">:</span></dt>
|
244 |
| -<dd class="field-odd"><p><strong>rules</strong> (<span class="sphinx_autodoc_typehints-type"><a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#dict" title="(in Python v3.12)"><code class="xref py py-class docutils literal notranslate"><span class="pre">dict</span></code></a>[<a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#str" title="(in Python v3.12)"><code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code></a>, <a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#str" title="(in Python v3.12)"><code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code></a>]</span>) – A dictionary containing names as keys and regex strings as values.</p> |
| 244 | +<dd class="field-odd"><p><strong>rules</strong> (<span class="sphinx_autodoc_typehints-type"><a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#dict" title="(in Python v3.13)"><code class="xref py py-class docutils literal notranslate"><span class="pre">dict</span></code></a>[<a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#str" title="(in Python v3.13)"><code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code></a>, <a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#str" title="(in Python v3.13)"><code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code></a>]</span>) – A dictionary containing names as keys and regex strings as values.</p> |
245 | 245 | </dd>
|
246 | 246 | </dl>
|
247 | 247 | <p class="rubric">Examples</p>
|
|
271 | 271 | <dl class="field-list simple">
|
272 | 272 | <dt class="field-odd">Parameters<span class="colon">:</span></dt>
|
273 | 273 | <dd class="field-odd"><ul class="simple">
|
274 |
| -<li><p><strong>main_rule</strong> (<span class="sphinx_autodoc_typehints-type"><a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#str" title="(in Python v3.12)"><code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code></a></span>) – The name main rule to add aliases to.</p></li> |
275 |
| -<li><p><strong>aliases</strong> (<span class="sphinx_autodoc_typehints-type"><a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#str" title="(in Python v3.12)"><code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code></a></span>) – Strings of aliases to the main rule.</p></li> |
| 274 | +<li><p><strong>main_rule</strong> (<span class="sphinx_autodoc_typehints-type"><a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#str" title="(in Python v3.13)"><code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code></a></span>) – The name main rule to add aliases to.</p></li> |
| 275 | +<li><p><strong>aliases</strong> (<span class="sphinx_autodoc_typehints-type"><a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#str" title="(in Python v3.13)"><code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code></a></span>) – Strings of aliases to the main rule.</p></li> |
276 | 276 | </ul>
|
277 | 277 | </dd>
|
278 | 278 | <dt class="field-even">Return type<span class="colon">:</span></dt>
|
279 |
| -<dd class="field-even"><p><span class="sphinx_autodoc_typehints-type"><a class="reference external" href="https://docs.python.org/3/library/constants.html#None" title="(in Python v3.12)"><code class="xref py py-obj docutils literal notranslate"><span class="pre">None</span></code></a></span></p> |
| 279 | +<dd class="field-even"><p><span class="sphinx_autodoc_typehints-type"><a class="reference external" href="https://docs.python.org/3/library/constants.html#None" title="(in Python v3.13)"><code class="xref py py-obj docutils literal notranslate"><span class="pre">None</span></code></a></span></p> |
280 | 280 | </dd>
|
281 | 281 | </dl>
|
282 | 282 | <p class="rubric">Examples</p>
|
|
285 | 285 | >>> DefaultRules.add_alias(“default”, “docker.io”, “docker”)</p>
|
286 | 286 | <dl class="field-list simple">
|
287 | 287 | <dt class="field-odd">Raises<span class="colon">:</span></dt>
|
288 |
| -<dd class="field-odd"><p><a class="reference external" href="https://docs.python.org/3/library/exceptions.html#NotImplementedError" title="(in Python v3.12)"><strong>NotImplementedError</strong></a> – If there are no aliases to be added.</p> |
| 288 | +<dd class="field-odd"><p><a class="reference external" href="https://docs.python.org/3/library/exceptions.html#NotImplementedError" title="(in Python v3.13)"><strong>NotImplementedError</strong></a> – If there are no aliases to be added.</p> |
289 | 289 | </dd>
|
290 | 290 | </dl>
|
291 | 291 | </dd></dl>
|
|
296 | 296 | <dd><p>Redefine the get function.</p>
|
297 | 297 | <dl class="field-list simple">
|
298 | 298 | <dt class="field-odd">Parameters<span class="colon">:</span></dt>
|
299 |
| -<dd class="field-odd"><p><strong>rule</strong> (<span class="sphinx_autodoc_typehints-type"><a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#str" title="(in Python v3.12)"><code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code></a></span>) – The name of the rule or its alias.</p> |
| 299 | +<dd class="field-odd"><p><strong>rule</strong> (<span class="sphinx_autodoc_typehints-type"><a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#str" title="(in Python v3.13)"><code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code></a></span>) – The name of the rule or its alias.</p> |
300 | 300 | </dd>
|
301 | 301 | <dt class="field-even">Return type<span class="colon">:</span></dt>
|
302 |
| -<dd class="field-even"><p><span class="sphinx_autodoc_typehints-type"><a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#str" title="(in Python v3.12)"><code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code></a></span></p> |
| 302 | +<dd class="field-even"><p><span class="sphinx_autodoc_typehints-type"><a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#str" title="(in Python v3.13)"><code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code></a></span></p> |
303 | 303 | </dd>
|
304 | 304 | <dt class="field-odd">Returns<span class="colon">:</span></dt>
|
305 | 305 | <dd class="field-odd"><p>A regex raw string.</p>
|
|
318 | 318 | <dd><p>Check if the rule exists or is an alias.</p>
|
319 | 319 | <dl class="field-list simple">
|
320 | 320 | <dt class="field-odd">Parameters<span class="colon">:</span></dt>
|
321 |
| -<dd class="field-odd"><p><strong>rule</strong> (<span class="sphinx_autodoc_typehints-type"><a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#str" title="(in Python v3.12)"><code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code></a></span>) – The name of the rule to check its existence of.</p> |
| 321 | +<dd class="field-odd"><p><strong>rule</strong> (<span class="sphinx_autodoc_typehints-type"><a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#str" title="(in Python v3.13)"><code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code></a></span>) – The name of the rule to check its existence of.</p> |
322 | 322 | </dd>
|
323 | 323 | <dt class="field-even">Return type<span class="colon">:</span></dt>
|
324 |
| -<dd class="field-even"><p><span class="sphinx_autodoc_typehints-type"><a class="reference external" href="https://docs.python.org/3/library/functions.html#bool" title="(in Python v3.12)"><code class="xref py py-class docutils literal notranslate"><span class="pre">bool</span></code></a></span></p> |
| 324 | +<dd class="field-even"><p><span class="sphinx_autodoc_typehints-type"><a class="reference external" href="https://docs.python.org/3/library/functions.html#bool" title="(in Python v3.13)"><code class="xref py py-class docutils literal notranslate"><span class="pre">bool</span></code></a></span></p> |
325 | 325 | </dd>
|
326 | 326 | <dt class="field-odd">Returns<span class="colon">:</span></dt>
|
327 | 327 | <dd class="field-odd"><p>True if the rule exists as either a real rule or an alias in this
|
|
0 commit comments