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

pygpt_net/controller/assistant/batch.py

@@ -6,9 +6,10 @@
 # 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 typing import Optional, Any
 
 from PySide6.QtWidgets import QApplication, QFileDialog
 
@@ -95,7 +96,11 @@ class Batch:
             self.window.core.debug.log(e)
             self.window.ui.dialogs.alert(e)
 
-    def import_store_files(self, store_id: str, force: bool = False):
+    def import_store_files(
+            self,
+            store_id: str,
+            force: bool = False
+    ):
         """
         Sync files with API (store)
 
@@ -123,7 +128,7 @@ class Batch:
         """
         Truncate all files in API
 
-        :param force: if true, imports without confirmation
+        :param force: if True, imports without confirmation
         """
         if not force:
             self.window.ui.dialogs.confirm(
@@ -142,7 +147,7 @@ class Batch:
         Truncate all files in API (store)
 
         :param idx: store index
-        :param force: if true, imports without confirmation
+        :param force: if True, imports without confirmation
         """
         store_id = self.window.controller.assistant.store.get_by_tab_idx(idx)
         self.truncate_store_files(store_id, force)
@@ -152,7 +157,7 @@ class Batch:
         Truncate all files in API (store)
 
         :param store_id: store ID
-        :param force: if true, imports without confirmation
+        :param force: if True, imports without confirmation
         """
         if store_id is None:
             self.window.ui.dialogs.alert(trans("dialog.assistant.store.alert.select"))
@@ -170,22 +175,30 @@ class Batch:
         QApplication.processEvents()
         self.window.core.gpt.assistants.importer.truncate_files(store_id)  # remove all files from API
 
-    def clear_store_files_by_idx(self, idx: int, force: bool = False):
+    def clear_store_files_by_idx(
+            self,
+            idx: int,
+            force: bool = False
+    ):
         """
         Clear files (store, local only)
 
         :param idx: store index
-        :param force: if true, clears without confirmation
+        :param force: if True, clears without confirmation
         """
         store_id = self.window.controller.assistant.store.get_by_tab_idx(idx)
         self.clear_store_files(store_id, force)
 
-    def clear_store_files(self, store_id: str = None, force: bool = False):
+    def clear_store_files(
+            self,
+            store_id: Optional[str] = None,
+            force: bool = False
+    ):
         """
         Clear files (store, local only)
 
         :param store_id: store ID
-        :param force: if true, clears without confirmation
+        :param force: if True, clears without confirmation
         """
         if store_id is None:
             self.window.ui.dialogs.alert(trans("dialog.assistant.store.alert.select"))
@@ -209,7 +222,7 @@ class Batch:
         """
         Clear files (all, local only)
 
-        :param force: if true, clears without confirmation
+        :param force: if True, clears without confirmation
         """
         if not force:
             self.window.ui.dialogs.confirm(
@@ -229,7 +242,7 @@ class Batch:
         """
         Clear vector stores (local only)
 
-        :param force: if true, clears without confirmation
+        :param force: if True, clears without confirmation
         """
         if not force:
             self.window.ui.dialogs.confirm(
@@ -251,7 +264,7 @@ class Batch:
         """
         Truncate vector stores in API
 
-        :param force: if true, truncates without confirmation
+        :param force: if True, truncates without confirmation
         """
         if not force:
             self.window.ui.dialogs.confirm(
@@ -274,7 +287,7 @@ class Batch:
         """
         Refresh all vector stores
 
-        :param force: if true, refresh without confirmation
+        :param force: if True, refresh without confirmation
         """
         if not force:
             self.window.ui.dialogs.confirm(
@@ -299,7 +312,7 @@ class Batch:
         self.window.update_status("OK. Imported assistants: " + str(num) + ".")
         self.window.ui.dialogs.alert(trans("status.finished"))
 
-    def handle_imported_assistants_failed(self, error: any):
+    def handle_imported_assistants_failed(self, error: Any):
         """
         Handle error on importing assistants
 
