Рефакторинг. docstring
This commit is contained in:
parent
060f4de175
commit
37f9e3abfb
14 changed files with 1234 additions and 243 deletions
|
|
@ -6,11 +6,9 @@ from functools import lru_cache
|
|||
from typing import List, Optional, Dict, Tuple
|
||||
from mac_vendor_lookup import MacLookup
|
||||
import pywifi
|
||||
from pywifi import Profile
|
||||
from models.wifi import WifiAccessPoint, WifiScanResult
|
||||
from pathlib import Path
|
||||
import json
|
||||
from datetime import datetime
|
||||
|
||||
logging.basicConfig(
|
||||
level=logging.DEBUG,
|
||||
|
|
@ -18,14 +16,34 @@ logging.basicConfig(
|
|||
logger = logging.getLogger(__name__)
|
||||
|
||||
class WifiStorage:
|
||||
"""Класс для хранения данных о Wi-Fi сетях и их заметках по SSID."""
|
||||
"""Класс для хранения данных о Wi-Fi сетях и их заметках по SSID.
|
||||
|
||||
Предоставляет методы для загрузки и сохранения заметок, связанных с SSID сетей,
|
||||
в JSON-файле на диске.
|
||||
"""
|
||||
|
||||
def __init__(self, storage_path: str = "etc/gonets/SRV/storage/wifi/wifi.json"):
|
||||
"""Инициализирует объект хранилища Wi-Fi с указанным путём к файлу.
|
||||
|
||||
Args:
|
||||
storage_path (str, optional): Путь к файлу для хранения заметок.
|
||||
По умолчанию "etc/gonets/SRV/storage/wifi/wifi.json".
|
||||
|
||||
Создаёт родительские директории, если они не существуют.
|
||||
"""
|
||||
self.storage_file = Path(storage_path)
|
||||
self.storage_file.parent.mkdir(parents=True, exist_ok=True)
|
||||
|
||||
def load_notes(self) -> Dict[str, Optional[str]]:
|
||||
"""Загружает заметки по SSID из файла хранения."""
|
||||
"""Загружает заметки по SSID из файла хранения.
|
||||
|
||||
Returns:
|
||||
Dict[str, Optional[str]]: Словарь, где ключ — SSID, значение — заметка
|
||||
или None, если заметки нет.
|
||||
|
||||
Raises:
|
||||
Exception: Если произошла ошибка при чтении или парсинге файла.
|
||||
"""
|
||||
try:
|
||||
if self.storage_file.exists():
|
||||
with open(self.storage_file, "r", encoding="utf-8") as f:
|
||||
|
|
@ -37,7 +55,15 @@ class WifiStorage:
|
|||
return {}
|
||||
|
||||
def save_notes(self, notes: Dict[str, Optional[str]]) -> None:
|
||||
"""Сохраняет заметки по SSID в файл."""
|
||||
"""Сохраняет заметки по SSID в файл.
|
||||
|
||||
Args:
|
||||
notes (Dict[str, Optional[str]]): Словарь с SSID как ключами и заметками
|
||||
как значениями.
|
||||
|
||||
Raises:
|
||||
Exception: Если произошла ошибка при записи в файл.
|
||||
"""
|
||||
try:
|
||||
data = {"networks": [{"ssid": ssid, "note": note} for ssid, note in notes.items()]}
|
||||
with open(self.storage_file, "w", encoding="utf-8") as f:
|
||||
|
|
@ -47,16 +73,33 @@ class WifiStorage:
|
|||
logger.error(f"Ошибка при сохранении заметок: {str(e)}")
|
||||
|
||||
class WifiService:
|
||||
"""Сервис для сканирования текущих Wi-Fi точек доступа"""
|
||||
"""Сервис для сканирования текущих Wi-Fi точек доступа.
|
||||
|
||||
Предоставляет функционал для обнаружения Wi-Fi сетей с использованием pywifi и iw,
|
||||
определения характеристик точек доступа (сигнал, шифрование, канал и т.д.),
|
||||
а также управления заметками.
|
||||
"""
|
||||
|
||||
def __init__(self):
|
||||
"""Инициализирует сервис Wi-Fi с настройкой интерфейса и хранилища.
|
||||
|
||||
Инициализирует объект MacLookup для определения вендоров по MAC-адресам,
|
||||
PyWiFi для работы с Wi-Fi-интерфейсами и объект хранилища заметок.
|
||||
"""
|
||||
self.mac_lookup = MacLookup()
|
||||
self.wifi = pywifi.PyWiFi()
|
||||
self.interface = self._get_wifi_interface()
|
||||
self.storage = WifiStorage()
|
||||
|
||||
def _get_wifi_interface(self) -> Optional[object]:
|
||||
"""Автоматически определяет активный Wi-Fi-интерфейс"""
|
||||
"""Автоматически определяет активный Wi-Fi-интерфейс.
|
||||
|
||||
Returns:
|
||||
Optional[object]: Объект интерфейса PyWiFi или None, если интерфейс не найден.
|
||||
|
||||
Проверяет доступные интерфейсы, выполняет тестовое сканирование и возвращает
|
||||
первый активный интерфейс, исключая P2P-интерфейсы.
|
||||
"""
|
||||
try:
|
||||
interfaces = self.wifi.interfaces()
|
||||
if not interfaces:
|
||||
|
|
@ -93,6 +136,17 @@ class WifiService:
|
|||
|
||||
@lru_cache(maxsize=1000)
|
||||
def get_vendor(self, mac: str) -> str:
|
||||
"""Определяет вендора по MAC-адресу с использованием кэширования.
|
||||
|
||||
Args:
|
||||
mac (str): MAC-адрес устройства в формате XX:XX:XX:XX:XX:XX.
|
||||
|
||||
Returns:
|
||||
str: Название вендора или "Unknown", если вендор не определён.
|
||||
|
||||
Raises:
|
||||
Exception: Если произошла ошибка при запросе к базе вендоров.
|
||||
"""
|
||||
try:
|
||||
return self.mac_lookup.lookup(mac)
|
||||
except Exception as e:
|
||||
|
|
@ -101,7 +155,14 @@ class WifiService:
|
|||
return "Unknown"
|
||||
|
||||
def _get_encryption_from_iw(self, ap_info: Dict) -> str:
|
||||
"""Определяет шифрование из данных iw"""
|
||||
"""Определяет тип шифрования из данных, полученных через iw.
|
||||
|
||||
Args:
|
||||
ap_info (Dict): Словарь с данными точки доступа, включая поле "security".
|
||||
|
||||
Returns:
|
||||
str: Тип шифрования ("WPA3", "WPA2", "WPA", "WEP" или "Open").
|
||||
"""
|
||||
security = ap_info.get("security", "")
|
||||
logger.debug(
|
||||
f"Шифрование для BSSID {ap_info.get('bssid')}: {security}")
|
||||
|
|
@ -116,7 +177,14 @@ class WifiService:
|
|||
return "Open"
|
||||
|
||||
def _get_channel(self, frequency: Optional[int]) -> Optional[int]:
|
||||
"""Преобразует частоту в канал."""
|
||||
"""Преобразует частоту в номер канала.
|
||||
|
||||
Args:
|
||||
frequency (Optional[int]): Частота в МГц или None.
|
||||
|
||||
Returns:
|
||||
Optional[int]: Номер канала или None, если частота вне диапазона.
|
||||
"""
|
||||
if frequency is None:
|
||||
return None
|
||||
try:
|
||||
|
|
@ -133,7 +201,14 @@ class WifiService:
|
|||
return None
|
||||
|
||||
def _get_frequency(self, frequency: Optional[int]) -> Optional[str]:
|
||||
"""Определяет частотный диапазон."""
|
||||
"""Определяет частотный диапазон на основе частоты.
|
||||
|
||||
Args:
|
||||
frequency (Optional[int]): Частота в МГц или None.
|
||||
|
||||
Returns:
|
||||
Optional[str]: Диапазон ("2.4 GHz", "5 GHz" или None).
|
||||
"""
|
||||
if frequency is None:
|
||||
return None
|
||||
try:
|
||||
|
|
@ -150,7 +225,17 @@ class WifiService:
|
|||
return None
|
||||
|
||||
def _get_iw_scan_data(self) -> List[Dict]:
|
||||
"""Получает данные сканирования через iw."""
|
||||
"""Получает данные сканирования Wi-Fi через команду iw.
|
||||
|
||||
Returns:
|
||||
List[Dict]: Список словарей с данными точек доступа (BSSID, SSID, частота,
|
||||
сигнал, шифрование).
|
||||
|
||||
Raises:
|
||||
subprocess.CalledProcessError: Если команда iw завершилась с ошибкой.
|
||||
subprocess.TimeoutExpired: Если превышен таймаут выполнения.
|
||||
Exception: Если произошла ошибка при парсинге вывода.
|
||||
"""
|
||||
try:
|
||||
if not self.interface:
|
||||
logger.error("Интерфейс не определён")
|
||||
|
|
@ -225,7 +310,18 @@ class WifiService:
|
|||
return []
|
||||
|
||||
def scan_wifi(self, timeout: int = 30) -> WifiScanResult:
|
||||
"""Сканирует текущие Wi-Fi точки доступа"""
|
||||
"""Сканирует текущие Wi-Fi точки доступа.
|
||||
|
||||
Args:
|
||||
timeout (int, optional): Таймаут ожидания в секундах. По умолчанию 30.
|
||||
|
||||
Returns:
|
||||
WifiScanResult: Объект с результатами сканирования, содержащий список точек
|
||||
доступа.
|
||||
|
||||
Сканирует Wi-Fi с использованием pywifi и iw, объединяет данные, определяет
|
||||
лучшие точки по сигналу и сохраняет заметки.
|
||||
"""
|
||||
start_time = time.time()
|
||||
aps = []
|
||||
|
||||
|
|
@ -282,12 +378,10 @@ class WifiService:
|
|||
if ssid not in best_aps_by_ssid or (
|
||||
current_ap.signal and best_aps_by_ssid[ssid].signal
|
||||
and current_ap.signal > best_aps_by_ssid[ssid].signal):
|
||||
# При обновлении или добавлении точки сохраняем заметку из saved_notes
|
||||
current_ap.note = saved_notes.get(ssid)
|
||||
best_aps_by_ssid[ssid] = current_ap
|
||||
|
||||
aps = list(best_aps_by_ssid.values())
|
||||
# Сохраняем заметки для всех найденных SSID
|
||||
notes_to_save = {ap.ssid: ap.note for ap in aps if ap.ssid}
|
||||
self.storage.save_notes(notes_to_save)
|
||||
|
||||
|
|
@ -313,7 +407,7 @@ class WifiService:
|
|||
- Ошибка: (False, сообщение об ошибке).
|
||||
|
||||
Raises:
|
||||
Exception: Если произошла ошибка при сохранении.
|
||||
Exception: Если произошла ошибка при сохранении заметки.
|
||||
"""
|
||||
try:
|
||||
saved_notes = self.storage.load_notes()
|
||||
|
|
@ -343,7 +437,7 @@ class WifiService:
|
|||
- Ошибка: (False, сообщение об ошибке).
|
||||
|
||||
Raises:
|
||||
Exception: Если произошла ошибка при сохранении.
|
||||
Exception: Если произошла ошибка при сохранении заметки.
|
||||
"""
|
||||
try:
|
||||
saved_notes = self.storage.load_notes()
|
||||
|
|
@ -373,7 +467,7 @@ class WifiService:
|
|||
- Ошибка: (False, сообщение об ошибке).
|
||||
|
||||
Raises:
|
||||
Exception: Если произошла ошибка при сохранении.
|
||||
Exception: Если произошла ошибка при сохранении изменений.
|
||||
"""
|
||||
try:
|
||||
saved_notes = self.storage.load_notes()
|
||||
|
|
|
|||
Loading…
Add table
Add a link
Reference in a new issue