quarchpy 2.1.20.dev1__py2.py3-none-any.whl → 2.1.20.dev3__py2.py3-none-any.whl

quarchpy/run.py.bak

@@ -1,283 +0,0 @@
-"""
-This module allows specific quarchpy utilities and embedded applications to be run from the command line
-using the format:
-> python -m quarchpy.run [option]
-"""
-
-# 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.debug.simple_terminal import main as simple_terminal_main
-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)  
-
-def _parse_run_options(args):
-    """
-    Parses the command line argument supplied via the quarchpy.run command line option
-
-    Parameters
-    ----------
-    args : list[str]
-        List of arguments to process
-
-    """
-
-    found = False
-
-    # Arguments may not always be present
-    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):
-                found = True
-                item[2](args[1:])
-    else:
-        logging.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")
-        _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
-    
-    Returns
-    -------
-    options_list : list[list[object]]
-        List of call parameters, each of which is a list of objects making up the function description
-
-    """
-
-    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"])
-
-    return run_options
-
-def _run_simple_terminal_function(args=None):
-    """
-    Runs the Simple Terminal script
-
-    Parameters
-    ----------
-    None
-    """
-    simple_terminal_main()
-
-def _run_debug_function(args=None):
-    """
-    Executes the python debug/system test option, returning details of the installation to the user
-    for debug purposes
-
-    Parameters
-    ----------
-    args : list[str]
-        List of sub arguments to process
-
-    """
-
-    systemTestMain(args)
-
-def _run_module_debug_function(args=None):
-    """
-    Executes the python debug/system test option, returning details of the installation to the user
-    for debug purposes
-
-    Parameters
-    ----------
-    args : list[str]
-        List of sub arguments to process
-
-    """
-
-    moduleDebugMain(args)
-
-def _run_show_drives_function(args=None):
-    """
-    Shows a list of current found drives to the user.
-
-    Parameters
-    ----------
-    args : list[str]
-        List of sub arguments to process
-
-    """
-
-    try:
-        import QuarchpyQCS
-        from QuarchpyQCS.hostInformation import HostInformation
-        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")
-
-def _run_qcs_function(args=None):
-    """
-    Executes the QCS server back end process
-
-    Parameters
-    ----------
-    args : list[str]
-        List of sub arguments to process
-
-    """
-
-    try:
-        import QuarchpyQCS
-        # from QuarchpyQCS.driveTestCore import main as driveTestCoreMain
-        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")
-
-
-def _run_qis_function(args=None):
-    """
-    Executes Quarch Instrumentation Server
-
-    Parameters
-    ----------
-    args : list[str]
-        List of sub arguments to process
-
-    """
-    shutdown = False
-    if args != None:
-        for arg in args:
-            if "-shutdown" in arg:
-                shutdown = True
-                if isQisRunning() == True:
-                    printText("Closing QIS")
-                    closeQIS()
-                    break
-                else:
-                    printText("QIS is not running")
-
-    if shutdown is False:
-        startLocalQis(args=args)
-
-
-def _run_qps_function(args=None):
-    """
-    Executes Quarch Power Studio
-
-    Parameters
-    ----------
-    args : list[str]
-        List of sub arguments to process
-
-    """
-    shutdown = False
-    if args != None:
-        for arg in args:
-            if "-shutdown" in arg:
-                shutdown = True
-                if isQpsRunning() == True:
-                    printText("Closing QPS")
-                    closeQPS()
-                    break
-                else:
-                    printText("QPS is not running")
-
-    if shutdown is False:
-        startLocalQps(args=args)
-
-
-def _run_calibration_function(args=None):
-    """
-    Executes the calibration utility for power modules
-
-    Parameters
-    ----------
-    args : list[str]
-        List of sub arguments to process
-
-    """
-    try:
-        from quarchCalibration.calibrationUtil import main as calibrationUtilMain
-        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")
-        traceback.print_exc()
-
-
-
-
-def _run_upgrade_function(args=None):
-    """
-    Checks for updates to quarchpy and runs the update process if required
-
-    Parameters
-    ----------
-    args : list[str]
-        List of sub arguments to process
-
-    """
-
-    uprade_quarchpy_main(args)
-
-
-def _run_help_function(args=None):
-    """
-    Shows the quarchpy.run help screen
-
-    Parameters
-    ----------
-    args : list[str]
-        List of sub arguments to process
-
-    """
-
-    printText("quarchpy.run -[Command]")
-    # 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]        
-        description = item[3]
-        display_options.append([short_name,description])
-    displayTable(display_options, align="l", tableHeaders=["Command", "Description"])
-
-if __name__ == "__main__":
-    main (["qps"])
-    main (sys.argv[1:])