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

pygpt_net/provider/core/preset/base.py

@@ -6,9 +6,11 @@
 # GitHub:  https://github.com/szczyglis-dev/py-gpt   #
 # MIT License                                        #
 # Created By  : Marcin Szczygliński                  #
-# Updated Date: 2024.02.01 00:00:00                  #
+# Updated Date: 2024.12.14 22:00:00                  #
 # ================================================== #
 
+from typing import Optional, Dict
+
 from packaging.version import Version
 
 from pygpt_net.item.preset import PresetItem
@@ -32,16 +34,16 @@ class BaseProvider:
     def create(self, item: PresetItem):
         pass
 
-    def load(self) -> dict:
+    def load(self) -> Optional[Dict[str, PresetItem]]:
         pass
 
-    def load_base(self) -> dict:
+    def load_base(self) -> Optional[Dict[str, PresetItem]]:
         pass
 
     def save(self, id: str, item: PresetItem):
         pass
 
-    def save_all(self, items: dict):
+    def save_all(self, items: Dict[str, PresetItem]):
         pass
 
     def remove(self, id: str):

pygpt_net/provider/core/preset/json_file.py

@@ -6,12 +6,14 @@
 # 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 os
 import shutil
+from typing import Dict, Optional, Any
+
 from packaging.version import Version
 
 from pygpt_net.core.types import (
@@ -42,9 +44,7 @@ class JsonFileProvider(BaseProvider):
         self.type = "preset"
 
     def install(self):
-        """
-        Install provider data
-        """
+        """Install provider data"""
         # install presets
         presets_dir = self.window.core.config.get_user_dir('presets')
         src = os.path.join(self.window.core.config.get_app_path(), 'data', 'config', 'presets')
@@ -58,7 +58,7 @@ class JsonFileProvider(BaseProvider):
                 if not os.path.exists(dst_file):
                     shutil.copyfile(src_file, dst_file)
 
-    def load(self) -> dict | None:
+    def load(self) -> Optional[Dict[str, PresetItem]]:
         """
         Load presets from JSON files
 
@@ -82,7 +82,7 @@ class JsonFileProvider(BaseProvider):
 
         return items
 
-    def load_base(self) -> dict | None:
+    def load_base(self) -> Optional[Dict[str, PresetItem]]:
         """
         Load base presets from JSON files
 
@@ -126,7 +126,7 @@ class JsonFileProvider(BaseProvider):
         except Exception as e:
             self.window.core.debug.log(e)
 
-    def save_all(self, items: dict):
+    def save_all(self, items: Dict[str, PresetItem]):
         """
         Save all presets to JSON files
 
@@ -171,7 +171,7 @@ class JsonFileProvider(BaseProvider):
         return self.patcher.execute(version)
 
     @staticmethod
-    def serialize(item: PresetItem) -> dict:
+    def serialize(item: PresetItem) -> Dict[str, Any]:
         """
         Serialize item to dict
 
@@ -207,7 +207,7 @@ class JsonFileProvider(BaseProvider):
         }
 
     @staticmethod
-    def deserialize(data: dict, item: PresetItem):
+    def deserialize(data: Dict[str, Any], item: PresetItem):
         """
         Deserialize item from dict
 

pygpt_net/provider/core/prompt/base.py

@@ -6,12 +6,15 @@
 # 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 typing import Dict
+
 from packaging.version import Version
 
 from pygpt_net.item.attachment import AttachmentItem
+from pygpt_net.item.prompt import PromptItem
 
 
 class BaseProvider:
@@ -32,10 +35,10 @@ class BaseProvider:
     def create(self, attachment: AttachmentItem) -> str:
         pass
 
-    def load(self) -> dict:
+    def load(self) -> Dict[str, PromptItem]:
         pass
 
-    def save(self, items: dict):
+    def save(self, items: Dict[str, PromptItem]):
         pass
 
     def remove(self, id: str):

pygpt_net/provider/core/prompt/json_file.py

@@ -6,12 +6,13 @@
 # GitHub:  https://github.com/szczyglis-dev/py-gpt   #
 # MIT License                                        #
 # Created By  : Marcin Szczygliński                  #
-# Updated Date: 2024.08.29 04:00:00                  #
+# Updated Date: 2024.12.14 22:00:00                  #
 # ================================================== #
 
 import json
 import os
 import uuid
+from typing import Dict
 
 from packaging.version import Version
 
@@ -46,7 +47,7 @@ class JsonFileProvider(BaseProvider):
             prompt.id = self.create_id()
         return prompt.id
 
-    def load(self) -> dict:
+    def load(self) -> Dict[str, PromptItem]:
         """
         Load prompts from file
 
