quarchpy 2.1.11.dev4__py3-none-any.whl → 2.2.17.dev1__py3-none-any.whl

quarchpy/run.py

@@ -1,26 +1,43 @@
+
+import os
+import sys
 """
 This module allows specific quarchpy utilities and embedded applications to be run from the command line
 using the format:
 > python -m quarchpy.run [option]
 """
 
+"""
+This is very important. It allows us to import from the run.py we are running from.
+If this cwn parent wasn't added we would always look at the python3/Lib/sitepackages/quarchpy
+which is not always where we are running from.
+"""
+
+cwd = os.getcwd()
+parent_dir = os.path.dirname(cwd)
+# It must be added at the start of the list so it is caught there before installed quarchpy is found.
+sys.path.insert(0, parent_dir)
+
 # Import the various functions which need to be called from the command line options
 from quarchpy.debug.SystemTest import main as systemTestMain
 from quarchpy.debug.module_debug import parse_arguments as moduleDebugMain
 from quarchpy.qis.qisFuncs import startLocalQis, isQisRunning, closeQis as closeQIS
 from quarchpy.qps.qpsFuncs import startLocalQps, isQpsRunning, closeQps as closeQPS
 from quarchpy.debug.upgrade_quarchpy import main as uprade_quarchpy_main
-from quarchpy.user_interface import*
+from quarchpy.user_interface import *
 from quarchpy.debug.simple_terminal import main as simple_terminal_main
+from quarchpy.install_qps import find_qps
 import sys, logging, traceback
 
+
 def main(args):
     """
     Main function parses the arguments from the run command only
     """
-   
+
     # Run the internal parser
-    _parse_run_options(args)  
+    _parse_run_options(args)
+
 
 def _parse_run_options(args):
     """
@@ -36,26 +53,26 @@ def _parse_run_options(args):
     found = False
 
     # Arguments may not always be present
-    if (len(args) > 0):
+    if len(args) > 0:
         # Obtain the list of commands that can be executed
         run_options = _get_run_options()
         # Try to locate a matching command name, executing it if found and passing in the remaining parameters
         main_arg = args[0]
         for item in run_options:
-            if (item[0] == main_arg or item[1] == main_arg):
+            if item[0] == main_arg or item[1] == main_arg:
                 found = True
                 item[2](args[1:])
     else:
-        logging.info("No args passed")
+        logger.info("No args passed")
         found = True
         _run_help_function()
 
     # If parsing failed, error and print the available commands
-    if (found == False):
-        logging.error("ERROR - Command line argument not recognised")
+    if not found:
+        logger.error("ERROR - Command line argument not recognised")
         _run_help_function()
 
-        
+
 def _get_run_options():
     """
     Gets the list of options for quarchpy.run commands which can be called.  This is used internally to access the available commands
@@ -69,31 +86,36 @@ def _get_run_options():
 
     run_options = []
 
