pyloid 0.23.6__tar.gz → 0.23.8__tar.gz

{pyloid-0.23.6 → pyloid-0.23.8}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.3
 Name: pyloid
-Version: 0.23.6
+Version: 0.23.8
 Summary: 
 Author: aesthetics-of-record
 Author-email: 111675679+aesthetics-of-record@users.noreply.github.com

{pyloid-0.23.6 → pyloid-0.23.8}/pyproject.toml

@@ -1,6 +1,6 @@
 [tool.poetry]
 name = "pyloid"
-version = "0.23.6"
+version = "0.23.8"
 description = ""
 authors = ["aesthetics-of-record <111675679+aesthetics-of-record@users.noreply.github.com>"]
 readme = "README.md"

{pyloid-0.23.6 → pyloid-0.23.8}/src/pyloid/browser_window.py

@@ -1211,7 +1211,9 @@ class _BrowserWindow:
 
         (JavaScript)
         ```javascript
-        document.addEventListener('customEvent', (data) => {
+        import { event } from 'pyloid-js';
+
+        event.listen('customEvent', (data) => {
             console.log(data.message);
         });
         ```
@@ -2113,7 +2115,7 @@ class BrowserWindow(QObject):
             result = self._window.remove_shortcut(params["key_sequence"])
         elif command_type == "get_all_shortcuts":
             result = self._window.get_all_shortcuts()
-        elif command_type == "emit":
+        elif command_type == "invoke":
             event_name = params["event_name"]
             data = params.get("data")
             result = self._window.invoke(event_name, data)
@@ -2668,9 +2670,13 @@ class BrowserWindow(QObject):
         >>> window.invoke("customEvent", {"message": "Hello, Pyloid!"})
 
         (JavaScript)
-        >>> document.addEventListener('customEvent', (data) => {
-        ...     console.log(data.message);
-        ... });
+        ```javascript
+        import { event } from 'pyloid-js';
+
+        event.listen('customEvent', (data) => {
+            console.log(data.message);
+        });
+        ```
         """
         return self.execute_command("invoke", {"event_name": event_name, "data": data})
 

{pyloid-0.23.6 → pyloid-0.23.8}/src/pyloid/utils.py

@@ -7,23 +7,43 @@ import socket
 
 def get_production_path(path: Optional[str] = None) -> Optional[str]:
     """
-    Returns the path to the resource files in a production environment.
-    If running as a regular Python script, returns None.
+    Constructs the absolute path to a resource file, adjusting based on the execution environment.
+
+    In a production environment (e.g., when packaged with PyInstaller or Nuitka),
+    it prepends the application's base directory (sys._MEIPASS for PyInstaller,
+    or the directory of the executable for Nuitka) to the provided relative path.
+    If no path is provided, it returns the base path itself.
+
+    If not running in a production environment (e.g., during development as a regular
+    Python script), it simply returns the provided path as is. If no path is provided,
+    it returns None in a non-production environment.
+
+    Parameters
+    ----------
+    path : Optional[str], optional
+        The relative path to the resource file from the application's root directory.
+        Defaults to None.
 
     Returns
     -------
-    str | None
-        The path to the resource files if in a production environment, 
-        otherwise None.
+    Optional[str]
+        - If in production: The absolute path to the resource file (or the base path if `path` is None).
+        - If not in production: The original `path` value passed to the function.
 
     Examples
     --------
-    >>> from pyloid.utils import get_production_path
-    >>> path = get_production_path("assets/icon.ico")
-    >>> if path:
-    >>>     print(f"Production path: {path}")
-    >>> else:
-    >>>     print("Not in a production environment.")
+    >>> # Assume running NOT in production
+    >>> get_production_path("assets/icon.ico")
+    'assets/icon.ico'
+    >>> get_production_path()
+    None
+
+    >>> # Assume running IN production (e.g., PyInstaller bundle)
+    >>> # where sys._MEIPASS might be '/tmp/_MEIabcde'
+    >>> get_production_path("assets/icon.ico") # doctest: +SKIP
+    '/tmp/_MEIabcde/assets/icon.ico'
+    >>> get_production_path() # doctest: +SKIP
+    '/tmp/_MEIabcde'
     """
     if is_production():
         if hasattr(sys, '_MEIPASS'):
@@ -40,7 +60,7 @@ def get_production_path(path: Optional[str] = None) -> Optional[str]:
         
         return os.path.join(base_path, path) if path else base_path
     else:
-        return None
+        return path
 
 
 def is_production() -> bool: