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

quarchpy/utilities/TestCenter.py

@@ -5,11 +5,12 @@ This is Quarch internal use only.  Each function uses the stdin/stdout to commun
 as such, communication is based on simple strings
 """
 
-#import testCenter
+# import testCenter
 from inspect import getframeinfo, stack
 import sys
 
-def setup (interface_name, *command_params):	
+
+def setup(interface_name, *command_params, stack_level=1):
     """
     Sets up a test interface, passing the interface parameters onto TestCenter to process
     
@@ -23,29 +24,30 @@ def setup (interface_name, *command_params):
     Returns
     -------
     setup_response : str
-        String returned from setup function. Generally "1" or "0" as a boolean success flag    
+        String returned from setup function. Generally "1" or "0" as a boolean success flag
+
+    """
 
-    """    
-    
     # Get stack info so we can track the calling function for reporting and debug
-    caller = getframeinfo(stack()[1][0])
+    caller = getframeinfo(stack()[stack_level][0])
 
     # Write the command and params to STDOUT
-    sys.stdout.write ("SETUP," + str(caller.filename) + "," + str(caller.lineno) + "," + interface_name + ",")
+    sys.stdout.write("SETUP," + str(caller.filename) + "," + str(caller.lineno) + "," + interface_name + ",")
     for index, item in enumerate(command_params):
-        if (index < len(command_params)-1):
-            sys.stdout.write ("\"" + item + "\"" + ",")
+        if index < len(command_params) - 1:
+            sys.stdout.write("\"" + item + "\"" + ",")
         else:
-            sys.stdout.write ("\"" + item)
+            sys.stdout.write("\"" + item)
 
-    sys.stdout.write ("\n")
+    sys.stdout.write("\n")
     sys.stdout.flush()
 
     # Read the response from STDIN as the function result
-    return sys.stdin.readline().strip();
-	
+    return sys.stdin.readline().strip()
+
+
 # Runs an interface setup function
-def testPoint (command_name, *command_params):
+def testPoint(command_name, *command_params, stack_level=1):
     """
     Runs a test point from the testcenter library functions
     
@@ -61,44 +63,37 @@ def testPoint (command_name, *command_params):
     test_response : str
         String returned from test function. This varies based on the TestPoint spec    
 
-    """  
+    """
 
-    # user_interface adds an extra level to the stack.
-    # TODO: This is non-optimal, perhaps some parameter or targetted test could be used instead
-    # to avoid failing a try/except on every test point? Why is this the only TestCenter function that has this check?
-    try:
-        caller = getframeinfo(stack()[2][0]) 
-    except:
-        caller = getframeinfo(stack()[1][0])
+    caller = getframeinfo(stack()[stack_level][0])
 
     # Write the command and params to STDOUT
-    sys.stdout.write ("TEST," + str(caller.filename) + "," + str(caller.lineno) + "," + command_name + ",")
+    sys.stdout.write("TEST," + str(caller.filename) + "," + str(caller.lineno) + "," + command_name + ",")
     for x in command_params:
-        sys.stdout.write ("\"" + x + "\"" + ",")
+        sys.stdout.write("\"" + x + "\"" + ",")
 
-    sys.stdout.write ("\n")
+    sys.stdout.write("\n")
     sys.stdout.flush()
 
     # Read the response from STDIN as the test response
-    return sys.stdin.readline().strip();
-	
+    return sys.stdin.readline().strip()
 
-def endTest():
+
+def endTest(stack_level=1):
     """
     Orders the end of the test.  This will terminate the test parser and disponse of any resources
     held by the test libraries (including quarch module connections)      
 
-    """  
+    """
 
-    caller = getframeinfo(stack()[1][0])
+    caller = getframeinfo(stack()[stack_level][0])
 
-    sys.stdout.write ("ENDTEST," + str(caller.filename) + "," + str(caller.lineno));
-    sys.stdout.write ("\n");
+    sys.stdout.write("ENDTEST," + str(caller.filename) + "," + str(caller.lineno))
+    sys.stdout.write("\n")
     sys.stdout.flush()
-	
-    
 
-def beginTestBlock (message_text):
+
+def beginTestBlock(message_text, stack_level=1):
     """
     Notes the start of a block of tests.  This allows multiple nested layers of related tests
     to improve readability of the results.  This has no effect on the test execution, only
@@ -114,21 +109,21 @@ def beginTestBlock (message_text):
     test_response : str
         String returned from test function. This will be "1" on success and "0" on error     
             
-    """  
+    """
 
-    caller = getframeinfo(stack()[1][0])
+    caller = getframeinfo(stack()[stack_level][0])
 
     # Write the command and params to STDOUT
-    sys.stdout.write ("BLOCK_START," + str(caller.filename) + "," + str(caller.lineno) + "," + "\"" + message_text + "\"")
-    sys.stdout.write ("\n")
+    sys.stdout.write(
+        "BLOCK_START," + str(caller.filename) + "," + str(caller.lineno) + "," + "\"" + message_text + "\"")
+    sys.stdout.write("\n")
     sys.stdout.flush()
 
     # Read the response from STDIN
     return sys.stdin.readline().strip()
-	
 
 
-def endTestBlock ():
+def endTestBlock(stack_level=1):
     """
     Notes the end of a block of tests.  This allows multiple nested layers of related tests
     to improve readability of the results.  This has no effect on the test execution, only
@@ -139,14 +134,38 @@ def endTestBlock ():
     test_response : str
         String returned from test function. This will be "1" on success and "0" on error      
             
-    """  
+    """
 
-    caller = getframeinfo(stack()[1][0])
+    caller = getframeinfo(stack()[stack_level][0])
 
     # Write the command and params to STDOUT
-    sys.stdout.write ("BLOCK_END," + str(caller.filename) + "," + str(caller.lineno) + "," + "\"")
-    sys.stdout.write ("\n")
+    sys.stdout.write("BLOCK_END," + str(caller.filename) + "," + str(caller.lineno) + "," + "\"")
+    sys.stdout.write("\n")
     sys.stdout.flush()
 
     # Read the response from STDIN
     return sys.stdin.readline().strip()
+
+
+def GetVariable(package: str, var_name: str) -> str:
+    """
+    Access a TestCenter user variable and return its value.
+
+    Args:
+        package: Name of the TestCenter package to access. UNUSED
+        var_name: Name of the string variable to return.
+
+    Returns:
+        The text of the stored variable.
+    """
+
+    # Get caller file and line number
+    caller = getframeinfo(stack()[stack_level][0])
+
+    # Write the command and params to STDOUT
+    print(f"GET_VARIABLE,{str(caller.filename)},{str(caller.lineno)},{var_name}")
+
+    # Read the response from STDIN
+    response = sys.stdin.readline().strip()
+
+    return response

quarchpy/utilities/TimeValue.py