-    #                   [old_name           , simple_name    , execute_function              , help_description]
-    run_options.append (["debug_info"       , "debug"       , _run_debug_function          , "Runs system tests which displays useful information for debugging"])
-    run_options.append ([None               , "module_debug", _run_module_debug_function   , "Gives debug info on selected module and DUT"])
-    run_options.append ([None               , "qcs"         , _run_qcs_function            , "Launches Quarch Compliance Suite server"])
-    run_options.append (["calibration_tool" , "calibration" , _run_calibration_function    , "Runs the Quarch power module calibration tool"])
-    run_options.append ([None               , "qis"         , _run_qis_function            , "Launches Quarch Instrument Server for communication with Quarch power modules"])
-    run_options.append ([None               , "qps"         , _run_qps_function            , "Launches Quarch Power Studios, for power capture and analysis"])
-    run_options.append (["simple_terminal"  , "terminal"    , _run_simple_terminal_function, "Runs the Simple Terminal script"])
-    run_options.append (["upgrade_quarchpy" , "upgrade"     , _run_upgrade_function        , "Detects if an update of Quarchpy is available and assists in the upgrade process"])
-    run_options.append (["h"                , "help"        , _run_help_function           , "Displays the help screen with a list of commands supported"])
-    run_options.append (["dd"               , "list_drives" , _run_show_drives_function    , "Displays a list of shown drives on the current system"])
+    #                   [old_name           , simple_name    , execute_function               , help_description]
+    run_options.append(["debug_info"        , "debug"        , _run_debug_function            , "Runs system tests which displays useful information for debugging"])
+    run_options.append([None                , "module_debug" , _run_module_debug_function     , "Gives debug info on selected module and DUT"])
+    run_options.append([None                , "qcs"          , _run_qcs_function              , "Launches Quarch Compliance Suite server"])
+    run_options.append(["calibration_tool"  , "calibration"  , _run_calibration_function      , "Runs the Quarch power module calibration tool"])
+    run_options.append([None                , "qis"          , _run_qis_function              ,"Launches Quarch Instrument Server for communication with Quarch power modules"])
+    run_options.append([None                , "qps"          , _run_qps_function              , "Launches Quarch Power Studios, for power capture and analysis"])
+    run_options.append(["simple_terminal"   , "terminal"     , _run_simple_terminal_function  , "Runs the Simple Terminal script"])
+    run_options.append(["upgrade_quarchpy"  , "upgrade"      , _run_upgrade_function          , "Detects if an update of Quarchpy is available and assists in the upgrade process"])
+    run_options.append(["fix_permissions"   , "fix_perm"     , _run_fix_permissions           , "Fixes Permissions for running Java 21 programs"])
+    run_options.append(["h"                 , "help"         , _run_help_function             , "Displays the help screen with a list of commands supported"])
+    run_options.append(["dd"                , "list_drives"  , _run_show_drives_function      , "Displays a list of shown drives on the current system"])
+    run_options.append([None                , "install_qps"  , _run_install_missing_components, "Displays a list of shown drives on the current system"])
 
     return run_options
 
-def _run_simple_terminal_function(args=None):
+
+def _run_simple_terminal_function(args=[]):
     """
     Runs the Simple Terminal script
 
     Parameters
     ----------
-    None
+    args : list[str]
+        List of sub arguments to process
     """
     simple_terminal_main()
 
-def _run_debug_function(args=None):
+
+def _run_debug_function(args=[]):
     """
     Executes the python debug/system test option, returning details of the installation to the user
     for debug purposes
@@ -107,7 +129,8 @@ def _run_debug_function(args=None):
 
     systemTestMain(args)
 
-def _run_module_debug_function(args=None):
+
+def _run_module_debug_function(args=[]):
     """
     Executes the python debug/system test option, returning details of the installation to the user
     for debug purposes
@@ -121,7 +144,8 @@ def _run_module_debug_function(args=None):
 
     moduleDebugMain(args)
 
-def _run_show_drives_function(args=None):
+
+def _run_show_drives_function(args=[]):
     """
     Shows a list of current found drives to the user.
 
@@ -138,12 +162,13 @@ def _run_show_drives_function(args=None):
         host_info = HostInformation()
         host_info.display_drives()
     except ImportError as err:
-        logging.error(err)
-        logging.error("Drive detection is now in the QCS standalone package. Please install the QCS package via:")
-        logging.error("'Pip install quarchQCS'")
-        logging.error("Then retry this command")
+        logger.error(err)
+        logger.error("Drive detection is now in the QCS standalone package. Please install the QCS package via:")
+        logger.error("'Pip install quarchQCS'")
+        logger.error("Then retry this command")
 
-def _run_qcs_function(args=None):
+
+def _run_qcs_function(args=[]):
     """
     Executes the QCS server back end process
 
@@ -160,13 +185,13 @@ def _run_qcs_function(args=None):
         from QuarchpyQCS.driveTestCore import main as driveTestCoreMain
         driveTestCoreMain(args)
     except ImportError as err:
