pygpt-net 2.4.41__py3-none-any.whl → 2.4.42__py3-none-any.whl

pygpt_net/provider/core/ctx/db_sqlite/__init__.py

@@ -6,10 +6,11 @@
 # GitHub:  https://github.com/szczyglis-dev/py-gpt   #
 # MIT License                                        #
 # Created By  : Marcin Szczygliński                  #
-# Updated Date: 2024.12.09 00:00:00                  #
+# Updated Date: 2024.12.14 22:00:00                  #
 # ================================================== #
 
 import time
+from typing import List, Dict, Optional
 from uuid import uuid4
 from packaging.version import Version
 
@@ -29,6 +30,11 @@ class DbSqliteProvider(BaseProvider):
         self.type = "ctx"
 
     def attach(self, window):
+        """
+        Attach window
+
+        :param window: Window instance
+        """
         self.window = window
         self.storage.attach(window)
 
@@ -68,14 +74,14 @@ class DbSqliteProvider(BaseProvider):
 
     def get_meta(
             self,
-            search_string: str = None,
-            order_by: str = None,
-            order_direction: str = None,
-            limit: int = None,
-            offset: int = None,
-            filters: dict = None,
+            search_string: Optional[str] = None,
+            order_by: Optional[str] = None,
+            order_direction: Optional[str] = None,
+            limit: Optional[int] = None,
+            offset: Optional[int] = None,
+            filters: Optional[dict] = None,
             search_content: bool = False,
-    ) -> dict:
+    ) -> Dict[int, CtxMeta]:
         """
         Return dict of ctx meta, TODO: add order, limit, offset, etc.
 
@@ -102,7 +108,7 @@ class DbSqliteProvider(BaseProvider):
             search_content=search_content,
         )
 
-    def get_meta_indexed(self) -> dict:
+    def get_meta_indexed(self) -> Dict[int, CtxMeta]:
         """
         Return dict of ctx meta indexed by ID
 
@@ -118,7 +124,7 @@ class DbSqliteProvider(BaseProvider):
         """
         return self.storage.get_last_meta_id()
 
-    def get_item_by_id(self, id: int) -> CtxItem:
+    def get_item_by_id(self, id: int) -> Optional[CtxItem]:
         """
         Get ctx item by ID
 
@@ -127,7 +133,7 @@ class DbSqliteProvider(BaseProvider):
         """
         return self.storage.get_item_by_id(id)
 
-    def load(self, id: int) -> list:
+    def load(self, id: int) -> List[CtxItem]:
         """
         Load items for ctx ID
 
@@ -137,13 +143,14 @@ class DbSqliteProvider(BaseProvider):
         return self.storage.get_items(id)
 
     def get_ctx_count_by_day(
-            self, year: int,
-            month: int = None,
-            day: int = None,
-            search_string: str = None,
-            filters: dict = None,
+            self,
+            year: int,
+            month: Optional[int] = None,
+            day: Optional[int] = None,
+            search_string: Optional[str] = None,
+            filters: Optional[dict] = None,
             search_content: bool = False,
-    ) -> dict:
+    ) -> Dict[str, int]:
         """
         Get ctx count by day or by month if only year is provided
 
@@ -165,13 +172,14 @@ class DbSqliteProvider(BaseProvider):
         )
 
     def get_ctx_labels_count_by_day(
-            self, year: int,
-            month: int = None,
-            day: int = None,
-            search_string: str = None,
-            filters: dict = None,
+            self,
+            year: int,
+            month: Optional[int] = None,
+            day: Optional[int] = None,
+            search_string: Optional[str] = None,
+            filters: Optional[dict] = None,
             search_content: bool = False,
-    ) -> dict:
+    ) -> Dict[str, Dict[int, int]]:
         """
         Get ctx labels count by day or by month if only year is provided
 
@@ -213,7 +221,7 @@ class DbSqliteProvider(BaseProvider):
         self.storage.update_meta_ts(item.meta_id)
         return self.storage.update_item(item) is not None
 
-    def save(self, id: int, meta: CtxMeta, items: list) -> bool:
+    def save(self, id: int, meta: CtxMeta, items: List[CtxItem]) -> bool:
         """
         Save ctx
 
@@ -225,7 +233,7 @@ class DbSqliteProvider(BaseProvider):
         if self.storage.update_meta(meta):
             return True  # update only meta, items are appended separately
 
-    def save_all(self, id: int, meta: CtxMeta, items: list) -> bool:
+    def save_all(self, id: int, meta: CtxMeta, items: List[CtxItem]) -> bool:
         """
         Save ctx
 
@@ -255,7 +263,7 @@ class DbSqliteProvider(BaseProvider):
         """
         return self.storage.delete_item_by_id(id)
 
-    def remove_items_from(self, meta_id: int, item_id: int):
+    def remove_items_from(self, meta_id: int, item_id: int) -> bool:
         """
         Remove ctx items from meta_id
 
@@ -328,7 +336,7 @@ class DbSqliteProvider(BaseProvider):
         """
         return self.storage.clear_meta_indexed_all()
 
-    def get_groups(self) -> dict:
+    def get_groups(self) -> Dict[int, CtxGroup]:
         """
         Return dict of groups
 
@@ -336,7 +344,7 @@ class DbSqliteProvider(BaseProvider):
         """
         return self.storage.get_groups()
 
-    def get_meta_by_id(self, id: int) -> CtxMeta or None:
+    def get_meta_by_id(self, id: int) -> Optional[CtxMeta]:
         """
         Get meta by ID
 
@@ -353,15 +361,16 @@ class DbSqliteProvider(BaseProvider):
         """
         return self.storage.get_meta_by_root_id_and_preset_id(root_id, preset_id)
 
-    def insert_group(self, group: CtxGroup):
+    def insert_group(self, group: CtxGroup) -> int:
         """
         Insert group
 
         :param group: CtxGroup
+        :return: group ID
         """
         return self.storage.insert_group(group)
 
-    def update_group(self, group: CtxGroup):
+    def update_group(self, group: CtxGroup) -> bool:
         """
         Update group
 
@@ -369,32 +378,39 @@ class DbSqliteProvider(BaseProvider):
         """
         return self.storage.update_group(group)
 
-    def remove_group(self, id: int, all: bool = False):
+    def remove_group(self, id: int, all: bool = False) -> bool:
         """
         Remove group by ID
 
         :param id: group ID
         :param all: remove items
+        :return: True if removed
         """
         return self.storage.delete_group(id, all=all)
 
-    def truncate_groups(self):
-        """Remove groups"""
+    def truncate_groups(self) -> bool:
+        """
+        Remove groups
+
+        :return: True if removed
+        """
         return self.storage.truncate_groups()
 
-    def update_meta_group_id(self, id: int, group_id: int):
+    def update_meta_group_id(self, id: int, group_id: int) -> bool:
         """
         Update meta group ID
 
         :param id: ctx ID
         :param group_id: group ID
+        :return: True if updated
         """
         return self.storage.update_meta_group_id(id, group_id)
 
-    def clear_meta(self, id: int):
+    def clear_meta(self, id: int) -> bool:
         """
         Clear meta by ID
 
         :param id: ctx ID
+        :return: True if cleared
         """
         return self.storage.clear_meta(id)

pygpt_net/provider/core/ctx/db_sqlite/storage.py

@@ -6,12 +6,13 @@
 # GitHub:  https://github.com/szczyglis-dev/py-gpt   #
 # MIT License                                        #
 # Created By  : Marcin Szczygliński                  #
-# Updated Date: 2024.12.09 00:00:00                  #
+# Updated Date: 2024.12.14 22:00:00                  #
 # ================================================== #
 
 from datetime import datetime
 import re
 import time
+from typing import Dict, Optional, Tuple, List
 
 from sqlalchemy import text
 
@@ -46,11 +47,11 @@ class Storage:
 
     def prepare_query(
             self,
-            search_string: str = None,
-            filters: dict = None,
+            search_string: Optional[str] = None,
+            filters: Optional[dict] = None,
             search_content: bool = False,
             append_date_ranges: bool = True,
-    ):
+    ) -> Tuple[str, str, dict]:
         """
         Prepare query for search_string and filters
 
