plantstar-shared 2.0.3.0.2.8__py3-none-any.whl → 2.0.3.0.2.10__py3-none-any.whl

plantstar_shared/convert_bytes_to_object.py

@@ -2,9 +2,9 @@ import msgpack
 
 from plantstar_shared.errors import SocketConnectionError
 
+
 # Converts bytes into an object using msgpack, with a parameter for strict_map_key
 def convert_bytes_to_object(object_as_bytes, strict_map_key=False):
-    
     if not object_as_bytes:
         raise SocketConnectionError
     

plantstar_shared/tcp_socket_utils.py

@@ -2,37 +2,75 @@ import struct
 
 from plantstar_shared.convert_bytes_to_object import convert_bytes_to_object
 from plantstar_shared.convert_object_to_bytes import convert_object_to_bytes
-from plantstar_shared.errors import SocketConnectionError
+from plantstar_shared.errors import SocketConnectionError, SysconProgrammingError
 
-SIZE_OF_UNSIGNED_INT_STRUCT = 4
+SIZE_OF_UNSIGNED_INT_STRUCT = 4  # size of integer value that precedes data coming from DCM
 
 
-def read_size_value_from_socket(*, remote_socket):
-    size_struct = remote_socket.recv(SIZE_OF_UNSIGNED_INT_STRUCT)
+def read_size_value_from_socket(*, remote_socket, is_big_endian, number_of_bytes_for_size_prefix):
+    size_bytes = remote_socket.recv(number_of_bytes_for_size_prefix)
 
-    if not size_struct:
+    if not size_bytes:
         return None
 
-    try:
-        message_length = struct.unpack('>I', size_struct)[0]
-    except struct.error as error:
-        raise SocketConnectionError
+    if number_of_bytes_for_size_prefix == 2:
+        message_length = int.from_bytes(size_bytes, 'big') if is_big_endian else int.from_bytes(size_bytes, 'little')
+    elif number_of_bytes_for_size_prefix == SIZE_OF_UNSIGNED_INT_STRUCT:
+        number_format = ">I" if is_big_endian else "<I"
+
+        try:
+            message_length = struct.unpack(number_format, size_bytes)[0]
+        except struct.error as error:
+            raise SocketConnectionError
+    else:
+        raise SysconProgrammingError("A size prefix was set to something other than 2 or 4")
 
     return message_length
 
 
-def get_message_from_socket(*, remote_socket):
-    message_length = read_size_value_from_socket(remote_socket=remote_socket)
+def get_bytes_from_socket(*, remote_socket, number_of_bytes_to_read=None, is_big_endian=True, number_of_bytes_for_size_prefix=0, should_remove_prefix_size_from_read=False):
+    """Obtains a number of bytes from a provided socket, with options for different configurations and situations
 
-    if not message_length:
-        return None
+    Keywords / Example Configurations:
+        remote_socket -- the connection that bytes will be read from
+
+        number_of_bytes_to_read -- the number of bytes to read on the socket, if this is known, this is the only optional parameter needed (default: 0)
+
+        is_big_endian -- bool that determines what format string should be used for unpacking the size value (default: True)
+
+        number_of_bytes_for_size_prefix -- the number of bytes to read to determine the total size of the message to pass (default: 0)
+
+        should_remove_prefix_size_from_read -- bool that determines if the size should be removed from the calculated number of bytes to read (default: False)
+
+        -----
+
+        get_bytes_from_socket(remote_socket=conn, number_of_bytes_to_read=100) - likely would not be called directly, in most cases
+
+        get_bytes_from_socket(remote_socket=conn, is_big_endian=True, number_of_bytes_for_size_prefix=4) - reads 4 bytes to get the size, then reads that amount (DCM socket, etc)
+
+        get_bytes_from_socket(remote_socket=conn, is_big_endian=False, number_of_bytes_for_size_prefix=2, should_remove_prefix_size_from_read=True) - reads 2 bytes to get the size,
+        then reads that calculated amount minus 2 (Husky socket, etc)
+
+    """
+
+    if not number_of_bytes_to_read:
+        if number_of_bytes_for_size_prefix:
+            number_of_bytes_to_read = read_size_value_from_socket(
+                remote_socket=remote_socket, is_big_endian=is_big_endian, number_of_bytes_for_size_prefix=number_of_bytes_for_size_prefix
+            )
+
+    if not number_of_bytes_to_read:
+        raise SysconProgrammingError("get_bytes_from_socket was called with no parameters for number_of_bytes_to_read or number_of_bytes_for_size_prefix")
+
+    if should_remove_prefix_size_from_read:
+        number_of_bytes_to_read = number_of_bytes_to_read - number_of_bytes_for_size_prefix
 
     packets = []
     bytes_received = 0
 
     # While loop that will stream in data if the full request is not available yet
-    while bytes_received < message_length:
-        buffer_size = message_length - bytes_received
+    while bytes_received < number_of_bytes_to_read:
+        buffer_size = number_of_bytes_to_read - bytes_received
         packet = remote_socket.recv(buffer_size)
 
         if not packet:
@@ -62,7 +100,13 @@ def send_encoded_message_on_socket(*, remote_socket, encoded_message):
         bytes_sent += new_bytes_sent
 
 