@@ -73,7 +74,7 @@ class JsonFileProvider(BaseProvider):
 
         return items
 
-    def save(self, items: dict):
+    def save(self, items: Dict[str, PromptItem]):
         """
         Save prompts to file
         """
@@ -108,7 +109,11 @@ class JsonFileProvider(BaseProvider):
         pass
 
     def truncate(self, mode: str):
-        """Delete all"""
+        """
+        Delete all
+
+        :param mode: mode
+        """
         path = os.path.join(self.window.core.config.path, self.config_file)
         data = {'__meta__': self.window.core.config.append_meta(), 'items': {}}
         try:
@@ -128,7 +133,7 @@ class JsonFileProvider(BaseProvider):
         return False
 
     @staticmethod
-    def serialize(prompt: PromptItem) -> dict:
+    def serialize(prompt: PromptItem) -> Dict[str, str]:
         """
         Serialize item to dict
 
@@ -141,7 +146,7 @@ class JsonFileProvider(BaseProvider):
         }
 
     @staticmethod
-    def deserialize(data: dict, prompt: PromptItem):
+    def deserialize(data: Dict[str, str], prompt: PromptItem):
         """
         Deserialize item from dict
 

pygpt_net/provider/gpt/assistants.py

@@ -6,10 +6,11 @@
 # GitHub:  https://github.com/szczyglis-dev/py-gpt   #
 # MIT License                                        #
 # Created By  : Marcin Szczygliński                  #
-# Updated Date: 2024.04.30 16:00:00                  #
+# Updated Date: 2024.12.14 22:00:00                  #
 # ================================================== #
 
 import json
+from typing import Optional, List, Dict
 
 from pygpt_net.item.assistant import AssistantItem
 from pygpt_net.item.ctx import CtxItem
@@ -37,7 +38,11 @@ class Assistants:
         """
         return self.window.core.gpt.get_client()
 
-    def log(self, msg: str, callback: callable = None):
+    def log(
+            self,
+            msg: str,
+            callback: Optional[callable] = None
+    ):
         """
         Log message
 
@@ -140,7 +145,12 @@ class Assistants:
         thread_messages = client.beta.threads.messages.list(thread_id)
         return thread_messages.data
 
-    def msg_send(self, id: str, text: str, file_ids: list = None):
+    def msg_send(
+            self,
+            id: str,
+            text: str,
+            file_ids: Optional[list] = None
+    ):
         """
         Send message to thread
 
@@ -175,7 +185,7 @@ class Assistants:
         if message is not None:
             return message
 
-    def get_tools(self, assistant: AssistantItem) -> list:
+    def get_tools(self, assistant: AssistantItem) -> List[dict]:
         """
         Get assistant tools
 
@@ -207,7 +217,7 @@ class Assistants:
                 )
         return tools
 
-    def get_tool_resources(self, assistant: AssistantItem) -> dict:
+    def get_tool_resources(self, assistant: AssistantItem) -> Dict[str, dict]:
         """
         Get assistant tool resources
 
@@ -226,8 +236,8 @@ class Assistants:
             self,
             thread_id: str,
             assistant_id: str,
-            model: str = None,
-            instructions: str = None
+            model: Optional[str] = None,
+            instructions: Optional[str] = None
     ):
         """
         Create assistant run
@@ -259,8 +269,8 @@ class Assistants:
             ctx: CtxItem,
             thread_id: str,
             assistant_id: str,
-            model: str = None,
-            instructions: str = None
+            model: Optional[str] = None,
+            instructions: Optional[str] = None
     ):
         """
         Create assistant run (stream)
@@ -377,8 +387,8 @@ class Assistants:
             items: dict,
             order: str = "asc",
             limit: int = 100,
-            after: str = None,
-            callback: callable = None
+            after: Optional[str] = None,
+            callback: Optional[callable] = None
     ) -> dict:
         """
         Import assistants from API (all, paginated)

pygpt_net/provider/gpt/audio.py

@@ -6,10 +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 18:00:00                  #
 # ================================================== #
 
 import base64