@@ -122,14 +123,14 @@ class Storage:
 
     def get_meta(
             self,
-            search_string: str = None,
-            order_by: str = None,
-            order_direction: str = None,
-            limit: int = None,
-            offset: int = None,
-            filters: dict = None,
+            search_string: Optional[str] = None,
+            order_by: Optional[str] = None,
+            order_direction: Optional[str] = None,
+            limit: Optional[int] = None,
+            offset: Optional[int] = None,
+            filters: Optional[dict] = None,
             search_content: bool = False,
-    ) -> dict:
+    ) -> Dict[int, CtxMeta]:
         """
         Return dict with CtxMeta objects, indexed by ID
 
@@ -169,7 +170,7 @@ class Storage:
 
         return items
 
-    def get_meta_indexed(self) -> dict:
+    def get_meta_indexed(self) -> Dict[int, CtxMeta]:
         """
         Return dict with indexed CtxMeta objects, indexed by ID
 
@@ -189,7 +190,7 @@ class Storage:
                 items[meta.id] = meta
         return items
 
-    def get_item_by_id(self, id: int) -> CtxItem:
+    def get_item_by_id(self, id: int) -> Optional[CtxItem]:
         """
         Return ctx item by ID
 
@@ -210,7 +211,11 @@ class Storage:
                 return item
         return None
 
-    def get_meta_by_root_id_and_preset_id(self, root_id: int, preset_id: str) -> dict:
+    def get_meta_by_root_id_and_preset_id(
+            self,
+            root_id: int,
+            preset_id: str
+    ) -> Dict[int, CtxMeta]:
         """
         Return dict with indexed CtxMeta objects, indexed by ID
 
@@ -233,7 +238,7 @@ class Storage:
                 items[meta.id] = meta
         return items
 
-    def get_meta_by_id(self, id: int) -> CtxMeta or None:
+    def get_meta_by_id(self, id: int) -> Optional[CtxMeta]:
         """
         Return ctx meta by ID
 
@@ -269,7 +274,7 @@ class Storage:
                 return int(row.id)
         return 0
 
-    def get_items(self, id: int) -> list:
+    def get_items(self, id: int) -> List[CtxItem]:
         """
         Return ctx items list by ctx meta ID
 
@@ -428,7 +433,11 @@ class Storage:
             conn.execute(stmt)
             return True
 
-    def update_meta_all(self, meta: CtxMeta, items: list) -> bool:
+    def update_meta_all(
+            self,
+            meta: CtxMeta,
+            items: List[CtxItem]
+    ) -> bool:
         """
         Update all, meta and items
 
@@ -891,12 +900,12 @@ class Storage:
     def get_ctx_count_by_day(
             self,
             year: int,
-            month: int = None,
-            day: int = None,
-            search_string: str = None,
-            filters: dict = None,
+            month: Optional[int] = None,
+            day: Optional[int] = None,
+            search_string: Optional[str] = None,
+            filters: Optional[dict] = None,
             search_content: bool = False,
-    ) -> dict:
+    ) -> Dict[str, int]:
         """
         Return ctx counters by day for given year and month
 
@@ -987,12 +996,12 @@ class Storage:
     def get_ctx_labels_count_by_day(
             self,
             year: int,
-            month: int = None,
-            day: int = None,
-            search_string: str = None,
-            filters: dict = None,
+            month: Optional[int] = None,
+            day: Optional[int] = None,
+            search_string: Optional[str] = None,
+            filters: Optional[dict] = None,
             search_content: bool = False,
-    ) -> dict:
+    ) -> Dict[str, Dict[int, int]]:
         """
         Return ctx counters by day for given year and month
 
@@ -1116,7 +1125,7 @@ class Storage:
 
                 return result_dict
 
-    def get_groups(self) -> dict:
+    def get_groups(self) -> Dict[int, CtxGroup]:
         """
         Return dict with CtxGroup objects, indexed by ID
 
@@ -1189,16 +1198,17 @@ class Storage:
             conn.execute(text("DELETE FROM sqlite_sequence WHERE name='ctx_group'"))
         return True
 
