plantstar-shared 2.0.3.0.2.11__py3-none-any.whl → 2.0.3.0.2.12__py3-none-any.whl

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,10 +102,10 @@ 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
     )
 
@@ -113,4 +113,4 @@ def get_object_from_socket(
         return 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.dist-info → plantstar_shared-2.0.3.0.2.12.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: plantstar-shared
-Version: 2.0.3.0.2.11
+Version: 2.0.3.0.2.12
 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.dist-info → plantstar_shared-2.0.3.0.2.12.dist-info}/RECORD

@@ -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=uI_VQGj5wgbk8NVMDVYuE2uL-SFSUDyu-PenzIqXbfE,5482
-plantstar_shared-2.0.3.0.2.11.dist-info/METADATA,sha256=E5FT-SGeL_ujFnGUt3w8UFVfKhpgMKD3NBJbT8muAuE,659
-plantstar_shared-2.0.3.0.2.11.dist-info/WHEEL,sha256=GJ7t_kWBFywbagK5eo9IoUwLW6oyOeTKmQ-9iHFVNxQ,92
-plantstar_shared-2.0.3.0.2.11.dist-info/top_level.txt,sha256=9ZTCr_aP1GqYGt7EVmlSIUF72bdMZErapyhbik-MWVQ,17
-plantstar_shared-2.0.3.0.2.11.dist-info/RECORD,,
+plantstar_shared/tcp_socket_utils.py,sha256=bW4KSKSTZLWyivdVZ0cIH4CN5Kw92CNa2xMj3fIZ7_U,5586
+plantstar_shared-2.0.3.0.2.12.dist-info/METADATA,sha256=bjxjBORuN81GgyCFuQ7bxShD1Hbh7ot7TsxuZQnFuUo,659
+plantstar_shared-2.0.3.0.2.12.dist-info/WHEEL,sha256=GJ7t_kWBFywbagK5eo9IoUwLW6oyOeTKmQ-9iHFVNxQ,92
+plantstar_shared-2.0.3.0.2.12.dist-info/top_level.txt,sha256=9ZTCr_aP1GqYGt7EVmlSIUF72bdMZErapyhbik-MWVQ,17
+plantstar_shared-2.0.3.0.2.12.dist-info/RECORD,,