Merge pull request #248 from lasp/release/6.1

Post 6.1.2 merge to main

Author: medley56

.github/workflows/ci.yml

@@ -22,12 +22,6 @@ jobs:
 
   # Run unit and integration tests
   run-tests:
-    # Don't run for label additions
-    if: |
-      github.event_name != 'pull_request' ||
-      github.event.action == 'opened' ||
-      github.event.action == 'synchronize' ||
-      github.event.action == 'reopened'
     name: Test
     runs-on: ${{ matrix.os }}
     permissions:
@@ -68,12 +62,6 @@ jobs:
 
   # Run the example scripts and ensure there are no errors
   run-examples:
-    # Don't run for label additions
-    if: |
-      github.event_name != 'pull_request' ||
-      github.event.action == 'opened' ||
-      github.event.action == 'synchronize' ||
-      github.event.action == 'reopened'
     name: Run Examples
     runs-on: ubuntu-latest
     permissions:

CITATION.cff

@@ -1,7 +1,7 @@
 cff-version: 1.2.0
 title: 'space_packet_parser'
 type: software
-version: '6.1.1'
+version: '6.1.2'
 description: A CCSDS telemetry packet decoding library based on the XTCE packet format description standard.
 license: BSD-3-Clause
 abstract: The Space Packet Parser Python library is a generalized, configurable packet decoding library for CCSDS telemetry

docs/source/changelog.md

@@ -7,6 +7,10 @@ list and release milestones.
 
 Release notes for the `space_packet_parser` library
 
+### v6.1.2
+
+- BUGFIX: Prevent BinaryParameter truncation in `create_dataset`. [#246](https://github.com/lasp/space_packet_parser/issues/246)
+
 ### v6.1.1
 
 - BUGFIX: Support lxml 5.2.1. [#236](https://github.com/lasp/space_packet_parser/issues/236)

meta.yaml

@@ -1,6 +1,6 @@
 package:
   name: "space_packet_parser"
-  version: "6.1.1"
+  version: "6.1.2"
 
 source:
   path: .

pyproject.toml

@@ -1,6 +1,6 @@
 [project]
 name = "space_packet_parser"
-version = "6.1.1"
+version = "6.1.2"
 description = "A CCSDS telemetry packet decoding library based on the XTCE packet format description standard."
 license = { text = "BSD-3-Clause" }
 readme = "README.md"

space_packet_parser/xarr.py

@@ -255,12 +255,17 @@ def _process_generator(generator):
     dataset_by_apid = {}
 
     for apid, data in data_dict.items():
-        ds = xr.Dataset(
-            data_vars={
-                key: (["packet"], np.asarray(list_of_values, dtype=datatype_mapping[apid][key]))
-                for key, list_of_values in data.items()
-            }
-        )
+        data_vars: dict[str, tuple[list[str], np.ndarray]] = {}  # {var_name: ([dims, ...], data_array)}
+        for key, list_of_values in data.items():
+            dtype = np.dtype(datatype_mapping[apid][key])
+            if dtype.kind == "S":
+                # Special case for byte strings. np.asarray doesn't process BinaryParameter objects correctly to
+                # byte strings, so we need to convert them to bytes first before creating the array.
+                # See: https://github.com/lasp/space_packet_parser/issues/246
+                list_of_values = [bytes(val) for val in list_of_values]
+            data_vars[key] = (["packet"], np.asarray(list_of_values, dtype=dtype))
+
+        ds = xr.Dataset(data_vars=data_vars)
 
         dataset_by_apid[apid] = ds
 

tests/unit/test_xarr.py

@@ -178,6 +178,43 @@ def test_create_dataset_with_custom_generator(tmp_path, fixed_length_packet_defi
     assert list(dataset["INT32_FIELD"].values) == [12345, 67890, -99999]
 
 
+def test_create_dataset_preserves_binary_parameter_width(tmp_path):
+    """Test that binary parameters keep their full byte width in the resulting dataset."""
+    packet_definition = definitions.XtcePacketDefinition(
+        container_set=[
+            containers.SequenceContainer(
+                "BINARY_CONTAINER",
+                entry_list=[
+                    parameters.Parameter(
+                        "BIN_FIELD",
+                        parameter_type=parameter_types.BinaryParameterType(
+                            "BIN_TYPE", encoding=encodings.BinaryDataEncoding(fixed_size_in_bits=64)
+                        ),
+                    )
+                ],
+            )
+        ]
+    )
+    packet_data = b"ABCDEFGH"
+    test_file = tmp_path / "binary_packets.bin"
+    test_file.write_bytes(packet_data)
+
+    datasets = xarr.create_dataset(
+        test_file,
+        packet_definition,
+        packet_bytes_generator=fixed_length_generator,
+        generator_kwargs={"packet_length_bytes": 8},
+        parse_bytes_kwargs={"root_container_name": "BINARY_CONTAINER"},
+    )
+
+    dataset = list(datasets.values())[0]
+
+    assert dataset["BIN_FIELD"].values.dtype.kind == "S"  # Should be a bytes/string type
+    assert dataset["BIN_FIELD"].values.dtype.itemsize == 8
+    assert dataset["BIN_FIELD"].values.dtype == "|S8"
+    assert dataset["BIN_FIELD"].values.tolist() == [packet_data]
+
+
 def test_create_dataset_with_packet_filter(tmp_path, fixed_length_packet_definition, fixed_length_test_packets):
     """Test filtering packets with packet_filter parameter using raw byte inspection"""
     _, _, _, binary_data = fixed_length_test_packets