Release 1.5.0 (#90)

Author: schizza

CHANGELOG.md

@@ -1,5 +1,25 @@
 ## Changelog
 
+## v1.5.0
+
+## ✨ Nové funkce
+
+**Mark messages as read, improve logging (#88) @schizza**
+- přidán API point k podepsání známek `message_mark_as_read`
+- přidána možnost podepsat známku / známky
+- automaticky je známka podepsána na serveru školy, pokud se zavolá `service_call makr_seen`
+ 
+## 🐛 Opravy chyb
+- opravena chyba duplicit v loggeru
+- `log format` nyní ukazuje i volající funkci
+
+## 🧹 Refaktoring / Údržba
+
+**Refactors Bakalari client handling (#89) @schizza**
+- centralizace `BakalariClient` na úroveň `async_setup_entry`
+- vytvoření jedné sdílené instance `BakalariClient`, aby nedocházelo k duplicitnímu vytváření instance u každého dítěte.
+- `BakalariClient` je sdílený pro všechny koordinatory
+
 ## v1.4.1
 
 ## 🐛 Opravy chyb

README.md

@@ -42,7 +42,7 @@ Custom komponenta pro Home Assistant, založená na [async-bakalari-api3](https:
   - zobrazení poslední přijaté známky nadále funguje bez rozdílu
   - přidána možnost `fire_event` pro vyvolání události při nové známce, bude sloužit k oznámení např. v mobilní aplikaci
   - přidána možnost Websocketu
-  - další funkcionality v následujících verzích
+  - známky lze nyní podepsat zavoláním `service_call` - `mark_as_seen` nebo `sign_all_marks`
 
 Příklad metadat v senzoru `Všechny známky`
 

bump-version.toml

@@ -1,5 +1,5 @@
 [tool.bumpversion]
-current_version = "1.4.1"
+current_version = "1.5.0"
 commit = false
 tag = false
 

custom_components/bakalari/__init__.py

@@ -14,6 +14,7 @@
 from homeassistant.helpers import device_registry as dr
 import voluptuous as vol
 
+from .api import BakalariClient
 from .children import ChildrenIndex
 from .const import DOMAIN, MANUFACTURER, MODEL, PLATFORMS, SW_VERSION
 from .coordinator_marks import BakalariMarksCoordinator
@@ -41,7 +42,7 @@ class CustomFormatter(logging.Formatter):
     cyan = "\u001b[36m"
     white = "\u001b[37m"
 
-    _format = f"%(asctime)s - %(levelname)s [%(name)s]\n{reset}Message: %(message)s)"
+    _format = f"%(asctime)s - %(levelname)s [%(name)s] %(funcName)s{reset}\nMessage: %(message)s)"
     dateformat = "%d/%m/%Y %H:%M:%S"
 
     FORMATS = {
@@ -62,6 +63,10 @@ def format(self, record):
 
 async def async_setup(hass: HomeAssistant, config) -> bool:
     """Set up the Bakalari component."""
+
+    _dev_console_handler_for(
+        logging.getLogger("custom_components.bakalari"), CustomFormatter()
+    )
     hass.data.setdefault(DOMAIN, {})
     return True
 
@@ -73,11 +78,19 @@ def _dev_console_handler_for(
     # pokud už nějaké handlery existují (na loggeru NEBO u předků), nedělej nic
     # if logger.hasHandlers():
     #     return
+    existing = [h for h in logger.handlers if getattr(h, "_bakalari_dev", False)]
+    if existing:
+        if formatter is not None:
+            existing[0].setFormatter(formatter)
+        logger.propagate = False
+        configure_logging(logger.getEffectiveLevel())
+        return
 
     h = logging.StreamHandler()  # default: stderr
     if formatter is None:
         formatter = logging.Formatter("[%(levelname)s] %(name)s: %(message)s")
     h.setFormatter(formatter)
+    h._bakalari_dev = True  # pyright: ignore[reportAttributeAccessIssue]
 
     # level nech na loggeru; handler level nenech NOTSET explicitně – zbytečné
     logger.addHandler(h)
@@ -120,7 +133,7 @@ async def _srv_mark_message_seen(call) -> None:
         await coord.async_mark_message_seen(
             call.data["message_id"], call.data.get("child_key")
         )
-        await coord.async_request_refresh()
+        await coord.async_refresh()
 
     async def _srv_refresh_messages(call) -> None:  # noqa: ARG001
         await hass.data[DOMAIN][entry.entry_id]["messages"].async_refresh()
@@ -207,19 +220,32 @@ async def ws_get_timetable(hass_, connection, msg):  # noqa: ANN001
 
 async def async_setup_entry(hass: HomeAssistant, entry: ConfigEntry) -> bool:
     """Set up of Bakalari component."""
-    _dev_console_handler_for(
-        logging.getLogger("custom_components.bakalari"), CustomFormatter()
-    )
 
-    children = ChildrenIndex.from_entry(entry)
+    children: ChildrenIndex = ChildrenIndex.from_entry(entry)
+
+    # create shared library for each child
+    _clients: dict[str, BakalariClient] = {}
+    for child in children.children:
+        _LOGGER.debug(
+            "[class=%s module=%s] Creating client for child: %s",
+            object.__name__,
+            __name__,
+            child.display_name,
+        )
+
+        _client = BakalariClient(
+            hass, entry, children.option_key_for_child(child.key) or ""
+        )
+        _clients[child.key] = _client
 
-    coord_marks = BakalariMarksCoordinator(hass, entry, children)
-    coord_msgs = BakalariMessagesCoordinator(hass, entry, children)
-    coord_tt = BakalariTimetableCoordinator(hass, entry, children)
+    coord_marks = BakalariMarksCoordinator(hass, entry, children, _clients)
+    coord_msgs = BakalariMessagesCoordinator(hass, entry, children, _clients)
+    coord_tt = BakalariTimetableCoordinator(hass, entry, children, _clients)
 
     hass.data.setdefault(DOMAIN, {})
     hass.data[DOMAIN][entry.entry_id] = {
         "children": children,
+        "clients": _clients,
         "marks": coord_marks,
         "messages": coord_msgs,
         "timetable": coord_tt,

custom_components/bakalari/api.py

@@ -65,11 +65,12 @@ def __init__(self, hass: HomeAssistant, entry: ConfigEntry, child_id: str):
         self._save_lock = asyncio.Lock()
         self._last_tokens: tuple[str, str] | None = None
 
-        _LOGGER.info(
+        _LOGGER.debug(
             "[class=%s module=%s] Created BakalariClient instance for child_id=%s",
             self.__class__.__name__,
             __name__,
             self.child_id,
+            stacklevel=2,
         )
 
     def api_call(
@@ -214,12 +215,14 @@ async def _is_lib(self) -> Bakalari | None:
                     self.lib = Bakalari(
                         server=server, credentials=cred, session=session
                     )
-                    _LOGGER.info(
+                    _LOGGER.debug(
                         "[class=%s module=%s] Bakalari library instance created for child_id=%s With parameters: %s",
                         self.__class__.__name__,
                         __name__,
                         self.child_id,
                         redact_child_info(child),
+                        stacklevel=2,
+                        stack_info=True,
                     )
 
         self._last_tokens = self._snapshot_tokens()
@@ -519,3 +522,17 @@ async def async_sign_marks(self, lib, subjects: list[str]):
 
         marks = Marks(lib)
         await marks.async_sign_marks(subjects)
+
+    @api_call(label="Mark message as read", default=None)
+    async def message_mark_as_read(self, lib, mid: str):
+        """Mark message as read.
+
+        Call API clients mark message as read function.
+        """
+        _LOGGER.debug(
+            "[class=%s module=%s] Called mark message as read endpoint.",
+            self.__class__.__name__,
+            __name__,
+        )
+        komens: Komens = Komens(lib)
+        await komens.message_mark_read(mid)

custom_components/bakalari/const.py

@@ -8,7 +8,7 @@
 MANUFACTURER = "Bakaláři pro HomeAssistant"
 MODEL = "Bakaláři backend"
 
-LIB_VERSION: Final = "1.4.1"
+LIB_VERSION: Final = "1.5.0"
 API_VERSION: Final = "0.9.0"
 SW_VERSION: Final = f"API: {API_VERSION} Library: {LIB_VERSION}"
 CONF_CHILDREN: Final = "children"

custom_components/bakalari/coordinator_marks.py

@@ -31,15 +31,18 @@ class BakalariMarksCoordinator(DataUpdateCoordinator[dict[str, Any]]):
     """Coordinator for Bakaláři marks – minimal data model for sensors."""
 
     def __init__(
-        self, hass: HomeAssistant, entry: ConfigEntry, children_index: ChildrenIndex
+        self,
+        hass: HomeAssistant,
+        entry: ConfigEntry,
+        children_index: ChildrenIndex,
+        clients: dict[str, BakalariClient],
     ) -> None:
         """Initialize the coordinator."""
         self.hass = hass
         self.entry = entry
-        self.children_index = children_index
-        self.child_list = list(children_index.children)
-
-        # api_version removed; integration uses central SW_VERSION for device info
+        self.children_index: ChildrenIndex = children_index
+        self.child_list = list(self.children_index.children)
+        self._clients: dict[str, BakalariClient] = clients
 
         # Diff cache per child: set of (child_key, mark_id)
         self._seen: set[tuple[str, str]] = set()
@@ -56,9 +59,6 @@ def __init__(
             update_interval=update_interval,
         )
 
-        # Per-child clients cache (BakalariClient instances)
-        self._clients: dict[str, BakalariClient] = {}
-
         _LOGGER.debug(
             "[class=%s module=%s] Marks coordinator ready (entry_id=%s, children=%d)",
             self.__class__.__name__,
@@ -67,6 +67,21 @@ def __init__(
             len(self.child_list),
         )
 
+    def get_client(self, child_key: str) -> BakalariClient | None:
+        """Return a client for a given child."""
+
+        client = self._clients[child_key] or None
+        if not client:
+            _LOGGER.error(
+                "[class=%s module=%s] Failed to get client for child %s",
+                self.__class__.__name__,
+                __name__,
+                child_key,
+                stacklevel=2,
+            )
+            return None
+        return client
+
     # ---------- Public API for services / WebSocket ----------
 
     async def async_mark_seen(self, mark_id: str, child_key: str | None) -> None:
@@ -141,13 +156,9 @@ async def _fetch_child(
     ) -> dict[str, Any]:
         """Fetch raw marks for a specific child via BakalariClient."""
 
-        # Map composite key to original options key (usually user_id)
-        opt_key = self.children_index.option_key_for_child(child.key) or child.user_id
-
-        client = self._clients.get(child.key)
+        client: BakalariClient | None = self.get_client(child.key)
         if client is None:
-            client = BakalariClient(self.hass, self.entry, opt_key)
-            self._clients[child.key] = client  # cache per child
+            return {}
 
         # Marks snapshot (subjects, grouped, flat)
         dt_from = (
@@ -180,7 +191,10 @@ async def _fetch_child(
 
     async def async_sign_marks(self, child_key, subjects: list[str]):
         """Sign all marks for a child."""
-        client = self._clients[child_key]
+        client: BakalariClient | None = self.get_client(child_key)
+
+        if not client:
+            return
 
         try:
             await client.async_sign_marks(subjects)