@@ -322,7 +335,7 @@ class Batch:
         self.window.ui.dialogs.alert(trans("status.finished"))
         self.window.update_status("OK. All stores refreshed.")
 
-    def handle_refreshed_stores_failed(self, error: any):
+    def handle_refreshed_stores_failed(self, error: Any):
         """
         Handle error on refreshing stores
 
@@ -347,7 +360,7 @@ class Batch:
         # alert on files import after stores
         # self.window.ui.dialogs.alert(trans("status.finished"))
 
-    def handle_imported_stores_failed(self, error: any):
+    def handle_imported_stores_failed(self, error: Any):
         """
         Handle error on importing stores
 
@@ -375,7 +388,7 @@ class Batch:
         self.window.update_status("OK. Removed stores: " + str(num) + ".")
         self.window.ui.dialogs.alert(trans("status.finished"))
 
-    def handle_truncated_stores_failed(self, error: any):
+    def handle_truncated_stores_failed(self, error: Any):
         """
         Handle error on truncating stores
 
@@ -398,7 +411,7 @@ class Batch:
         self.window.update_status("OK. Imported files: " + str(num) + ".")
         self.window.ui.dialogs.alert(trans("status.finished"))
 
-    def handle_imported_files_failed(self, error: any):
+    def handle_imported_files_failed(self, error: Any):
         """
         Handle error on importing files
 
@@ -410,7 +423,11 @@ class Batch:
         self.window.update_status("Error importing files.")
         self.window.ui.dialogs.alert(error)
 
-    def handle_truncated_files(self, store_id: str = None, num: int = 0):
+    def handle_truncated_files(
+            self,
+            store_id: Optional[str] = None,
+            num: int = 0
+    ):
         """
         Handle truncated (in API) files
 
@@ -423,7 +440,7 @@ class Batch:
         self.window.controller.assistant.files.update()
         self.window.ui.dialogs.alert(trans("status.finished"))
 
-    def handle_truncated_files_failed(self, error: any):
+    def handle_truncated_files_failed(self, error: Any):
         """
         Handle error on truncated files
 
@@ -536,7 +553,7 @@ class Batch:
         self.window.update_status("OK. Uploaded files: " + str(num) + ".")
         self.window.ui.dialogs.alert("OK. Uploaded files: " + str(num) + ".")
 
-    def handle_uploaded_files_failed(self, error: any):
+    def handle_uploaded_files_failed(self, error: Any):
         """
         Handle error on uploading files
 

pygpt_net/controller/assistant/editor.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 copy
+from typing import Optional
 
 from PySide6.QtWidgets import QApplication
 
@@ -133,7 +134,7 @@ class Editor:
             value="",
         )
 
-    def get_selected_store_id(self) -> str or None:
+    def get_selected_store_id(self) -> Optional[str]:
         """
         Return current selected vector store ID
 
@@ -149,7 +150,7 @@ class Editor:
             return self.window.ui.config[self.id]['vector_store'].combo.itemData(idx)
         return None
 
-    def get_choice_idx_by_id(self, store_id) -> int:
+    def get_choice_idx_by_id(self, store_id: str) -> int:
         """
         Return combo choice index by vector store ID
 
@@ -166,7 +167,7 @@ class Editor:
             i += 1
         return 0  # none
 
-    def edit(self, idx: int = None):
+    def edit(self, idx: Optional[int] = None):
         """
         Open assistant editor
 
@@ -183,7 +184,7 @@ class Editor:
         """Close assistant editor"""
         self.window.ui.dialogs.close('editor.assistants')
 
-    def init(self, id: str = None):
+    def init(self, id: Optional[str] = None):
         """
         Initialize assistant editor
 
@@ -379,7 +380,7 @@ class Editor:
         """
         Assign data from fields to assistant
 