-    def clear_meta(self, meta_id: int):
+    def clear_meta(self, meta_id: int) -> bool:
         """
         Delete all items with meta ID
 
         :param meta_id: meta ID
-        :return:
+        :return: True if cleared
         """
         db = self.window.core.db.get_db()
         with db.begin() as conn:
             conn.execute(text(f"DELETE FROM ctx_item WHERE meta_id = {meta_id}"))
+        return True
 
     def update_group(self, group: CtxGroup) -> bool:
         """
@@ -1258,12 +1268,13 @@ class Storage:
             group.id = result.lastrowid
             return group.id
 
-    def update_meta_group_id(self, meta_id: int, group_id: int = None):
+    def update_meta_group_id(self, meta_id: int, group_id: int = None) -> bool:
         """
         Update meta group ID
 
         :param meta_id: ctx meta ID
         :param group_id: ctx group ID
+        :return: True if updated
         """
         db = self.window.core.db.get_db()
         stmt = text("""

pygpt_net/provider/core/ctx/db_sqlite/utils.py

@@ -6,18 +6,20 @@
 # GitHub:  https://github.com/szczyglis-dev/py-gpt   #
 # MIT License                                        #
 # Created By  : Marcin Szczygliński                  #
-# Updated Date: 2024.11.26 19:00:00                  #
+# Updated Date: 2024.12.14 22:00:00                  #
 # ================================================== #
 
 import json
 import re
+
 from datetime import datetime, timedelta
+from typing import List, Tuple, Any, Dict
 
 from pygpt_net.item.ctx import CtxMeta, CtxItem, CtxGroup
 from pygpt_net.utils import unpack_var
 
 
-def search_by_date_string(search_string: str) -> list:
+def search_by_date_string(search_string: str) -> List[Tuple[Any, Any]]:
     """
     Prepare date ranges from search string if @date() syntax is used
 
@@ -64,7 +66,7 @@ def search_by_date_string(search_string: str) -> list:
     return date_ranges
 
 
-def get_month_start_end_timestamps(year: int, month: int) -> (int, int):
+def get_month_start_end_timestamps(year: int, month: int) -> Tuple[int, int]:
     """
     Get start and end timestamps for given month
 
@@ -82,7 +84,7 @@ def get_month_start_end_timestamps(year: int, month: int) -> (int, int):
     return start_timestamp, end_timestamp
 
 
-def get_year_start_end_timestamps(year: int) -> (int, int):
+def get_year_start_end_timestamps(year: int) -> Tuple[int, int]:
     """
     Get start and end timestamps for given year
 
@@ -96,7 +98,7 @@ def get_year_start_end_timestamps(year: int) -> (int, int):
     return start_timestamp, end_timestamp
 
 
-def pack_item_value(value: any) -> str:
+def pack_item_value(value: Any) -> str:
     """
     Pack item value to JSON
 
@@ -108,7 +110,7 @@ def pack_item_value(value: any) -> str:
     return value
 
 
-def unpack_item_value(value: any) -> any:
+def unpack_item_value(value: Any) -> Any:
     """
     Unpack item value from JSON
 
@@ -123,7 +125,7 @@ def unpack_item_value(value: any) -> any:
         return value
 
 
-def unpack_item(item: CtxItem, row: dict) -> CtxItem:
+def unpack_item(item: CtxItem, row: Dict[str, Any]) -> CtxItem:
     """
     Unpack context item from DB row
 
@@ -183,7 +185,7 @@ def unpack_item(item: CtxItem, row: dict) -> CtxItem:
     return item
 
 
-def unpack_meta(meta: CtxMeta, row: dict) -> CtxMeta:
+def unpack_meta(meta: CtxMeta, row: Dict[str, Any]) -> CtxMeta:
     """
     Unpack context meta data from DB row
 
@@ -222,7 +224,7 @@ def unpack_meta(meta: CtxMeta, row: dict) -> CtxMeta:
     return meta
 
 
-def unpack_group(group: CtxGroup, row: dict) -> CtxGroup:
+def unpack_group(group: CtxGroup, row: Dict[str, Any]) -> CtxGroup:
     """
     Unpack context group data from DB row