Repair docs (html, md). Update docstrings
This commit is contained in:
parent
e264750187
commit
6a4ad48577
125 changed files with 3706 additions and 4913 deletions
|
|
@ -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.arp_service">
|
||||
<span id="arp-service"></span><h1>ARP Service<a class="headerlink" href="#module-services.arp_service" title="Link to this heading">¶</a></h1>
|
||||
<section id="arp-service">
|
||||
<h1>ARP Service<a class="headerlink" href="#arp-service" title="Link to this heading">¶</a></h1>
|
||||
<p>Сервис низкоуровневого ARP-сканирования локальной сети.</p>
|
||||
<p>Назначение:</p>
|
||||
<ul class="simple">
|
||||
|
|
@ -300,46 +300,53 @@
|
|||
<li><p>Для отправки ARP-кадров могут потребоваться повышенные привилегии или capability на сырой сокет.</p></li>
|
||||
</ul>
|
||||
<dl class="py class">
|
||||
<dt class="sig sig-object py" id="services.arp_service.NetworkScanner">
|
||||
<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.arp_service.</span></span><span class="sig-name descname"><span class="pre">NetworkScanner</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">interface</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</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><a class="reference internal" href="../../_modules/services/arp_service.html#NetworkScanner"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#services.arp_service.NetworkScanner" 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.arp_service.</span></span><span class="sig-name descname"><span class="pre">NetworkScanner</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">interface</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</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><a class="reference internal" href="../../_modules/services/arp_service.html#NetworkScanner"><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>Инициализация сетевого сканера.</p>
|
||||
<p>Предоставляет методы для сканирования сети с использованием ARP-запросов и
|
||||
вывода информации о клиентах.</p>
|
||||
<dl class="py method">
|
||||
<dt class="sig sig-object py" id="services.arp_service.NetworkScanner.print_clients">
|
||||
<span class="sig-name descname"><span class="pre">print_clients</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">clients</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="../../_modules/services/arp_service.html#NetworkScanner.print_clients"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#services.arp_service.NetworkScanner.print_clients" title="Link to this definition">¶</a></dt>
|
||||
<dt class="sig sig-object py">
|
||||
<span class="sig-name descname"><span class="pre">print_clients</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">clients</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="../../_modules/services/arp_service.html#NetworkScanner.print_clients"><span class="viewcode-link"><span class="pre">[source]</span></span></a></dt>
|
||||
<dd><p>Выводит список адресов клиентов в формате таблицы.</p>
|
||||
<dl class="simple">
|
||||
<dt>Args:</dt><dd><dl class="simple">
|
||||
<dt>clients (List[dict]): Список словарей с ключами “ip” и “mac”,</dt><dd><p>представляющих клиентов.</p>
|
||||
</dd>
|
||||
</dl>
|
||||
<dl class="field-list simple">
|
||||
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
|
||||
<dd class="field-odd"><p><strong>clients</strong> (<em>List</em><em>[</em><em>dict</em><em>]</em>) – Список словарей с ключами “ip” и “mac”,
|
||||
представляющих клиентов.</p>
|
||||
</dd>
|
||||
</dl>
|
||||
<p>Выводит IP-адреса и MAC-адреса в отсортированном по IP порядке.</p>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py method">
|
||||
<dt class="sig sig-object py" id="services.arp_service.NetworkScanner.scan_network">
|
||||
<span class="sig-name descname"><span class="pre">scan_network</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">attempts</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">3</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">timeout</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">2</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="../../_modules/services/arp_service.html#NetworkScanner.scan_network"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#services.arp_service.NetworkScanner.scan_network" title="Link to this definition">¶</a></dt>
|
||||
<dt class="sig sig-object py">
|
||||
<span class="sig-name descname"><span class="pre">scan_network</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">attempts</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">3</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">timeout</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">2</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="../../_modules/services/arp_service.html#NetworkScanner.scan_network"><span class="viewcode-link"><span class="pre">[source]</span></span></a></dt>
|
||||
<dd><p>Сканирует сеть для обнаружения активных клиентов.</p>
|
||||
<dl class="simple">
|
||||
<dt>Args:</dt><dd><dl class="simple">
|
||||
<dt>attempts (int, optional): Количество попыток отправки ARP-запросов.</dt><dd><p>По умолчанию 3.</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>attempts</strong> (<em>int</em><em>, </em><em>optional</em>) – Количество попыток отправки ARP-запросов.
|
||||
По умолчанию 3.</p></li>
|
||||
<li><p><strong>timeout</strong> (<em>int</em><em>, </em><em>optional</em>) – Таймаут ожидания ответа в секундах.
|
||||
По умолчанию 2.</p></li>
|
||||
</ul>
|
||||
</dd>
|
||||
<dt>timeout (int, optional): Таймаут ожидания ответа в секундах.</dt><dd><p>По умолчанию 2.</p>
|
||||
<dt class="field-even">Returns<span class="colon">:</span></dt>
|
||||
<dd class="field-even"><p><dl class="simple">
|
||||
<dt>Список словарей с ключами “ip” и “mac”, представляющих</dt><dd><p>обнаруженных клиентов, включая локальные IP-адреса.</p>
|
||||
</dd>
|
||||
</dl>
|
||||
</p>
|
||||
</dd>
|
||||
<dt>Returns:</dt><dd><dl class="simple">
|
||||
<dt>List[dict]: Список словарей с ключами “ip” и “mac”, представляющих</dt><dd><p>обнаруженных клиентов, включая локальные IP-адреса.</p>
|
||||
</dd>
|
||||
</dl>
|
||||
</dd>
|
||||
<dt>Note:</dt><dd><p>Учитывает локальные IP-адреса интерфейса и удаляет дубликаты.</p>
|
||||
<dt class="field-odd">Return type<span class="colon">:</span></dt>
|
||||
<dd class="field-odd"><p>List[dict]</p>
|
||||
</dd>
|
||||
</dl>
|
||||
<div class="admonition note">
|
||||
<p class="admonition-title">Note</p>
|
||||
<p>Учитывает локальные IP-адреса интерфейса и удаляет дубликаты.</p>
|
||||
</div>
|
||||
</dd></dl>
|
||||
|
||||
</dd></dl>
|
||||
|
|
@ -389,32 +396,9 @@
|
|||
|
||||
</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="#">ARP Service</a><ul>
|
||||
<li><a class="reference internal" href="#services.arp_service.NetworkScanner"><code class="docutils literal notranslate"><span class="pre">NetworkScanner</span></code></a><ul>
|
||||
<li><a class="reference internal" href="#services.arp_service.NetworkScanner.print_clients"><code class="docutils literal notranslate"><span class="pre">NetworkScanner.print_clients()</span></code></a></li>
|
||||
<li><a class="reference internal" href="#services.arp_service.NetworkScanner.scan_network"><code class="docutils literal notranslate"><span class="pre">NetworkScanner.scan_network()</span></code></a></li>
|
||||
</ul>
|
||||
</li>
|
||||
</ul>
|
||||
</li>
|
||||
</ul>
|
||||
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
|
||||
|
||||
</aside>
|
||||
</div>
|
||||
|
|
|
|||
Loading…
Add table
Add a link
Reference in a new issue