Repair docs (html, md). Update docstrings

This commit is contained in:
parent e264750187
commit 6a4ad48577
125 changed files with 3706 additions and 4913 deletions

View file

@ -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,13 +276,13 @@
<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.connect_service">
<span id="connect-service"></span><h1>Connect Service<a class="headerlink" href="#module-services.connect_service" title="Link to this heading"></a></h1>
<section id="connect-service">
<h1>Connect Service<a class="headerlink" href="#connect-service" title="Link to this heading"></a></h1>
<p>Сервис управления подключениями Wi-Fi через <cite>nmcli</cite>.</p>
<p>Назначение:</p>
<ul class="simple">
@ -299,68 +299,94 @@
<li><p>В окружениях без NetworkManager команды <cite>nmcli</cite> будут недоступны.</p></li>
</ul>
<dl class="py class">
<dt class="sig sig-object py" id="services.connect_service.WifiConnectionService">
<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.connect_service.</span></span><span class="sig-name descname"><span class="pre">WifiConnectionService</span></span><span class="sig-paren">(</span><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><a class="reference internal" href="../../_modules/services/connect_service.html#WifiConnectionService"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#services.connect_service.WifiConnectionService" 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.connect_service.</span></span><span class="sig-name descname"><span class="pre">WifiConnectionService</span></span><span class="sig-paren">(</span><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><a class="reference internal" href="../../_modules/services/connect_service.html#WifiConnectionService"><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>Сервис для управления подключением к Wi-Fi сетям с использованием nmcli.</p>
<p>Предоставляет методы для подключения, отключения и проверки статуса Wi-Fi соединений.</p>
<dl class="py method">
<dt class="sig sig-object py" id="services.connect_service.WifiConnectionService.connect">
<span class="sig-name descname"><span class="pre">connect</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">ssid</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">password</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</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">Tuple</span><span class="p"><span class="pre">[</span></span><span class="pre">bool</span><span class="p"><span class="pre">,</span></span><span class="w"> </span><span class="pre">str</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">None</span><span class="p"><span class="pre">]</span></span></span></span><a class="reference internal" href="../../_modules/services/connect_service.html#WifiConnectionService.connect"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#services.connect_service.WifiConnectionService.connect" title="Link to this definition"></a></dt>
<dt class="sig sig-object py">
<span class="sig-name descname"><span class="pre">connect</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">ssid</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">password</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</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">Tuple</span><span class="p"><span class="pre">[</span></span><span class="pre">bool</span><span class="p"><span class="pre">,</span></span><span class="w"> </span><span class="pre">str</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">None</span><span class="p"><span class="pre">]</span></span></span></span><a class="reference internal" href="../../_modules/services/connect_service.html#WifiConnectionService.connect"><span class="viewcode-link"><span class="pre">[source]</span></span></a></dt>
<dd><p>Подключается к Wi-Fi сети по SSID и паролю.</p>
<dl class="simple">
<dt>Args:</dt><dd><p>ssid (str): Идентификатор сети Wi-Fi.
password (str): Пароль для подключения.</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>ssid</strong> (<em>str</em>) – Идентификатор сети Wi-Fi.</p></li>
<li><p><strong>password</strong> (<em>str</em>) – Пароль для подключения.</p></li>
</ul>
</dd>
<dt>Returns:</dt><dd><dl class="simple">
<dt>Tuple[bool, Optional[str]]: Кортеж (успех, сообщение об ошибке).</dt><dd><ul class="simple">
<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>Успех: (True, None).</p></li>
<li><p>Ошибка: (False, сообщение об ошибке).</p></li>
</ul>
</dd>
</dl>
</p>
</dd>
<dt>Raises:</dt><dd><p>subprocess.CalledProcessError: Если команда nmcli завершилась с ошибкой.
Exception: Если произошла неизвестная ошибка при выполнении.</p>
<dt class="field-odd">Return type<span class="colon">:</span></dt>
<dd class="field-odd"><p>Tuple[bool, Optional[str]]</p>
</dd>
<dt class="field-even">Raises<span class="colon">:</span></dt>
<dd class="field-even"><ul class="simple">
<li><p><strong>subprocess.CalledProcessError</strong> – Если команда nmcli завершилась с ошибкой.</p></li>
<li><p><strong>Exception</strong> – Если произошла неизвестная ошибка при выполнении.</p></li>
</ul>
</dd>
</dl>
</dd></dl>
<dl class="py method">
<dt class="sig sig-object py" id="services.connect_service.WifiConnectionService.disconnect">
<span class="sig-name descname"><span class="pre">disconnect</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">ssid</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</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">Tuple</span><span class="p"><span class="pre">[</span></span><span class="pre">bool</span><span class="p"><span class="pre">,</span></span><span class="w"> </span><span class="pre">str</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">None</span><span class="p"><span class="pre">]</span></span></span></span><a class="reference internal" href="../../_modules/services/connect_service.html#WifiConnectionService.disconnect"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#services.connect_service.WifiConnectionService.disconnect" title="Link to this definition"></a></dt>
<dt class="sig sig-object py">
<span class="sig-name descname"><span class="pre">disconnect</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">ssid</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</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">Tuple</span><span class="p"><span class="pre">[</span></span><span class="pre">bool</span><span class="p"><span class="pre">,</span></span><span class="w"> </span><span class="pre">str</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">None</span><span class="p"><span class="pre">]</span></span></span></span><a class="reference internal" href="../../_modules/services/connect_service.html#WifiConnectionService.disconnect"><span class="viewcode-link"><span class="pre">[source]</span></span></a></dt>
<dd><p>Отключается от Wi-Fi сети по указанному SSID.</p>
<dl class="simple">
<dt>Args:</dt><dd><p>ssid (str): Идентификатор сети Wi-Fi для отключения.</p>
<dl class="field-list simple">
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
<dd class="field-odd"><p><strong>ssid</strong> (<em>str</em>) – Идентификатор сети Wi-Fi для отключения.</p>
</dd>
<dt>Returns:</dt><dd><dl class="simple">
<dt>Tuple[bool, Optional[str]]: Кортеж (успех, сообщение об ошибке).</dt><dd><ul class="simple">
<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>Успех: (True, None или сообщение, если подключение не найдено).</p></li>
<li><p>Ошибка: (False, сообщение об ошибке).</p></li>
</ul>
</dd>
</dl>
</p>
</dd>
<dt>Raises:</dt><dd><p>subprocess.CalledProcessError: Если команда nmcli завершилась с ошибкой.
Exception: Если произошла неизвестная ошибка при выполнении.</p>
<dt class="field-odd">Return type<span class="colon">:</span></dt>
<dd class="field-odd"><p>Tuple[bool, Optional[str]]</p>
</dd>
<dt class="field-even">Raises<span class="colon">:</span></dt>
<dd class="field-even"><ul class="simple">
<li><p><strong>subprocess.CalledProcessError</strong> – Если команда nmcli завершилась с ошибкой.</p></li>
<li><p><strong>Exception</strong> – Если произошла неизвестная ошибка при выполнении.</p></li>
</ul>
</dd>
</dl>
</dd></dl>
<dl class="py method">
<dt class="sig sig-object py" id="services.connect_service.WifiConnectionService.get_status">
<span class="sig-name descname"><span class="pre">get_status</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">&#x2192;</span> <span class="sig-return-typehint"><span class="pre">Tuple</span><span class="p"><span class="pre">[</span></span><span class="pre">bool</span><span class="p"><span class="pre">,</span></span><span class="w"> </span><span class="pre">str</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">None</span><span class="p"><span class="pre">]</span></span></span></span><a class="reference internal" href="../../_modules/services/connect_service.html#WifiConnectionService.get_status"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#services.connect_service.WifiConnectionService.get_status" title="Link to this definition"></a></dt>
<dt class="sig sig-object py">
<span class="sig-name descname"><span class="pre">get_status</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">&#x2192;</span> <span class="sig-return-typehint"><span class="pre">Tuple</span><span class="p"><span class="pre">[</span></span><span class="pre">bool</span><span class="p"><span class="pre">,</span></span><span class="w"> </span><span class="pre">str</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">None</span><span class="p"><span class="pre">]</span></span></span></span><a class="reference internal" href="../../_modules/services/connect_service.html#WifiConnectionService.get_status"><span class="viewcode-link"><span class="pre">[source]</span></span></a></dt>
<dd><p>Проверяет статус текущего подключения к Wi-Fi.</p>
<dl class="simple">
<dt>Returns:</dt><dd><dl class="simple">
<dt>Tuple[bool, Optional[str]]: Кортеж (успех, SSID или сообщение об ошибке).</dt><dd><ul class="simple">
<dl class="field-list simple">
<dt class="field-odd">Returns<span class="colon">:</span></dt>
<dd class="field-odd"><p><dl class="simple">
<dt>Кортеж (успех, SSID или сообщение об ошибке).</dt><dd><ul class="simple">
<li><p>Успех: (True, SSID текущей сети).</p></li>
<li><p>Ошибка или отсутствие подключения: (False, сообщение об ошибке).</p></li>
</ul>
</dd>
</dl>
</p>
</dd>
<dt>Raises:</dt><dd><p>Exception: Если произошла ошибка при выполнении команды nmcli.</p>
<dt class="field-even">Return type<span class="colon">:</span></dt>
<dd class="field-even"><p>Tuple[bool, Optional[str]]</p>
</dd>
<dt class="field-odd">Raises<span class="colon">:</span></dt>
<dd class="field-odd"><p><strong>Exception</strong> – Если произошла ошибка при выполнении команды nmcli.</p>
</dd>
</dl>
</dd></dl>
@ -412,33 +438,9 @@ Exception: Если произошла неизвестная ошибка пр
</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="#">Connect Service</a><ul>
<li><a class="reference internal" href="#services.connect_service.WifiConnectionService"><code class="docutils literal notranslate"><span class="pre">WifiConnectionService</span></code></a><ul>
<li><a class="reference internal" href="#services.connect_service.WifiConnectionService.connect"><code class="docutils literal notranslate"><span class="pre">WifiConnectionService.connect()</span></code></a></li>
<li><a class="reference internal" href="#services.connect_service.WifiConnectionService.disconnect"><code class="docutils literal notranslate"><span class="pre">WifiConnectionService.disconnect()</span></code></a></li>
<li><a class="reference internal" href="#services.connect_service.WifiConnectionService.get_status"><code class="docutils literal notranslate"><span class="pre">WifiConnectionService.get_status()</span></code></a></li>
</ul>
</li>
</ul>
</li>
</ul>
</div>
</div>
</div>
</aside>
</div>