+from typing import Optional, Union, List, Dict, Any
 
 from pygpt_net.core.bridge.context import MultimodalContext
 
@@ -25,11 +26,11 @@ class Audio:
 
     def build_content(
             self,
-            content,
-            multimodal_ctx: MultimodalContext = None,
-    ) -> list:
+            content: Optional[Union[str, list]] = None,
+            multimodal_ctx: Optional[MultimodalContext] = None,
+    ) -> List[Dict[str, Any]]:
         """
-        Build audio content
+        Build audio content from multimodal context
 
         :param content: previous content or input prompt
         :param multimodal_ctx: multimodal context

pygpt_net/provider/gpt/chat.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 22:00:00                  #
 # ================================================== #
 
 import json
 import time
+from typing import Optional, Dict, Any, List
 
 from pygpt_net.core.types import (
     MODE_CHAT,
@@ -22,6 +23,8 @@ from pygpt_net.item.ctx import CtxItem
 from pygpt_net.item.model import ModelItem
 
 from .utils import sanitize_name
+from ...item.attachment import AttachmentItem
+
 
 class Chat:
     def __init__(self, window=None):
@@ -36,7 +39,7 @@ class Chat:
     def send(
             self,
             context: BridgeContext,
-            extra: dict = None
+            extra: Optional[Dict[str, Any]] = None
     ):
         """
         Call OpenAI API for chat
@@ -151,11 +154,11 @@ class Chat:
             prompt: str,
             system_prompt: str,
             model: ModelItem,
-            history: list = None,
-            attachments: dict = None,
-            ai_name: str = None,
-            user_name: str = None,
-            multimodal_ctx: MultimodalContext = None,
+            history: Optional[List[CtxItem]] = None,
+            attachments: Optional[Dict[str, AttachmentItem]] = None,
+            ai_name: Optional[str] = None,
+            user_name: Optional[str] = None,
+            multimodal_ctx: Optional[MultimodalContext] = None,
     ) -> list:
         """
         Build list of chat messages

pygpt_net/provider/gpt/completion.py

@@ -6,9 +6,11 @@
 # GitHub:  https://github.com/szczyglis-dev/py-gpt   #
 # MIT License                                        #
 # Created By  : Marcin Szczygliński                  #
-# Updated Date: 2024.11.23 00:00:00                  #
+# Updated Date: 2024.12.14 22:00:00                  #
 # ================================================== #
 
+from typing import Optional, Dict, Any, List
+
 from pygpt_net.core.types import (
     MODE_COMPLETION,
 )
@@ -27,7 +29,11 @@ class Completion:
         self.window = window
         self.input_tokens = 0
 
-    def send(self, context: BridgeContext, extra: dict = None):
+    def send(
+            self,
+            context: BridgeContext,
+            extra: Optional[Dict[str, Any]] = None
+    ):
         """
         Call OpenAI API for completion
 
@@ -98,9 +104,9 @@ class Completion:
             prompt: str,
             system_prompt: str,
             model: ModelItem,
-            history: list = None,
-            ai_name: str = None,
-            user_name: str = None,
+            history: Optional[List[CtxItem]] = None,
+            ai_name: Optional[str] = None,
+            user_name: Optional[str] = None,
     ) -> str:
         """
         Build completion string

pygpt_net/provider/gpt/image.py

@@ -6,11 +6,13 @@
 # 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 22:00:00                  #
 # ================================================== #
 
 import datetime
 import os
+from typing import Optional, Dict, Any
+
 import requests
 
 from PySide6.QtCore import QObject, Signal, QRunnable, Slot
@@ -31,7 +33,12 @@ class Image:
         self.window = window
         self.worker = None
 
-    def generate(self, context: BridgeContext, extra: dict = None, sync: bool = True):
+    def generate(
+            self,
+            context: BridgeContext,
+            extra: Optional[Dict[str, Any]] = None,
+            sync: bool = True
+    ):
         """
         Call images API
 

pygpt_net/provider/gpt/store.py

@@ -6,10 +6,11 @@
 # GitHub:  https://github.com/szczyglis-dev/py-gpt   #
 # MIT License                                        #
 # Created By  : Marcin Szczygliński                  #
-# Updated Date: 2024.04.30 16:00:00                  #
+# Updated Date: 2024.12.14 22:00:00                  #
 # ================================================== #
 
 import os
+from typing import Optional, List
 
 from pygpt_net.item.assistant import AssistantStoreItem
 
