Repair docs (html, md). Update docstrings

2025-10-21 10:51:32 +05:00 · 2025-10-21 10:51:32 +05:00 · 6a4ad48577
commit 6a4ad48577
parent e264750187
125 changed files with 3706 additions and 4913 deletions
--- a/SRV/docs/_build/html/api/services/ip_service.html
+++ b/SRV/docs/_build/html/api/services/ip_service.html
@ -172,7 +172,7 @@
          <svg class="theme-icon-when-light"><use href="#svg-sun"></use></svg>
        </button>
      </div>
-      <label class="toc-overlay-icon toc-header-icon" for="__toc">
+      <label class="toc-overlay-icon toc-header-icon no-toc" for="__toc">
        <span class="icon"><svg><use href="#svg-toc"></use></svg></span>
      </label>
    </div>
@ -276,82 +276,88 @@
              <svg class="theme-icon-when-light"><use href="#svg-sun"></use></svg>
            </button>
          </div>
-          <label class="toc-overlay-icon toc-content-icon" for="__toc">
+          <label class="toc-overlay-icon toc-content-icon no-toc" for="__toc">
            <span class="icon"><svg><use href="#svg-toc"></use></svg></span>
          </label>
        </div>
        <article role="main" id="furo-main-content">
-          <section id="module-services.ip_service">
-<span id="ip-service"></span><h1>IP Service<a class="headerlink" href="#module-services.ip_service" title="Link to this heading">¶</a></h1>
+          <section id="ip-service">
+<h1>IP Service<a class="headerlink" href="#ip-service" title="Link to this heading">¶</a></h1>
 <p>Сервис проверки и применения IP-настроек через NetworkManager (D-Bus).</p>
-<p>Назначение:
- Перед применением конфигурации проверяет занятость IP адреса, сканируя сегмент</p>
-<blockquote>
-<div><p>сети средствами ARP (через <cite>NetworkScanner</cite>).</p>
-</div></blockquote>
+<p>Назначение:</p>
 <ul class="simple">
-<li><p>Применяет изменения профиля подключения через <cite>sdbus_async.networkmanager</cite> и
-выполняет переподключение интерфейса.</p></li>
+<li><p>Перед применением конфигурации проверяет занятость IP адреса, сканируя сегмент сети средствами ARP (через <cite>NetworkScanner</cite>).</p></li>
+<li><p>Применяет изменения профиля подключения через <cite>sdbus_async.networkmanager</cite> и выполняет переподключение интерфейса.</p></li>
+</ul>
+<p>Требования/ограничения:</p>
+<ul class="simple">
+<li><p>Доступ к системной шине D-Bus и права на изменения сетевых профилей.</p></li>
+<li><p>Структура входных данных должна соответствовать схеме <cite>ipv4_updates</cite> для корректного обновления вложенных полей у профиля.</p></li>
 </ul>
-<p>Требования/ограничения:
- Доступ к системной шине D-Bus и права на изменения сетевых профилей.
- Структура входных данных должна соответствовать схеме <cite>ipv4_updates</cite> для</p>
-<blockquote>
-<div><p>корректного обновления вложенных полей у профиля.</p>
-</div></blockquote>
 <dl class="py class">
-<dt class="sig sig-object py" id="services.ip_service.IPService">
-<em class="property"><span class="k"><span class="pre">class</span></span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">services.ip_service.</span></span><span class="sig-name descname"><span class="pre">IPService</span></span><a class="reference internal" href="../../_modules/services/ip_service.html#IPService"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#services.ip_service.IPService" title="Link to this definition">¶</a></dt>
+<dt class="sig sig-object py">
+<em class="property"><span class="k"><span class="pre">class</span></span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">services.ip_service.</span></span><span class="sig-name descname"><span class="pre">IPService</span></span><a class="reference internal" href="../../_modules/services/ip_service.html#IPService"><span class="viewcode-link"><span class="pre">[source]</span></span></a></dt>
 <dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">object</span></code></p>
 <p>Сервис проверки доступности IP-адреса и применения настроек сети.</p>
 <p>Предоставляет асинхронные методы для проверки занятости IP-адреса с использованием
 ARP-сканирования и применения настроек через NetworkManager.</p>
 <dl class="py method">
