From a66e8eb07414fb1f0438edd3509fd2989f87e8fd Mon Sep 17 00:00:00 2001
From: Gregory Parkes <gregorymparkes@gmail.com>
Date: Tue, 23 Dec 2025 11:55:12 +0000
Subject: [PATCH 1/3] feat: replace asserts with if statements

---
 sigmf/sigmffile.py | 28 +++++++++++++++++++++-------
 1 file changed, 21 insertions(+), 7 deletions(-)

diff --git a/sigmf/sigmffile.py b/sigmf/sigmffile.py
index 1203c53..81f6683 100644
--- a/sigmf/sigmffile.py
+++ b/sigmf/sigmffile.py
@@ -60,7 +60,8 @@ def ordered_metadata(self):
         """
         ordered_meta = OrderedDict()
         for top_key in self.VALID_KEYS.keys():
-            assert top_key in self._metadata
+            if top_key not in self._metadata:
+                raise SigMFAccessError("key '{}' is not a VALID KEY for metadata".format(top_key))
             ordered_meta[top_key] = json.loads(json.dumps(self._metadata[top_key], sort_keys=True))
         # If there are other top-level keys, they go later
         # TODO: sort potential `other` top-level keys
@@ -270,7 +271,8 @@ def get_schema(self):
         if self.version != current_metadata_version or self.schema is None:
             self.version = current_metadata_version
             self.schema = schema.get_schema(self.version)
-        assert isinstance(self.schema, dict)
+        if not isinstance(self.schema, dict):
+            raise SigMFError("SigMF schema expects a dict (key, value pairs)")
         return self.schema
 
     def set_metadata(self, metadata):
@@ -327,7 +329,10 @@ def add_capture(self, start_index, metadata=None):
         If there is already capture info for this index, metadata will be merged
         with the existing metadata, overwriting keys if they were previously set.
         """
-        assert start_index >= self._get_start_offset()
+        if start_index < self._get_start_offset():
+            raise SigMFAccessError(
+                "`start_index` {} must be >= the global start index {}".format(start_index, self._get_start_offset())
+            )
         capture_list = self._metadata[self.CAPTURE_KEY]
         new_capture = metadata or {}
         new_capture[self.START_INDEX_KEY] = start_index
@@ -356,9 +361,13 @@ def get_capture_info(self, index):
         Returns a dictionary containing all the capture information at sample
         'index'.
         """
-        assert index >= self._get_start_offset()
+        if index < self._get_start_offset():
+            raise SigMFAccessError(
+                "`start_index` {} must be >= the global start index {}".format(index, self._get_start_offset())
+            )
         captures = self._metadata.get(self.CAPTURE_KEY, [])
-        assert len(captures) > 0
+        if len(captures) == 0:
+            raise SigMFAccessError("No captures are present!")
         cap_info = captures[0]
         for capture in captures:
             if capture[self.START_INDEX_KEY] > index:
@@ -413,12 +422,17 @@ def add_annotation(self, start_index, length=None, metadata=None):
         """
         Insert annotation at start_index with length (if != None).
         """
-        assert start_index >= self._get_start_offset()
+
+        if start_index < self._get_start_offset():
+            raise SigMFAccessError(
+                "`start_index` {} must be >= the global start index {}".format(start_index, self._get_start_offset())
+            )
 
         new_annot = metadata or {}
         new_annot[self.START_INDEX_KEY] = start_index
         if length is not None:
-            assert length >= 1
+            if length <= 0:
+                raise SigMFAccessError("Annotation `length` must be >= 0")
             new_annot[self.LENGTH_INDEX_KEY] = length
 
         self._metadata[self.ANNOTATION_KEY] += [new_annot]

From 98590b01d72420224b0016ca29f82668b3ec87cf Mon Sep 17 00:00:00 2001
From: Gregory Parkes <gregorymparkes@gmail.com>
Date: Tue, 23 Dec 2025 11:55:29 +0000
Subject: [PATCH 2/3] remove: assert in conftest

---
 tests/conftest.py | 1 -
 1 file changed, 1 deletion(-)

diff --git a/tests/conftest.py b/tests/conftest.py
index a5379ef..639340d 100644
--- a/tests/conftest.py
+++ b/tests/conftest.py
@@ -34,5 +34,4 @@ def test_sigmffile(test_data_file):
     meta.add_annotation(start_index=0, length=len(TEST_FLOAT32_DATA))
     meta.add_capture(start_index=0)
     meta.set_data_file(test_data_file.name)
-    assert meta._metadata == TEST_METADATA
     return meta

From 7a751bdcb5bcd9ac8d58a599ec1cd4ca6dd75c56 Mon Sep 17 00:00:00 2001
From: Kyle A Logue <kyle.a.logue@aero.org>
Date: Tue, 23 Dec 2025 08:32:33 -0800
Subject: [PATCH 3/3] increment patch

---
 sigmf/__init__.py | 2 +-
 tests/conftest.py | 1 +
 2 files changed, 2 insertions(+), 1 deletion(-)

diff --git a/sigmf/__init__.py b/sigmf/__init__.py
index b23ff4d..63e6b39 100644
--- a/sigmf/__init__.py
+++ b/sigmf/__init__.py
@@ -5,7 +5,7 @@
 # SPDX-License-Identifier: LGPL-3.0-or-later
 
 # version of this python module
-__version__ = "1.2.12"
+__version__ = "1.2.13"
 # matching version of the SigMF specification
 __specification__ = "1.2.5"
 
diff --git a/tests/conftest.py b/tests/conftest.py
index 639340d..a5379ef 100644
--- a/tests/conftest.py
+++ b/tests/conftest.py
@@ -34,4 +34,5 @@ def test_sigmffile(test_data_file):
     meta.add_annotation(start_index=0, length=len(TEST_FLOAT32_DATA))
     meta.add_capture(start_index=0)
     meta.set_data_file(test_data_file.name)
+    assert meta._metadata == TEST_METADATA
     return meta