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

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 00:00:00                  #
 # ================================================== #
 
 import copy
+from typing import Optional
 
 from packaging.version import Version
 
@@ -258,7 +259,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,7 +296,7 @@ class Models:
             return self.items[model].ctx
         return 4096
 
-    def restore_default(self, model: str = None):
+    def restore_default(self, model: Optional[str] = None):
         """Restore default models"""
         # restore all models
         if model is None:

pygpt_net/core/notepad.py

@@ -6,11 +6,12 @@
 # GitHub:  https://github.com/szczyglis-dev/py-gpt   #
 # MIT License                                        #
 # Created By  : Marcin Szczygliński                  #
-# Updated Date: 2024.04.09 23:00:00                  #
+# Updated Date: 2024.12.14 00:00:00                  #
 # ================================================== #
 
 import datetime
 import uuid
+from typing import Optional
 
 from packaging.version import Version
 
@@ -49,7 +50,7 @@ class Notepad:
         """Reset provider data"""
         self.items = {}
 
-    def get_by_id(self, idx: int) -> NotepadItem or None:
+    def get_by_id(self, idx: int) -> Optional[NotepadItem]:
         """
         Get notepad by idx
 
@@ -136,8 +137,12 @@ class Notepad:
         """Save all notepads"""
         self.provider.save_all(self.items)
 
-    def import_from_db(self) -> dict or None:
-        """Import notepad tabs from database"""
+    def import_from_db(self) -> Optional[dict]:
+        """
+        Import notepad tabs from database
+
+        :return: dict with tabs
+        """
         self.load_all()
         items = self.get_all()
         if len(items) == 0:

pygpt_net/core/plugins.py

@@ -6,13 +6,14 @@
 # GitHub:  https://github.com/szczyglis-dev/py-gpt   #
 # MIT License                                        #
 # Created By  : Marcin Szczygliński                  #
-# Updated Date: 2024.11.18 21:00:00                  #
+# Updated Date: 2024.12.14 08:00:00                  #
 # ================================================== #
 
 import copy
 import configparser
 import io
 import os
+from typing import Optional, Dict, List, Any
 
 from pygpt_net.provider.core.plugin_preset.json_file import JsonFileProvider
 from pygpt_net.plugin.base.plugin import BasePlugin
@@ -64,7 +65,7 @@ class Plugins:
         """
         return list(self.plugins.keys())
 
-    def get(self, id: str) -> BasePlugin or None:
+    def get(self, id: str) -> Optional[BasePlugin]:
         """
         Get plugin by id
 
@@ -142,7 +143,7 @@ class Plugins:
         if removed:
             self.window.core.config.save()
 
-    def register_options(self, id: str, options: dict):
+    def register_options(self, id: str, options: Dict[str, dict]):
         """
         Register plugin options
 
@@ -276,7 +277,7 @@ class Plugins:
             tooltip = trans('plugin.description', domain=domain)
         return tooltip
 
-    def dump_locale(self, plugin, path: str):
+    def dump_locale(self, plugin: BasePlugin, path: str):
         """
         Dump locale
 
@@ -356,7 +357,7 @@ class Plugins:
         """
         return self.presets
 
-    def reset_options(self, plugin_id: str, keys: list):
+    def reset_options(self, plugin_id: str, keys: List[str]):
         """
         Reset plugin options
 
@@ -430,7 +431,7 @@ 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
 

pygpt_net/core/presets.py

@@ -6,11 +6,12 @@
 # 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 08:00:00                  #
 # ================================================== #
 
 import copy
 import uuid
+from typing import Optional, Tuple, Dict
 
 from packaging.version import Version
 from pygpt_net.core.types import (
@@ -47,7 +48,11 @@ class Presets:
         self.provider.install()
 
     def patch(self, app_version: Version):
-        """Patch provider data"""
+        """
+        Patch provider data
+
+        :param app_version: app version
+        """
         self.provider.patch(app_version)
 
     def build(self) -> PresetItem:
@@ -197,7 +202,7 @@ class Presets:
         if id in self.items:
             self.items[id].enabled = False
 
-    def get_first_mode(self, id: str) -> str or None:
+    def get_first_mode(self, id: str) -> Optional[str]:
         """
         Return first mode for preset
 