-        :param assistant: assistant
+        :param assistant: assistant item
         """
         model = self.window.controller.config.get_value(
             parent_id=self.id,

pygpt_net/controller/assistant/files.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 Optional, Dict, List
 
 from PySide6.QtWidgets import QApplication
 
@@ -50,7 +51,10 @@ class Files:
         file_id = self.window.core.assistants.files.get_file_id_by_idx(idx, assistant.vector_store, thread_id)
         self.window.core.assistants.current_file = file_id
 
-    def count_upload(self, attachments: dict) -> int:
+    def count_upload(
+            self,
+            attachments: Dict[str, AttachmentItem]
+    ) -> int:
         """
         Count attachments for upload
 
@@ -64,7 +68,7 @@ class Files:
                 num += 1  # increment uploaded files counter if file is not uploaded yet
         return num
 
-    def import_files(self, store_id: str = None):
+    def import_files(self, store_id: Optional[str] = None):
         """
         Import assistant files from API
 
@@ -239,11 +243,15 @@ class Files:
         self.window.core.assistants.save()
         self.update()
 
-    def upload(self, mode: str, attachments: dict) -> int:
+    def upload(
+            self,
+            mode: str,
+            attachments: Dict[str, AttachmentItem]
+    ) -> int:
         """
         Upload attachments to assistant
 
-        :param mode: mode
+        :param mode: work mode
         :param attachments: attachments dict
         :return: number of uploaded files
         """
@@ -334,7 +342,11 @@ class Files:
 
         return num
 
-    def append(self, assistant: AssistantItem, attachment: AttachmentItem):
+    def append(
+            self,
+            assistant: AssistantItem,
+            attachment: AttachmentItem
+    ):
         """
         Append attachment to assistant
 
@@ -375,7 +387,11 @@ class Files:
             suffix = f' ({num_files})'
         self.window.ui.tabs['input'].setTabText(2, trans('attachments_uploaded.tab') + suffix)
 
-    def handle_received_ids(self, ids: list, ext: str = None) -> list:
+    def handle_received_ids(
+            self,
+            ids: List[str],
+            ext: Optional[str] = None
+    ) -> list:
         """
         Handle (download) received message files
 

pygpt_net/controller/assistant/store.py

@@ -6,11 +6,12 @@
 # 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 copy
 import json
+from typing import Optional
 
 from PySide6.QtWidgets import QApplication
 
@@ -65,7 +66,7 @@ class VectorStore:
         """
         return self.options
 
-    def get_option(self, key: str) -> dict or None:
+    def get_option(self, key: str) -> Optional[dict]:
         """
         Get option by key
 
@@ -157,7 +158,11 @@ class VectorStore:
                 self.window.update_status(trans('status.assistant.saved'))
                 self.update()  # update stores list in assistant dialog
 
-    def refresh_store(self, store: AssistantStoreItem, update: bool = True):
+    def refresh_store(
+            self,
+            store: AssistantStoreItem,
+            update: bool = True
+    ):
         """
         Refresh store by ID
 
@@ -301,7 +306,11 @@ class VectorStore:
         self.restore_selection()
         self.refresh_by_store_id(store.id)
 
-    def delete_by_idx(self, idx: int, force: bool = False):
+    def delete_by_idx(
+            self,
+            idx: int,
+            force: bool = False
+    ):
         """
         Delete store by idx
 
@@ -311,7 +320,11 @@ class VectorStore:
         store_id = self.get_by_tab_idx(idx)
         self.delete(store_id, force=force)
 
-    def delete(self, store_id: str = None, force: bool = False):
+    def delete(
+            self,
+            store_id: Optional[str] = None,
+            force: bool = False
+    ):
         """
         Delete store by idx
 
@@ -413,7 +426,7 @@ class VectorStore:
             i += 1
         return idx
 
-    def get_by_tab_idx(self, idx: int) -> str or None:
+    def get_by_tab_idx(self, idx: int) -> Optional[str]:
         """
         Get key by list index (including hidden)
 
@@ -429,7 +442,7 @@ class VectorStore:
             store_idx += 1
         return None
 
-    def get_first_visible(self) -> str or None:
+    def get_first_visible(self) -> Optional[str]:
         """
         Get first visible store ID (including hidden)
 

