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,16 +276,16 @@
|
|||
<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.subnet_service">
|
||||
<span id="subnet-service"></span><h1>Subnet Service<a class="headerlink" href="#module-services.subnet_service" title="Link to this heading">¶</a></h1>
|
||||
<section id="subnet-service">
|
||||
<h1>Subnet Service<a class="headerlink" href="#subnet-service" title="Link to this heading">¶</a></h1>
|
||||
<dl class="py class">
|
||||
<dt class="sig sig-object py" id="services.subnet_service.DeviceInfoCollector">
|
||||
<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.subnet_service.</span></span><span class="sig-name descname"><span class="pre">DeviceInfoCollector</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></em><span class="sig-paren">)</span><a class="reference internal" href="../../_modules/services/subnet_service.html#DeviceInfoCollector"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#services.subnet_service.DeviceInfoCollector" 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.subnet_service.</span></span><span class="sig-name descname"><span class="pre">DeviceInfoCollector</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></em><span class="sig-paren">)</span><a class="reference internal" href="../../_modules/services/subnet_service.html#DeviceInfoCollector"><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>
|
||||
<dl class="simple">
|
||||
|
|
@ -303,38 +303,49 @@
|
|||
</dd>
|
||||
</dl>
|
||||
<dl class="py method">
|
||||
<dt class="sig sig-object py" id="services.subnet_service.DeviceInfoCollector.get_hostname">
|
||||
<span class="sig-name descname"><span class="pre">get_hostname</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">ip</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">→</span> <span class="sig-return-typehint"><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></span><a class="reference internal" href="../../_modules/services/subnet_service.html#DeviceInfoCollector.get_hostname"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#services.subnet_service.DeviceInfoCollector.get_hostname" title="Link to this definition">¶</a></dt>
|
||||
<dt class="sig sig-object py">
|
||||
<span class="sig-name descname"><span class="pre">get_hostname</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">ip</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">→</span> <span class="sig-return-typehint"><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></span><a class="reference internal" href="../../_modules/services/subnet_service.html#DeviceInfoCollector.get_hostname"><span class="viewcode-link"><span class="pre">[source]</span></span></a></dt>
|
||||
<dd><p>Получает хостнейм для указанного IP-адреса.</p>
|
||||
<p>Пробует сначала DNS, затем NetBIOS.</p>
|
||||
<dl class="simple">
|
||||
<dt>Args:</dt><dd><p>ip (str): IP-адрес устройства.</p>
|
||||
<dl class="field-list simple">
|
||||
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
|
||||
<dd class="field-odd"><p><strong>ip</strong> (<em>str</em>) – IP-адрес устройства.</p>
|
||||
</dd>
|
||||
<dt>Returns:</dt><dd><p>Optional[str]: Хостнейм или None, если не удалось определить.</p>
|
||||
<dt class="field-even">Returns<span class="colon">:</span></dt>
|
||||
<dd class="field-even"><p>Хостнейм или None, если не удалось определить.</p>
|
||||
</dd>
|
||||
<dt class="field-odd">Return type<span class="colon">:</span></dt>
|
||||
<dd class="field-odd"><p>Optional[str]</p>
|
||||
</dd>
|
||||
</dl>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py method">
|
||||
<dt class="sig sig-object py" id="services.subnet_service.DeviceInfoCollector.get_vendor">
|
||||
<span class="sig-name descname"><span class="pre">get_vendor</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">mac</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">→</span> <span class="sig-return-typehint"><span class="pre">str</span></span></span><a class="reference internal" href="../../_modules/services/subnet_service.html#DeviceInfoCollector.get_vendor"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#services.subnet_service.DeviceInfoCollector.get_vendor" title="Link to this definition">¶</a></dt>
|
||||
<dt class="sig sig-object py">
|
||||
<span class="sig-name descname"><span class="pre">get_vendor</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">mac</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">→</span> <span class="sig-return-typehint"><span class="pre">str</span></span></span><a class="reference internal" href="../../_modules/services/subnet_service.html#DeviceInfoCollector.get_vendor"><span class="viewcode-link"><span class="pre">[source]</span></span></a></dt>
|
||||
<dd><p>Получает вендора устройства по MAC-адресу.</p>
|
||||
<p>Использует кэширование для повышения производительности.</p>
|
||||
<dl class="simple">
|
||||
<dt>Args:</dt><dd><p>mac (str): MAC-адрес устройства.</p>
|
||||
<dl class="field-list simple">
|
||||
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
|
||||
<dd class="field-odd"><p><strong>mac</strong> (<em>str</em>) – MAC-адрес устройства.</p>
|
||||
</dd>
|
||||
<dt>Returns:</dt><dd><p>str: Название вендора или “Неизвестный” в случае ошибки.</p>
|
||||
<dt class="field-even">Returns<span class="colon">:</span></dt>
|
||||
<dd class="field-even"><p>Название вендора или “Неизвестный” в случае ошибки.</p>
|
||||
</dd>
|
||||
<dt class="field-odd">Return type<span class="colon">:</span></dt>
|
||||
<dd class="field-odd"><p>str</p>
|
||||
</dd>
|
||||
</dl>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py method">
|
||||
<dt class="sig sig-object py" id="services.subnet_service.DeviceInfoCollector.scan_nbtscan">
|
||||
<span class="sig-name descname"><span class="pre">scan_nbtscan</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">subnet</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">→</span> <span class="sig-return-typehint"><span class="pre">None</span></span></span><a class="reference internal" href="../../_modules/services/subnet_service.html#DeviceInfoCollector.scan_nbtscan"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#services.subnet_service.DeviceInfoCollector.scan_nbtscan" title="Link to this definition">¶</a></dt>
|
||||
<dt class="sig sig-object py">
|
||||
<span class="sig-name descname"><span class="pre">scan_nbtscan</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">subnet</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">→</span> <span class="sig-return-typehint"><span class="pre">None</span></span></span><a class="reference internal" href="../../_modules/services/subnet_service.html#DeviceInfoCollector.scan_nbtscan"><span class="viewcode-link"><span class="pre">[source]</span></span></a></dt>
|
||||
<dd><p>Сканирует подсеть с помощью nbtscan для получения хостнеймов.</p>
|
||||
<p>Сохраняет результаты в кэш и логирует процесс.</p>
|
||||
<dl class="simple">
|
||||
<dt>Args:</dt><dd><p>subnet (str): Подсеть в формате CIDR.</p>
|
||||
<dl class="field-list simple">
|
||||
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
|
||||
<dd class="field-odd"><p><strong>subnet</strong> (<em>str</em>) – Подсеть в формате CIDR.</p>
|
||||
</dd>
|
||||
</dl>
|
||||
</dd></dl>
|
||||
|
|
@ -342,60 +353,71 @@
|
|||
</dd></dl>
|
||||
|
||||
<dl class="py class">
|
||||
<dt class="sig sig-object py" id="services.subnet_service.DeviceStorage">
|
||||
<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.subnet_service.</span></span><span class="sig-name descname"><span class="pre">DeviceStorage</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">base_path</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</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">'storage/subnets'</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">None</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="../../_modules/services/subnet_service.html#DeviceStorage"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#services.subnet_service.DeviceStorage" 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.subnet_service.</span></span><span class="sig-name descname"><span class="pre">DeviceStorage</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">base_path</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</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">'storage/subnets'</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">None</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="../../_modules/services/subnet_service.html#DeviceStorage"><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>
|
||||
<dl>
|
||||
<dt>Формат файла подсети:</dt><dd><p>JSON-структура вида
|
||||
{</p>
|
||||
<blockquote>
|
||||
<div><p>“devices”: [Device, …]</p>
|
||||
</div></blockquote>
|
||||
<p>}</p>
|
||||
</dd>
|
||||
<dt>Политика очистки:</dt><dd><ul class="simple">
|
||||
<li><p>Метод <cite>_clean_old_devices</cite> удаляет оффлайн-устройства, не наблюдавшиеся
|
||||
более 7 дней, чтобы поддерживать актуальность списка.</p></li>
|
||||
<p>Формат файла подсети:</p>
|
||||
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="p">{</span>
|
||||
<span class="s2">"devices"</span><span class="p">:</span> <span class="p">[</span><span class="n">Device</span><span class="p">,</span> <span class="o">...</span><span class="p">]</span>
|
||||
<span class="p">}</span>
|
||||
</pre></div>
|
||||
</div>
|
||||
<p>Политика очистки:</p>
|
||||
<ul class="simple">
|
||||
<li><p>Метод <cite>_clean_old_devices</cite> удаляет оффлайн-устройства, не наблюдавшиеся более 7 дней,
|
||||
чтобы поддерживать актуальность списка.</p></li>
|
||||
</ul>
|
||||
</dd>
|
||||
</dl>
|
||||
<dl class="py method">
|
||||
<dt class="sig sig-object py" id="services.subnet_service.DeviceStorage.get_subnet_file">
|
||||
<span class="sig-name descname"><span class="pre">get_subnet_file</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">subnet</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">→</span> <span class="sig-return-typehint"><span class="pre">Path</span></span></span><a class="reference internal" href="../../_modules/services/subnet_service.html#DeviceStorage.get_subnet_file"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#services.subnet_service.DeviceStorage.get_subnet_file" title="Link to this definition">¶</a></dt>
|
||||
<dt class="sig sig-object py">
|
||||
<span class="sig-name descname"><span class="pre">get_subnet_file</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">subnet</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">→</span> <span class="sig-return-typehint"><span class="pre">Path</span></span></span><a class="reference internal" href="../../_modules/services/subnet_service.html#DeviceStorage.get_subnet_file"><span class="viewcode-link"><span class="pre">[source]</span></span></a></dt>
|
||||
<dd><p>Возвращает путь к файлу для конкретной подсети.</p>
|
||||
<p>Заменяет символы ‘/’ на ‘_’ для корректного имени файла.</p>
|
||||
<dl class="simple">
|
||||
<dt>Args:</dt><dd><p>subnet (str): Подсеть в формате CIDR.</p>
|
||||
<dl class="field-list simple">
|
||||
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
|
||||
<dd class="field-odd"><p><strong>subnet</strong> (<em>str</em>) – Подсеть в формате CIDR.</p>
|
||||
</dd>
|
||||
<dt>Returns:</dt><dd><p>Path: Путь к файлу.</p>
|
||||
<dt class="field-even">Returns<span class="colon">:</span></dt>
|
||||
<dd class="field-even"><p>Путь к файлу.</p>
|
||||
</dd>
|
||||
<dt class="field-odd">Return type<span class="colon">:</span></dt>
|
||||
<dd class="field-odd"><p>Path</p>
|
||||
</dd>
|
||||
</dl>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py method">
|
||||
<dt class="sig sig-object py" id="services.subnet_service.DeviceStorage.load_devices">
|
||||
<span class="sig-name descname"><span class="pre">load_devices</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">subnet</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">→</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><a class="reference internal" href="../models/subnet.html#models.subnet.Device" title="models.subnet.Device"><span class="pre">Device</span></a><span class="p"><span class="pre">]</span></span></span></span><a class="reference internal" href="../../_modules/services/subnet_service.html#DeviceStorage.load_devices"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#services.subnet_service.DeviceStorage.load_devices" title="Link to this definition">¶</a></dt>
|
||||
<dt class="sig sig-object py">
|
||||
<span class="sig-name descname"><span class="pre">load_devices</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">subnet</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">→</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">Device</span><span class="p"><span class="pre">]</span></span></span></span><a class="reference internal" href="../../_modules/services/subnet_service.html#DeviceStorage.load_devices"><span class="viewcode-link"><span class="pre">[source]</span></span></a></dt>
|
||||
<dd><p>Загружает устройства для указанной подсети.</p>
|
||||
<p>Читает данные из JSON-файла и фильтрует устаревшие устройства.</p>
|
||||
<dl class="simple">
|
||||
<dt>Args:</dt><dd><p>subnet (str): Подсеть в формате CIDR.</p>
|
||||
<dl class="field-list simple">
|
||||
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
|
||||
<dd class="field-odd"><p><strong>subnet</strong> (<em>str</em>) – Подсеть в формате CIDR.</p>
|
||||
</dd>
|
||||
<dt>Returns:</dt><dd><p>Dict[str, Device]: Словарь устройств с MAC как ключом.</p>
|
||||
<dt class="field-even">Returns<span class="colon">:</span></dt>
|
||||
<dd class="field-even"><p>Словарь устройств с MAC как ключом.</p>
|
||||
</dd>
|
||||
<dt class="field-odd">Return type<span class="colon">:</span></dt>
|
||||
<dd class="field-odd"><p>Dict[str, Device]</p>
|
||||
</dd>
|
||||
</dl>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py method">
|
||||
<dt class="sig sig-object py" id="services.subnet_service.DeviceStorage.save_devices">
|
||||
<span class="sig-name descname"><span class="pre">save_devices</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">subnet</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">devices</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">List</span><span class="p"><span class="pre">[</span></span><a class="reference internal" href="../models/subnet.html#models.subnet.Device" title="models.subnet.Device"><span class="pre">Device</span></a><span class="p"><span class="pre">]</span></span></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><span class="pre">None</span></span></span><a class="reference internal" href="../../_modules/services/subnet_service.html#DeviceStorage.save_devices"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#services.subnet_service.DeviceStorage.save_devices" title="Link to this definition">¶</a></dt>
|
||||
<dt class="sig sig-object py">
|
||||
<span class="sig-name descname"><span class="pre">save_devices</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">subnet</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">devices</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">List</span><span class="p"><span class="pre">[</span></span><span class="pre">Device</span><span class="p"><span class="pre">]</span></span></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><span class="pre">None</span></span></span><a class="reference internal" href="../../_modules/services/subnet_service.html#DeviceStorage.save_devices"><span class="viewcode-link"><span class="pre">[source]</span></span></a></dt>
|
||||
<dd><p>Сохраняет устройства для указанной подсети.</p>
|
||||
<p>Записывает данные в JSON-файл.</p>
|
||||
<dl class="simple">
|
||||
<dt>Args:</dt><dd><p>subnet (str): Подсеть в формате CIDR.
|
||||
devices (List[Device]): Список устройств для сохранения.</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>subnet</strong> (<em>str</em>) – Подсеть в формате CIDR.</p></li>
|
||||
<li><p><strong>devices</strong> (<em>List</em><em>[</em><em>Device</em><em>]</em>) – Список устройств для сохранения.</p></li>
|
||||
</ul>
|
||||
</dd>
|
||||
<dt>Raises:</dt><dd><p>Exception: Если произошла ошибка при сохранении.</p>
|
||||
<dt class="field-even">Raises<span class="colon">:</span></dt>
|
||||
<dd class="field-even"><p><strong>Exception</strong> – Если произошла ошибка при сохранении.</p>
|
||||
</dd>
|
||||
</dl>
|
||||
</dd></dl>
|
||||
|
|
@ -403,8 +425,8 @@ devices (List[Device]): Список устройств для сохранен
|
|||
</dd></dl>
|
||||
|
||||
<dl class="py class">
|
||||
<dt class="sig sig-object py" id="services.subnet_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.subnet_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="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">translations</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">Translations</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="../../_modules/services/subnet_service.html#NetworkScanner"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#services.subnet_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.subnet_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="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">translations</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">Translations</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="../../_modules/services/subnet_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>Класс для сканирования подсети с использованием ARP-запросов.</p>
|
||||
<dl class="simple">
|
||||
|
|
@ -426,17 +448,23 @@ ARP-запросы по указанной подсети и собирая от
|
|||
</dd>
|
||||
</dl>
|
||||
<dl class="py method">
|
||||
<dt class="sig sig-object py" id="services.subnet_service.NetworkScanner.scan">
|
||||
<span class="sig-name descname"><span class="pre">scan</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">subnet</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">→</span> <span class="sig-return-typehint"><span class="pre">List</span><span class="p"><span class="pre">[</span></span><span class="pre">Tuple</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">str</span><span class="p"><span class="pre">]</span></span><span class="p"><span class="pre">]</span></span></span></span><a class="reference internal" href="../../_modules/services/subnet_service.html#NetworkScanner.scan"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#services.subnet_service.NetworkScanner.scan" title="Link to this definition">¶</a></dt>
|
||||
<dt class="sig sig-object py">
|
||||
<span class="sig-name descname"><span class="pre">scan</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">subnet</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">→</span> <span class="sig-return-typehint"><span class="pre">List</span><span class="p"><span class="pre">[</span></span><span class="pre">Tuple</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">str</span><span class="p"><span class="pre">]</span></span><span class="p"><span class="pre">]</span></span></span></span><a class="reference internal" href="../../_modules/services/subnet_service.html#NetworkScanner.scan"><span class="viewcode-link"><span class="pre">[source]</span></span></a></dt>
|
||||
<dd><p>Сканирует подсеть с использованием ARP-запросов.</p>
|
||||
<p>Отправляет ARP-пакеты для обнаружения активных устройств и возвращает
|
||||
список кортежей (IP, MAC).</p>
|
||||
<dl class="simple">
|
||||
<dt>Args:</dt><dd><p>subnet (str): Подсеть в формате CIDR (например, “10.1.1.0/24”).</p>
|
||||
<dl class="field-list simple">
|
||||
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
|
||||
<dd class="field-odd"><p><strong>subnet</strong> (<em>str</em>) – Подсеть в формате CIDR (например, “10.1.1.0/24”).</p>
|
||||
</dd>
|
||||
<dt>Returns:</dt><dd><p>List[Tuple[str, str]]: Список кортежей (IP-адрес, MAC-адрес) обнаруженных устройств.</p>
|
||||
<dt class="field-even">Returns<span class="colon">:</span></dt>
|
||||
<dd class="field-even"><p>Список кортежей (IP-адрес, MAC-адрес) обнаруженных устройств.</p>
|
||||
</dd>
|
||||
<dt>Raises:</dt><dd><p>Exception: Если произошла ошибка сканирования.</p>
|
||||
<dt class="field-odd">Return type<span class="colon">:</span></dt>
|
||||
<dd class="field-odd"><p>List[Tuple[str, str]]</p>
|
||||
</dd>
|
||||
<dt class="field-even">Raises<span class="colon">:</span></dt>
|
||||
<dd class="field-even"><p><strong>Exception</strong> – Если произошла ошибка сканирования.</p>
|
||||
</dd>
|
||||
</dl>
|
||||
</dd></dl>
|
||||
|
|
@ -444,8 +472,8 @@ ARP-запросы по указанной подсети и собирая от
|
|||
</dd></dl>
|
||||
|
||||
<dl class="py class">
|
||||
<dt class="sig sig-object py" id="services.subnet_service.PortScanner">
|
||||
<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.subnet_service.</span></span><span class="sig-name descname"><span class="pre">PortScanner</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">interface</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">translations</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">Translations</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="../../_modules/services/subnet_service.html#PortScanner"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#services.subnet_service.PortScanner" 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.subnet_service.</span></span><span class="sig-name descname"><span class="pre">PortScanner</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">interface</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">translations</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">Translations</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="../../_modules/services/subnet_service.html#PortScanner"><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>
|
||||
<dl class="simple">
|
||||
|
|
@ -460,14 +488,19 @@ ARP-запросы по указанной подсети и собирая от
|
|||
</dd>
|
||||
</dl>
|
||||
<dl class="py method">
|
||||
<dt class="sig sig-object py" id="services.subnet_service.PortScanner.scan">
|
||||
<span class="sig-name descname"><span class="pre">scan</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">ip</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">→</span> <span class="sig-return-typehint"><span class="pre">List</span><span class="p"><span class="pre">[</span></span><span class="pre">str</span><span class="p"><span class="pre">]</span></span></span></span><a class="reference internal" href="../../_modules/services/subnet_service.html#PortScanner.scan"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#services.subnet_service.PortScanner.scan" title="Link to this definition">¶</a></dt>
|
||||
<dt class="sig sig-object py">
|
||||
<span class="sig-name descname"><span class="pre">scan</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">ip</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">→</span> <span class="sig-return-typehint"><span class="pre">List</span><span class="p"><span class="pre">[</span></span><span class="pre">str</span><span class="p"><span class="pre">]</span></span></span></span><a class="reference internal" href="../../_modules/services/subnet_service.html#PortScanner.scan"><span class="viewcode-link"><span class="pre">[source]</span></span></a></dt>
|
||||
<dd><p>Сканирует открытые порты на указанном IP-адресе.</p>
|
||||
<p>Пока возвращает пустой список, так как функциональность не реализована.</p>
|
||||
<dl class="simple">
|
||||
<dt>Args:</dt><dd><p>ip (str): IP-адрес устройства для сканирования.</p>
|
||||
<dl class="field-list simple">
|
||||
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
|
||||
<dd class="field-odd"><p><strong>ip</strong> (<em>str</em>) – IP-адрес устройства для сканирования.</p>
|
||||
</dd>
|
||||
<dt>Returns:</dt><dd><p>List[str]: Список открытых портов (пока пустой).</p>
|
||||
<dt class="field-even">Returns<span class="colon">:</span></dt>
|
||||
<dd class="field-even"><p>Список открытых портов (пока пустой).</p>
|
||||
</dd>
|
||||
<dt class="field-odd">Return type<span class="colon">:</span></dt>
|
||||
<dd class="field-odd"><p>List[str]</p>
|
||||
</dd>
|
||||
</dl>
|
||||
</dd></dl>
|
||||
|
|
@ -475,8 +508,8 @@ ARP-запросы по указанной подсети и собирая от
|
|||
</dd></dl>
|
||||
|
||||
<dl class="py class">
|
||||
<dt class="sig sig-object py" id="services.subnet_service.SubnetService">
|
||||
<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.subnet_service.</span></span><span class="sig-name descname"><span class="pre">SubnetService</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></em><span class="sig-paren">)</span><a class="reference internal" href="../../_modules/services/subnet_service.html#SubnetService"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#services.subnet_service.SubnetService" 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.subnet_service.</span></span><span class="sig-name descname"><span class="pre">SubnetService</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></em><span class="sig-paren">)</span><a class="reference internal" href="../../_modules/services/subnet_service.html#SubnetService"><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>
|
||||
<dl class="simple">
|
||||
|
|
@ -496,75 +529,104 @@ ARP-запросы по указанной подсети и собирая от
|
|||
</dd>
|
||||
</dl>
|
||||
<dl class="py method">
|
||||
<dt class="sig sig-object py" id="services.subnet_service.SubnetService.add_note">
|
||||
<span class="sig-name descname"><span class="pre">add_note</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">mac</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">note</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">translations</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">Translations</span></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</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">Tuple</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">Dict</span><span class="p"><span class="pre">]</span></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/subnet_service.html#SubnetService.add_note"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#services.subnet_service.SubnetService.add_note" title="Link to this definition">¶</a></dt>
|
||||
<dt class="sig sig-object py">
|
||||
<span class="sig-name descname"><span class="pre">add_note</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">mac</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">note</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">translations</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">Translations</span></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</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">Tuple</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">Dict</span><span class="p"><span class="pre">]</span></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/subnet_service.html#SubnetService.add_note"><span class="viewcode-link"><span class="pre">[source]</span></span></a></dt>
|
||||
<dd><p>Добавляет заметку для устройства по MAC-адресу.</p>
|
||||
<p>Привязывает заметку к устройству, если оно существует.</p>
|
||||
<dl class="simple">
|
||||
<dt>Args:</dt><dd><p>mac (str): MAC-адрес устройства.
|
||||
note (str): Текст заметки.
|
||||
translations (Translations): Объект переводов для текущего языка.</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>mac</strong> (<em>str</em>) – MAC-адрес устройства.</p></li>
|
||||
<li><p><strong>note</strong> (<em>str</em>) – Текст заметки.</p></li>
|
||||
<li><p><strong>translations</strong> (<em>Translations</em>) – Объект переводов для текущего языка.</p></li>
|
||||
</ul>
|
||||
</dd>
|
||||
<dt>Returns:</dt><dd><dl class="simple">
|
||||
<dt>Tuple[bool, Optional[Tuple[str, Dict]]]: Кортеж (успех, результат),</dt><dd><p>где результат содержит код ошибки/успеха и данные.</p>
|
||||
<dt class="field-even">Returns<span class="colon">:</span></dt>
|
||||
<dd class="field-even"><p><dl class="simple">
|
||||
<dt>Кортеж (успех, результат),</dt><dd><p>где результат содержит код ошибки/успеха и данные.</p>
|
||||
</dd>
|
||||
</dl>
|
||||
</p>
|
||||
</dd>
|
||||
<dt class="field-odd">Return type<span class="colon">:</span></dt>
|
||||
<dd class="field-odd"><p>Tuple[bool, Optional[Tuple[str, Dict]]]</p>
|
||||
</dd>
|
||||
</dl>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py method">
|
||||
<dt class="sig sig-object py" id="services.subnet_service.SubnetService.delete_note">
|
||||
<span class="sig-name descname"><span class="pre">delete_note</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">mac</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">translations</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">Translations</span></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</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">Tuple</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">Dict</span><span class="p"><span class="pre">]</span></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/subnet_service.html#SubnetService.delete_note"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#services.subnet_service.SubnetService.delete_note" title="Link to this definition">¶</a></dt>
|
||||
<dt class="sig sig-object py">
|
||||
<span class="sig-name descname"><span class="pre">delete_note</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">mac</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">translations</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">Translations</span></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</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">Tuple</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">Dict</span><span class="p"><span class="pre">]</span></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/subnet_service.html#SubnetService.delete_note"><span class="viewcode-link"><span class="pre">[source]</span></span></a></dt>
|
||||
<dd><p>Удаляет заметку для устройства по MAC-адресу.</p>
|
||||
<p>Удаляет привязанную заметку, если она существует.</p>
|
||||
<dl class="simple">
|
||||
<dt>Args:</dt><dd><p>mac (str): MAC-адрес устройства.
|
||||
translations (Translations): Объект переводов для текущего языка.</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>mac</strong> (<em>str</em>) – MAC-адрес устройства.</p></li>
|
||||
<li><p><strong>translations</strong> (<em>Translations</em>) – Объект переводов для текущего языка.</p></li>
|
||||
</ul>
|
||||
</dd>
|
||||
<dt>Returns:</dt><dd><dl class="simple">
|
||||
<dt>Tuple[bool, Optional[Tuple[str, Dict]]]: Кортеж (успех, результат),</dt><dd><p>где результат содержит код ошибки/успеха и данные.</p>
|
||||
<dt class="field-even">Returns<span class="colon">:</span></dt>
|
||||
<dd class="field-even"><p><dl class="simple">
|
||||
<dt>Кортеж (успех, результат),</dt><dd><p>где результат содержит код ошибки/успеха и данные.</p>
|
||||
</dd>
|
||||
</dl>
|
||||
</p>
|
||||
</dd>
|
||||
<dt class="field-odd">Return type<span class="colon">:</span></dt>
|
||||
<dd class="field-odd"><p>Tuple[bool, Optional[Tuple[str, Dict]]]</p>
|
||||
</dd>
|
||||
</dl>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py method">
|
||||
<dt class="sig sig-object py" id="services.subnet_service.SubnetService.scan_subnet">
|
||||
<span class="sig-name descname"><span class="pre">scan_subnet</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">subnet</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><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><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><a class="reference internal" href="../models/subnet.html#models.subnet.SubnetScanResult" title="models.subnet.SubnetScanResult"><span class="pre">SubnetScanResult</span></a></span></span><a class="reference internal" href="../../_modules/services/subnet_service.html#SubnetService.scan_subnet"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#services.subnet_service.SubnetService.scan_subnet" title="Link to this definition">¶</a></dt>
|
||||
<dt class="sig sig-object py">
|
||||
<span class="sig-name descname"><span class="pre">scan_subnet</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">subnet</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><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><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><span class="pre">SubnetScanResult</span></span></span><a class="reference internal" href="../../_modules/services/subnet_service.html#SubnetService.scan_subnet"><span class="viewcode-link"><span class="pre">[source]</span></span></a></dt>
|
||||
<dd><p>Сканирует указанную подсеть и возвращает результаты.</p>
|
||||
<p>Выполняет ARP-сканирование, собирает информацию о устройствах и сохраняет данные.</p>
|
||||
<dl class="simple">
|
||||
<dt>Args:</dt><dd><dl class="simple">
|
||||
<dt>subnet (Optional[str]): Подсеть в формате CIDR (например, “10.1.1.0/24”).</dt><dd><p>Если None или пустая строка, определяется автоматически.</p>
|
||||
<dl class="field-list simple">
|
||||
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
|
||||
<dd class="field-odd"><p><strong>subnet</strong> (<em>Optional</em><em>[</em><em>str</em><em>]</em>) – Подсеть в формате CIDR (например, “10.1.1.0/24”).
|
||||
Если None или пустая строка, определяется автоматически.</p>
|
||||
</dd>
|
||||
<dt class="field-even">Returns<span class="colon">:</span></dt>
|
||||
<dd class="field-even"><p><dl class="simple">
|
||||
<dt>Объект с результатами сканирования, содержащий список</dt><dd><p>устройств или сообщение об ошибке.</p>
|
||||
</dd>
|
||||
</dl>
|
||||
</p>
|
||||
</dd>
|
||||
<dt>Returns:</dt><dd><dl class="simple">
|
||||
<dt>SubnetScanResult: Объект с результатами сканирования, содержащий список</dt><dd><p>устройств или сообщение об ошибке.</p>
|
||||
<dt class="field-odd">Return type<span class="colon">:</span></dt>
|
||||
<dd class="field-odd"><p>SubnetScanResult</p>
|
||||
</dd>
|
||||
</dl>
|
||||
</dd>
|
||||
<dt>Raises:</dt><dd><p>Exception: Если произошла ошибка сканирования.</p>
|
||||
<dt class="field-even">Raises<span class="colon">:</span></dt>
|
||||
<dd class="field-even"><p><strong>Exception</strong> – Если произошла ошибка сканирования.</p>
|
||||
</dd>
|
||||
</dl>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py method">
|
||||
<dt class="sig sig-object py" id="services.subnet_service.SubnetService.update_note">
|
||||
<span class="sig-name descname"><span class="pre">update_note</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">mac</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">note</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">translations</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">Translations</span></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</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">Tuple</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">Dict</span><span class="p"><span class="pre">]</span></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/subnet_service.html#SubnetService.update_note"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#services.subnet_service.SubnetService.update_note" title="Link to this definition">¶</a></dt>
|
||||
<dt class="sig sig-object py">
|
||||
<span class="sig-name descname"><span class="pre">update_note</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">mac</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">note</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">translations</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">Translations</span></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</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">Tuple</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">Dict</span><span class="p"><span class="pre">]</span></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/subnet_service.html#SubnetService.update_note"><span class="viewcode-link"><span class="pre">[source]</span></span></a></dt>
|
||||
<dd><p>Обновляет заметку для устройства по MAC-адресу.</p>
|
||||
<p>Изменяет существующую заметку, если она есть.</p>
|
||||
<dl class="simple">
|
||||
<dt>Args:</dt><dd><p>mac (str): MAC-адрес устройства.
|
||||
note (str): Новый текст заметки.
|
||||
translations (Translations): Объект переводов для текущего языка.</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>mac</strong> (<em>str</em>) – MAC-адрес устройства.</p></li>
|
||||
<li><p><strong>note</strong> (<em>str</em>) – Новый текст заметки.</p></li>
|
||||
<li><p><strong>translations</strong> (<em>Translations</em>) – Объект переводов для текущего языка.</p></li>
|
||||
</ul>
|
||||
</dd>
|
||||
<dt>Returns:</dt><dd><dl class="simple">
|
||||
<dt>Tuple[bool, Optional[Tuple[str, Dict]]]: Кортеж (успех, результат),</dt><dd><p>где результат содержит код ошибки/успеха и данные.</p>
|
||||
<dt class="field-even">Returns<span class="colon">:</span></dt>
|
||||
<dd class="field-even"><p><dl class="simple">
|
||||
<dt>Кортеж (успех, результат),</dt><dd><p>где результат содержит код ошибки/успеха и данные.</p>
|
||||
</dd>
|
||||
</dl>
|
||||
</p>
|
||||
</dd>
|
||||
<dt class="field-odd">Return type<span class="colon">:</span></dt>
|
||||
<dd class="field-odd"><p>Tuple[bool, Optional[Tuple[str, Dict]]]</p>
|
||||
</dd>
|
||||
</dl>
|
||||
</dd></dl>
|
||||
|
|
@ -572,15 +634,20 @@ translations (Translations): Объект переводов для текуще
|
|||
</dd></dl>
|
||||
|
||||
<dl class="py function">
|
||||
<dt class="sig sig-object py" id="services.subnet_service.get_subnet_service">
|
||||
<span class="sig-prename descclassname"><span class="pre">services.subnet_service.</span></span><span class="sig-name descname"><span class="pre">get_subnet_service</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/subnet_service.html#get_subnet_service"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#services.subnet_service.get_subnet_service" title="Link to this definition">¶</a></dt>
|
||||
<dt class="sig sig-object py">
|
||||
<span class="sig-prename descclassname"><span class="pre">services.subnet_service.</span></span><span class="sig-name descname"><span class="pre">get_subnet_service</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/subnet_service.html#get_subnet_service"><span class="viewcode-link"><span class="pre">[source]</span></span></a></dt>
|
||||
<dd><p>Фабричная функция для создания экземпляра SubnetService.</p>
|
||||
<p>Использует зависимости FastAPI для получения объекта переводов и возвращает
|
||||
экземпляр SubnetService с текущей локализацией.</p>
|
||||
<dl class="simple">
|
||||
<dt>Args:</dt><dd><p>translations (Translations): Объект переводов для текущего языка.</p>
|
||||
<dl class="field-list simple">
|
||||
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
|
||||
<dd class="field-odd"><p><strong>translations</strong> (<em>Translations</em>) – Объект переводов для текущего языка.</p>
|
||||
</dd>
|
||||
<dt>Returns:</dt><dd><p>SubnetService: Экземпляр сервиса для работы с подсетями.</p>
|
||||
<dt class="field-even">Returns<span class="colon">:</span></dt>
|
||||
<dd class="field-even"><p>Экземпляр сервиса для работы с подсетями.</p>
|
||||
</dd>
|
||||
<dt class="field-odd">Return type<span class="colon">:</span></dt>
|
||||
<dd class="field-odd"><p>SubnetService</p>
|
||||
</dd>
|
||||
</dl>
|
||||
</dd></dl>
|
||||
|
|
@ -630,55 +697,9 @@ translations (Translations): Объект переводов для текуще
|
|||
|
||||
</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="#">Subnet Service</a><ul>
|
||||
<li><a class="reference internal" href="#services.subnet_service.DeviceInfoCollector"><code class="docutils literal notranslate"><span class="pre">DeviceInfoCollector</span></code></a><ul>
|
||||
<li><a class="reference internal" href="#services.subnet_service.DeviceInfoCollector.get_hostname"><code class="docutils literal notranslate"><span class="pre">DeviceInfoCollector.get_hostname()</span></code></a></li>
|
||||
<li><a class="reference internal" href="#services.subnet_service.DeviceInfoCollector.get_vendor"><code class="docutils literal notranslate"><span class="pre">DeviceInfoCollector.get_vendor()</span></code></a></li>
|
||||
<li><a class="reference internal" href="#services.subnet_service.DeviceInfoCollector.scan_nbtscan"><code class="docutils literal notranslate"><span class="pre">DeviceInfoCollector.scan_nbtscan()</span></code></a></li>
|
||||
</ul>
|
||||
</li>
|
||||
<li><a class="reference internal" href="#services.subnet_service.DeviceStorage"><code class="docutils literal notranslate"><span class="pre">DeviceStorage</span></code></a><ul>
|
||||
<li><a class="reference internal" href="#services.subnet_service.DeviceStorage.get_subnet_file"><code class="docutils literal notranslate"><span class="pre">DeviceStorage.get_subnet_file()</span></code></a></li>
|
||||
<li><a class="reference internal" href="#services.subnet_service.DeviceStorage.load_devices"><code class="docutils literal notranslate"><span class="pre">DeviceStorage.load_devices()</span></code></a></li>
|
||||
<li><a class="reference internal" href="#services.subnet_service.DeviceStorage.save_devices"><code class="docutils literal notranslate"><span class="pre">DeviceStorage.save_devices()</span></code></a></li>
|
||||
</ul>
|
||||
</li>
|
||||
<li><a class="reference internal" href="#services.subnet_service.NetworkScanner"><code class="docutils literal notranslate"><span class="pre">NetworkScanner</span></code></a><ul>
|
||||
<li><a class="reference internal" href="#services.subnet_service.NetworkScanner.scan"><code class="docutils literal notranslate"><span class="pre">NetworkScanner.scan()</span></code></a></li>
|
||||
</ul>
|
||||
</li>
|
||||
<li><a class="reference internal" href="#services.subnet_service.PortScanner"><code class="docutils literal notranslate"><span class="pre">PortScanner</span></code></a><ul>
|
||||
<li><a class="reference internal" href="#services.subnet_service.PortScanner.scan"><code class="docutils literal notranslate"><span class="pre">PortScanner.scan()</span></code></a></li>
|
||||
</ul>
|
||||
</li>
|
||||
<li><a class="reference internal" href="#services.subnet_service.SubnetService"><code class="docutils literal notranslate"><span class="pre">SubnetService</span></code></a><ul>
|
||||
<li><a class="reference internal" href="#services.subnet_service.SubnetService.add_note"><code class="docutils literal notranslate"><span class="pre">SubnetService.add_note()</span></code></a></li>
|
||||
<li><a class="reference internal" href="#services.subnet_service.SubnetService.delete_note"><code class="docutils literal notranslate"><span class="pre">SubnetService.delete_note()</span></code></a></li>
|
||||
<li><a class="reference internal" href="#services.subnet_service.SubnetService.scan_subnet"><code class="docutils literal notranslate"><span class="pre">SubnetService.scan_subnet()</span></code></a></li>
|
||||
<li><a class="reference internal" href="#services.subnet_service.SubnetService.update_note"><code class="docutils literal notranslate"><span class="pre">SubnetService.update_note()</span></code></a></li>
|
||||
</ul>
|
||||
</li>
|
||||
<li><a class="reference internal" href="#services.subnet_service.get_subnet_service"><code class="docutils literal notranslate"><span class="pre">get_subnet_service()</span></code></a></li>
|
||||
</ul>
|
||||
</li>
|
||||
</ul>
|
||||
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
|
||||
|
||||
</aside>
|
||||
</div>
|
||||
|
|
|
|||
Loading…
Add table
Add a link
Reference in a new issue