plantstar-shared 2.0.3.0.2.10__tar.gz → 2.0.3.0.2.11__tar.gz

{plantstar-shared-2.0.3.0.2.10 → plantstar-shared-2.0.3.0.2.11}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: plantstar-shared
-Version: 2.0.3.0.2.10
+Version: 2.0.3.0.2.11
 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.10 → plantstar-shared-2.0.3.0.2.11}/plantstar_shared/tcp_socket_utils.py

@@ -4,6 +4,7 @@ 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, SysconProgrammingError
 
+SIZE_OF_UNSIGNED_INT_FOR_HUSKY = 2  # size of integer value that preceds data coming from Husky OIs
 SIZE_OF_UNSIGNED_INT_STRUCT = 4  # size of integer value that precedes data coming from DCM
 
 
@@ -11,25 +12,26 @@ def read_size_value_from_socket(*, remote_socket, is_big_endian, number_of_bytes
     size_bytes = remote_socket.recv(number_of_bytes_for_size_prefix)
 
     if not size_bytes:
-        return None
+        return None, None
 
-    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')
+    if number_of_bytes_for_size_prefix == SIZE_OF_UNSIGNED_INT_FOR_HUSKY:
+        size_for_message = 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]
+            size_for_message = 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
+    return size_for_message, size_bytes
 
 
-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
+def get_bytes_from_socket(*, remote_socket, number_of_bytes_to_read=None, is_big_endian=True, number_of_bytes_for_size_prefix=0):
+    """Obtains a number of bytes from a provided socket, with options for different configurations and situations.
+    Returns byte sequence, and the size value that was obtained from the prefix bytes.
 
     Keywords / Example Configurations:
         remote_socket -- the connection that bytes will be read from
@@ -55,15 +57,14 @@ def get_bytes_from_socket(*, remote_socket, number_of_bytes_to_read=None, is_big
 
     if not number_of_bytes_to_read:
         if number_of_bytes_for_size_prefix:
-            number_of_bytes_to_read = read_size_value_from_socket(
+            number_of_bytes_to_read, size_bytes = 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
+            if not number_of_bytes_to_read:
+                return None, None
+        else:
+            raise SysconProgrammingError("get_bytes_from_socket was called with no parameters for number_of_bytes_to_read or number_of_bytes_for_size_prefix")
 
     packets = []
     bytes_received = 0
@@ -74,13 +75,13 @@ def get_bytes_from_socket(*, remote_socket, number_of_bytes_to_read=None, is_big
         packet = remote_socket.recv(buffer_size)
 
         if not packet:
-            return None
+            return None, number_of_bytes_to_read
 
         packets.append(packet)
         bytes_received = bytes_received + len(packet)
 
     data = b''.join(packets)
-    return data
+    return data, number_of_bytes_to_read
 
 
 def send_message_on_socket(*, remote_socket, dumpsable_object):
@@ -104,9 +105,12 @@ 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_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
     )
+
+    if not object_from_interface_as_bytes:
+        return None
+
     object_from_interface = convert_bytes_to_object(object_from_interface_as_bytes)
     return object_from_interface

{plantstar-shared-2.0.3.0.2.10 → plantstar-shared-2.0.3.0.2.11}/plantstar_shared.egg-info/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: plantstar-shared
-Version: 2.0.3.0.2.10
+Version: 2.0.3.0.2.11
 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.10 → plantstar-shared-2.0.3.0.2.11}/setup.py

@@ -7,7 +7,7 @@ setuptools.setup(
     name="plantstar-shared",
     # MAJOR_MILESTONE_VERSION.MINOR_MILESTONE_VERSION.MAJOR_VERSION.MINOR_VERSION.HOTFIX_VERSION.SUBVERSION
     # The main version should stay as v2.0.3.0.x until we have passed that in the plantstar_apu/plantstar_dcm projects
-    version="2.0.3.0.2.10",
+    version="2.0.3.0.2.11",
     author="SYSCON International",
     author_email="dev@syscon-intl.com",
     description="Shared code used in plantstar_apu and plantstar_dcm",