Sphinx generate docs

This commit is contained in:
Merelden 2025-10-14 12:17:13 +05:00
parent 5bc23e7eb8
commit af1420dbde
216 changed files with 39471 additions and 13 deletions

View file

@ -2,20 +2,19 @@
Сервис низкоуровневого ARP-сканирования локальной сети.
Назначение:
- Обнаружение активных узлов в пределах сетей хоста путём широковещательных
ARP‑запросов от имени выбранного интерфейса.
- Помощь сервисам более высокого уровня (например, IPService) при проверке
занятости адресов перед применением конфигураций.
- Обнаружение активных узлов в пределах сетей хоста путём широковещательных ARP‑запросов от имени выбранного интерфейса.
- Помощь сервисам более высокого уровня (например, IPService) при проверке занятости адресов перед применением конфигураций.
Особенности реализации:
- Определяет подключённые сети интерфейса через `netifaces` и строит CIDR для
сканирования.
- Определяет подключённые сети интерфейса через `netifaces` и строит CIDR для сканирования.
- Формирует ARP‑пакеты с помощью `scapy` (Ether/ARP) и отправляет их с таймаутом.
- Добавляет локальный адрес интерфейса в результирующий список клиентов.
Требования/ограничения:
- Для отправки ARP‑кадров могут потребоваться повышенные привилегии или
capability на сырой сокет.
- Для отправки ARP‑кадров могут потребоваться повышенные привилегии или capability на сырой сокет.
"""
from fastapi import Depends
from scapy.layers.l2 import ARP, Ether

View file

@ -2,15 +2,16 @@
Сервис управления подключениями Wi‑Fi через `nmcli`.
Назначение:
- Предоставляет операции подключения/отключения к точкам доступа и проверки
текущего статуса, ориентируясь на системный NetworkManager.
- Предоставляет операции подключения/отключения к точкам доступа и проверки текущего статуса, ориентируясь на системный NetworkManager.
Поведение:
- Автоматически определяет активный Wi‑Fi‑интерфейс.
- Валидирует наличие SSID в листинге перед подключением и интерпретирует
частые ошибки `nmcli` (неверный пароль, отсутствующая сеть и т.п.).
- Валидирует наличие SSID в листинге перед подключением и интерпретирует частые ошибки `nmcli` (неверный пароль, отсутствующая сеть и т.п.).
Ограничения:
- Требуются права для управления сетевыми соединениями в системе.
- В окружениях без NetworkManager команды `nmcli` будут недоступны.
"""