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

pygpt_net/core/idx/types/ctx.py

@@ -6,9 +6,12 @@
 # GitHub:  https://github.com/szczyglis-dev/py-gpt   #
 # MIT License                                        #
 # Created By  : Marcin Szczygliński                  #
-# Updated Date: 2024.02.27 04:00:00                  #
+# Updated Date: 2024.12.14 00:00:00                  #
 # ================================================== #
 
+from typing import Optional
+
+
 class Ctx:
     def __init__(self, window=None, provider=None):
         """
@@ -43,7 +46,12 @@ class Ctx:
             doc_id=doc_id,
         )
 
-    def exists(self, store_id: str, idx: str, meta_id: int) -> bool:
+    def exists(
+            self,
+            store_id: str,
+            idx: str,
+            meta_id: int
+    ) -> bool:
         """
         Check if ctx meta is indexed
 
@@ -58,7 +66,12 @@ class Ctx:
             meta_id=meta_id,
         )
 
-    def get_doc_id(self, store_id: str, idx: str, meta_id: int) -> str:
+    def get_doc_id(
+            self,
+            store_id: str,
+            idx: str,
+            meta_id: int
+    ) -> str:
         """
         Get indexed document id by meta id
 
@@ -73,7 +86,11 @@ class Ctx:
             meta_id=meta_id,
         )
 
-    def update(self, meta_id: int, doc_id: str) -> bool:
+    def update(
+            self,
+            meta_id: int,
+            doc_id: str
+    ) -> bool:
         """
         Update timestamp of indexed ctx meta
 
@@ -86,7 +103,12 @@ class Ctx:
             doc_id=doc_id,
         )
 
-    def remove(self, store_id: str, idx: str, meta_id: str):
+    def remove(
+            self,
+            store_id: str,
+            idx: str,
+            meta_id: str
+    ):
         """
         Remove document from index db
 
@@ -100,7 +122,11 @@ class Ctx:
             meta_id=meta_id,
         )
 
-    def truncate(self, store_id: str = None, idx: str = None):
+    def truncate(
+            self,
+            store_id: Optional[str] = None,
+            idx: Optional[str] = None
+    ):
         """
         Truncate ctx meta from index db
 

pygpt_net/core/idx/types/external.py

@@ -6,11 +6,12 @@
 # GitHub:  https://github.com/szczyglis-dev/py-gpt   #
 # MIT License                                        #
 # Created By  : Marcin Szczygliński                  #
-# Updated Date: 2024.02.27 04:00:00                  #
+# Updated Date: 2024.12.14 00:00:00                  #
 # ================================================== #
 
 import datetime
 import time
+from typing import Optional
 
 
 class External:
@@ -54,7 +55,13 @@ class External:
             data=data,
         )
 
-    def get_doc_id(self, store_id: str, idx: str, content: str, type: str) -> str:
+    def get_doc_id(
+            self,
+            store_id: str,
+            idx: str,
+            content: str,
+            type: str
+    ) -> str:
         """
         Get indexed document id by content
 
@@ -71,7 +78,13 @@ class External:
             type=type,
         )
 
-    def exists(self, store_id: str, idx: str, content: str, type: str) -> bool:
+    def exists(
+            self,
+            store_id: str,
+            idx: str,
+            content: str,
+            type: str
+    ) -> bool:
         """
         Check if content is indexed
 
@@ -88,7 +101,13 @@ class External:
             type=type,
         )
 
-    def update(self, content: str, type: str, doc_id: str, ts: int) -> bool:
+    def update(
+            self,
+            content: str,
+            type: str,
+            doc_id: str,
+            ts: int
+    ) -> bool:
         """
         Update timestamp of indexed external content
 
@@ -105,7 +124,12 @@ class External:
             ts=ts,
         )
 
-    def remove(self, store_id: str, idx: str, doc_id: str):
+    def remove(
+            self,
+            store_id: str,
+            idx: str,
+            doc_id: str
+    ):
         """
         Remove document from index
 
@@ -119,7 +143,11 @@ class External:
             doc_id=doc_id,
         )
 
