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

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

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

@@ -4,8 +4,8 @@ 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
+SIZE_OF_UNSIGNED_INT_FOR_HUSKY = 2  # size of the integer value that precedes data coming from Husky OIs
+SIZE_OF_UNSIGNED_INT_STRUCT = 4  # size of the integer value that precedes data coming from most sockets (DeviceController, DCM, etc)
 
 
 def read_size_value_from_socket(*, remote_socket, is_big_endian, number_of_bytes_for_size_prefix):
@@ -102,15 +102,15 @@ def send_encoded_message_on_socket(*, remote_socket, encoded_message):
 
 
 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
+    *, remote_socket, number_of_bytes_to_read=None, is_big_endian=True, number_of_bytes_for_size_prefix=SIZE_OF_UNSIGNED_INT_STRUCT
 ):
-    """Function that is used between the APU and DCM to send dictionaries """
-    object_from_interface_as_bytes, _ = get_bytes_from_socket(
+    """Function that is used between the APU and DCM to send dictionaries. Returns a tuple of the object and its size in bytes."""
+    object_from_interface_as_bytes, size_of_object_in_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
+        return None, None
 
     object_from_interface = convert_bytes_to_object(object_from_interface_as_bytes)
-    return object_from_interface
+    return object_from_interface, size_of_object_in_bytes

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

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: plantstar-shared
-Version: 2.0.3.0.2.11
+Version: 2.0.3.0.2.13
 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.11 → plantstar-shared-2.0.3.0.2.13}/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.11",
+    version="2.0.3.0.2.13",
     author="SYSCON International",
     author_email="dev@syscon-intl.com",
     description="Shared code used in plantstar_apu and plantstar_dcm",