HybrydMain/gonets
3
2
Fork 0
Code Issues 5 Pull requests Projects 1 Releases 3 Packages Wiki Activity Actions

Рефакторинг. docstring

Browse source
This commit is contained in:
Галанский Сергей Александрович 2025-06-23 12:47:05 +05:00
parent 060f4de175
commit 37f9e3abfb
14 changed files with 1234 additions and 243 deletions
Download patch file Download diff file Expand all files Collapse all files

126
SRV/api/v1/network.py
View file

@ -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="Не удалось получить имя хоста")