Add support to load a file as little endian

Author: hkzlab

CHANGELOG.md

@@ -1,6 +1,10 @@
 # Changelog
 Changelog for dpdumperlib
 
+## [0.0.4] - 2024-09-28
+### Added
+- Parameter to set endianness of data loaded from file
+
 ## [0.0.3] - 2024-08-22
 ### Added
 - Keep a copy of non-remapped address and data arrays in the ICDefinition

dpdumperlib/io/file_utils.py

@@ -1,10 +1,11 @@
 """This file contains functions to aid with common file operations"""
 
 import os
-from typing import List
+from typing import List, Literal
 
-def load_file_data(in_file_path: str, bytes_per_entry: int) -> List[int]:
+def load_file_data(in_file_path: str, bytes_per_entry: int, reverse_byte_order: bool = False) -> List[int]:
     data_array: List[int] = []
+    endianness: Literal['big', 'little'] = 'little' if reverse_byte_order else 'big' 
 
     with open(in_file_path, "rb") as f:
         # Read the file size
@@ -18,6 +19,6 @@ def load_file_data(in_file_path: str, bytes_per_entry: int) -> List[int]:
         # Push data in an array
         data: bytes
         while (data := f.read(bytes_per_entry)):
-            data_array.append(int.from_bytes(data, byteorder='big', signed=False))
+            data_array.append(int.from_bytes(data, byteorder=endianness, signed=False))
 
     return data_array

pyproject.toml

@@ -4,7 +4,7 @@ build-backend = "setuptools.build_meta"
 
 [project]
 name = "dpdumperlib"
-version = "0.0.3"
+version = "0.0.4"
 description = "Library with some utility code for the dpdumper tool"
 authors = [
    { name = "Fabio Battaglia", email = "hkzlabnet@gmail.com" }

tests/test_file_utils.py

@@ -22,6 +22,11 @@ def test_loading_1K(filename_randomdata_1k):
 
     data_8B: List[int] = FileUtils.load_file_data(filename_randomdata_1k, 8)
     assert(len(data_8B) == 128)
+    assert(data_8B[0].to_bytes(length=8, byteorder='big', signed=False) == b'\xB2\x20\xA5\x60\x35\x3B\x63\x6D')
+    
+    data_8BLE: List[int] = FileUtils.load_file_data(filename_randomdata_1k, 8, reverse_byte_order=True)
+    assert(len(data_8BLE) == 128)
+    assert(data_8BLE[0].to_bytes(length=8, byteorder='little', signed=False) == b'\xB2\x20\xA5\x60\x35\x3B\x63\x6D')
 
     # Size of file is not divisible by 3
     with pytest.raises(Exception):