quarchpy.debug package

Submodules

quarchpy.debug.SystemTest module

quarchpy.debug.SystemTest.QuarchSimpleIdentify(device1)

Prints basic identification test data on the specified module, compatible with all Quarch devices

Parameters

device1 (quarchDevice) – Open connection to a quarch device

quarchpy.debug.SystemTest.fix_usb()
quarchpy.debug.SystemTest.get_QIS_version()

Returns the version of QIS. This is the version of QIS currenty running on the local system if one exists. Otherwise the local version within quarchpy will be exectued and its version returned.

Returns

version – String representation of the QIS version number

Return type

str

quarchpy.debug.SystemTest.get_java_location()

Returns the location of java.

Returns

location – String representation of the java location.

Return type

str

quarchpy.debug.SystemTest.get_quarchpy_version()
quarchpy.debug.SystemTest.main(args=None)

Main function to allow the system test to be called direct from the command line

quarchpy.debug.SystemTest.test_communication()
quarchpy.debug.SystemTest.test_system_info()

quarchpy.debug.upgrade_quarchpy module

Functions to allow automatic update and checking of the quarchpy package.

quarchpy.debug.upgrade_quarchpy.check_if_update(auto_update)

Checks if updated version is available on pip. Prompts for shutdown of QIS and QPS if they are open, as this will prevent the update from working

Parameters

auto_update (bool) – If True, QPS and QIS will be checked and shut down to prepare for update

quarchpy.debug.upgrade_quarchpy.main(argstring, auto_update=False)

Main function to allow access to access to the upgrade system from the command line

quarchpy.debug.upgrade_quarchpy.updateQuarchpy(versionNumber=None)

Requests an upgrade to the quarchpy package_list. Prints to the terminal

Parameters

versionNumber (str, optional) – Optional quarchpy version number in string form for previous/dev build access

quarchpy.debug.versionCompare module

Provides functions to compare quarchpy versions

quarchpy.debug.versionCompare.requiredQuarchpyVersion(requiredVersion)

Checks if the given (required) version is present. This is used by example scripts to ensure the features they use are supported by the installed package version

Parameters

requiredVersion (str) – String representation of the minimum quarchpy version required

Returns

safe_to_run – True if the minimum version requirement is met, otherwise false

Return type

bool

Module contents