@@ -3,6 +3,7 @@
 Implements a simple time class to simplify working with large time values
 """
 import logging
+logger = logging.getLogger(__name__)
 
 
 class TimeValue:
@@ -29,7 +30,7 @@ class TimeValue:
                     
             # Fail if we can't find the 2 sections
             if (split_char == 0 or split_char >= len(from_time_string)):
-                logging.error("Invalid time string, could not find the unit: " + from_time_string)
+                logger.error("Invalid time string, could not find the unit: " + from_time_string)
                 raise Exception ("Invalid time string, could not find the unit: " + from_time_string)
             
             # Get the time value as a number
@@ -39,13 +40,13 @@ class TimeValue:
             # Get the unit for the time
             unit_str = from_time_string[split_char:].strip()
             if (unit_str.lower() not in self.valid_units):
-                logging.error("Invalid time string, unit is not recognised: " + unit_str)
+                logger.error("Invalid time string, unit is not recognised: " + unit_str)
                 raise Exception ("Invalid time string, unit is not recognised: " + unit_str)
             self.time_unit = unit_str.lower()
             
     def __str__(self):
         if (self.time_value == None or self.time_unit == None):
-            logging.error("ERROR - Null Time Value, cannot return as string")
+            logger.error("ERROR - Null Time Value, cannot return as string")
             return "ERROR - Null Time Value"
         else:
             return str(self.time_value) + str(self.time_unit)

quarchpy/utilities/Version.py

@@ -0,0 +1,50 @@
+"""
+A utility class for versioning.
+"""
+
+import re
+
+try:
+    from typing import List
+except ImportError:
+    List = list  # For Python 2 compatibility
+
+class Version:
+    """
+    Support for Python package version numbering.
+    """
+
+    @staticmethod
+    def major_number(version_number_string):
+        """ Returns the version major number. """
+        major = int(Version.major_minor_patch_numbers(version_number_string)[0])
+        return major
+
+    @staticmethod
+    def minor_number(version_number_string):
+        """ Returns the version minor number. """
+        minor = int(Version.major_minor_patch_numbers(version_number_string)[1])
+        return minor
+
+    @staticmethod
+    def patch_number(version_number_string):
+        """ Returns the version patch number. """
+        patch = int(Version.major_minor_patch_numbers(version_number_string)[2])
+        return patch
+
+    @staticmethod
+    def major_minor_patch_numbers(version_number_string):
+        """ Returns the version patch number. """
+        v_list = re.split(r"\.", version_number_string)
+        return v_list
+
+    @staticmethod
+    def is_v1_ge_v2(v1, v2):
+        """ Returns true if v1 >= v2, else false. """
+        v1_version_list = Version.major_minor_patch_numbers(v1)
+        v2_version_list = Version.major_minor_patch_numbers(v2)
+        v1_version_number = int(''.join(v1_version_list))
+        v2_version_number = int(''.join(v2_version_list))
+        if v1_version_number >= v2_version_number:
+            return True
+        return False

{quarchpy-2.1.11.dev8.dist-info → quarchpy-2.2.17.dev1.dist-info}/METADATA

@@ -1,13 +1,11 @@
-Metadata-Version: 2.1
+Metadata-Version: 2.4
 Name: quarchpy
-Version: 2.1.11.dev8
+Version: 2.2.17.dev1
 Summary: This packpage offers Python support for Quarch Technology modules.
-Home-page: UNKNOWN
 Author: Quarch Technology ltd
 Author-email: support@quarch.com
 License: Quarch Technology ltd
 Keywords: quarch quarchpy torridon
-Platform: UNKNOWN
 Classifier: Intended Audience :: Information Technology
 Classifier: Intended Audience :: Developers
 Classifier: Natural Language :: English
@@ -18,7 +16,25 @@ Classifier: Programming Language :: Python
 Classifier: Topic :: Scientific/Engineering :: Information Analysis
 Classifier: Topic :: System
 Classifier: Topic :: System :: Power (UPS)
+Requires-Python: >=3.7
 Description-Content-Type: text/x-rst
+Requires-Dist: zeroconf>=0.23.0
+Requires-Dist: numpy
+Requires-Dist: pandas
+Requires-Dist: requests
+Requires-Dist: packaging
+Requires-Dist: quarchpy-binaries
+Requires-Dist: typing-extensions
+Dynamic: author
+Dynamic: author-email
+Dynamic: classifier
+Dynamic: description
+Dynamic: description-content-type
+Dynamic: keywords
+Dynamic: license
+Dynamic: requires-dist
+Dynamic: requires-python
+Dynamic: summary
 
 ====================
 Changelog (Quarchpy)
@@ -35,6 +51,156 @@ Quarchpy
 Change Log
 ----------
 
+
+2.2.16
+------
+- New QPS 1.50 and QIS 1.52
+
+2.2.15
+------
+- Bugfix for ">" appearing in qis output when streaming at max speed
+
+2.2.14
+------
+- New QPS 1.49 and QIS 1.51
+
+2.2.13
+------
+- New QPS 1.48 and QIS 1.50
+- Lightweight Quarchpy, QPS and QIS now downloaded on first use after install.
+- Minor bug fixes
+
+2.2.12
+------
+- Minor bug fix
+
+2.2.11
+------
+- Minor bug fix
+
+2.2.10
+------
+- Fix for new HDPPM FW discovery over eithernet
+- Minor bug fix
+
+2.2.9
+-----
+- New QPS 1.47 and QIS 1.49
+
+2.2.8
+-----
+- New QPS 1.46 and QIS 1.48
+
+2.2.7
+-----
+- Bug fix for QIS 1.47 missing lib for linux only 
+
+2.2.6
+-----
+- New QPS 1.45 and QIS 1.47
+
+2.2.5
+-----
+- Minor Bug fix and removal of redundant jar
+
+2.2.4
+-----
+- Update to Java libraries to run QPS
+- Removal of depracated libs saveing space
+
+2.2.3
+-----
+- Minor bug fix
+
+2.2.2
+-----
+- New QPS 1.44 and QIS 1.46
+- Added support for automatic creation of default synthetic channels when connecting to module via QIS
+- Minor bug fixes
+
+2.2.1
+-----
+- New QPS v1.43 and QIS v1.45 packaged with java 21 with no need for installed java.
+- Minor bug fixes
+
+2.2.0
+-----
+- New QPS v1.42 and QIS v1.44 packaged with java 21 with no need for installed java.
+- Minor bug fixes
+
+2.1.26
+------
+- minor bugfix
+
+2.1.25
+------
+- New QPS 1.40 and Qis 1.43
+- mdns scanning added to quarchpy
+
+2.1.24
+------
+- Yanked
+
+2.1.23
+------
+- QIS and QPS devices and interfaces can use sendCommand to send comannds to the modules and to the applications uniformly
+- Tidy up of print statments and comments.
+
+2.1.22
+------
+- QIS and QPS patch containing mDNS removal
+
+
+2.1.21
+------
+- New QPS v1.38 and QIS 1.41
+- Minor bug fixes
+
+2.1.20
+------
+- Improved direct IP scanning for quarch modules
+- New QPS v1.37 and QIS v1.40
+
+2.1.19
+------
+- Imporoved QIS streaming 
+- Bug fixes
+- Added zeroconf, numpy and pandas as requirements
+
+2.1.18
+------
+- Minor bug fix
+
+2.1.17
+------
+- Improved QIS QPS launching on Linux sytems
+- System debug for linux systems
+
+2.1.16
+------
+- FIO mb/s parsing
+- Improved QIS QPS launching
+
+2.1.15
+------
+- minor bug fix
+
+2.1.14
+------
+- minor bug fixes and logging improvements
+
+2.1.13
+------
+- New QPS v1.36
+- New QIS v1.39
+- minor bug fixes and logging improvements
+
+2.1.12
+------
+- New QPS v1.35
+- New QIS v1.38
+- minor bug fixes and removal of depracated code
+
 2.1.11
 ------
 - New QPS v1.32
@@ -72,7 +238,7 @@ Change Log
 2.1.3
 -----
 - New QPS v1.22
-- modules on the network can now be connected to using conType:QTLNumber eg. TCP:QTL1999-02-001. 
+- modules on the network can now be connected to using conType:QTLNumber eg. TCP:QTL1999-02-001
 - fixed QIS not closing with QPS when launch with by QPS
 - closeConnection added to QIS api
 - display table formats multiline items and handles empty cells
@@ -348,5 +514,3 @@ Change Log
 -----
 
 - Changes to object model
-
-