pyloid 0.22.1__py3-none-any.whl → 0.23.1__py3-none-any.whl

pyloid/pyloid.py

@@ -30,7 +30,12 @@ from PySide6.QtCore import Signal, QObject, Slot
 import uuid
 from PySide6.QtCore import QEventLoop
 import socket
-from typing import Any
+from typing import Any, Set
+from platformdirs import PlatformDirs
+from .store import Store
+from .rpc import PyloidRPC
+import threading
+import asyncio
 
 # software backend
 os.environ["QT_QUICK_BACKEND"] = "software"
@@ -74,7 +79,7 @@ qInstallMessageHandler(custom_message_handler)
 
 class _WindowController(QObject):
     create_window_signal = Signal(
-        QApplication, str, int, int, int, int, bool, bool, bool, list
+        QApplication, str, int, int, int, int, bool, bool, bool, PyloidRPC
     )
 
 
@@ -113,7 +118,7 @@ class _Pyloid(QApplication):
 
         self.data = data
 
-        self.windows_dict = {}  # 윈도우 ID를 키로 사용하는 딕셔너리
+        self.windows_dict: Dict[str, BrowserWindow] = {}  # 윈도우 ID를 키로 사용하는 딕셔너리
         self.server = None
 
         self.app_name = app_name
@@ -154,6 +159,8 @@ class _Pyloid(QApplication):
         # Add color scheme tracking
         self.styleHints().colorSchemeChanged.connect(self._handle_color_scheme_change)
 
+        self.dirs = PlatformDirs(self.app_name, appauthor=False)
+
     # def set_theme(self, theme: Literal["system", "dark", "light"]):
     #     """
     #     시스템의 테마를 설정합니다.
@@ -223,7 +230,7 @@ class _Pyloid(QApplication):
         frame: bool = True,
         context_menu: bool = False,
         dev_tools: bool = False,
-        js_apis: List[PyloidAPI] = [],
+        rpc: Optional[PyloidRPC] = None,
     ) -> BrowserWindow:
         """
         Creates a new browser window.
@@ -246,8 +253,8 @@ class _Pyloid(QApplication):
             Whether to use the context menu (default is False)
         dev_tools : bool, optional
             Whether to use developer tools (default is False)
-        js_apis : list of PyloidAPI, optional
-            List of JavaScript APIs to add to the window (default is an empty list)
+        rpc : PyloidRPC, optional
+            The RPC server instance to be used in the window
 
         Returns
         -------
@@ -270,7 +277,7 @@ class _Pyloid(QApplication):
             frame,
             context_menu,
             dev_tools,
-            js_apis,
+            rpc,
         )
         latest_window_id = list(self.windows_dict.keys())[-1]
         return self.windows_dict[latest_window_id]
@@ -286,7 +293,8 @@ class _Pyloid(QApplication):
         frame: bool,
         context_menu: bool,
         dev_tools: bool,
-        js_apis: List[PyloidAPI] = [],
+        # js_apis: List[PyloidAPI] = [],
+        rpc: Optional[PyloidRPC] = None,
     ) -> BrowserWindow:
         """Function to create a new browser window."""
         window = BrowserWindow(
@@ -299,7 +307,7 @@ class _Pyloid(QApplication):
             frame,
             context_menu,
             dev_tools,
-            js_apis,
+            rpc,
         )
         self.windows_dict[window._window.id] = window
         return window
@@ -319,6 +327,19 @@ class _Pyloid(QApplication):
         app.run()
         ```
         """
+        
+        # Collect and deduplicate RPC servers
+        rpc_servers: Set[PyloidRPC] = set()
+        for window in self.windows_dict.values():
+            if window._window.rpc is not None:
+                rpc_servers.add(window._window.rpc)
+        
+        # 고유한 RPC 서버만 시작
+        for rpc in rpc_servers:
+            server_thread = threading.Thread(target=rpc.start, daemon=True)
+            server_thread.start()
+            
+        
         if is_production():
             sys.exit(self.exec())
         else:
@@ -347,20 +368,20 @@ class _Pyloid(QApplication):
     ###########################################################################################
     def get_windows(self) -> Dict[str, BrowserWindow]:
         """
-        Returns a list of all browser windows.
+        Returns a dictionary of all browser windows.
 
         Returns
         -------
-        List[BrowserWindow]
-            List of all browser windows
+        Dict[str, BrowserWindow]
+            Dictionary with window IDs as keys and BrowserWindow objects as values
 
         Examples
         --------
         ```python
         app = Pyloid(app_name="Pyloid-App")
         windows = app.get_windows()
-        for window in windows:
-            print(window.get_id())
+        for window_id, window in windows.items():
+            print(f"Window ID: {window_id}")
         ```
         """
         return self.windows_dict
@@ -1422,6 +1443,208 @@ class _Pyloid(QApplication):
                 Qt.GlobalColor.black if self.theme == "dark" else Qt.GlobalColor.white
             )
 
+    ###########################################################################################
+    # platformdirs
+    ###########################################################################################
+
+    def user_data_dir(self) -> str:
+        """
+        Returns the user data directory path.
+
+        Returns
+        -------
+        str
+            User data directory path
+
+        Examples
+        --------
+        >>> app = Pyloid(app_name="Pyloid-App")
+        >>> data_dir = app.user_data_dir()
+        >>> print(data_dir)
+        '/Users/user/Library/Application Support/Pyloid-App' # Example for macOS
+        """
+        return self.dirs.user_data_dir
+
+    def site_data_dir(self) -> str:
+        """
+        Returns the site data directory path.
+
+        Returns
+        -------
+        str
+            Site data directory path
+
+        Examples
+        --------
+        >>> app = Pyloid(app_name="Pyloid-App")
+        >>> site_data_dir = app.site_data_dir()
+        >>> print(site_data_dir)
+        '/Library/Application Support/Pyloid-App' # Example for macOS
+        """
+        return self.dirs.site_data_dir
+
+    def user_cache_dir(self) -> str:
+        """
+        Returns the user cache directory path.
+
+        Returns
+        -------
+        str
+            User cache directory path
+
+        Examples
+        --------
+        >>> app = Pyloid(app_name="Pyloid-App")
+        >>> cache_dir = app.user_cache_dir()
+        >>> print(cache_dir)
+        '/Users/user/Library/Caches/Pyloid-App' # Example for macOS
+        """
+        return self.dirs.user_cache_dir
+
+    def user_log_dir(self) -> str:
+        """
+        Returns the user log directory path.
+
+        Returns
+        -------
+        str
+            User log directory path
+
+        Examples
+        --------
+        >>> app = Pyloid(app_name="Pyloid-App")
+        >>> log_dir = app.user_log_dir()
+        >>> print(log_dir)
+        '/Users/user/Library/Logs/Pyloid-App' # Example for macOS
+        """
+        return self.dirs.user_log_dir
+
+    def user_documents_dir(self) -> str:
+        """
+        Returns the user documents directory path.
+
+        Returns
+        -------
+        str
+            User documents directory path
+
+        Examples
+        --------
+        >>> app = Pyloid(app_name="Pyloid-App")
+        >>> documents_dir = app.user_documents_dir()
+        >>> print(documents_dir)
+        '/Users/user/Documents' # Example for macOS
+        """
+        return self.dirs.user_documents_dir
+
+    def user_downloads_dir(self) -> str:
+        """
+        Returns the user downloads directory path.
+
+        Returns
+        -------
+        str
+            User downloads directory path
+
+        Examples
+        --------
+        >>> app = Pyloid(app_name="Pyloid-App")
+        >>> downloads_dir = app.user_downloads_dir()
+        >>> print(downloads_dir)
+        '/Users/user/Downloads' # Example for macOS
+        """
+        return self.dirs.user_downloads_dir
+
+    def user_pictures_dir(self) -> str:
+        """
+        Returns the user pictures directory path.
+
+        Returns
+        -------
+        str
+            User pictures directory path
+
+        Examples
+        --------
+        >>> app = Pyloid(app_name="Pyloid-App")
+        >>> pictures_dir = app.user_pictures_dir()
+        >>> print(pictures_dir)
+        '/Users/user/Pictures' # Example for macOS
+        """
+        return self.dirs.user_pictures_dir
+
+    def user_videos_dir(self) -> str:
+        """
+        Returns the user videos directory path.
+
+        Returns
+        -------
+        str
+            User videos directory path
+
+        Examples
+        --------
+        >>> app = Pyloid(app_name="Pyloid-App")
+        >>> videos_dir = app.user_videos_dir()
+        >>> print(videos_dir)
+        '/Users/user/Movies' # Example for macOS
+        """
+        return self.dirs.user_videos_dir
+
+    def user_music_dir(self) -> str:
+        """
+        Returns the user music directory path.
+
+        Returns
+        -------
+        str
+            User music directory path
+
+        Examples
+        --------
+        >>> app = Pyloid(app_name="Pyloid-App")
+        >>> music_dir = app.user_music_dir()
+        >>> print(music_dir)
+        '/Users/user/Music' # Example for macOS
+        """
+        return self.dirs.user_music_dir
+
+    def user_desktop_dir(self) -> str:
+        """
+        Returns the user desktop directory path.
+
+        Returns
+        -------
+        str
+            User desktop directory path
+
+        Examples
+        --------
+        >>> app = Pyloid(app_name="Pyloid-App")
+        >>> desktop_dir = app.user_desktop_dir()
+        >>> print(desktop_dir)
+        '/Users/user/Desktop' # Example for macOS
+        """
+        return self.dirs.user_desktop_dir
+
+    def user_runtime_dir(self) -> str:
+        """
+        Returns the user runtime directory path.
+
+        Returns
+        -------
+        str
+            User runtime directory path
+
+        Examples
+        --------
+        >>> app = Pyloid(app_name="Pyloid-App")
+        >>> runtime_dir = app.user_runtime_dir()
+        >>> print(runtime_dir)
+        '/Users/user/Library/Caches/TemporaryItems/Pyloid-App' # Example for macOS
+        """
+        return self.dirs.user_runtime_dir
+
 
 class Pyloid(QObject):
     command_signal = Signal(str, str, object)
@@ -1431,7 +1654,7 @@ class Pyloid(QObject):
         self,
         app_name: str,
         single_instance: bool = True,
-        data: Optional[Dict[str, Any]] = None,
+        # data: Optional[Dict[str, Any]] = None,
     ):
         """
         Initialize the Pyloid application.
@@ -1446,8 +1669,6 @@ class Pyloid(QObject):
             The name of the application.
         single_instance : bool, optional
             Determines whether to run as a single instance. (Default is True)
-        data : dict, optional
-            Data to be transmitted to the frontend web engine via IPC
 
         Notes
         -----
@@ -1456,7 +1677,7 @@ class Pyloid(QObject):
         """
         super().__init__()
 
-        self.data = data
+        self.data = None # 나중에 데이터 필요 시 수정
 
         self.app = _Pyloid(app_name, single_instance, self.data)
 
@@ -1479,6 +1700,7 @@ class Pyloid(QObject):
                 frame=params.get("frame", True),
                 context_menu=params.get("context_menu", False),
                 dev_tools=params.get("dev_tools", False),
+                rpc=params.get("rpc", None),
             )
             result = window
 
@@ -1653,6 +1875,7 @@ class Pyloid(QObject):
         frame: bool = True,
         context_menu: bool = False,
         dev_tools: bool = False,
+        rpc: Optional[PyloidRPC] = None,
     ) -> BrowserWindow:
         """
         Creates a new browser window.
@@ -1675,6 +1898,8 @@ class Pyloid(QObject):
             Whether to use the context menu (default is False)
         dev_tools : bool, optional
             Whether to use developer tools (default is False)
+        rpc : PyloidRPC, optional
+            The RPC server instance to be used in the window
 
         Returns
         -------
@@ -1695,6 +1920,7 @@ class Pyloid(QObject):
             "frame": frame,
             "context_menu": context_menu,
             "dev_tools": dev_tools,
+            "rpc": rpc,
         }
         return self.execute_command("create_window", params)
 
@@ -2210,6 +2436,7 @@ class Pyloid(QObject):
         --------
         >>> def on_file_change(file_path):
         >>>     print(f"File changed: {file_path}")
+        >>>
         >>> app = Pyloid(app_name="Pyloid-App")
         >>> app.set_file_change_callback(on_file_change)
         """
@@ -2228,6 +2455,7 @@ class Pyloid(QObject):
         --------
         >>> def on_directory_change(dir_path):
         >>>     print(f"Directory changed: {dir_path}")
+        >>>
         >>> app = Pyloid(app_name="Pyloid-App")
         >>> app.set_directory_change_callback(on_directory_change)
         """
@@ -2305,3 +2533,234 @@ class Pyloid(QObject):
         >>> directory_path = app.select_directory_dialog(dir="/home/user")
         """
         return self.execute_command("select_directory_dialog", {"dir": dir})
