Рефакторинг. docstring
This commit is contained in:
parent
060f4de175
commit
37f9e3abfb
14 changed files with 1234 additions and 243 deletions
|
|
@ -1,4 +1,3 @@
|
|||
# api/v1/auth.py
|
||||
from fastapi import APIRouter, Depends, HTTPException, Request
|
||||
from fastapi.security import OAuth2PasswordBearer
|
||||
from services.auth_service import AuthService
|
||||
|
|
@ -17,7 +16,21 @@ oauth2_scheme = OAuth2PasswordBearer(tokenUrl="/auth/login")
|
|||
|
||||
@router.post("/register", response_model=UserResponse)
|
||||
async def register(user: UserCreate):
|
||||
"""Регистрирует нового пользователя"""
|
||||
"""Регистрирует нового пользователя.
|
||||
|
||||
Создаёт нового пользователя на основе предоставленных данных и возвращает
|
||||
информацию о зарегистрированном пользователе.
|
||||
|
||||
Args:
|
||||
user (UserCreate): Объект с данными нового пользователя (username, password, is_admin).
|
||||
|
||||
Returns:
|
||||
UserResponse: Объект с данными зарегистрированного пользователя (id, username, is_admin).
|
||||
|
||||
Raises:
|
||||
HTTPException: Если пользователь уже существует (status_code=400) или произошла
|
||||
внутренняя ошибка (status_code=500).
|
||||
"""
|
||||
try:
|
||||
db_user = auth_service.register(user)
|
||||
logger.info(f"Пользователь {user.username} успешно зарегистрирован")
|
||||
|
|
@ -26,13 +39,27 @@ async def register(user: UserCreate):
|
|||
raise e
|
||||
except Exception as e:
|
||||
logger.error(f"Ошибка в register: {type(e).__name__} - {str(e)}")
|
||||
raise HTTPException(status_code=500,
|
||||
detail="Не удалось зарегистрировать пользователя")
|
||||
raise HTTPException(status_code=500, detail="Не удалось зарегистрировать пользователя")
|
||||
|
||||
|
||||
@router.post("/login", response_model=Token)
|
||||
async def login(user: UserLogin, request: Request):
|
||||
"""Авторизует пользователя и создаёт сессию"""
|
||||
"""Авторизует пользователя и создаёт сессию.
|
||||
|
||||
Проверяет учетные данные пользователя и возвращает токен и session_id для
|
||||
последующей авторизации.
|
||||
|
||||
Args:
|
||||
user (UserLogin): Объект с данными для входа (username, password).
|
||||
request (Request): Объект запроса для получения client_id (IP-адрес клиента).
|
||||
|
||||
Returns:
|
||||
Token: Объект с access_token и session_id для авторизации.
|
||||
|
||||
Raises:
|
||||
HTTPException: Если учетные данные неверны (status_code=401) или произошла
|
||||
внутренняя ошибка (status_code=500).
|
||||
"""
|
||||
try:
|
||||
client_id = request.client.host
|
||||
logger.debug(f"Попытка авторизации для client_id {client_id}")
|
||||
|
|
@ -45,13 +72,27 @@ async def login(user: UserLogin, request: Request):
|
|||
raise e
|
||||
except Exception as e:
|
||||
logger.error(f"Ошибка в login: {type(e).__name__} - {str(e)}")
|
||||
raise HTTPException(status_code=500,
|
||||
detail="Не удалось авторизовать пользователя")
|
||||
raise HTTPException(status_code=500, detail="Не удалось авторизовать пользователя")
|
||||
|
||||
|
||||
@router.get("/me")
|
||||
async def get_current_user(request: Request):
|
||||
"""Возвращает данные текущего пользователя и токен"""
|
||||
"""Возвращает данные текущего пользователя и токен.
|
||||
|
||||
Проверяет активную сессию по client_id и возвращает информацию о пользователе
|
||||
и токен для дальнейшего использования.
|
||||
|
||||
Args:
|
||||
request (Request): Объект запроса для получения client_id (IP-адрес клиента).
|
||||
|
||||
Returns:
|
||||
dict: Словарь с ключами "user" (UserResponse), "access_token" (str) и
|
||||
"token_type" (str, всегда "bearer").
|
||||
|
||||
Raises:
|
||||
HTTPException: Если сессия не найдена или истекла (status_code=401) или
|
||||
произошла внутренняя ошибка (status_code=500).
|
||||
"""
|
||||
try:
|
||||
client_id = request.client.host
|
||||
logger.debug(f"Запрос /me для client_id {client_id}")
|
||||
|
|
@ -66,13 +107,25 @@ async def get_current_user(request: Request):
|
|||
except Exception as e:
|
||||
logger.error(
|
||||
f"Ошибка в get_current_user: {type(e).__name__} - {str(e)}")
|
||||
raise HTTPException(status_code=500,
|
||||
detail="Не удалось получить данные пользователя")
|
||||
raise HTTPException(status_code=500, detail="Не удалось получить данные пользователя")
|
||||
|
||||
|
||||
@router.get("/logout")
|
||||
async def logout(request: Request):
|
||||
"""Выход из системы, удаление сессии"""
|
||||
"""Выход из системы, удаление сессии.
|
||||
|
||||
Удаляет активную сессию пользователя по client_id.
|
||||
|
||||
Args:
|
||||
request (Request): Объект запроса для получения client_id (IP-адрес клиента).
|
||||
|
||||
Returns:
|
||||
dict: Пустой словарь или сообщение об успешном выходе.
|
||||
|
||||
Raises:
|
||||
HTTPException: Если сессия не найдена (status_code=401) или произошла
|
||||
внутренняя ошибка (status_code=500).
|
||||
"""
|
||||
try:
|
||||
client_id = request.client.host
|
||||
logger.debug(f"Запрос logout для client_id {client_id}")
|
||||
|
|
@ -81,13 +134,24 @@ async def logout(request: Request):
|
|||
raise e
|
||||
except Exception as e:
|
||||
logger.error(f"Ошибка в logout: {type(e).__name__} - {str(e)}")
|
||||
raise HTTPException(status_code=500,
|
||||
detail="Не удалось выйти из системы")
|
||||
raise HTTPException(status_code=500, detail="Не удалось выйти из системы")
|
||||
|
||||
|
||||
@router.get("/check_json")
|
||||
async def check_users_file():
|
||||
"""Проверяет, существует ли файл users.json и содержит ли он пользователей"""
|
||||
"""Проверяет, существует ли файл users.json и содержит ли он пользователей.
|
||||
|
||||
Возвращает информацию о состоянии файла и наличии пользователей.
|
||||
|
||||
Returns:
|
||||
dict: Словарь с ключами:
|
||||
- "exists" (bool): Существует ли файл.
|
||||
- "has_users" (bool): Содержит ли файл пользователей.
|
||||
- "message" (str): Сообщение с описанием результата.
|
||||
|
||||
Raises:
|
||||
HTTPException: Если произошла ошибка при проверке файла (status_code=500).
|
||||
"""
|
||||
try:
|
||||
file_path = "/etc/gonets/users.json"
|
||||
storage = JsonStorage(file_path=file_path)
|
||||
|
|
@ -104,27 +168,24 @@ async def check_users_file():
|
|||
has_users = len(data.get("users", [])) > 0
|
||||
if has_users:
|
||||
logger.info(
|
||||
f"Файл {file_path} существует и содержит пользователей")
|
||||
f"Файл {file_path} существует и содержит пользователей"
|
||||
)
|
||||
return {
|
||||
"exists": True,
|
||||
"has_users": True,
|
||||
"message":
|
||||
"Файл users.json существует и содержит пользователей",
|
||||
"message": "Файл users.json существует и содержит пользователей",
|
||||
}
|
||||
else:
|
||||
logger.info(
|
||||
f"Файл {file_path} существует, но не содержит пользователей")
|
||||
f"Файл {file_path} существует, но не содержит пользователей"
|
||||
)
|
||||
return {
|
||||
"exists":
|
||||
True,
|
||||
"has_users":
|
||||
False,
|
||||
"message":
|
||||
"Файл users.json существует, но не содержит пользователей",
|
||||
"exists": True,
|
||||
"has_users": False,
|
||||
"message": "Файл users.json существует, но не содержит пользователей",
|
||||
}
|
||||
except Exception as e:
|
||||
logger.error(
|
||||
f"Ошибка при проверке файла users.json: {type(e).__name__} - {str(e)}"
|
||||
)
|
||||
raise HTTPException(status_code=500,
|
||||
detail="Ошибка при проверке файла")
|
||||
raise HTTPException(status_code=500, detail="Ошибка при проверке файла")
|
||||
|
|
@ -8,7 +8,23 @@ ip_service = IPService()
|
|||
|
||||
@router.post("/check_ip")
|
||||
async def check_ip_config(data: Dict[str, Any] = Body(...)):
|
||||
"""Проверяет доступность IP-адреса"""
|
||||
"""Проверяет доступность IP-адреса перед его применением.
|
||||
|
||||
Выполняет ARP-сканирование для проверки, занят ли указанный IP-адрес,
|
||||
и возвращает результат проверки.
|
||||
|
||||
Args:
|
||||
data (Dict[str, Any]): Словарь с данными конфигурации, включая
|
||||
"ipv4_updates" с полем "ipv4.address-data" для нового IP-адреса.
|
||||
|
||||
Returns:
|
||||
Dict[str, Any]: Словарь с ключами:
|
||||
- "available" (bool): Доступен ли IP-адрес.
|
||||
- "message" (str): Сообщение о результате проверки.
|
||||
|
||||
Raises:
|
||||
HTTPException: Если произошла внутренняя ошибка (status_code=500).
|
||||
"""
|
||||
try:
|
||||
result = await ip_service.check_ip_config(data)
|
||||
return result
|
||||
|
|
@ -20,37 +36,63 @@ async def check_ip_config(data: Dict[str, Any] = Body(...)):
|
|||
|
||||
@router.post("/apply_ip")
|
||||
async def apply_ip_config(data: Dict[str, Any] = Body(...)):
|
||||
"""Применяет проверенные IP-настройки"""
|
||||
"""Применяет проверенные IP-настройки к указанному сетевому профилю.
|
||||
|
||||
Обновляет настройки соединения через NetworkManager, отключает и
|
||||
переподключает устройство к сети.
|
||||
|
||||
Args:
|
||||
data (Dict[str, Any]): Словарь с данными конфигурации, включая
|
||||
"connection_id" и "ipv4_updates" с обновлениями IP-настроек.
|
||||
|
||||
Returns:
|
||||
dict: Словарь с ключами:
|
||||
- "success" (bool): Успешность операции.
|
||||
- "message" (str): Сообщение об успешном применении настроек.
|
||||
|
||||
Raises:
|
||||
HTTPException: Если подключение не найдено (status_code=404) или
|
||||
произошла внутренняя ошибка (status_code=500).
|
||||
"""
|
||||
try:
|
||||
await ip_service.apply_ip_config(data)
|
||||
return {
|
||||
"success":
|
||||
True,
|
||||
"message":
|
||||
f"Настройки сетевого профиля для {data['connection_id']} применены",
|
||||
"success": True,
|
||||
"message": f"Настройки сетевого профиля для {data['connection_id']} применены",
|
||||
}
|
||||
except ValueError as e:
|
||||
raise HTTPException(status_code=404, detail=str(e))
|
||||
except Exception as e:
|
||||
raise HTTPException(
|
||||
status_code=500,
|
||||
detail=f"Ошибка проверки IP конфигурации: {str(e)}")
|
||||
raise HTTPException(status_code=500, detail=f"Ошибка проверки IP конфигурации: {str(e)}")
|
||||
|
||||
|
||||
@router.post("/save_ip")
|
||||
async def save_ip_config(data: Dict[str, Any] = Body(...)):
|
||||
"""Применяет проверенные IP-настройки (Нужен для того, чтобы откатить настройки сетевого профиля обратно)"""
|
||||
"""Применяет проверенные IP-настройки для отката сетевого профиля.
|
||||
|
||||
Используется для сохранения и отката настроек сетевого профиля к предыдущему
|
||||
состоянию через NetworkManager.
|
||||
|
||||
Args:
|
||||
data (Dict[str, Any]): Словарь с данными конфигурации, включая
|
||||
"connection_id" и "ipv4_updates" с обновлениями IP-настроек.
|
||||
|
||||
Returns:
|
||||
dict: Словарь с ключами:
|
||||
- "success" (bool): Успешность операции.
|
||||
- "message" (str): Сообщение об успешном применении настроек.
|
||||
|
||||
Raises:
|
||||
HTTPException: Если подключение не найдено (status_code=404) или
|
||||
произошла внутренняя ошибка (status_code=500).
|
||||
"""
|
||||
try:
|
||||
await ip_service.apply_ip_config(data)
|
||||
return {
|
||||
"success":
|
||||
True,
|
||||
"message":
|
||||
f"Настройки сетевого профиля для {data['connection_id']} применены",
|
||||
"success": True,
|
||||
"message": f"Настройки сетевого профиля для {data['connection_id']} применены",
|
||||
}
|
||||
except ValueError as e:
|
||||
raise HTTPException(status_code=404, detail=str(e))
|
||||
except Exception as e:
|
||||
raise HTTPException(
|
||||
status_code=500,
|
||||
detail=f"Ошибка проверки IP конфигурации: {str(e)}")
|
||||
raise HTTPException(status_code=500, detail=f"Ошибка проверки IP конфигурации: {str(e)}")
|
||||
|
|
@ -19,11 +19,18 @@ network_service = NetworkService()
|
|||
|
||||
|
||||
class ContainerPositionManager:
|
||||
"""
|
||||
Класс для управления позициями и состоянием контейнеров
|
||||
"""Класс для управления позициями и состоянием контейнеров.
|
||||
|
||||
Хранит и обновляет координаты (x, y) и состояние (isOpen) для контейнеров
|
||||
активации и деактивации.
|
||||
"""
|
||||
|
||||
def __init__(self):
|
||||
"""Инициализирует менеджер позиций контейнеров.
|
||||
|
||||
Создаёт начальные позиции и состояния для контейнеров "activation" и
|
||||
"deactivation" с координатами (0, 0) и закрытым состоянием (False).
|
||||
"""
|
||||
self.positions: Dict[str, Dict[str, Union[int, bool]]] = {
|
||||
"activation": {
|
||||
"x": 0,
|
||||
|
|
@ -37,15 +44,35 @@ class ContainerPositionManager:
|
|||
},
|
||||
}
|
||||
|
||||
def get_position_and_state(self,
|
||||
container_name: str) -> Tuple[int, int, bool]:
|
||||
def get_position_and_state(self, container_name: str) -> Tuple[int, int, bool]:
|
||||
"""Получает текущие координаты и состояние указанного контейнера.
|
||||
|
||||
Args:
|
||||
container_name (str): Имя контейнера ("activation" или "deactivation").
|
||||
|
||||
Returns:
|
||||
Tuple[int, int, bool]: Кортеж с координатами (x, y) и состоянием (isOpen).
|
||||
|
||||
Raises:
|
||||
ValueError: Если указан неверный идентификатор контейнера.
|
||||
"""
|
||||
container = self.positions.get(container_name)
|
||||
if not container:
|
||||
raise ValueError(f"Неверное имя контейнера: {container_name}")
|
||||
return container["x"], container["y"], container["isOpen"]
|
||||
|
||||
def update_position(self, container_id: int, x: int, y: int,
|
||||
isOpen: bool) -> None:
|
||||
def update_position(self, container_id: int, x: int, y: int, isOpen: bool) -> None:
|
||||
"""Обновляет позицию и состояние контейнера по его идентификатору.
|
||||
|
||||
Args:
|
||||
container_id (int): Идентификатор контейнера (1 для "activation", 2 для "deactivation").
|
||||
x (int): Новая координата X.
|
||||
y (int): Новая координата Y.
|
||||
isOpen (bool): Новое состояние контейнера (открыт/закрыт).
|
||||
|
||||
Raises:
|
||||
ValueError: Если container_id не соответствует ни одному контейнеру.
|
||||
"""
|
||||
container_name = "activation" if container_id == 1 else "deactivation"
|
||||
self.positions[container_name] = {"x": x, "y": y, "isOpen": isOpen}
|
||||
|
||||
|
|
@ -54,20 +81,27 @@ container_manager = ContainerPositionManager()
|
|||
|
||||
|
||||
async def get_network_data() -> Dict[str, Dict]:
|
||||
"""
|
||||
Возвращает текущие сетевые данные в виде словаря
|
||||
"""Возвращает текущие сетевые данные в виде словаря.
|
||||
|
||||
Получает данные о сетевых интерфейсах, разделяет их на активные и неактивные,
|
||||
и возвращает их в формате Activation и Deactivation с учётом позиций и состояний
|
||||
контейнеров.
|
||||
|
||||
Returns:
|
||||
Dict[str, Dict]: Словарь с ключами "activation" и "deactivation", содержащими
|
||||
данные о соответствующих контейнерах.
|
||||
|
||||
Raises:
|
||||
HTTPException: Если произошла ошибка при получении данных (status_code=500).
|
||||
"""
|
||||
logger.debug("Вызов get_network_data()")
|
||||
try:
|
||||
network_data = await network_service.get_network_interfaces_container()
|
||||
|
||||
activation_interfaces, deactivation_interfaces = _split_interfaces(
|
||||
network_data.interfaces)
|
||||
activation_interfaces, deactivation_interfaces = _split_interfaces(network_data.interfaces)
|
||||
|
||||
activation_x, activation_y, activation_is_open = (
|
||||
container_manager.get_position_and_state("activation"))
|
||||
deactivation_x, deactivation_y, deactivation_is_open = (
|
||||
container_manager.get_position_and_state("deactivation"))
|
||||
activation_x, activation_y, activation_is_open = (container_manager.get_position_and_state("activation"))
|
||||
deactivation_x, deactivation_y, deactivation_is_open = (container_manager.get_position_and_state("deactivation"))
|
||||
|
||||
activation = Activation(
|
||||
id=1,
|
||||
|
|
@ -90,16 +124,20 @@ async def get_network_data() -> Dict[str, Dict]:
|
|||
}
|
||||
except Exception as e:
|
||||
logger.error(f"Ошибка в get_network_data: {e}")
|
||||
raise HTTPException(status_code=500,
|
||||
detail="Не удалось получить сетевые данные")
|
||||
raise HTTPException(status_code=500, detail="Не удалось получить сетевые данные")
|
||||
|
||||
|
||||
def _split_interfaces(
|
||||
interfaces: List[Union[NetworkInterface, WiFiDevice]],
|
||||
) -> Tuple[List[Union[NetworkInterface, WiFiDevice]], List[Union[
|
||||
NetworkInterface, WiFiDevice]]]:
|
||||
"""
|
||||
Разделяет интерфейсы на активные и неактивные
|
||||
) -> Tuple[List[Union[NetworkInterface, WiFiDevice]], List[Union[NetworkInterface, WiFiDevice]]]:
|
||||
"""Разделяет интерфейсы на активные и неактивные.
|
||||
|
||||
Args:
|
||||
interfaces (List[Union[NetworkInterface, WiFiDevice]]): Список сетевых интерфейсов.
|
||||
|
||||
Returns:
|
||||
Tuple[List[Union[NetworkInterface, WiFiDevice]], List[Union[NetworkInterface, WiFiDevice]]]:
|
||||
Кортеж из списков активных и неактивных интерфейсов.
|
||||
"""
|
||||
activation_interfaces = []
|
||||
deactivation_interfaces = []
|
||||
|
|
@ -112,13 +150,29 @@ def _split_interfaces(
|
|||
|
||||
|
||||
@router.post("/update_container_position")
|
||||
async def update_container_position(data: Dict[str, Union[int,
|
||||
bool]] = Body(...)):
|
||||
"""
|
||||
Обновляет позицию и состояние контейнера
|
||||
async def update_container_position(data: Dict[str, Union[int, bool]] = Body(...)):
|
||||
"""Обновляет позицию и состояние контейнера.
|
||||
|
||||
Принимает данные о новом положении и состоянии контейнера и обновляет их
|
||||
в менеджере позиций.
|
||||
|
||||
Args:
|
||||
data (Dict[str, Union[int, bool]]): Словарь с ключами:
|
||||
- "container_id" (int): Идентификатор контейнера (1 или 2).
|
||||
- "container_x" (int): Новая координата X.
|
||||
- "container_y" (int): Новая координата Y.
|
||||
- "isOpen" (bool): Новое состояние контейнера (открыт/закрыт).
|
||||
|
||||
Returns:
|
||||
dict: Словарь с ключами:
|
||||
- "success" (bool): Успешность операции.
|
||||
- "message" (str): Сообщение об успешном обновлении.
|
||||
|
||||
Raises:
|
||||
HTTPException: Если отсутствуют обязательные поля (status_code=400) или
|
||||
типы данных неверны.
|
||||
"""
|
||||
try:
|
||||
|
||||
required_keys = [
|
||||
"container_id", "container_x", "container_y", "isOpen"
|
||||
]
|
||||
|
|
@ -132,33 +186,37 @@ async def update_container_position(data: Dict[str, Union[int,
|
|||
container_y = data["container_y"]
|
||||
is_open = data["isOpen"]
|
||||
|
||||
# Проверка типов
|
||||
if (not isinstance(container_id, int)
|
||||
or not isinstance(container_x, int)
|
||||
or not isinstance(container_y, int)
|
||||
or not isinstance(is_open, bool)):
|
||||
raise ValueError("Неверный тип данных в запросе")
|
||||
|
||||
container_manager.update_position(container_id, container_x,
|
||||
container_y, is_open)
|
||||
container_manager.update_position(container_id, container_x, container_y, is_open)
|
||||
return {
|
||||
"success": True,
|
||||
"message": "Позиция и состояние контейнера обновлены"
|
||||
}
|
||||
except Exception as e:
|
||||
logger.error(f"Ошибка обновления позиции контейнера: {e}")
|
||||
raise HTTPException(
|
||||
status_code=400,
|
||||
detail=f"Не удалось обновить положение контейнера: {str(e)}",
|
||||
)
|
||||
raise HTTPException(status_code=400, detail=f"Не удалось обновить положение контейнера: {str(e)}")
|
||||
|
||||
|
||||
@router.get("/get_hostname")
|
||||
async def get_hostname():
|
||||
"""Возвращает имя хоста системы.
|
||||
|
||||
Выполняет запрос к сервису для получения имени хоста.
|
||||
|
||||
Returns:
|
||||
dict: Словарь с ключом "hostname" и значением имени хоста.
|
||||
|
||||
Raises:
|
||||
HTTPException: Если произошла ошибка при получении имени хоста (status_code=500).
|
||||
"""
|
||||
try:
|
||||
hostname_info = await network_service.get_hostname()
|
||||
return hostname_info
|
||||
except Exception as e:
|
||||
logger.error(f"Ошибка в get_hostname: {e}")
|
||||
raise HTTPException(status_code=500,
|
||||
detail="Не удалось получить имя хоста")
|
||||
raise HTTPException(status_code=500, detail="Не удалось получить имя хоста")
|
||||
|
|
@ -11,7 +11,22 @@ router = APIRouter()
|
|||
|
||||
@router.get("/devices", response_model=SubnetScanResult)
|
||||
def scan_subnet(subnet: str = "192.168.1.0/24", ports: List[int] = None):
|
||||
"""Сканирует локальную подсеть и возвращает данные об устройствах"""
|
||||
"""Сканирует локальную подсеть и возвращает данные об устройствах.
|
||||
|
||||
Выполняет сканирование указанной подсети для обнаружения активных устройств
|
||||
с возможностью проверки указанных портов.
|
||||
|
||||
Args:
|
||||
subnet (str, optional): Адрес подсети в формате CIDR (например, "192.168.1.0/24").
|
||||
По умолчанию "192.168.1.0/24".
|
||||
ports (List[int], optional): Список портов для сканирования. По умолчанию None.
|
||||
|
||||
Returns:
|
||||
SubnetScanResult: Объект с результатами сканирования (устройства и их данные).
|
||||
|
||||
Raises:
|
||||
HTTPException: Если произошла ошибка сканирования (status_code=500).
|
||||
"""
|
||||
try:
|
||||
subnet_service = SubnetService()
|
||||
result = subnet_service.scan_subnet(subnet, ports)
|
||||
|
|
@ -21,7 +36,19 @@ def scan_subnet(subnet: str = "192.168.1.0/24", ports: List[int] = None):
|
|||
|
||||
@router.get("/wifi", response_model=WifiScanResult)
|
||||
def scan_wifi(timeout: int = 30):
|
||||
"""Сканирует Wi-Fi точки доступа и возвращает данные о них"""
|
||||
"""Сканирует Wi-Fi точки доступа и возвращает данные о них.
|
||||
|
||||
Выполняет сканирование доступных Wi-Fi сетей с указанным таймаутом.
|
||||
|
||||
Args:
|
||||
timeout (int, optional): Таймаут сканирования в секундах. По умолчанию 30.
|
||||
|
||||
Returns:
|
||||
WifiScanResult: Объект с результатами сканирования (список Wi-Fi сетей).
|
||||
|
||||
Raises:
|
||||
HTTPException: Если произошла ошибка сканирования Wi-Fi (status_code=500).
|
||||
"""
|
||||
try:
|
||||
wifi_service = WifiService()
|
||||
result = wifi_service.scan_wifi(timeout=timeout)
|
||||
|
|
@ -31,7 +58,21 @@ def scan_wifi(timeout: int = 30):
|
|||
|
||||
@router.post("/devices/{mac}/note")
|
||||
def add_note(mac: str, request: NoteRequest):
|
||||
"""Добавляет заметку для устройства по MAC-адресу"""
|
||||
"""Добавляет заметку для устройства по MAC-адресу.
|
||||
|
||||
Привязывает заметку к устройству, идентифицируемому по MAC-адресу.
|
||||
|
||||
Args:
|
||||
mac (str): MAC-адрес устройства.
|
||||
request (NoteRequest): Объект с полем "note" для текста заметки.
|
||||
|
||||
Returns:
|
||||
dict: Словарь с сообщением об успешном добавлении заметки.
|
||||
|
||||
Raises:
|
||||
HTTPException: Если устройство не найдено (status_code=404), заметка уже
|
||||
существует (status_code=400), или произошла внутренняя ошибка (status_code=500).
|
||||
"""
|
||||
try:
|
||||
subnet_service = SubnetService()
|
||||
success, error_message = subnet_service.add_note(mac, request.note)
|
||||
|
|
@ -48,7 +89,21 @@ def add_note(mac: str, request: NoteRequest):
|
|||
|
||||
@router.put("/devices/{mac}/note")
|
||||
def update_note(mac: str, request: NoteRequest):
|
||||
"""Обновляет заметку для устройства по MAC-адресу"""
|
||||
"""Обновляет заметку для устройства по MAC-адресу.
|
||||
|
||||
Изменяет существующую заметку, привязанную к устройству.
|
||||
|
||||
Args:
|
||||
mac (str): MAC-адрес устройства.
|
||||
request (NoteRequest): Объект с полем "note" для нового текста заметки.
|
||||
|
||||
Returns:
|
||||
dict: Словарь с сообщением об успешном обновлении заметки.
|
||||
|
||||
Raises:
|
||||
HTTPException: Если устройство не найдено (status_code=404), заметка не
|
||||
существует (status_code=400), или произошла внутренняя ошибка (status_code=500).
|
||||
"""
|
||||
try:
|
||||
subnet_service = SubnetService()
|
||||
success, error_message = subnet_service.update_note(mac, request.note)
|
||||
|
|
@ -65,7 +120,20 @@ def update_note(mac: str, request: NoteRequest):
|
|||
|
||||
@router.delete("/devices/{mac}/note")
|
||||
def delete_note(mac: str):
|
||||
"""Удаляет заметку для устройства по MAC-адресу"""
|
||||
"""Удаляет заметку для устройства по MAC-адресу.
|
||||
|
||||
Удаляет привязанную заметку для указанного устройства.
|
||||
|
||||
Args:
|
||||
mac (str): MAC-адрес устройства.
|
||||
|
||||
Returns:
|
||||
dict: Словарь с сообщением об успешном удалении заметки.
|
||||
|
||||
Raises:
|
||||
HTTPException: Если устройство не найдено (status_code=404), заметка не
|
||||
существует (status_code=400), или произошла внутренняя ошибка (status_code=500).
|
||||
"""
|
||||
try:
|
||||
subnet_service = SubnetService()
|
||||
success, error_message = subnet_service.delete_note(mac)
|
||||
|
|
@ -82,7 +150,21 @@ def delete_note(mac: str):
|
|||
|
||||
@router.post("/wifi/{ssid}/note")
|
||||
def add_wifi_note(ssid: str, request: NoteRequest):
|
||||
"""Добавляет заметку для сети Wi-Fi по SSID"""
|
||||
"""Добавляет заметку для сети Wi-Fi по SSID.
|
||||
|
||||
Привязывает заметку к Wi-Fi сети, идентифицируемой по SSID.
|
||||
|
||||
Args:
|
||||
ssid (str): Идентификатор Wi-Fi сети.
|
||||
request (NoteRequest): Объект с полем "note" для текста заметки.
|
||||
|
||||
Returns:
|
||||
dict: Словарь с сообщением об успешном добавлении заметки.
|
||||
|
||||
Raises:
|
||||
HTTPException: Если сеть не найдена (status_code=404), заметка уже
|
||||
существует (status_code=400), или произошла внутренняя ошибка (status_code=500).
|
||||
"""
|
||||
try:
|
||||
wifi_service = WifiService()
|
||||
success, error_message = wifi_service.add_note(ssid, request.note)
|
||||
|
|
@ -99,7 +181,21 @@ def add_wifi_note(ssid: str, request: NoteRequest):
|
|||
|
||||
@router.put("/wifi/{ssid}/note")
|
||||
def update_wifi_note(ssid: str, request: NoteRequest):
|
||||
"""Обновляет заметку для сети Wi-Fi по SSID"""
|
||||
"""Обновляет заметку для сети Wi-Fi по SSID.
|
||||
|
||||
Изменяет существующую заметку, привязанную к Wi-Fi сети.
|
||||
|
||||
Args:
|
||||
ssid (str): Идентификатор Wi-Fi сети.
|
||||
request (NoteRequest): Объект с полем "note" для нового текста заметки.
|
||||
|
||||
Returns:
|
||||
dict: Словарь с сообщением об успешном обновлении заметки.
|
||||
|
||||
Raises:
|
||||
HTTPException: Если сеть не найдена (status_code=404), заметка не
|
||||
существует (status_code=400), или произошла внутренняя ошибка (status_code=500).
|
||||
"""
|
||||
try:
|
||||
wifi_service = WifiService()
|
||||
success, error_message = wifi_service.update_note(ssid, request.note)
|
||||
|
|
@ -116,7 +212,20 @@ def update_wifi_note(ssid: str, request: NoteRequest):
|
|||
|
||||
@router.delete("/wifi/{ssid}/note")
|
||||
def delete_wifi_note(ssid: str):
|
||||
"""Удаляет заметку для сети Wi-Fi по SSID"""
|
||||
"""Удаляет заметку для сети Wi-Fi по SSID.
|
||||
|
||||
Удаляет привязанную заметку для указанной Wi-Fi сети.
|
||||
|
||||
Args:
|
||||
ssid (str): Идентификатор Wi-Fi сети.
|
||||
|
||||
Returns:
|
||||
dict: Словарь с сообщением об успешном удалении заметки.
|
||||
|
||||
Raises:
|
||||
HTTPException: Если сеть не найдена (status_code=404), заметка не
|
||||
существует (status_code=400), или произошла внутренняя ошибка (status_code=500).
|
||||
"""
|
||||
try:
|
||||
wifi_service = WifiService()
|
||||
success, error_message = wifi_service.delete_note(ssid)
|
||||
|
|
@ -133,7 +242,20 @@ def delete_wifi_note(ssid: str):
|
|||
|
||||
@router.post("/wifi/connect")
|
||||
def connect_to_wifi(request: WifiConnectRequest):
|
||||
"""Подключается к Wi-Fi сети по SSID и паролю."""
|
||||
"""Подключается к Wi-Fi сети по SSID и паролю.
|
||||
|
||||
Выполняет подключение к указанной Wi-Fi сети с использованием предоставленных
|
||||
учетных данных.
|
||||
|
||||
Args:
|
||||
request (WifiConnectRequest): Объект с полями "ssid" и "password".
|
||||
|
||||
Returns:
|
||||
dict: Словарь с сообщением об успешном подключении.
|
||||
|
||||
Raises:
|
||||
HTTPException: Если подключение не удалось (status_code=400).
|
||||
"""
|
||||
wifi_service = WifiConnectionService()
|
||||
success, message = wifi_service.connect(request.ssid, request.password)
|
||||
if not success:
|
||||
|
|
@ -142,7 +264,19 @@ def connect_to_wifi(request: WifiConnectRequest):
|
|||
|
||||
@router.post("/wifi/disconnect")
|
||||
def disconnect_from_wifi(request: WifiDisconnectRequest):
|
||||
"""Отключается от Wi-Fi сети по указанному SSID."""
|
||||
"""Отключается от Wi-Fi сети по указанному SSID.
|
||||
|
||||
Выполняет отключение от указанной Wi-Fi сети.
|
||||
|
||||
Args:
|
||||
request (WifiDisconnectRequest): Объект с полем "ssid".
|
||||
|
||||
Returns:
|
||||
dict: Словарь с сообщением об успешном отключении.
|
||||
|
||||
Raises:
|
||||
HTTPException: Если отключение не удалось (status_code=400).
|
||||
"""
|
||||
wifi_service = WifiConnectionService()
|
||||
success, message = wifi_service.disconnect(request.ssid)
|
||||
if not success:
|
||||
|
|
@ -151,7 +285,18 @@ def disconnect_from_wifi(request: WifiDisconnectRequest):
|
|||
|
||||
@router.get("/wifi/status")
|
||||
def get_wifi_status():
|
||||
"""Проверяет статус текущего подключения к Wi-Fi."""
|
||||
"""Проверяет статус текущего подключения к Wi-Fi.
|
||||
|
||||
Возвращает информацию о текущем состоянии подключения и SSID, если подключение активно.
|
||||
|
||||
Returns:
|
||||
dict: Словарь с ключами:
|
||||
- "status" (str): Состояние ("connected" или другое).
|
||||
- "ssid" (str, optional): SSID текущей сети, если подключено.
|
||||
|
||||
Raises:
|
||||
HTTPException: Если проверка статуса не удалась (status_code=400).
|
||||
"""
|
||||
wifi_service = WifiConnectionService()
|
||||
success, message = wifi_service.get_status()
|
||||
if not success:
|
||||
|
|
|
|||
|
|
@ -12,27 +12,57 @@ router = APIRouter()
|
|||
logging.basicConfig(level=logging.INFO)
|
||||
logger = logging.getLogger(__name__)
|
||||
|
||||
|
||||
class WebSocketManager:
|
||||
"""
|
||||
Класс для управления подключениями к WebSocket-серверу
|
||||
"""Класс для управления подключениями к WebSocket-серверу.
|
||||
|
||||
Обрабатывает подключение, отключение и трансляцию сообщений для клиентов,
|
||||
подключённых через WebSocket.
|
||||
"""
|
||||
|
||||
def __init__(self):
|
||||
"""Инициализация менеджера подключений к WebSocket-серверу"""
|
||||
"""Инициализирует менеджер подключений к WebSocket-серверу.
|
||||
|
||||
Создаёт пустое множество для хранения активных соединений.
|
||||
"""
|
||||
self.active_connections: Set[WebSocket] = set()
|
||||
|
||||
async def connect(self, websocket: WebSocket):
|
||||
"""Подключение клиента к WebSocket-серверу"""
|
||||
"""Подключает клиента к WebSocket-серверу.
|
||||
|
||||
Принимает подключение и добавляет WebSocket в список активных соединений.
|
||||
|
||||
Args:
|
||||
websocket (WebSocket): Объект WebSocket для подключения.
|
||||
|
||||
Raises:
|
||||
Exception: Если произошла ошибка при принятии подключения.
|
||||
"""
|
||||
await websocket.accept()
|
||||
self.active_connections.add(websocket)
|
||||
|
||||
def disconnect(self, websocket: WebSocket):
|
||||
"""Отключение клиента от WebSocket-серверу"""
|
||||
"""Отключает клиента от WebSocket-серверу.
|
||||
|
||||
Удаляет WebSocket из списка активных соединений.
|
||||
|
||||
Args:
|
||||
websocket (WebSocket): Объект WebSocket для отключения.
|
||||
"""
|
||||
self.active_connections.remove(websocket)
|
||||
|
||||
async def broadcast(self, message: dict):
|
||||
"""Трансляция сообщений всем подключенным клиентам"""
|
||||
"""Транслирует сообщения всем подключённым клиентам.
|
||||
|
||||
Отправляет JSON-данные всем активным соединениям, обрабатывая
|
||||
отключения клиентов.
|
||||
|
||||
Args:
|
||||
message (dict): Сообщение для трансляции в формате JSON.
|
||||
|
||||
Raises:
|
||||
WebSocketDisconnect: Если клиент неожиданно отключился.
|
||||
Exception: Если произошла другая ошибка при отправке.
|
||||
"""
|
||||
for connection in list(self.active_connections):
|
||||
try:
|
||||
if connection.client_state == WebSocketState.CONNECTED:
|
||||
|
|
@ -49,15 +79,25 @@ manager = WebSocketManager()
|
|||
|
||||
@router.websocket("/api/v1")
|
||||
async def websocket_endpoint(websocket: WebSocket):
|
||||
"""Обработчик WebSocket-соединения"""
|
||||
"""Обработчик WebSocket-соединения.
|
||||
|
||||
Управляет соединением клиента, принимает данные для обновления позиций
|
||||
контейнеров и транслирует сетевые данные.
|
||||
|
||||
Args:
|
||||
websocket (WebSocket): Объект WebSocket для обработки соединения.
|
||||
|
||||
Raises:
|
||||
WebSocketDisconnect: Если клиент отключился.
|
||||
Exception: Если произошла ошибка при обработке данных.
|
||||
"""
|
||||
await manager.connect(websocket)
|
||||
try:
|
||||
while True:
|
||||
data = await websocket.receive_json()
|
||||
logger.info(f"Полученные данные: {data}")
|
||||
|
||||
if all(key in data
|
||||
for key in ["container_id", "container_x", "container_y"]):
|
||||
if all(key in data for key in ["container_id", "container_x", "container_y"]):
|
||||
await update_container_position(data)
|
||||
|
||||
network_data = await get_network_data()
|
||||
|
|
@ -77,12 +117,25 @@ async def websocket_endpoint(websocket: WebSocket):
|
|||
|
||||
@router.on_event("startup")
|
||||
async def startup_event():
|
||||
"""Запуск таска для трансляции сетевых данных"""
|
||||
"""Запуск таска для трансляции сетевых данных при старте приложения.
|
||||
|
||||
Создаёт асинхронную задачу для периодической трансляции данных.
|
||||
|
||||
Raises:
|
||||
Exception: Если произошла ошибка при запуске таска.
|
||||
"""
|
||||
asyncio.create_task(broadcast_data())
|
||||
|
||||
|
||||
async def broadcast_data():
|
||||
"""Таск для трансляции сетевых данных"""
|
||||
"""Таск для периодической трансляции сетевых данных.
|
||||
|
||||
Выполняет сканирование сети и отправляет данные всем подключённым клиентам
|
||||
с интервалом в 2 секунды.
|
||||
|
||||
Raises:
|
||||
Exception: Если произошла ошибка при получении данных или трансляции.
|
||||
"""
|
||||
while True:
|
||||
try:
|
||||
network_data = await get_network_data()
|
||||
|
|
@ -96,4 +149,4 @@ async def broadcast_data():
|
|||
await manager.broadcast(network_data)
|
||||
except Exception as e:
|
||||
logger.error(f"Ошибка в broadcast_data:{e}")
|
||||
await asyncio.sleep(2)
|
||||
await asyncio.sleep(2)
|
||||
Loading…
Add table
Add a link
Reference in a new issue