quarchpy.user_interface package

Submodules

quarchpy.user_interface.user_interface module

This module provides standard user interface elements to quarchpy functions, ensuring common style and support for both terminal and TestCenter (quarch internal) execution

class quarchpy.user_interface.user_interface.User_interface(ui)

Bases: object

This class is a singleton pattern and provides common access to the user interace for user interaction. The UI can be the terminal or TestCenter

instance = None

quarchpy.user_interface.user_interface.dictToList(tableData)

quarchpy.user_interface.user_interface.displayTable(tableData=[['']], message='', tableHeaders=None, indexReq=False, printToConsole=True, align='l')

quarchpy.user_interface.user_interface.endTestBlock()

quarchpy.user_interface.user_interface.get_check_valid_calPath(calPath, message='Enter the desired save path for the calibration report.')

quarchpy.user_interface.user_interface.is_user_admin()

quarchpy.user_interface.user_interface.listSelection(title='', message='', selectionList=[], additionalOptions=[], nice=False, tableHeaders=[], indexReq=True, align='l')

quarchpy.user_interface.user_interface.logCalibrationResult(title, report)

quarchpy.user_interface.user_interface.logResults(test, notes)

quarchpy.user_interface.user_interface.logSimpleResult(title, result)

quarchpy.user_interface.user_interface.niceListSelection(selectionList, title='', message='', tableHeaders=None, indexReq=True, additionalOptions=None, align='l')

quarchpy.user_interface.user_interface.printText(text, fillLine=False, terminalWidth=100, fill=' ', **kwargs)

quarchpy.user_interface.user_interface.progressBar(iteration, total, prefix='', suffix='', decimals=1, fill='█', fullWidth=100)

quarchpy.user_interface.user_interface.requestDialog(title='', message='', desiredType=None, minRange=None, maxRange=None, defaultUserInput='')

quarchpy.user_interface.user_interface.setup_logging(logLevel)

quarchpy.user_interface.user_interface.showDialog(message='', title='')

quarchpy.user_interface.user_interface.startTestBlock(text)

quarchpy.user_interface.user_interface.storeResult(message)

quarchpy.user_interface.user_interface.userRangeIntSelection(inputString, intLength=3)

quarchpy.user_interface.user_interface.validateUserInput(userStr, desiredType, minRange, maxRange)

Module contents

class quarchpy.user_interface.User_interface(ui)

Bases: object

This class is a singleton pattern and provides common access to the user interace for user interaction. The UI can be the terminal or TestCenter

instance = None

quarchpy.user_interface.listSelection(title='', message='', selectionList=[], additionalOptions=[], nice=False, tableHeaders=[], indexReq=True, align='l')

quarchpy.user_interface.printText(text, fillLine=False, terminalWidth=100, fill=' ', **kwargs)

quarchpy.user_interface.progressBar(iteration, total, prefix='', suffix='', decimals=1, fill='█', fullWidth=100)

quarchpy.user_interface.showDialog(message='', title='')

quarchpy.user_interface.logCalibrationResult(title, report)

quarchpy.user_interface.logSimpleResult(title, result)

quarchpy.user_interface.startTestBlock(text)

quarchpy.user_interface.endTestBlock()

quarchpy.user_interface.requestDialog(title='', message='', desiredType=None, minRange=None, maxRange=None, defaultUserInput='')

quarchpy.user_interface.validateUserInput(userStr, desiredType, minRange, maxRange)

quarchpy.user_interface.userRangeIntSelection(inputString, intLength=3)

quarchpy.user_interface.displayTable(tableData=[['']], message='', tableHeaders=None, indexReq=False, printToConsole=True, align='l')

quarchpy.user_interface.get_check_valid_calPath(calPath, message='Enter the desired save path for the calibration report.')