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

pygpt_net/core/idx/chat.py

@@ -6,7 +6,7 @@
 # GitHub:  https://github.com/szczyglis-dev/py-gpt   #
 # MIT License                                        #
 # Created By  : Marcin Szczygliński                  #
-# Updated Date: 2024.12.14 08:00:00                  #
+# Updated Date: 2024.12.14 22:00:00                  #
 # ================================================== #
 
 import json
@@ -360,7 +360,7 @@ class Chat:
             ctx: CtxItem,
             type: str,
             url: str,
-            args: dict,
+            args: Dict[str, Any],
             query: str,
             model: Optional[ModelItem] = None
     ) -> str:
@@ -552,7 +552,11 @@ class Chat:
         ]
         return ChatPromptTemplate(qa_msgs)
 
-    def get_index(self, idx: str, model: ModelItem):
+    def get_index(
+            self,
+            idx: str,
+            model: ModelItem
+    ):
         """
         Get index instance
 
@@ -573,7 +577,10 @@ class Chat:
         index = self.storage.get(idx, service_context=service_context)  # get index
         return index, service_context
 
-    def get_metadata(self, source_nodes: Optional[list]) -> Dict[str, Any]:
+    def get_metadata(
+            self,
+            source_nodes: Optional[list]
+    ) -> Dict[str, Any]:
         """
         Get metadata from source nodes
 
@@ -601,7 +608,10 @@ class Chat:
                             break
         return metadata
 
-    def parse_metadata(self, metadata: Optional[Dict]) -> Dict[str, Any]:
+    def parse_metadata(
+            self,
+            metadata: Optional[Dict]
+    ) -> Dict[str, Any]:
         """
         Parse metadata
 

pygpt_net/core/idx/indexing.py

@@ -6,7 +6,7 @@
 # GitHub:  https://github.com/szczyglis-dev/py-gpt   #
 # MIT License                                        #
 # Created By  : Marcin Szczygliński                  #
-# Updated Date: 2024.12.14 08:00:00                  #
+# Updated Date: 2024.12.14 22:00:00                  #
 # ================================================== #
 
 import datetime
@@ -600,7 +600,10 @@ class Indexing:
 
         return indexed, errors
 
-    def get_db_data_from_ts(self, updated_ts: int = 0) -> list:
+    def get_db_data_from_ts(
+            self,
+            updated_ts: int = 0
+    ) -> List[Document]:
         """
         Get data from database from timestamp
 
@@ -640,7 +643,10 @@ class Indexing:
                 documents.append(doc)
         return documents
 
-    def get_db_meta_ids_from_ts(self, updated_ts: int = 0) -> list:
+    def get_db_meta_ids_from_ts(
+            self,
+            updated_ts: int = 0
+    ) -> List[int]:
         """
         Get IDs of meta from database from timestamp
 
@@ -664,7 +670,11 @@ class Indexing:
                 ids.append(data["id"])
         return ids
 
-    def get_db_data_by_id(self, id: int = 0, updated_ts: int = 0) -> list:
+    def get_db_data_by_id(
+            self,
+            id: int = 0,
+            updated_ts: int = 0
+    ) -> List[Document]:
         """
         Get data from database by meta id
 
@@ -726,7 +736,8 @@ class Indexing:
                 self.window.core.idx.log("Indexing documents from database by meta id: {}".format(id))
                 self.remove_old_meta_id(idx, id)
             elif from_ts > 0:
-                self.window.core.idx.log("Indexing documents from database by meta id: {} from timestamp: {}".format(id, from_ts))
+                self.window.core.idx.log("Indexing documents from database by meta id: {} from timestamp: {}".
+                                         format(id, from_ts))
 
             # get items from database
             documents = self.get_db_data_by_id(id, from_ts)
@@ -736,7 +747,8 @@ class Indexing:
 
                 self.index_document(index, d)
                 doc_id = d.id_