-    def truncate(self, store_id: str = None, idx: str = None):
+    def truncate(
+            self,
+            store_id: Optional[str] = None,
+            idx: Optional[str] = None
+    ):
         """
         Truncate external data from index
 
@@ -131,7 +159,13 @@ class External:
             idx=idx,
         )
 
-    def set_indexed(self, content: str, type: str, idx: str, doc_id: str) -> bool:
+    def set_indexed(
+            self,
+            content: str,
+            type: str,
+            idx: str,
+            doc_id: str
+    ) -> bool:
         """
         Set external content as indexed
 

pygpt_net/core/idx/types/files.py

@@ -6,11 +6,12 @@
 # GitHub:  https://github.com/szczyglis-dev/py-gpt   #
 # MIT License                                        #
 # Created By  : Marcin Szczygliński                  #
-# Updated Date: 2024.02.27 04:00:00                  #
+# Updated Date: 2024.12.14 00:00:00                  #
 # ================================================== #
 
 import datetime
 import os.path
+from typing import Optional
 
 
 class Files:
@@ -67,7 +68,12 @@ class Files:
         path = path.replace("\\", "/").strip(r'\/')
         return path
 
-    def get_doc_id(self, store_id: str, idx: str, file_id: str) -> str:
+    def get_doc_id(
+            self,
+            store_id: str,
+            idx: str,
+            file_id: str
+    ) -> str:
         """
         Get indexed document id by file
 
@@ -82,7 +88,12 @@ class Files:
             file_id=file_id,
         )
 
-    def exists(self, store_id: str, idx: str, file_id: str) -> bool:
+    def exists(
+            self,
+            store_id: str,
+            idx: str,
+            file_id: str
+    ) -> bool:
         """
         Check if file is indexed
 
@@ -97,7 +108,12 @@ class Files:
             file_id=file_id,
         )
 
-    def update(self, id: int, doc_id: str, ts: int) -> bool:
+    def update(
+            self,
+            id: int,
+            doc_id: str,
+            ts: int
+    ) -> bool:
         """
         Update timestamp of indexed file
 
@@ -112,7 +128,12 @@ class Files:
             ts=ts,
         )
 
-    def remove(self, store_id: str, idx: str, doc_id: str):
+    def remove(
+            self,
+            store_id: str,
+            idx: str,
+            doc_id: str
+    ):
         """
         Remove document from index
 
@@ -126,7 +147,11 @@ class Files:
             doc_id=doc_id,
         )
 
-    def truncate(self, store_id: str = None, idx: str = None):
+    def truncate(
+            self,
+            store_id: Optional[str] = None,
+            idx: Optional[str] = None
+    ):
         """
         Truncate files from index
 

pygpt_net/core/image.py

@@ -6,10 +6,11 @@
 # GitHub:  https://github.com/szczyglis-dev/py-gpt   #
 # MIT License                                        #
 # Created By  : Marcin Szczygliński                  #
-# Updated Date: 2024.11.20 21:00:00                  #
+# Updated Date: 2024.12.14 08:00:00                  #
 # ================================================== #
 
 import os
+from typing import List
 
 from PySide6.QtCore import Slot, QObject
 
@@ -34,7 +35,12 @@ class Image(QObject):
             os.makedirs(img_dir, exist_ok=True)
 
     @Slot(object, list, str)
-    def handle_finished(self, ctx: CtxItem, paths: list, prompt: str):
+    def handle_finished(
+            self,
+            ctx: CtxItem,
+            paths: List[str],
+            prompt: str
+    ):
         """
         Handle finished image generation
 
@@ -45,7 +51,12 @@ class Image(QObject):
         self.window.controller.chat.image.handle_response(ctx, paths, prompt)
 
     @Slot(object, list, str)
-    def handle_finished_inline(self, ctx: CtxItem, paths: list, prompt: str):
+    def handle_finished_inline(
+            self,
+            ctx: CtxItem,
+            paths: List[str],
+            prompt: str
+    ):
         """
         Handle finished image generation
 
@@ -86,7 +97,7 @@ class Image(QObject):
         self.window.update_status(msg)
         self.window.core.debug.log(msg)
 
-    def save_image(self, path: str, image: any) -> bool:
+    def save_image(self, path: str, image: bytes) -> bool:
         """
         Save image to file
 

pygpt_net/core/installer.py

@@ -6,7 +6,7 @@
 # GitHub:  https://github.com/szczyglis-dev/py-gpt   #
 # MIT License                                        #
 # Created By  : Marcin Szczygliński                  #
