pyloid 0.23.6__py3-none-any.whl → 0.23.7__py3-none-any.whl

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:

{pyloid-0.23.6.dist-info → pyloid-0.23.7.dist-info}/METADATA

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

{pyloid-0.23.6.dist-info → pyloid-0.23.7.dist-info}/RECORD

@@ -16,8 +16,8 @@ pyloid/thread_pool.py,sha256=fKOBb8jMfZn_7crA_fJCno8dObBRZE31EIWaNQ759aw,14616
 pyloid/timer.py,sha256=RqMsChFUd93cxMVgkHWiIKrci0QDTBgJSTULnAtYT8M,8712
 pyloid/tray.py,sha256=D12opVEc2wc2T4tK9epaN1oOdeziScsIVNM2uCN7C-A,1710
 pyloid/url_interceptor.py,sha256=AFjPANDELc9-E-1TnVvkNVc-JZBJYf0677dWQ8LDaqw,726
-pyloid/utils.py,sha256=e866N9uyAGHTMYsqRYY4JL0AEMRCOiY-k1c1zmEpDA4,4686
-pyloid-0.23.6.dist-info/LICENSE,sha256=F96EzotgWhhpnQTW2TcdoqrMDir1jyEo6H915tGQ-QE,11524
-pyloid-0.23.6.dist-info/METADATA,sha256=5pCR8x1L4xODWwxRjiQ8PW3W-vErg4lzHGzgkpukFpU,3197
-pyloid-0.23.6.dist-info/WHEEL,sha256=IYZQI976HJqqOpQU6PHkJ8fb3tMNBFjg-Cn-pwAbaFM,88
-pyloid-0.23.6.dist-info/RECORD,,
+pyloid/utils.py,sha256=NqB8W-irXDtTGb74rrJ2swU6tgzU0HSE8lGewrStOKc,5685
+pyloid-0.23.7.dist-info/LICENSE,sha256=F96EzotgWhhpnQTW2TcdoqrMDir1jyEo6H915tGQ-QE,11524
+pyloid-0.23.7.dist-info/METADATA,sha256=7P2pX25Afe5LpVh-ydYgYdTiDltSJysxnZ-MY3lXysM,3197
+pyloid-0.23.7.dist-info/WHEEL,sha256=IYZQI976HJqqOpQU6PHkJ8fb3tMNBFjg-Cn-pwAbaFM,88
+pyloid-0.23.7.dist-info/RECORD,,