ltcodecs 4.3.0__tar.gz → 4.3.1__tar.gz

{ltcodecs-4.3.0 → ltcodecs-4.3.1}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: ltcodecs
-Version: 4.3.0
+Version: 4.3.1
 Summary: LT Codecs: Lightweight codecs for use over low-throughput links
 Author: Woods Hole Oceanographic Institution, Acoustic Communications Group
 License: LGPL-3.0-or-later

{ltcodecs-4.3.0 → ltcodecs-4.3.1}/src/ltcodecs/__init__.py

@@ -10,6 +10,7 @@ from .bool_codec import BoolCodec
 from .string_codecs import AsciiStringCodec
 from .string_enum_codec import StringEnumCodec
 from .bytes_codec import BytesCodec
+from .metadata_field_codec import MetadataFieldCodec
 from .variable_len_array_codec import VariableLenArrayCodec
 from .fixed_len_array_codec import FixedLenArrayCodec
 from .dict_field_codec import DictFieldCodec

{ltcodecs-4.3.0 → ltcodecs-4.3.1}/src/ltcodecs/dict_field_codec.py

@@ -6,7 +6,6 @@ This module contains the field codec used for nested dictionaries.
 """
 
 from __future__ import annotations
-import operator
 from bitstring import BitArray, ConstBitStream
 
 from typing import Any, Dict
@@ -14,6 +13,7 @@ from typing import Any, Dict
 import ltcodecs as ltcodecs
 
 from .field_codec import FieldCodec
+from .metadata_field_codec import MetadataFieldCodec
 from .multiple_field_codec import MultipleFieldCodec
 from .exceptions import EncodingFailed
 
@@ -49,7 +49,7 @@ class DictFieldCodec(FieldCodec):
                         field_params["codec"]
                     ](**field_params)
                 else:
-                    self.field_codecs[field_name] = field_params["codec"]
+                    self.field_codecs[field_name] = MetadataFieldCodec(field_params["codec"])
             except KeyError as err:
                 raise KeyError(
                     f"Error parsing codec config for {field_name}. Got params:\n{field_params}\nError: {err}"
@@ -75,7 +75,7 @@ class DictFieldCodec(FieldCodec):
         encoded_dict = {}
         for field_name, field_params in self.fields.items():
             field_codec = self.field_codecs.get(field_name, None)
-            if not field_codec or isinstance(field_codec, str):
+            if not field_codec or isinstance(field_codec, MetadataFieldCodec):
                 continue
             try:
                 if isinstance(field_codec, MultipleFieldCodec):
@@ -110,18 +110,12 @@ class DictFieldCodec(FieldCodec):
             if not field_codec:
                 continue
 
-            if isinstance(field_codec, str):
+            if isinstance(field_codec, MetadataFieldCodec):
                 if not metadata:
                     continue
-                if field_codec in ltcodecs.metadata_decoders:
-                    metadata_attribute = ltcodecs.metadata_decoders[field_codec]
-                    if isinstance(metadata, dict):
-                        value = metadata
-                        for attr_part in metadata_attribute.split("."):
-                            value = value[attr_part]
-                    else:
-                        value = operator.attrgetter(metadata_attribute)(metadata)
-                    decoded_message[field_name] = value
+                decoded_message[field_name] = field_codec.decode_metadata(
+                    metadata, ltcodecs.metadata_decoders
+                )
                 continue
 
             if isinstance(field_codec, MultipleFieldCodec):
@@ -150,9 +144,9 @@ class DictFieldCodec(FieldCodec):
     @property
     def min_length_bits(self) -> int:
         """Minimum encoded dictionary field length."""
-        return sum([c.min_length_bits for c in self.field_codecs.values() if not isinstance(c, str)])
+        return sum([c.min_length_bits for c in self.field_codecs.values()])
 
     @property
     def max_length_bits(self) -> int:
         """Maximum encoded dictionary field length."""
-        return sum([c.max_length_bits for c in self.field_codecs.values() if not isinstance(c, str)])
+        return sum([c.max_length_bits for c in self.field_codecs.values()])

ltcodecs-4.3.1/src/ltcodecs/metadata_field_codec.py

@@ -0,0 +1,51 @@
+"""
+ltcodecs.metadata_field_codec
+-----------------------------
+
+This module contains the zero-bit field codec used for metadata aliases.
+"""
+
+from __future__ import annotations
+
+import operator
+from typing import Any, Dict
+
+from bitstring import BitArray, ConstBitStream
+
+from .field_codec import FieldCodec
+
+
+class MetadataFieldCodec(FieldCodec):
+    """
+    Zero-bit codec for fields decoded from packet metadata.
+
+    Metadata fields do not consume payload bits, but they still need to behave
+    like field codecs so aggregate codec properties can handle them uniformly.
+    """
+
+    def __init__(self, codec_name: str, **kwargs) -> None:
+        super().__init__(**kwargs)
+        self.codec_name = codec_name
+
+    def encode(self, value: Any) -> tuple[BitArray, Any]:
+        return BitArray(), value
+
+    def decode(self, bits_to_decode: ConstBitStream) -> None:
+        return None
+
+    def decode_metadata(self, metadata: Any, metadata_decoders: Dict[str, str]) -> Any:
+        metadata_attribute = metadata_decoders[self.codec_name]
+        if isinstance(metadata, dict):
+            value = metadata
+            for attr_part in metadata_attribute.split("."):
+                value = value[attr_part]
+            return value
+        return operator.attrgetter(metadata_attribute)(metadata)
+
+    @property
+    def min_length_bits(self) -> int:
+        return 0
+
+    @property
+    def max_length_bits(self) -> int:
+        return 0

{ltcodecs-4.3.0 → ltcodecs-4.3.1}/src/ltcodecs/ros_msg_field_codec.py

@@ -8,7 +8,6 @@ This module contains the field codec used for nested ROS messages.
 from __future__ import annotations
 import re
 from bitstring import ConstBitStream, BitArray
-import operator
 
 from typing import Union, Any, Dict
 import armw
@@ -16,6 +15,7 @@ import armw
 import ltcodecs as ltcodecs
 
 from .field_codec import FieldCodec
+from .metadata_field_codec import MetadataFieldCodec
 from .multiple_field_codec import MultipleFieldCodec
 from .exceptions import EncodingFailed
 
@@ -186,8 +186,7 @@ class RosMsgFieldCodec(FieldCodec):
                         field_params["codec"]
                     ](**field_params)
                 else:
-                    # The metadata codec is a string, which we use for a lookup later.
-                    self.field_codecs[field_name] = field_params["codec"]
+                    self.field_codecs[field_name] = MetadataFieldCodec(field_params["codec"])
             except KeyError as err:
                 raise KeyError(
                     f"Error parsing codec config for {field_name}.  Got params:\n{field_params}\nError: {err}"
@@ -224,7 +223,7 @@ class RosMsgFieldCodec(FieldCodec):
         for field_name, field_params in self.fields.items():
             field_codec = self.field_codecs.get(field_name, None)
             # Note that metadata encoding is done at the ros_msg_codec level, not here
-            if not field_codec or isinstance(field_codec, str):
+            if not field_codec or isinstance(field_codec, MetadataFieldCodec):
                 continue
             try:
                 if isinstance(field_codec, MultipleFieldCodec):
@@ -262,15 +261,14 @@ class RosMsgFieldCodec(FieldCodec):
                 continue
 
             # Handle metadata codecs
-            if isinstance(field_codec, str):
+            if isinstance(field_codec, MetadataFieldCodec):
                 if not metadata:
                     continue
                 try:
-                    if field_codec in ltcodecs.metadata_decoders:
-                        metadata_attribute = ltcodecs.metadata_decoders[field_codec]
-                        value = operator.attrgetter(metadata_attribute)(metadata)
-                        decoded_message[field_name] = value
-                        continue
+                    decoded_message[field_name] = field_codec.decode_metadata(
+                        metadata, ltcodecs.metadata_decoders
+                    )
+                    continue
                 except KeyError:
                     # if we don't recognize the metadata codec, just keep going
                     continue
@@ -302,6 +300,8 @@ class RosMsgFieldCodec(FieldCodec):
         decoded_message = {}
         for field_name, field_params in self.fields.items():
             field_codec = self.field_codecs[field_name]
+            if isinstance(field_codec, MetadataFieldCodec):
+                continue
             if hasattr(field_codec, "decode_as_dict"):
                 decoded_message[field_name] = field_codec.decode_as_dict(bits_to_decode)
             else:

{ltcodecs-4.3.0 → ltcodecs-4.3.1}/src/ltcodecs.egg-info/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: ltcodecs
-Version: 4.3.0
+Version: 4.3.1
 Summary: LT Codecs: Lightweight codecs for use over low-throughput links
 Author: Woods Hole Oceanographic Institution, Acoustic Communications Group
 License: LGPL-3.0-or-later

{ltcodecs-4.3.0 → ltcodecs-4.3.1}/src/ltcodecs.egg-info/SOURCES.txt

@@ -34,6 +34,7 @@ src/ltcodecs/float_codec.py
 src/ltcodecs/ieee_float_codec.py
 src/ltcodecs/linspace_float_codec.py
 src/ltcodecs/lzma_codec.py
+src/ltcodecs/metadata_field_codec.py
 src/ltcodecs/multiple_field_codec.py
 src/ltcodecs/optional_field_codec.py
 src/ltcodecs/padding_codec.py

{ltcodecs-4.3.0 → ltcodecs-4.3.1}/src/ltcodecs.egg-info/scm_file_list.json

@@ -1,55 +1,56 @@
 {
   "files": [
-    "README.md",
-    "LICENSE",
-    "requirements.txt",
-    "CONTRIBUTING.md",
-    ".gitlab-ci.yml",
     ".gitignore",
+    ".gitlab-ci.yml",
+    ".gitlab/merge_request_templates/Default.md",
+    "CONTRIBUTING.md",
+    "LICENSE",
+    "README.md",
+    "docs/Makefile",
+    "docs/codec_configs.rst",
+    "docs/conf.py",
+    "docs/index.rst",
+    "docs/quickstart.rst",
+    "docs/reference/codec_aliases.rst",
+    "docs/reference/codecs.rst",
+    "docs/reference/config_schema.rst",
+    "docs/reference/python_api.rst",
+    "docs/requirements.txt",
+    "docs/ros_messages.rst",
+    "docs/tests.rst",
     "pyproject.toml",
-    "src/ltcodecs/exponentialgolomb_integer_codec.py",
+    "requirements.txt",
+    "src/ltcodecs/__init__.py",
+    "src/ltcodecs/bool_codec.py",
+    "src/ltcodecs/bytes_codec.py",
+    "src/ltcodecs/ccl_latlon_bcd_codec.py",
+    "src/ltcodecs/ccl_latlon_codec.py",
     "src/ltcodecs/dict_codec.py",
+    "src/ltcodecs/dict_field_codec.py",
     "src/ltcodecs/exceptions.py",
+    "src/ltcodecs/exponentialgolomb_integer_codec.py",
     "src/ltcodecs/field_codec.py",
-    "src/ltcodecs/ros_msg_field_codec.py",
-    "src/ltcodecs/linspace_float_codec.py",
+    "src/ltcodecs/fixed_len_array_codec.py",
+    "src/ltcodecs/fixedint_codec.py",
     "src/ltcodecs/float_codec.py",
+    "src/ltcodecs/ieee_float_codec.py",
+    "src/ltcodecs/linspace_float_codec.py",
+    "src/ltcodecs/lzma_codec.py",
+    "src/ltcodecs/metadata_field_codec.py",
+    "src/ltcodecs/multiple_field_codec.py",
+    "src/ltcodecs/optional_field_codec.py",
+    "src/ltcodecs/padding_codec.py",
     "src/ltcodecs/ros_message_codec.py",
+    "src/ltcodecs/ros_msg_field_codec.py",
     "src/ltcodecs/rostime_codec.py",
-    "src/ltcodecs/ccl_latlon_codec.py",
-    "src/ltcodecs/bytes_codec.py",
-    "src/ltcodecs/__init__.py",
-    "src/ltcodecs/multiple_field_codec.py",
-    "src/ltcodecs/dict_field_codec.py",
+    "src/ltcodecs/string_codecs.py",
     "src/ltcodecs/string_enum_codec.py",
-    "src/ltcodecs/fixedint_codec.py",
-    "src/ltcodecs/varint_codec.py",
-    "src/ltcodecs/ccl_latlon_bcd_codec.py",
-    "src/ltcodecs/lzma_codec.py",
-    "src/ltcodecs/ieee_float_codec.py",
-    "src/ltcodecs/fixed_len_array_codec.py",
     "src/ltcodecs/variable_len_array_codec.py",
-    "src/ltcodecs/padding_codec.py",
-    "src/ltcodecs/optional_field_codec.py",
-    "src/ltcodecs/string_codecs.py",
-    "src/ltcodecs/bool_codec.py",
-    "docs/codec_configs.rst",
-    "docs/conf.py",
-    "docs/ros_messages.rst",
-    "docs/requirements.txt",
-    "docs/index.rst",
-    "docs/quickstart.rst",
-    "docs/Makefile",
-    "docs/tests.rst",
-    "docs/reference/codec_aliases.rst",
-    "docs/reference/config_schema.rst",
-    "docs/reference/python_api.rst",
-    "docs/reference/codecs.rst",
-    ".gitlab/merge_request_templates/Default.md",
-    "tests/string_msg_codec.yaml",
-    "tests/test_dict_codec.py",
-    "tests/dict_codec.yaml",
+    "src/ltcodecs/varint_codec.py",
     "tests/__init__.py",
-    "tests/test_codecs.py"
+    "tests/dict_codec.yaml",
+    "tests/string_msg_codec.yaml",
+    "tests/test_codecs.py",
+    "tests/test_dict_codec.py"
   ]
 }

ltcodecs-4.3.1/src/ltcodecs.egg-info/scm_version.json

@@ -0,0 +1,8 @@
+{
+  "tag": "4.3.1",
+  "distance": 0,
+  "node": "gb95b17684296152051461fbb7c2cd01de1841f07",
+  "dirty": false,
+  "branch": "HEAD",
+  "node_date": "2026-08-13"
+}

{ltcodecs-4.3.0 → ltcodecs-4.3.1}/tests/test_dict_codec.py

@@ -102,3 +102,36 @@ def test_dict_codec_with_checksum() -> None:
     decoded_msg = codec.decode(bit_stream)
 
     assert decoded_msg == input_dict
+
+
+def test_dict_codec_metadata_fields_are_zero_length_codecs() -> None:
+    """test metadata fields implement the field codec length properties"""
+    codec = ltcodecs.DictCodec(
+        {
+            "src": {"codec": "src"},
+            "count": {"codec": "integer", "min_value": 0, "max_value": 100},
+        }
+    )
+
+    count_codec = ltcodecs.VarintCodec(0, 100)
+
+    assert codec.min_length_bits == count_codec.min_length_bits
+    assert codec.max_length_bits == count_codec.max_length_bits
+    assert codec.root_field_codec.field_codecs["src"].min_length_bits == 0
+    assert codec.root_field_codec.field_codecs["src"].max_length_bits == 0
+
+
+def test_dict_codec_decodes_metadata_field_from_dict() -> None:
+    """test metadata fields still decode from supplied packet metadata"""
+    codec = ltcodecs.DictCodec(
+        {
+            "src": {"codec": "src"},
+            "count": {"codec": "integer", "min_value": 0, "max_value": 100},
+        }
+    )
+
+    encoded_msg = codec.encode({"count": 21})
+    bit_stream = ConstBitStream(encoded_msg[0])
+    decoded_msg = codec.decode(bit_stream, received_packet={"packet": {"src": 3}})
+
+    assert decoded_msg == {"src": 3, "count": 21}

ltcodecs-4.3.0/src/ltcodecs.egg-info/scm_version.json

@@ -1,8 +0,0 @@
-{
-  "tag": "4.3.0",
-  "distance": 0,
-  "node": "g81a0abb84aa35b1e0a0526a5cb6981de880e2466",
-  "dirty": false,
-  "branch": "HEAD",
-  "node_date": "2026-07-21"
-}