removed _DESC_ATTR_KEYS; the loop now iterates over message.attrs.items() and stamps every entry into the desc XML

Author: cboulay

src/ezmsg/lsl/outlet.py

@@ -43,31 +43,17 @@ def generate_source_id(
     return hashlib.sha256(combined.encode()).hexdigest()[:16]
 
 
-# Stream-level attrs we promote to top-level desc XML elements when present
-# on the incoming AxisArray.  Sources upstream (e.g. ``Digitize``) stamp
-# these so consumers — pulling from the stream's desc XML — can recover an
-# approximation of the original float values via ``data * conversion +
-# offset`` (and label units accordingly).  Anything else stays on
-# ``message.attrs`` but doesn't ride the LSL XML.
-#
-# ``min_val`` / ``max_val`` aren't included: a consumer that has the data
-# dtype can derive them from ``conversion`` and ``offset``, so emitting
-# them would be redundant.
-_DESC_ATTR_KEYS = ("conversion", "offset", "unit")
-
-
 def populate_desc_from_axisarray(info: pylsl.StreamInfo, message: AxisArray, *, out_size: int) -> None:
     """Populate the ``desc`` of *info* from *message*'s metadata.
 
-    Stamps two kinds of metadata onto the StreamInfo description:
-    well-known stream-level attrs (see :data:`_DESC_ATTR_KEYS`) and
+    Stamps two kinds of metadata onto the StreamInfo description: all
+    stream-level ``message.attrs`` as top-level desc XML elements, and
     per-channel labels / structured-array fields from a ``"ch"``
     CoordinateAxis.
     """
     desc = info.desc()
-    for key in _DESC_ATTR_KEYS:
-        if key in message.attrs:
-            desc.append_child_value(key, str(message.attrs[key]))
+    for key, value in message.attrs.items():
+        desc.append_child_value(str(key), str(value))
 
     # Add channel metadata to the info desc.
     if "ch" in message.axes and isinstance(message.axes["ch"], AxisArray.CoordinateAxis):

tests/test_outlet_desc.py

@@ -5,8 +5,8 @@
 would touch the LSL network.  The function takes a fresh ``StreamInfo``
 and an :class:`AxisArray`, and writes both:
 
-* well-known stream-level ``attrs`` (``conversion``, ``offset``,
-  ``unit``) as top-level desc XML elements; and
+* every stream-level entry in ``message.attrs`` as a top-level desc XML
+  element; and
 * a per-channel ``<channel>`` block when the message's ``"ch"`` axis is
   a :class:`CoordinateAxis`.
 """
@@ -54,7 +54,7 @@ def _make_info(
 
 
 class TestStreamLevelAttrs:
-    def test_known_attrs_emitted_as_desc_children(self):
+    def test_attrs_emitted_as_desc_children(self):
         msg = _make_int16_msg(
             attrs={
                 "conversion": 0.000244,
@@ -65,7 +65,7 @@ def test_known_attrs_emitted_as_desc_children(self):
         info = _make_info()
         populate_desc_from_axisarray(info, msg, out_size=3)
         xml = info.as_xml()
-        # Each promoted attr appears as a top-level <key>value</key> in desc.
+        # Each attr appears as a top-level <key>value</key> in desc.
         assert "<conversion>0.000244</conversion>" in xml
         assert "<offset>0.0</offset>" in xml
         assert "<unit>a.u.</unit>" in xml
@@ -85,21 +85,16 @@ def test_missing_attrs_do_not_appear(self):
         assert "<offset>" not in xml
         assert "<unit>" not in xml
 
-    def test_non_known_attrs_are_dropped(self):
-        """Only the well-known attr keys ride the LSL XML.
-
-        Other AxisArray.attrs entries stay on the message but don't
-        appear in the stream descriptor, so the on-the-wire XML stays
-        bounded regardless of how the upstream graph populates attrs.
-        """
+    def test_arbitrary_attrs_ride_xml(self):
+        """All AxisArray.attrs entries land in the stream descriptor."""
         msg = _make_int16_msg(
-            attrs={"conversion": 0.5, "ignore_me": "private"},
+            attrs={"conversion": 0.5, "custom_key": "custom_value"},
         )
         info = _make_info()
         populate_desc_from_axisarray(info, msg, out_size=3)
         xml = info.as_xml()
         assert "<conversion>0.5</conversion>" in xml
-        assert "ignore_me" not in xml
+        assert "<custom_key>custom_value</custom_key>" in xml
 
 
 class TestPerChannelLabels: