add comment in all function and class< and use .env file

modules/HomeAssistant.py

@@ -1,17 +1,27 @@
 import requests
 import yaml
 from fuzzywuzzy import process
+from requests import Response
 
 from data import config
 
 
 class HomeAssistant:
+    """
+    Модуль home assistant для работы с его api
+    """
     def __init__(self):
         self.url = "http://192.168.0.112:9999/api"
         self.token = config.HOME_ASSISTANT_TOKEN
         self.HA_CMD_LIST = yaml.safe_load(open('data/home_assistant_entities.yaml', encoding='utf8'))
 
-    def get_info(self, state):
+    def get_info(self, state: str) -> Response:
+        """
+        Функция для получения информации о заданном entity
+
+        :param state: str - объект в home assistant информацию о котором надо узнать
+        :return: Response - ответ от сервера api
+        """
         response = requests.get(
             url=f"{self.url}/states",
             headers={
@@ -23,7 +33,13 @@ class HomeAssistant:
                 return entity
         return response
 
-    def send_process(self, command="выключи телевизор"):
+    def send_process(self, command: str = "выключи телевизор") -> bool:
+        """
+        Функция для отправки запроса о выполнении команды к api
+
+        :param command: str - команда в виде строки
+        :return: bool - удачная ли отправка запроса к api
+        """
         response = requests.post(
             url=f"{self.url}/services/conversation/process",
             json={"text": command},
@@ -37,6 +53,13 @@ class HomeAssistant:
         return False
 
     def voice_to_name(self, voice: str) -> str:
+        """
+        Функция для неточного сравнивания входной строки голоса
+        и списка устройств дял которых можно узнать информацию
+
+        :param voice: str - распознанная фраза без проверки по списку
+        :return: str - найденный объект для получения информации
+        """
         words = voice.lower().split()
         best_match = None
         highest_score = 0
@@ -47,13 +70,20 @@ class HomeAssistant:
                 best_match = result
         return best_match
 
-    def validate_info(self, name: str):
+    def validate_info(self, name: str) -> str:
+        """
+        Функция для получения готовой строки информации entity по его имени.
+        Эта строка готова для произношения
+
+        :param name: str - имя entity для нахождения информации о нём
+        :return: str - готовая строка для найденного по имени объекта для её произношения
+        """
         answer = name
         entity_config = self.HA_CMD_LIST.get(name)
         if entity_config:
             # Создание словаря, разделяя каждый элемент конфигурации на ключ и значение
             entity_details = {item.split(':')[0]: item.split(':')[1] for item in entity_config}
-            entity_id = entity_details.pop("entity_id", None)
+            entity_id = entity_details.pop("entity_id", "robot")
             if entity_id:
                 responses = self.get_info(entity_id)
                 for attribute_path, label in entity_details.items():