-                self.window.core.idx.log("Inserted ctx DB document: {} / {}, id: {}, metadata: {}".format(n+1, len(documents), d.id_, d.metadata))
+                self.window.core.idx.log("Inserted ctx DB document: {} / {}, id: {}, metadata: {}".
+                                         format(n+1, len(documents), d.id_, d.metadata))
                 self.window.core.ctx.idx.set_meta_as_indexed(id, idx, doc_id)  # update ctx
                 n += 1
         except Exception as e:
@@ -850,7 +862,8 @@ class Indexing:
                         idx=idx,
                         doc_id=doc_id,
                     )  # update external index
-                self.window.core.idx.log("Inserted web document: {} / {}, id: {}, metadata: {}".format(n+1, len(documents), d.id_, d.metadata))
+                self.window.core.idx.log("Inserted web document: {} / {}, id: {}, metadata: {}".
+                                         format(n+1, len(documents), d.id_, d.metadata))
                 n += 1
         except Exception as e:
             errors.append(str(e))
@@ -1044,7 +1057,10 @@ class Indexing:
             model = self.window.core.models.from_defaults()
 
         service_context = self.window.core.idx.llm.get_service_context(model=model)
-        index = self.window.core.idx.storage.get_ctx_idx(index_path, service_context=service_context)  # get or create ctx index
+        index = self.window.core.idx.storage.get_ctx_idx(
+            index_path,
+            service_context=service_context
+        )  # get or create ctx index
 
         idx = "tmp:{}".format(index_path)  # tmp index id
         self.window.core.idx.log("Indexing to context attachment index: {}...".format(idx))

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/models.py

@@ -6,11 +6,11 @@
 # GitHub:  https://github.com/szczyglis-dev/py-gpt   #
 # MIT License                                        #
 # Created By  : Marcin Szczygliński                  #
-# Updated Date: 2024.12.14 00:00:00                  #
+# Updated Date: 2024.12.14 22:00:00                  #
 # ================================================== #
 
 import copy
-from typing import Optional
+from typing import Optional, List, Dict
 
 from packaging.version import Version
 
@@ -92,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
 
@@ -118,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
 
@@ -130,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
 
@@ -140,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
 
@@ -151,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
 
@@ -164,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
 
@@ -179,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
 
@@ -218,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
 
@@ -248,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
 
@@ -296,8 +322,15 @@ class Models:
             return self.items[model].ctx
         return 4096
 