@@ -31,7 +32,11 @@ class Store:
         """
         return self.window.core.gpt.get_client()
 
-    def log(self, msg: str, callback: callable = None):
+    def log(
+            self,
+            msg: str,
+            callback: Optional[callable] = None
+    ):
         """
         Log message
 
@@ -57,7 +62,7 @@ class Store:
             self,
             path: str,
             purpose: str = "assistants"
-    ) -> str or None:
+    ) -> Optional[str]:
         """
         Upload file to assistant
 
@@ -98,7 +103,7 @@ class Store:
             items: list,
             order: str = "asc",
             limit: int = 100,
-            after: str = None,
+            after: Optional[str] = None,
     ) -> list:
         """
         Get all vector store IDs
@@ -132,7 +137,7 @@ class Store:
                 )
         return items
 
-    def get_files_ids(self) -> list:
+    def get_files_ids(self) -> List[str]:
         """
         Get all files IDs
 
@@ -148,7 +153,10 @@ class Store:
                     items.append(id)
         return items
 
-    def remove_files(self, callback: callable = None) -> int:
+    def remove_files(
+            self,
+            callback: Optional[callable] = None
+    ) -> int:
         """
         Remove all files
 
@@ -167,7 +175,11 @@ class Store:
                 self.log(msg, callback)
         return num
 
-    def remove_store_files(self, store_id: str, callback: callable = None) -> int:
+    def remove_store_files(
+            self,
+            store_id: str,
+            callback: Optional[callable] = None
+    ) -> int:
         """
         Remove all files from store
 
@@ -192,8 +204,8 @@ class Store:
             items: dict,
             order: str = "asc",
             limit: int = 100,
-            after: str = None,
-            callback: callable = None
+            after: Optional[str] = None,
+            callback: Optional[callable] = None
     ) -> dict:
         """
         Import vector stores from API
@@ -239,7 +251,11 @@ class Store:
                 )
         return items
 
-    def create_store(self, name: str, expire_days: int = 0):
+    def create_store(
+            self,
+            name: str,
+            expire_days: int = 0
+    ):
         """
         Create vector store
 
@@ -261,7 +277,12 @@ class Store:
         if vector_store is not None:
             return vector_store
 
-    def update_store(self, id: str, name: str, expire_days: int = 0):
+    def update_store(
+            self,
+            id: str,
+            name: str,
+            expire_days: int = 0
+    ):
         """
         Update vector store
 
@@ -318,7 +339,7 @@ class Store:
             items: list,
             order: str = "asc",
             limit: int = 100,
-            after: str = None,
+            after: Optional[str] = None,
     ) -> list:
         """
         Get all vector stores IDs
@@ -358,7 +379,7 @@ class Store:
             items: list,
             order: str = "asc",
             limit: int = 100,
-            after: str = None,
+            after: Optional[str] = None,
     ) -> list:
         """
         Get all vector store files IDs
@@ -426,7 +447,10 @@ class Store:
             num += 1
         return num
 
-    def remove_all(self, callback: callable = None) -> int:
+    def remove_all(
+            self,
+            callback: Optional[callable] = None
+    ) -> int:
         """
         Remove all vector stores
 
@@ -445,7 +469,11 @@ class Store:
                 self.log(msg, callback)
         return num
 
-    def add_file(self, store_id: str, file_id: str):
+    def add_file(
+            self,
+            store_id: str,
+            file_id: str
+    ):
         """
         Add file to vector store
 
@@ -479,7 +507,11 @@ class Store:
             if deleted_file is not None:
                 return deleted_file.id
 
-    def delete_store_file(self, store_id: str, file_id: str):
+    def delete_store_file(
+            self,
+            store_id: str,
+            file_id: str
+    ):
         """
         Delete file from vector store
 
@@ -495,7 +527,10 @@ class Store:
         if vector_store_file is not None:
             return vector_store_file
 
-    def import_stores_files(self, callback: callable = None) -> int:
+    def import_stores_files(
+            self,
+            callback: Optional[callable] = None
+    ) -> int:
         """
         Import all vector stores files
 
@@ -525,7 +560,7 @@ class Store:
             order: str = "asc",
             limit: int = 100,
             after: str = None,
-            callback: callable = None
+            callback: Optional[callable] = None
     ) -> list:
         """
         Import and get all vector store files IDs