-        logging.error(err)
-        logging.error("QCS is now a standalone package. Please install the QCS package via:")
-        logging.error("'Pip install quarchQCS'")
-        logging.error("Then retry this command")
+        logger.error(err)
+        logger.error("QCS is now a standalone package. Please install the QCS package via:")
+        logger.error("'Pip install quarchQCS'")
+        logger.error("Then retry this command")
 
 
-def _run_qis_function(args=None):
+def _run_qis_function(args=[]):
     """
     Executes Quarch Instrumentation Server
 
@@ -177,22 +202,22 @@ def _run_qis_function(args=None):
 
     """
     shutdown = False
-    if args != None:
+    if args is not None:
         for arg in args:
             if "-shutdown" in arg:
                 shutdown = True
-                if isQisRunning() == True:
+                if isQisRunning():
                     printText("Closing QIS")
                     closeQIS()
                     break
                 else:
                     printText("QIS is not running")
 
-    if shutdown is False:
+    if not shutdown:
         startLocalQis(args=args)
 
 
-def _run_qps_function(args=None):
+def _run_qps_function(args=[]):
     """
     Executes Quarch Power Studio
 
@@ -203,22 +228,22 @@ def _run_qps_function(args=None):
 
     """
     shutdown = False
-    if args != None:
+    if args is not None:
         for arg in args:
             if "-shutdown" in arg:
                 shutdown = True
-                if isQpsRunning() == True:
+                if isQpsRunning():
                     printText("Closing QPS")
                     closeQPS()
                     break
                 else:
                     printText("QPS is not running")
 
-    if shutdown is False:
+    if not shutdown:
         startLocalQps(args=args)
 
 
-def _run_calibration_function(args=None):
+def _run_calibration_function(args=[]):
     """
     Executes the calibration utility for power modules
 
@@ -233,17 +258,13 @@ def _run_calibration_function(args=None):
         retVal = calibrationUtilMain(args)
         return retVal
     except ImportError as err:
-        #TODO check err for a more specific "quarchCalibration" cannot be found rather than a generic import error
-
-        logging.error("Quarch Calibration is now in the quarchCalibration package. Please install the quarchCalibration package via:")
-        logging.error("'pip install quarchCalibration'")
-        logging.error("Then retry this command")
+        logger.error("Quarch Calibration is now in the quarchCalibration package. Please install the quarchCalibration package via:")
+        logger.error("'pip install quarchCalibration'")
+        logger.error("Then retry this command")
         traceback.print_exc()
 
 
-
-
-def _run_upgrade_function(args=None):
+def _run_upgrade_function(args=[]):
     """
     Checks for updates to quarchpy and runs the update process if required
 
@@ -257,7 +278,20 @@ def _run_upgrade_function(args=None):
     uprade_quarchpy_main(args)
 
 
-def _run_help_function(args=None):
+def _run_fix_permissions(args):
+    """
+    Fixes excecution permissions for running quarch java 21 applications.
+
+    Parameters
+    ----------
+    args : list[str]
+        List of sub arguments to process
+    """
+    from quarchpy.connection_specific.jdk_jres.fix_permissions import main as fix_permissions_main
+    fix_permissions_main()
+
+
+def _run_help_function(args=[]):
     """
     Shows the quarchpy.run help screen
 
@@ -272,11 +306,24 @@ def _run_help_function(args=None):
     # Iterate through all of the possible commands and print a nice help string for each
     run_options = _get_run_options()
     display_options = []
-    for item in run_options:        
-        short_name = item[1]        
+    for item in run_options:
+        short_name = item[1]
         description = item[3]
-        display_options.append([short_name,description])
+        display_options.append([short_name, description])
     displayTable(display_options, align="l", tableHeaders=["Command", "Description"])
 
+
+def _run_install_missing_components(args):
+    """
+    Attempts to find QPS + Required JDK JRE Binaries and install them if required.
+
+    Parameters
+    ----------
+    args : list[str]
+        List of sub arguments to process
+    """
+    find_qps()
+
+
 if __name__ == "__main__":
-    main (sys.argv[1:])
+    main(sys.argv[1:])