-<dt class="sig sig-object py" id="services.ip_service.IPService.apply_ip_config">
-<em class="property"><span class="k"><span class="pre">async</span></span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">apply_ip_config</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">args</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">Dict</span><span class="p"><span class="pre">[</span></span><span class="pre">str</span><span class="p"><span class="pre">,</span></span><span class="w"> </span><span class="pre">Any</span><span class="p"><span class="pre">]</span></span></span></em>, <em class="sig-param"><span class="n"><span class="pre">translations</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">Translations</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">Depends(translations_dependency)</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="reference internal" href="../../_modules/services/ip_service.html#IPService.apply_ip_config"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#services.ip_service.IPService.apply_ip_config" title="Link to this definition">¶</a></dt>
+<dt class="sig sig-object py">
+<em class="property"><span class="k"><span class="pre">async</span></span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">apply_ip_config</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">args</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">Dict</span><span class="p"><span class="pre">[</span></span><span class="pre">str</span><span class="p"><span class="pre">,</span></span><span class="w"> </span><span class="pre">Any</span><span class="p"><span class="pre">]</span></span></span></em>, <em class="sig-param"><span class="n"><span class="pre">translations</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">Translations</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">Depends(translations_dependency)</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="reference internal" href="../../_modules/services/ip_service.html#IPService.apply_ip_config"><span class="viewcode-link"><span class="pre">[source]</span></span></a></dt>
 <dd><p>Применяет проверенные настройки IP к указанному соединению.</p>
 <p>Перезапускает шину D-Bus, обновляет настройки соединения через NetworkManager,
 отключает и переподключает устройство к сети.</p>
-<dl>
-<dt>Args:</dt><dd><dl class="simple">
-<dt>args (Dict[str, Any]): Словарь с данными, включая:</dt><dd><ul class="simple">
-<li><p>“connection_id” (str): Идентификатор соединения.</p></li>
-<li><p>“ipv4_updates” (Dict): Обновления настроек IPv4.</p></li>
+<dl class="field-list simple">
+<dt class="field-odd">Parameters<span class="colon">:</span></dt>
+<dd class="field-odd"><ul class="simple">
+<li><p><strong>args</strong> (<em>Dict</em><em>[</em><em>str</em><em>, </em><em>Any</em><em>]</em>) – Словарь с данными, включая:
+- “connection_id” (str): Идентификатор соединения.
+- “ipv4_updates” (Dict): Обновления настроек IPv4.</p></li>
+<li><p><strong>translations</strong> (<em>Translations</em>) – Объект переводов.</p></li>
+</ul>
+</dd>
+<dt class="field-even">Raises<span class="colon">:</span></dt>
+<dd class="field-even"><ul class="simple">
+<li><p><strong>ValueError</strong> – Если соединение с указанным ID не найдено.</p></li>
+<li><p><strong>RuntimeError</strong> – Если устройство для интерфейса не найдено.</p></li>
 </ul>
 </dd>
 </dl>
-<p>translations (Translations): Объект переводов.</p>
-</dd>
-<dt>Raises:</dt><dd><p>ValueError: Если соединение с указанным ID не найдено.
-RuntimeError: Если устройство для интерфейса не найдено.</p>
-</dd>
-<dt>Note:</dt><dd><p>Требуются права для изменения настроек через NetworkManager.</p>
-</dd>
-</dl>
+<div class="admonition note">
+<p class="admonition-title">Note</p>
+<p>Требуются права для изменения настроек через NetworkManager.</p>
+</div>
 </dd></dl>

 <dl class="py method">
-<dt class="sig sig-object py" id="services.ip_service.IPService.check_ip_config">
-<em class="property"><span class="k"><span class="pre">async</span></span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">check_ip_config</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">args</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">Dict</span><span class="p"><span class="pre">[</span></span><span class="pre">str</span><span class="p"><span class="pre">,</span></span><span class="w"> </span><span class="pre">Any</span><span class="p"><span class="pre">]</span></span></span></em>, <em class="sig-param"><span class="n"><span class="pre">translations</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">Translations</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">Depends(translations_dependency)</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">Dict</span><span class="p"><span class="pre">[</span></span><span class="pre">str</span><span class="p"><span class="pre">,</span></span><span class="w"> </span><span class="pre">Any</span><span class="p"><span class="pre">]</span></span></span></span><a class="reference internal" href="../../_modules/services/ip_service.html#IPService.check_ip_config"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#services.ip_service.IPService.check_ip_config" title="Link to this definition">¶</a></dt>
+<dt class="sig sig-object py">
+<em class="property"><span class="k"><span class="pre">async</span></span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">check_ip_config</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">args</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">Dict</span><span class="p"><span class="pre">[</span></span><span class="pre">str</span><span class="p"><span class="pre">,</span></span><span class="w"> </span><span class="pre">Any</span><span class="p"><span class="pre">]</span></span></span></em>, <em class="sig-param"><span class="n"><span class="pre">translations</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">Translations</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">Depends(translations_dependency)</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">Dict</span><span class="p"><span class="pre">[</span></span><span class="pre">str</span><span class="p"><span class="pre">,</span></span><span class="w"> </span><span class="pre">Any</span><span class="p"><span class="pre">]</span></span></span></span><a class="reference internal" href="../../_modules/services/ip_service.html#IPService.check_ip_config"><span class="viewcode-link"><span class="pre">[source]</span></span></a></dt>
 <dd><p>Проверяет доступность IP-адреса перед его применением.</p>
 <p>Выполняет ARP-сканирование сети для проверки, занят ли указанный IP-адрес.
 Перезапускает шину D-Bus перед выполнением.</p>