@@ -253,7 +258,7 @@ class Presets:
         presets = self.get_by_mode(mode)
         return list(presets.keys())[idx]
 
-    def get_by_id(self, mode: str, id: str) -> PresetItem or None:
+    def get_by_id(self, mode: str, id: str) -> Optional[PresetItem]:
         """
         Return preset by id
 
@@ -266,7 +271,7 @@ class Presets:
             return presets[id]
         return None
 
-    def get_by_uuid(self, uuid: str) -> PresetItem or None:
+    def get_by_uuid(self, uuid: str) -> Optional[PresetItem]:
         """
         Return preset by UUID
 
@@ -278,7 +283,7 @@ class Presets:
                 return self.items[id]
         return None
 
-    def get_by_mode(self, mode: str) -> dict:
+    def get_by_mode(self, mode: str) -> Dict[str, PresetItem]:
         """
         Return presets for mode
 
@@ -317,7 +322,7 @@ class Presets:
             i += 1
         return 0
 
-    def get_default(self, mode: str) -> str or None:
+    def get_default(self, mode: str) -> Optional[str]:
         """
         Return default preset for mode
 
@@ -329,7 +334,7 @@ class Presets:
             return None
         return list(presets.keys())[0]
 
-    def get_duplicate_name(self, id: str) -> (str, str):
+    def get_duplicate_name(self, id: str) -> Tuple[str, str]:
         """
         Prepare name for duplicated preset
 
@@ -423,8 +428,12 @@ class Presets:
             self.items[id] = base[id]
             self.save(id)
 
-    def load_base(self):
-        """Load base presets"""
+    def load_base(self) -> dict:
+        """
+        Load base presets
+
+        :return: base presets
+        """
         return self.provider.load_base()
 
     def load(self):

pygpt_net/core/profile.py

@@ -6,12 +6,13 @@
 # GitHub:  https://github.com/szczyglis-dev/py-gpt   #
 # MIT License                                        #
 # Created By  : Marcin Szczygliński                  #
-# Updated Date: 2024.04.09 23:00:00                  #
+# Updated Date: 2024.12.14 08:00:00                  #
 # ================================================== #
 
 import json
 import os
 from pathlib import Path
+from typing import Optional, Dict
 from uuid import uuid4
 
 
@@ -44,7 +45,7 @@ class Profile:
             self.load()
             self.update_path()
 
-    def set_base_workdir(self, workdir):
+    def set_base_workdir(self, workdir: str):
         """
         Set base workdir
 
@@ -162,7 +163,12 @@ class Profile:
             return True
         return False
 
-    def update_profile(self, uuid: str, name: str, workdir: str) -> bool:
+    def update_profile(
+            self,
+            uuid: str,
+            name: str,
+            workdir: str
+    ) -> bool:
         """
         Update profile
 
@@ -188,7 +194,7 @@ class Profile:
         """
         return self.current
 
-    def get(self, uuid: str) -> dict or None:
+    def get(self, uuid: str) -> Optional[dict]:
         """
         Get profile by uuid
 
@@ -199,7 +205,7 @@ class Profile:
             return self.profiles[uuid]
         return None
 
-    def get_all(self) -> dict:
+    def get_all(self) -> Dict[str, Dict]:
         """
         Get all profiles
 
@@ -222,7 +228,7 @@ 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
 

pygpt_net/core/prompt/__init__.py

@@ -6,7 +6,7 @@
 # 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                  #
 # ================================================== #
 
 from pygpt_net.core.events import Event
@@ -41,6 +41,12 @@ class Prompt:
         return ""
 
     def build_final_system_prompt(self, prompt: str) -> str:
+        """
+        Build final system prompt
+
+        :param prompt: prompt
+        :return: final system prompt
+        """
         # tmp dispatch event: system prompt
         event = Event(Event.SYSTEM_PROMPT, {
             'mode': self.window.core.config.get('mode'),
@@ -50,7 +56,8 @@ class Prompt:
         self.window.dispatch(event)
         prompt = event.data['value']
 
-        if self.window.core.config.get('cmd') or self.window.controller.plugins.is_type_enabled("cmd.inline"):
+        if (self.window.core.config.get('cmd')
+                or self.window.controller.plugins.is_type_enabled("cmd.inline")):
 
             # abort if native func call enabled
             if self.window.core.command.is_native_enabled():
@@ -88,7 +95,7 @@ class Prompt:
             internal: bool,
             is_expert: bool = False,
             disable_native_tool_calls: bool = False,
-    ):
+    ) -> str:
         """
         Prepare system prompt
 

pygpt_net/core/prompt/custom.py

@@ -6,10 +6,11 @@
 # GitHub:  https://github.com/szczyglis-dev/py-gpt   #
 # MIT License                                        #
 # Created By  : Marcin Szczygliński                  #
-# Updated Date: 2024.08.29 05:00:00                  #
+# Updated Date: 2024.12.14 00:00:00                  #
 # ================================================== #
 
 import copy
+from typing import Optional
 
 from PySide6.QtGui import QAction, QIcon
 from packaging.version import Version
@@ -70,7 +71,7 @@ class Custom:
         """
         return list(self.items.keys())
 
-    def get_id_by_idx(self, idx: int) -> str or None:
+    def get_id_by_idx(self, idx: int) -> Optional[str]:
         """
         Get ID by index
 
@@ -83,7 +84,7 @@ class Custom:
                 return id
             i += 1
 
-    def get_by_id(self, id: str) -> PromptItem or None:
+    def get_by_id(self, id: str) -> Optional[PromptItem]:
         """
         Return prompt by ID
 
@@ -93,7 +94,7 @@ class Custom:
         if id in self.items:
             return self.items[id]
 
-    def get_by_idx(self, idx: int) -> PromptItem or None:
+    def get_by_idx(self, idx: int) -> Optional[PromptItem]:
         """
         Return item by index
 
@@ -114,8 +115,8 @@ class Custom:
 
     def new(
             self,
-            name: str = None,
-            content: str = None,
+            name: Optional[str] = None,
+            content: Optional[str] = None,
             auto_save: bool = True
     ) -> PromptItem:
         """

pygpt_net/core/prompt/template.py

@@ -6,11 +6,12 @@
 # GitHub:  https://github.com/szczyglis-dev/py-gpt   #
 # MIT License                                        #
 # Created By  : Marcin Szczygliński                  #
-# Updated Date: 2024.08.25 04:00:00                  #
+# Updated Date: 2024.12.14 00:00:00                  #
 # ================================================== #
 
 import os
 import csv
+from typing import Optional
 
 from PySide6.QtGui import QAction
 from pygpt_net.utils import trans
@@ -62,7 +63,12 @@ class Template:
         self.prompts = dict(sorted(self.prompts.items(), key=lambda item: item[1]['name']))
 
     def to_menu_options(self, menu, parent: str = "global"):
-        """Convert prompts to menu options"""
+        """
+        Convert prompts to menu options
+
+        :param menu: Menu
+        :param parent: Parent menu
+        """
         self.init()
         menu.addSeparator()
         submenu = menu.addMenu(trans("preset.prompt.paste_template"))
@@ -82,7 +88,7 @@ class Template:
             action.setToolTip(value['prompt'])
             letter_submenus[letter].addAction(action)
 
-    def get_by_id(self, id: int) -> dict or None:
+    def get_by_id(self, id: int) -> Optional[dict]:
         """
         Get prompt by id