pygpt_net/controller/assistant/threads.py

@@ -6,11 +6,12 @@
 # GitHub:  https://github.com/szczyglis-dev/py-gpt   #
 # MIT License                                        #
 # Created By  : Marcin Szczygliński                  #
-# Updated Date: 2024.11.24 00:00:00                  #
+# Updated Date: 2024.12.14 08:00:00                  #
 # ================================================== #
 
 import json
 import time
+from typing import Optional, Any, List, Dict
 
 from PySide6.QtCore import QObject, Signal, Slot, QRunnable
 
@@ -46,7 +47,11 @@ class Threads(QObject):
         self.window.core.ctx.append_thread(thread_id)
         return thread_id
 
-    def handle_output_message(self, ctx: CtxItem, stream: bool = False):
+    def handle_output_message(
+            self,
+            ctx: CtxItem,
+            stream: bool = False
+    ):
         """
         Handle output message (not stream ONLY)
 
@@ -92,7 +97,12 @@ class Threads(QObject):
 
         self.log("Handled output message.")
 
-    def handle_message_data(self, ctx: CtxItem, msg, stream: bool = False):
+    def handle_message_data(
+            self,
+            ctx: CtxItem,
+            msg,
+            stream: bool = False
+    ):
         """
         Handle message data (files, images, text) - stream and not-stream
 
@@ -286,7 +296,10 @@ class Threads(QObject):
             })
             self.window.dispatch(event)
 
-    def handle_tool_outputs(self, ctx: CtxItem) -> list:
+    def handle_tool_outputs(
+            self,
+            ctx: CtxItem
+    ) -> List[Dict[str, Any]]:
         """
         Handle tool outputs
 
@@ -304,7 +317,10 @@ class Threads(QObject):
         return tools_outputs
 
 
-    def apply_outputs(self, ctx: CtxItem) -> list:
+    def apply_outputs(
+            self,
+            ctx: CtxItem
+    ) -> List[Dict[str, Any]]:
         """
         Apply tool call outputs
 
@@ -316,7 +332,12 @@ class Threads(QObject):
         ctx.tool_calls = self.tool_calls  # set previous tool calls
         return self.window.core.command.get_tool_calls_outputs(ctx)
 
-    def handle_run_created(self, ctx: CtxItem, run, stream: bool = False):
+    def handle_run_created(
+            self,
+            ctx: CtxItem,
+            run,
+            stream: bool = False
+    ):
         """
         Handle run created (stream and not stream)
 
@@ -330,7 +351,7 @@ class Threads(QObject):
         self.window.core.ctx.append_run(ctx.run_id)  # get run ID and store in ctx
         self.handle_run(ctx, run, stream)  # handle assistant run
 
-    def handle_run_error(self, ctx: CtxItem, err):
+    def handle_run_error(self, ctx: CtxItem, err: Any):
         """
         Handle run created (stream and not stream)
 
@@ -354,7 +375,12 @@ class Threads(QObject):
         self.window.controller.chat.common.unlock_input()  # unlock input
         # self.handle_stream_end(ctx)
 
-    def handle_run(self, ctx: CtxItem, run, stream: bool = False):
+    def handle_run(
+            self,
+            ctx: CtxItem,
+            run,
+            stream: bool = False
+    ):
         """
         Handle assistant's run (not stream ONLY)
 

pygpt_net/controller/attachment.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 02:00:00                  #
+# Updated Date: 2024.12.14 08:00:00                  #
 # ================================================== #
 
 import os
 from datetime import datetime
+from typing import Optional
 from urllib.parse import urlparse
 
 from PySide6.QtGui import QImage
@@ -112,7 +113,12 @@ class Attachment:
         # TODO: implement this
         pass
 
-    def delete(self, idx: int, force: bool = False, remove_local: bool = False):
+    def delete(
+            self,
+            idx: int,
+            force: bool = False,
+            remove_local: bool = False
+    ):
         """
         Delete attachment
 
