Docstring документация моделей сервера

This commit is contained in:
parent d80adfb2e0
commit 1b0d18b681
7 changed files with 184 additions and 13 deletions

View file

@ -1,7 +1,21 @@
from pydantic import BaseModel
from typing import Optional, List
class WifiAccessPoint(BaseModel):
"""
Модель точки доступа Wi-Fi
Атрибуты:
ssid (Optional[str]): Название точки доступа. Может быть скрытым
bssid (str): Уникальный идентификатор точки доступа (по типу MAC-адреса)
channel (Optional[int]): Канал, на котором работает точка доступа
signal (Optional[int]): Уровень сигнала (dBm)
encryption (Optional[str]): Тип шифрования (WPA2, WPA3, открытая и т.д.)
frequency (Optional[str]): Частота вещания (2.4GHz/5GHz)
vendor (Optional[str]): Производитель точки доступа (определяется по MAC-адресу)
hidden (bool): Флаг скрытия названия точки доступа (ssid)
"""
ssid: Optional[str] = None
bssid: str
channel: Optional[int] = None
@ -11,5 +25,12 @@ class WifiAccessPoint(BaseModel):
vendor: Optional[str] = None
hidden: bool = False
class WifiScanResult(BaseModel):
access_points: List[WifiAccessPoint]
"""
Результат сканирования Wi-Fi
Атрибуты:
access_points (List[WifiAccessPoint]): Список найденных Wi-Fi точек доступа
"""
access_points: List[WifiAccessPoint]