-<dl>
-<dt>Args:</dt><dd><dl class="simple">
-<dt>args (Dict[str, Any]): Словарь с данными, включая “ipv4_updates”</dt><dd><p>с полем “ipv4.address-data” для нового IP-адреса.</p>
+<dl class="field-list simple">
+<dt class="field-odd">Parameters<span class="colon">:</span></dt>
+<dd class="field-odd"><ul class="simple">
+<li><p><strong>args</strong> (<em>Dict</em><em>[</em><em>str</em><em>, </em><em>Any</em><em>]</em>) – Словарь с данными, включая “ipv4_updates”
+с полем “ipv4.address-data” для нового IP-адреса.</p></li>
+<li><p><strong>translations</strong> (<em>Translations</em>) – Объект переводов.</p></li>
+</ul>
 </dd>
-</dl>
-<p>translations (Translations): Объект переводов.</p>
-</dd>
-<dt>Returns:</dt><dd><dl class="simple">
-<dt>Dict[str, Any]: Словарь с ключами:</dt><dd><ul class="simple">
-<li><p>“available” (bool): Доступен ли IP-адрес.</p></li>
-<li><p>“message” (str): Сообщение о результате проверки.</p></li>
+<dt class="field-even">Returns<span class="colon">:</span></dt>
+<dd class="field-even"><p><dl class="simple">
+<dt>Словарь с ключами:</dt><dd><ul class="simple">
+<li><p>”available” (bool): Доступен ли IP-адрес.</p></li>
+<li><p>”message” (str): Сообщение о результате проверки.</p></li>
 </ul>
 </dd>
 </dl>
+</p>
 </dd>
-<dt>Raises:</dt><dd><p>Exception: Если произошла ошибка при сканировании ARP.</p>
+<dt class="field-odd">Return type<span class="colon">:</span></dt>
+<dd class="field-odd"><p>Dict[str, Any]</p>
+</dd>
+<dt class="field-even">Raises<span class="colon">:</span></dt>
+<dd class="field-even"><p><strong>Exception</strong> – Если произошла ошибка при сканировании ARP.</p>
 </dd>
 </dl>
 </dd></dl>
@ -403,32 +409,9 @@ RuntimeError: Если устройство для интерфейса не н
        
      </footer>
    </div>
-    <aside class="toc-drawer">
+    <aside class="toc-drawer no-toc">
      
      
-      <div class="toc-sticky toc-scroll">
-        <div class="toc-title-container">
-          <span class="toc-title">
-            On this page
-          </span>
-        </div>
-        <div class="toc-tree-container">
-          <div class="toc-tree">
-            <ul>
-<li><a class="reference internal" href="#">IP Service</a><ul>
-<li><a class="reference internal" href="#services.ip_service.IPService"><code class="docutils literal notranslate"><span class="pre">IPService</span></code></a><ul>
-<li><a class="reference internal" href="#services.ip_service.IPService.apply_ip_config"><code class="docutils literal notranslate"><span class="pre">IPService.apply_ip_config()</span></code></a></li>
-<li><a class="reference internal" href="#services.ip_service.IPService.check_ip_config"><code class="docutils literal notranslate"><span class="pre">IPService.check_ip_config()</span></code></a></li>
-</ul>
-</li>
-</ul>
-</li>
-</ul>
-
-          </div>
-        </div>
-      </div>
-      
      
    </aside>
  </div>