@@ -196,7 +202,11 @@ class Attachment:
         self.window.ui.dialog['rename'].close()
         self.update()
 
-    def add(self, mode: str, attachment: AttachmentItem):
+    def add(
+            self,
+            mode: str,
+            attachment: AttachmentItem
+    ):
         """
         Add attachment item to list
 
@@ -210,7 +220,12 @@ class Attachment:
         self.is_consumed = False  # reset consumed flag
         self.update()
 
-    def clear(self, force: bool = False, remove_local=False, auto: bool = False):
+    def clear(
+            self,
+            force: bool = False,
+            remove_local: bool = False,
+            auto: bool = False
+    ):
         """
         Clear attachments list
 
@@ -240,9 +255,7 @@ class Attachment:
             self.window.dispatch(AppEvent(AppEvent.CTX_ATTACHMENTS_CLEAR))
 
     def clear_silent(self):
-        """
-        Clear attachments list
-        """
+        """Clear attachments list without confirmation"""
         # delete all from attachments for current mode
         mode = self.window.core.config.get('mode')
         self.window.core.attachments.delete_all(
@@ -407,9 +420,13 @@ class Attachment:
                 self.window.core.config.get_user_dir('data'),
                 file_name,
             )
-        return path
+        return str(path)
 
-    def download(self, file_id: str, ext: str = None) -> str or None:
+    def download(
+            self,
+            file_id: str,
+            ext: Optional[str] = None
+    ) -> Optional[str]:
         """
         Download file
 
@@ -501,6 +518,8 @@ class Attachment:
     def from_clipboard_image(self, image):
         """
         Handle image from clipboard
+
+        :param image: image data
         """
         now = datetime.now()
         dt = now.strftime("%Y-%m-%d_%H-%M-%S")
@@ -509,7 +528,7 @@ class Attachment:
         image.save(path, "PNG")
         self.from_clipboard_url(path)
 
-    def from_clipboard_url(self, url, all: bool = False):
+    def from_clipboard_url(self, url: str, all: bool = False):
         """
         Handle image from clipboard url
 

pygpt_net/controller/audio/__init__.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 08:00:00                  #
 # ================================================== #
 
 import os
+from typing import Optional
 
 from pygpt_net.core.events import Event, BaseEvent
 from pygpt_net.item.ctx import CtxItem
@@ -29,7 +30,11 @@ class Audio:
         """Setup controller"""
         self.update()
 
-    def toggle_input(self, state: bool, btn: bool = True):
+    def toggle_input(
+            self,
+            state: bool,
+            btn: bool = True
+    ):
         """
         Toggle audio input
 
@@ -155,7 +160,11 @@ class Audio:
         else:
             self.window.ui.menu['audio.control.global'].setChecked(False)
 
-    def read_text(self, text: str, cache_file: str = None):
+    def read_text(
+            self,
+            text: str,
+            cache_file: Optional[str] = None
+    ):
         """
         Read text using audio output plugins
 
@@ -200,6 +209,14 @@ class Audio:
         }
         self.window.dispatch(event, all=True)
 
+    def stop_audio(self):
+        """Stop audio playback"""
+        ctx = CtxItem()
+        event = Event(Event.AUDIO_OUTPUT_STOP)
+        event.ctx = ctx
+        event.data = {}
+        self.window.dispatch(event, all=True)
+
     def play_sound(self, filename: str):
         """
         Play sound
@@ -210,7 +227,11 @@ class Audio:
         if path:
             self.play_audio(path)
 
-    def play_event(self, text: str, event: BaseEvent = None):
+    def play_event(
+            self,
+            text: str,
+            event: Optional[BaseEvent] = None
+    ):
         """
         Play event (read text or play cached audio file)