+
+    # --- Add platformdirs wrapper functions ---
+
+    def user_data_dir(self) -> str:
+        """
+        Returns the user data directory path.
+
+        Returns
+        -------
+        str
+            User data directory path
+
+        Examples
+        --------
+        >>> app = Pyloid(app_name="Pyloid-App")
+        >>> data_dir = app.user_data_dir()
+        >>> print(data_dir)
+        '/Users/user/Library/Application Support/Pyloid-App' # Example for macOS
+        """
+        return self.app.user_data_dir()
+
+    def site_data_dir(self) -> str:
+        """
+        Returns the site data directory path.
+
+        Returns
+        -------
+        str
+            Site data directory path
+
+        Examples
+        --------
+        >>> app = Pyloid(app_name="Pyloid-App")
+        >>> site_data_dir = app.site_data_dir()
+        >>> print(site_data_dir)
+        '/Library/Application Support/Pyloid-App' # Example for macOS
+        """
+        return self.app.site_data_dir()
+
+    def user_cache_dir(self) -> str:
+        """
+        Returns the user cache directory path.
+
+        Returns
+        -------
+        str
+            User cache directory path
+
+        Examples
+        --------
+        >>> app = Pyloid(app_name="Pyloid-App")
+        >>> cache_dir = app.user_cache_dir()
+        >>> print(cache_dir)
+        '/Users/user/Library/Caches/Pyloid-App' # Example for macOS
+        """
+        return self.app.user_cache_dir()
+
+    def user_log_dir(self) -> str:
+        """
+        Returns the user log directory path.
+
+        Returns
+        -------
+        str
+            User log directory path
+
+        Examples
+        --------
+        >>> app = Pyloid(app_name="Pyloid-App")
+        >>> log_dir = app.user_log_dir()
+        >>> print(log_dir)
+        '/Users/user/Library/Logs/Pyloid-App' # Example for macOS
+        """
+        return self.app.user_log_dir()
+
+    def user_documents_dir(self) -> str:
+        """
+        Returns the user documents directory path.
+
+        Returns
+        -------
+        str
+            User documents directory path
+
+        Examples
+        --------
+        >>> app = Pyloid(app_name="Pyloid-App")
+        >>> documents_dir = app.user_documents_dir()
+        >>> print(documents_dir)
+        '/Users/user/Documents' # Example for macOS
+        """
+        return self.app.user_documents_dir()
+
+    def user_downloads_dir(self) -> str:
+        """
+        Returns the user downloads directory path.
+
+        Returns
+        -------
+        str
+            User downloads directory path
+
+        Examples
+        --------
+        >>> app = Pyloid(app_name="Pyloid-App")
+        >>> downloads_dir = app.user_downloads_dir()
+        >>> print(downloads_dir)
+        '/Users/user/Downloads' # Example for macOS
+        """
+        return self.app.user_downloads_dir()
+
+    def user_pictures_dir(self) -> str:
+        """
+        Returns the user pictures directory path.
+
+        Returns
+        -------
+        str
+            User pictures directory path
+
+        Examples
+        --------
+        >>> app = Pyloid(app_name="Pyloid-App")
+        >>> pictures_dir = app.user_pictures_dir()
+        >>> print(pictures_dir)
+        '/Users/user/Pictures' # Example for macOS
+        """
+        return self.app.user_pictures_dir()
+
+    def user_videos_dir(self) -> str:
+        """
+        Returns the user videos directory path.
+
+        Returns
+        -------
+        str
+            User videos directory path
+
+        Examples
+        --------
+        >>> app = Pyloid(app_name="Pyloid-App")
+        >>> videos_dir = app.user_videos_dir()
+        >>> print(videos_dir)
+        '/Users/user/Movies' # Example for macOS
+        """
+        return self.app.user_videos_dir()
+
+    def user_music_dir(self) -> str:
+        """
+        Returns the user music directory path.
+
+        Returns
+        -------
+        str
+            User music directory path
+
+        Examples
+        --------
+        >>> app = Pyloid(app_name="Pyloid-App")
+        >>> music_dir = app.user_music_dir()
+        >>> print(music_dir)
+        '/Users/user/Music' # Example for macOS
+        """
+        return self.app.user_music_dir()
+
+    def user_desktop_dir(self) -> str:
+        """
+        Returns the user desktop directory path.
+
+        Returns
+        -------
+        str
+            User desktop directory path
+
+        Examples
+        --------
+        >>> app = Pyloid(app_name="Pyloid-App")
+        >>> desktop_dir = app.user_desktop_dir()
+        >>> print(desktop_dir)
+        '/Users/user/Desktop' # Example for macOS
+        """
+        return self.app.user_desktop_dir()
+
+    def user_runtime_dir(self) -> str:
+        """
+        Returns the user runtime directory path.
+
+        Returns
+        -------
+        str
+            User runtime directory path
+
+        Examples
+        --------
+        >>> app = Pyloid(app_name="Pyloid-App")
+        >>> runtime_dir = app.user_runtime_dir()
+        >>> print(runtime_dir)
+        '/Users/user/Library/Caches/TemporaryItems/Pyloid-App' # Example for macOS
+        """
+        return self.app.user_runtime_dir()
+
+    # --- Add store wrapper functions ---
+
+    def store(self, path: str, user_data_dir: bool = True) -> Store:
+        """
+        Returns a Store instance for the given path.
+
+        Parameters
+        ----------
+        path : str
+            The path to the store file
+        user_data_dir : bool, optional
+            If True, the store will be created in the user data directory
+
+        Returns
+        -------
+        Store
+            A Store instance for the given path
+
+        Examples
+        --------
+        >>> app = Pyloid(app_name="Pyloid-App")
+        >>> store = app.store("store.json")
+        >>> store.set("key", "value")
+        True
+        >>> print(store.get("key"))
+        'value'
+        """
+        if user_data_dir:
+            path = os.path.join(self.app.user_data_dir(), path)
+        return Store(path)