-def get_object_from_socket(*, remote_socket):
-    object_from_interface_as_bytes = get_message_from_socket(remote_socket=remote_socket)
+def get_object_from_socket(
+    *, remote_socket, number_of_bytes_to_read=None, is_big_endian=True, number_of_bytes_for_size_prefix=SIZE_OF_UNSIGNED_INT_STRUCT, should_remove_prefix_size_from_read=False
+):
+    """Function that is used between the APU and DCM to send dictionaries """
+    object_from_interface_as_bytes = get_bytes_from_socket(
+        remote_socket=remote_socket, number_of_bytes_to_read=number_of_bytes_to_read, is_big_endian=is_big_endian, number_of_bytes_for_size_prefix=number_of_bytes_for_size_prefix,
+        should_remove_prefix_size_from_read=should_remove_prefix_size_from_read
+    )
     object_from_interface = convert_bytes_to_object(object_from_interface_as_bytes)
     return object_from_interface

{plantstar_shared-2.0.3.0.2.8.dist-info → plantstar_shared-2.0.3.0.2.10.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: plantstar-shared
-Version: 2.0.3.0.2.8
+Version: 2.0.3.0.2.10
 Summary: Shared code used in plantstar_apu and plantstar_dcm
 Home-page: https://github.com/SYSCON-International/plantstar_shared
 Author: SYSCON International

{plantstar_shared-2.0.3.0.2.8.dist-info → plantstar_shared-2.0.3.0.2.10.dist-info}/RECORD

@@ -6,7 +6,7 @@ plantstar_shared/SysconType.py,sha256=6Ae9F0fBr0vpXAmP8fYqoWyFUGTEECtS55zAYMkeKl
 plantstar_shared/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
 plantstar_shared/add_size_onto_string_and_return.py,sha256=j7XSs5ubKKo5LCMVljzZudK2nw8CZh-zMSLT_t30aGg,385
 plantstar_shared/api_types.py,sha256=gKN2LmUFBcpa7gJSNwCJ0eSv4IqkIP01pCLfy8-mT50,5001
-plantstar_shared/convert_bytes_to_object.py,sha256=MVOKqJJeUjvEKJL_ELNPkxZEgqwlk3zT8CwfVtpwOgU,409
+plantstar_shared/convert_bytes_to_object.py,sha256=YKf410EWUpeyyeBhJ3kl6PYIAcHJKKkhp8JkE-CuSv0,405
 plantstar_shared/convert_object_to_bytes.py,sha256=vVS3dKkPynOJ2NV2LgLHdEOZflK_0hhdS-NuU_gcfHs,206
 plantstar_shared/errors.py,sha256=qEUHh2d7pqZHoag6YJjnVfRWzWAzjuyGZH7stT_-Nzk,341
 plantstar_shared/global_definitions.py,sha256=mj59nU21DYza4XgZQxLX2lTvJYooN_-ZFrh8SVXFBRs,1153
@@ -14,8 +14,8 @@ plantstar_shared/is_valid_signed_string.py,sha256=5ZiEsPRz30J8yxN4A1dHq-hlz7VI9r
 plantstar_shared/obtain_raw_data_processor_function_for_action_name.py,sha256=DYo307PraRRD8zGiSO6Fn03bZ4X9aDOYV9rwaRm8mXM,1134
 plantstar_shared/syscon_image_field.py,sha256=GlTTudqFT5EsWM5sPRO0p5SDascX7gI1BEOeF1OG7Tw,441
 plantstar_shared/syscon_json.py,sha256=8OG9_55d52V9e2fFNguDtQ_pnw1YwyYsg2pnUkhjW6g,4213
-plantstar_shared/tcp_socket_utils.py,sha256=sI5IJXMTsQuTPzm8V5T1nsY5aMF-78zGL69aIDLCD_A,2250
-plantstar_shared-2.0.3.0.2.8.dist-info/METADATA,sha256=1QDXF2nl6RkCT0t3JpHJezBnojrHM2ei6QfvrrBQUf0,658
-plantstar_shared-2.0.3.0.2.8.dist-info/WHEEL,sha256=oiQVh_5PnQM0E3gPdiz09WCNmwiHDMaGer_elqB3coM,92
-plantstar_shared-2.0.3.0.2.8.dist-info/top_level.txt,sha256=9ZTCr_aP1GqYGt7EVmlSIUF72bdMZErapyhbik-MWVQ,17
-plantstar_shared-2.0.3.0.2.8.dist-info/RECORD,,
+plantstar_shared/tcp_socket_utils.py,sha256=uQ_Jhw1JVGtFD44AN7qnQo9mHor_lvPu2vr0yLBpd3Q,5312
+plantstar_shared-2.0.3.0.2.10.dist-info/METADATA,sha256=1Ny-4BV00AclXLq-V9Pf5f7dKCZyv1FMHR_bCNGrjHg,659
+plantstar_shared-2.0.3.0.2.10.dist-info/WHEEL,sha256=GJ7t_kWBFywbagK5eo9IoUwLW6oyOeTKmQ-9iHFVNxQ,92
+plantstar_shared-2.0.3.0.2.10.dist-info/top_level.txt,sha256=9ZTCr_aP1GqYGt7EVmlSIUF72bdMZErapyhbik-MWVQ,17
+plantstar_shared-2.0.3.0.2.10.dist-info/RECORD,,

{plantstar_shared-2.0.3.0.2.8.dist-info → plantstar_shared-2.0.3.0.2.10.dist-info}/WHEEL

@@ -1,5 +1,5 @@
 Wheel-Version: 1.0
-Generator: bdist_wheel (0.42.0)
+Generator: bdist_wheel (0.43.0)
 Root-Is-Purelib: true
 Tag: py3-none-any