-# Updated Date: 2023.12.31 04:00:00                  #
+# Updated Date: 2024.12.14 22:00:00                  #
 # ================================================== #
 
 from pathlib import Path
@@ -23,9 +23,7 @@ class Installer:
         self.window = window
 
     def install(self):
-        """
-        Install db, config data and directories
-        """
+        """Install db, config data and directories"""
         try:
             # create user config directory
             path = Path(self.window.core.config.path)

pygpt_net/core/llm/__init__.py

@@ -6,9 +6,12 @@
 # GitHub:  https://github.com/szczyglis-dev/py-gpt   #
 # MIT License                                        #
 # Created By  : Marcin Szczygliński                  #
-# Updated Date: 2024.01.14 04:00:00                  #
+# Updated Date: 2024.12.14 08:00:00                  #
 # ================================================== #
 
+from typing import Optional, List
+
+
 class LLM:
     def __init__(self, window=None):
         """
@@ -19,7 +22,10 @@ class LLM:
         self.window = window
         self.llms = {}
 
-    def get_ids(self, type: str = None) -> list:
+    def get_ids(
+            self,
+            type: Optional[str] = None
+    ) -> List[str]:
         """
         Get providers ids
 
@@ -30,7 +36,11 @@ class LLM:
             return [id for id in self.llms.keys() if type in self.llms[id].type]
         return list(self.llms.keys())
 
-    def register(self, id: str, llm):
+    def register(
+            self,
+            id: str,
+            llm
+    ):
         """
         Register LLM provider
 

pygpt_net/core/locale.py

@@ -6,18 +6,23 @@
 # GitHub:  https://github.com/szczyglis-dev/py-gpt   #
 # MIT License                                        #
 # Created By  : Marcin Szczygliński                  #
-# Updated Date: 2024.01.15 10:00:00                  #
+# Updated Date: 2024.12.14 00:00:00                  #
 # ================================================== #
 
 import os
 import configparser
 import io
+from typing import Optional
 
 from pygpt_net.config import Config
 
 
 class Locale:
-    def __init__(self, domain: str = None, config=None):
+    def __init__(
+            self,
+            domain: Optional[str] = None,
+            config: Optional[Config] = None
+    ):
         """
         Locale loader
 
@@ -47,7 +52,7 @@ class Locale:
             self.lang = self.config.get_lang()
         self.load(self.lang)
 
-    def reload(self, domain: str = None):
+    def reload(self, domain: Optional[str] = None):
         """
         Reload translations for domain
 
@@ -70,7 +75,11 @@ class Locale:
         ini.read_string(data.read())
         return dict(ini.items(self.ini_key))
 
-    def load_by_lang(self, lang: str, domain: str = None):
+    def load_by_lang(
+            self,
+            lang: str,
+            domain: Optional[str] = None
+    ):
         """
         Load translation data by language code
 
@@ -96,7 +105,11 @@ class Locale:
         except Exception as e:
             print(e)
 
-    def load(self, lang: str, domain: str = None):
+    def load(
+            self,
+            lang: str,
+            domain: Optional[str] = None
+    ):
         """
         Load translation data
 
@@ -109,7 +122,12 @@ class Locale:
             self.load_by_lang(self.fallback, domain)  # load fallback first
         self.load_by_lang(lang, domain)
 
-    def get(self, key: str, domain: str = None, params: dict = None) -> str:
+    def get(
+            self,
+            key: str,
+            domain: Optional[str] = None,
+            params: Optional[dict] = None
+    ) -> str:
         """
         Return translation for key and domain
 
@@ -133,7 +151,11 @@ class Locale:
         else:
             return key
 
-    def get_base_path(self, domain: str, lang: str) -> str:
+    def get_base_path(
+            self,
+            domain: str,
+            lang: str
+    ) -> str:
         """
         Get base path for locale file
 
@@ -143,7 +165,11 @@ class Locale:
         """
         return os.path.join(self.config.get_app_path(), 'data', 'locale', domain + '.' + lang + '.ini')
 
-    def get_user_path(self, domain: str, lang: str) -> str:
+    def get_user_path(
+            self,
+            domain: str,
+            lang: str
+    ) -> str:
         """
         Get user path for locale file (overwrites base path)
 

pygpt_net/core/models.py

@@ -6,10 +6,11 @@
 # GitHub:  https://github.com/szczyglis-dev/py-gpt   #
 # MIT License                                        #
 # Created By  : Marcin Szczygliński                  #
-# Updated Date: 2024.11.21 20:00:00                  #
+# Updated Date: 2024.12.14 22:00:00                  #
 # ================================================== #
 
 import copy
+from typing import Optional, List, Dict
 
 from packaging.version import Version
 
@@ -91,7 +92,7 @@ class Models:
         if key in self.items:
             return self.items[key]
 
-    def get_ids(self) -> list:
+    def get_ids(self) -> List[str]:
         """
         Return models ids
 
@@ -117,7 +118,11 @@ class Models:
         """
         return model in self.items
 
-    def is_allowed(self, model: str, mode: str) -> bool:
+    def is_allowed(
+            self,
+            model: str,
+            mode: str
+    ) -> bool:
         """
         Check if model is allowed for mode
 
@@ -129,7 +134,10 @@ class Models:
             return mode in self.items[model].mode
         return False
 
-    def get_id(self, key: str) -> str:
+    def get_id(
+            self,
+            key: str
+    ) -> str:
         """
         Return model internal ID
 
@@ -139,7 +147,11 @@ class Models:
         if key in self.items:
             return self.items[key].id
 
-    def get_by_idx(self, idx: int, mode: str) -> str:
+    def get_by_idx(
+            self,
+            idx: int,
+            mode: str
+    ) -> str:
         """
         Return model by index
 
@@ -150,7 +162,10 @@ class Models:
         items = self.get_by_mode(mode)
         return list(items.keys())[idx]
 
-    def get_by_mode(self, mode: str) -> dict:
+    def get_by_mode(
+            self,
+            mode: str
+    ) -> Dict[str, ModelItem]:
         """
         Return models for mode
 
@@ -163,7 +178,11 @@ class Models:
                 items[key] = self.items[key]
         return items
 
-    def get_next(self, model: str, mode: str) -> str:
+    def get_next(
+            self,
+            model: str,
+            mode: str
+    ) -> str:
         """
         Return next model
 
@@ -178,7 +197,11 @@ class Models:
             return keys[idx + 1]
         return keys[0]
 
-    def get_prev(self, model: str, mode: str) -> str:
+    def get_prev(
+            self,
+            model: str,
+            mode: str
+    ) -> str:
         """
         Return previous model
 
@@ -217,7 +240,7 @@ class Models:
         self.items[id] = model
         return model
 
-    def get_all(self) -> dict:
+    def get_all(self) -> Dict[str, ModelItem]:
         """
         Return all models
 
@@ -247,7 +270,11 @@ class Models:
         if model in self.items:
             del self.items[model]
 
-    def has_model(self, mode: str, model: str) -> bool:
+    def has_model(
+            self,
+            mode: str,
+            model: str
+    ) -> bool:
         """
         Check if model exists for mode
 
@@ -258,7 +285,7 @@ class Models:
         items = self.get_by_mode(mode)
         return model in items
 
-    def get_default(self, mode: str) -> str | None:
+    def get_default(self, mode: str) -> Optional[str]:
         """
         Return default model for mode
 
@@ -295,8 +322,15 @@ class Models:
             return self.items[model].ctx
         return 4096
 
-    def restore_default(self, model: str = None):
-        """Restore default models"""
+    def restore_default(
+            self,
+            model: Optional[str] = None
+    ):
+        """
+        Restore default models
+
+        :param model: model name
+        """
         # restore all models
         if model is None:
             self.load_base()
@@ -307,8 +341,12 @@ class Models:
         if model in items:
             self.items[model] = items[model]
 
-    def get_base(self) -> dict:
-        """Get base models"""
+    def get_base(self) -> Dict[str, ModelItem]:
+        """
+        Get base models
+
+        :return: base models
+        """
         return self.provider.load_base()
 
     def load_base(self):
@@ -329,7 +367,11 @@ class Models:
         """Save models"""
         self.provider.save(self.items)
 
-    def get_supported_mode(self, model: ModelItem, mode: str) -> str:
+    def get_supported_mode(
+            self,
+            model: ModelItem,
+            mode: str
+    ) -> str:
         """
         Get supported mode
 
@@ -352,5 +394,9 @@ class Models:
         return mode
 
     def get_version(self) -> str:
-        """Get config version"""
+        """
+        Get config version
+
+        :return: config version
+        """
         return self.provider.get_version()