-    def restore_default(self, model: Optional[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()
@@ -308,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):
@@ -330,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
 
@@ -353,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()

pygpt_net/core/modes.py

@@ -6,9 +6,11 @@
 # 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                  #
 # ================================================== #
 
+from typing import Dict, List
+
 from pygpt_net.provider.core.mode.json_file import JsonFileProvider
 from pygpt_net.core.types import (
     MODE_AGENT,
@@ -51,7 +53,7 @@ class Modes:
         ]
         self.items = {}
 
-    def get_by_idx(self, idx):
+    def get_by_idx(self, idx) -> str:
         """
         Return mode by index
 
@@ -61,7 +63,7 @@ class Modes:
         modes = self.get_all()
         return list(modes.keys())[idx]
 
-    def get_idx_by_name(self, name):
+    def get_idx_by_name(self, name) -> int:
         """
         Return mode index by name
 
@@ -71,7 +73,7 @@ class Modes:
         modes = self.get_all()
         return list(modes.keys()).index(name)
 
-    def get_all(self):
+    def get_all(self) -> Dict[str, List[str]]:
         """
         Return modes
 
@@ -79,7 +81,7 @@ class Modes:
         """
         return self.items
 
-    def get_default(self):
+    def get_default(self) -> str:
         """
         Return default mode name
 
@@ -89,7 +91,7 @@ class Modes:
             if self.items[id].default:
                 return id
 
-    def get_next(self, mode: str):
+    def get_next(self, mode: str) -> str:
         """
         Return next mode
 
@@ -103,7 +105,7 @@ class Modes:
             return keys[idx + 1]
         return keys[0]
 
-    def get_prev(self, mode: str):
+    def get_prev(self, mode: str) -> str:
         """
         Return previous mode
 
@@ -118,13 +120,9 @@ class Modes:
         return keys[-1]
 
     def load(self):
-        """
-        Load modes
-        """
+        """Load modes"""
         self.items = self.provider.load()
 
     def save(self):
-        """
-        Save modes
-        """
+        """Save modes"""
         self.provider.save(self.items)

pygpt_net/core/notepad.py

@@ -6,12 +6,12 @@
 # GitHub:  https://github.com/szczyglis-dev/py-gpt   #
 # MIT License                                        #
 # Created By  : Marcin Szczygliński                  #
-# Updated Date: 2024.12.14 00:00:00                  #
+# Updated Date: 2024.12.14 22:00:00                  #
 # ================================================== #
 
 import datetime
 import uuid
-from typing import Optional
+from typing import Optional, Dict
 
 from packaging.version import Version
 
@@ -61,7 +61,7 @@ class Notepad:
             return self.items[idx]
         return None
 
-    def get_all(self) -> dict:
+    def get_all(self) -> Dict[int, NotepadItem]:
         """
         Get all notepads
 
@@ -137,7 +137,7 @@ class Notepad:
         """Save all notepads"""
         self.provider.save_all(self.items)
 
-    def import_from_db(self) -> Optional[dict]:
+    def import_from_db(self) -> Optional[Dict[int, dict]]:
         """
         Import notepad tabs from database
 

pygpt_net/core/plugins.py

@@ -6,7 +6,7 @@
 # GitHub:  https://github.com/szczyglis-dev/py-gpt   #
 # MIT License                                        #
 # Created By  : Marcin Szczygliński                  #
-# Updated Date: 2024.12.14 08:00:00                  #
+# Updated Date: 2024.12.14 22:00:00                  #
 # ================================================== #
 
 import copy
@@ -49,7 +49,7 @@ class Plugins:
         """
         return id in self.plugins
 
-    def all(self) -> dict:
+    def all(self) -> Dict[str, BasePlugin]:
         """
         Get all plugins
 
@@ -57,7 +57,7 @@ class Plugins:
         """
         return self.plugins
 
-    def get_ids(self) -> list:
+    def get_ids(self) -> List[str]:
         """
         Get all plugins ids
 
@@ -76,7 +76,7 @@ class Plugins:
             return self.plugins[id]
         return None
 
-    def get_option(self, id: str, key: str) -> any:
+    def get_option(self, id: str, key: str) -> Any:
         """
         Get plugin option
 
@@ -172,7 +172,7 @@ class Plugins:
 
     def enable(self, id: str):
         """
-        Enable plugin
+        Enable plugin by ID
 
         :param id: plugin id
         """
@@ -183,7 +183,7 @@ class Plugins:
 
     def disable(self, id: str):
         """
-        Disable plugin
+        Disable plugin by ID
 
         :param id: plugin id
         """
@@ -318,7 +318,7 @@ class Plugins:
         """
         return id in self.presets
 
-    def get_preset(self, id: str) -> dict:
+    def get_preset(self, id: str) -> Dict[str, Any]:
         """
         Get preset by id
 
@@ -328,7 +328,7 @@ class Plugins:
         if self.has_preset(id):
             return self.presets[id]
 
-    def set_preset(self, id: str, preset: dict):
+    def set_preset(self, id: str, preset: Dict[str, Any]):
         """
         Set config value
 
@@ -337,7 +337,7 @@ class Plugins:
         """
         self.presets[id] = preset
 
-    def replace_presets(self, presets: dict):
+    def replace_presets(self, presets: Dict[str, Any]):
         """
         Replace presets
 
@@ -349,7 +349,7 @@ class Plugins:
         """Load presets"""
         self.presets = self.provider.load()
 
-    def get_presets(self) -> dict:
+    def get_presets(self) -> Dict[str, Any]:
         """
         Return all presets
 
@@ -357,7 +357,11 @@ class Plugins:
         """
         return self.presets
 
-    def reset_options(self, plugin_id: str, keys: List[str]):
+    def reset_options(
+            self,
+            plugin_id: str,
+            keys: List[str]
+    ):
         """
         Reset plugin options
 
@@ -408,7 +412,11 @@ class Plugins:
             self.save_presets()
             print("[FIX] Removed invalid keys from plugin presets.")
 
-    def remove_preset_values(self, plugin_id:str, key: str):
+    def remove_preset_values(
+            self,
+            plugin_id: str,
+            key: str
+    ):
         """
         Update preset value
 
@@ -431,7 +439,12 @@ class Plugins:
         if updated:
             self.save_presets()
 
-    def update_preset_values(self, plugin_id: str, key: str, value: Any):
+    def update_preset_values(
+            self,
+            plugin_id: str,
+            key: str,
+            value: Any
+    ):
         """
         Update preset value
 
@@ -471,9 +484,7 @@ class Plugins:
             self.dump_locale(self.plugins[id], path)
 
     def dump_locales(self):
-        """
-        Dump all locales
-        """
+        """Dump all locales"""
         langs = ['en', 'pl']
         for id in self.plugins:
             domain = 'plugin.' + id

pygpt_net/core/presets.py

@@ -6,7 +6,7 @@
 # GitHub:  https://github.com/szczyglis-dev/py-gpt   #
 # MIT License                                        #
 # Created By  : Marcin Szczygliński                  #
-# Updated Date: 2024.12.14 08:00:00                  #
+# Updated Date: 2024.12.14 22:00:00                  #
 # ================================================== #
 
 import copy
@@ -193,6 +193,7 @@ class Presets:
         """
         if id in self.items:
             self.items[id].enabled = True
+
     def disable(self, id: str):
         """
         Disable preset
@@ -366,7 +367,11 @@ class Presets:
         self.sort_by_name()
         return id
 
-    def remove(self, id: str, remove_file: bool = True):
+    def remove(
+            self,
+            id: str,
+            remove_file: bool = True
+    ):
         """
         Delete preset
 
@@ -381,9 +386,7 @@ class Presets:
             # self.load_presets()
 
     def sort_by_name(self):
-        """
-        Sort presets by name
-        """
+        """Sort presets by name"""
         self.items = dict(
             sorted(
                 self.items.items(),
@@ -408,7 +411,7 @@ class Presets:
         self.items[preset.filename] = preset
         self.save(preset.filename)
 
-    def get_all(self) -> dict:
+    def get_all(self) -> Dict[str, PresetItem]:
         """
         Return all presets
 
@@ -428,7 +431,7 @@ class Presets:
             self.items[id] = base[id]
             self.save(id)
 
-    def load_base(self) -> dict:
+    def load_base(self) -> Dict[str, PresetItem]:
         """
         Load base presets
 
@@ -460,7 +463,11 @@ class Presets:
         """Save all presets"""
         self.provider.save_all(self.items)
 
-    def add_expert(self, agent_uuid: str, expert_uuid: str):
+    def add_expert(
+            self,
+            agent_uuid: str,
+            expert_uuid: str
+    ):
         """
         Add expert to agent
 
@@ -474,7 +481,11 @@ class Presets:
             agent.experts.append(expert_uuid)
         self.save(agent.filename)
 
-    def remove_expert(self, agent_uuid: str, expert_uuid: str):
+    def remove_expert(
+            self,
+            agent_uuid: str,
+            expert_uuid: str
+    ):
         """
         Remove expert from agent
         :param agent_uuid: agent uuid

pygpt_net/core/profile.py

@@ -6,7 +6,7 @@
 # GitHub:  https://github.com/szczyglis-dev/py-gpt   #
 # MIT License                                        #
 # Created By  : Marcin Szczygliński                  #
-# Updated Date: 2024.12.14 08:00:00                  #
+# Updated Date: 2024.12.14 22:00:00                  #
 # ================================================== #
 
 import json
@@ -120,7 +120,11 @@ class Profile:
         with open(f, 'w', encoding='utf-8') as f:
             f.write(json_data)
 
-    def add(self, name: str, workdir: str) -> str:
+    def add(
+            self,
+            name: str,
+            workdir: str
+    ) -> str:
         """
         Add new profile
 
@@ -228,7 +232,11 @@ class Profile:
                 return tmp_dir
         return self.base_workdir
 
-    def append(self, uuid: str, profile: Dict):
+    def append(
+            self,
+            uuid: str,
+            profile: Dict
+    ):
         """
         Append profile