add astropy Table support to compare_asdf (#915)

CHANGES.rst

@@ -16,6 +16,8 @@ general
   ``asdf.commands.diff`` with ``deepdiff`` and add ``deepdiff`` as
   a test dependency [#868]
 
+- Add ``astropy.table.Table`` support to ``compare_asdf`` [#915]
+
 ramp_fitting
 ------------
 

romancal/regtest/regtestdata.py

@@ -1,3 +1,4 @@
+import io
 import os
 import os.path as op
 import pprint
@@ -8,7 +9,9 @@
 from pathlib import Path
 
 import asdf
+import astropy.table
 import astropy.time
+import astropy.utils.diff
 import deepdiff
 import gwcs
 import numpy as np
@@ -578,6 +581,23 @@ def give_up_diffing(self, level, diff_instance):
         return True
 
 
+class TableOperator(BaseOperator):
+    def give_up_diffing(self, level, diff_instance):
+        sio = io.StringIO()
+        identical = astropy.utils.diff.report_diff_values(
+            level.t1, level.t2, fileobj=sio
+        )
+        difference = {}
+        if not identical:
+            difference["values_differ"] = sio.read()
+        # also compare meta (which report_diff_values does not)
+        if level.t1.meta != level.t2.meta:
+            difference["metas_differ"] = deepdiff.DeepDiff(level.t1.meta, level.t2.meta)
+        if difference:
+            diff_instance.custom_report_result("tables_differ", level, difference)
+        return True
+
+
 class TimeOperator(BaseOperator):
     def give_up_diffing(self, level, diff_instance):
         if level.t1 != level.t2:
@@ -673,6 +693,7 @@ def compare_asdf(result, truth, ignore=None, rtol=1e-05, atol=1e-08, equal_nan=T
             rtol, atol, equal_nan, types=[asdf.tags.core.NDArrayType, np.ndarray]
         ),
         TimeOperator(types=[astropy.time.Time]),
+        TableOperator(types=[astropy.table.Table]),
         WCSOperator(types=[gwcs.WCS]),
     ]
     # warnings can be seen in regtest runs which indicate

romancal/regtest/test_regtestdata.py

@@ -1,3 +1,7 @@
+import asdf
+import astropy.table
+import numpy as np
+import pytest
 from roman_datamodels import datamodels as rdm
 from roman_datamodels import maker_utils
 
@@ -25,3 +29,30 @@ def test_compare_asdf_differ(tmp_path):
     assert not diff.identical, diff.report()
     assert "arrays_differ" in diff.diff
     assert "root['roman']['data']" in diff.diff["arrays_differ"]
+
+
+@pytest.mark.parametrize("modification", [None, "dtype", "names", "values", "meta"])
+def test_compare_asdf_tables(tmp_path, modification):
+    fn0 = tmp_path / "test0.asdf"
+    fn1 = tmp_path / "test1.asdf"
+    names = ("a",)
+    values = [1, 2, 3]
+    dtype = np.uint8
+    t0 = astropy.table.Table([np.array(values, dtype=dtype)], names=names)
+    if modification == "names":
+        names = ("b",)
+    if modification == "values":
+        values = [4, 5, 6]
+    if modification == "dtype":
+        dtype = np.float64
+    t1 = astropy.table.Table([np.array(values, dtype=dtype)], names=names)
+    if modification == "meta":
+        t1.meta["modified"] = True
+    asdf.AsdfFile({"t": t0}).write_to(fn0)
+    asdf.AsdfFile({"t": t1}).write_to(fn1)
+    diff = compare_asdf(fn0, fn1)
+    if modification is None:
+        assert diff.identical, diff.report()
+    else:
+        assert not diff.identical, diff.report()
+        assert "tables_differ" in diff.diff