p3lib 1.1.115__tar.gz → 1.1.116__tar.gz

{p3lib-1.1.115 → p3lib-1.1.116}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: p3lib
-Version: 1.1.115
+Version: 1.1.116
 Summary: A group of python modules for networking, plotting data, config storage, automating boot scripts, ssh access and user input output.
 Home-page: https://github.com/pjaos/p3lib
 License: MIT

{p3lib-1.1.115 → p3lib-1.1.116}/pyproject.toml

@@ -1,6 +1,6 @@
 [tool.poetry]
 name = "p3lib"
-version = "1.1.115"
+version = "1.1.116"
 description = "A group of python modules for networking, plotting data, config storage, automating boot scripts, ssh access and user input output."
 authors = ["Paul Austen <pjaos@gmail.com>"]
 license = "MIT License"

{p3lib-1.1.115 → p3lib-1.1.116}/src/p3lib/helper.py

@@ -9,6 +9,7 @@ import platform
 import json
 import traceback
 import socket
+import inspect
 
 def initArgs(parser, lastCmdLineArg=None, checkHostArg=True):
     """This method is responsible for
@@ -446,3 +447,70 @@ def getProgramVersion():
         raise Exception(f"Failed to extract program version from '{line}' line of {poetryConfigFile} file.")
     return programVersion
 
+def get_assets_folders():
+    """@return A list of all the assets folders found."""
+    searchFolders = []
+    assetsFolders = []
+    calling_file = None
+    # Get the full path to the python file that called this get_assets_folders() function.
+    frame = inspect.stack()[1]
+    module = inspect.getmodule(frame[0])
+    if module and hasattr(module, '__file__'):
+        calling_file = os.path.abspath(module.__file__)
+
+    if calling_file:
+        startup_path = os.path.dirname(calling_file)
+        searchFolders.append( os.path.join(startup_path, 'assets') )
+        pp1 = os.path.join(startup_path, '..')
+        searchFolders.append( os.path.join(pp1, 'assets') )
+        pp2 = os.path.join(pp1, '..')
+        searchFolders.append( os.path.join(pp2, 'assets') )
+        # Try all the site packages folders we know about.
+        for path in sys.path:
+            if 'site-packages' in path:
+                site_packages_path = path
+                searchFolders.append( os.path.join(site_packages_path, 'assets') )
+
+        for folder in searchFolders:
+            absPath = os.path.abspath(folder)
+            if os.path.isdir(absPath):
+                assetsFolders.append(absPath)
+
+    return assetsFolders
+
+
+def get_assets_folder(raise_error=True):
+    """@brief Get the assests folder.
+       @param raise_error If True then raise an error if the assets folder is not found.
+       @return The abs assets folder path string."""
+    searchFolders = []
+    assetsFolder = None
+    calling_file = None
+    # Get the full path to the python file that called this get_assets_folder() function.
+    frame = inspect.stack()[1]
+    module = inspect.getmodule(frame[0])
+    if module and hasattr(module, '__file__'):
+        calling_file = os.path.abspath(module.__file__)
+
+    if calling_file:
+        startup_path = os.path.dirname(calling_file)
+        searchFolders.append( os.path.join(startup_path, 'assets') )
+        pp1 = os.path.join(startup_path, '..')
+        searchFolders.append( os.path.join(pp1, 'assets') )
+        pp2 = os.path.join(pp1, '..')
+        searchFolders.append( os.path.join(pp2, 'assets') )
+        # Try all the site packages folders we know about.
+        for path in sys.path:
+            if 'site-packages' in path:
+                site_packages_path = path
+                searchFolders.append( os.path.join(site_packages_path, 'assets') )
+
+        for folder in searchFolders:
+            absPath = os.path.abspath(folder)
+            if os.path.isdir(absPath):
+                assetsFolder = absPath
+
+    if raise_error and assetsFolder is None:
+        raise Exception('Failed to find assets folder.')
+
+    return assetsFolder