Ensure metadata and getPixel results are json serializable

girder · May 29, 2023 · 1b1b8a9 · 1b1b8a9
1 parent 9cdd1cf
commit 1b1b8a9
Show file tree

Hide file tree

Showing 3 changed files with 6 additions and 1 deletion.
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -8,6 +8,7 @@
 
 ### Improvements
 - Parse qptiff and imagej vendor information ([#1168](../../pull/1168))
+- Ensure metadata and getPixel results are json serializable ([#1182](../../pull/1182))
 
 ### Changes
 - Remove an unneeded warnings filter ([#1172](../../pull/1172))

diff --git a/large_image/tilesource/base.py b/large_image/tilesource/base.py
@@ -1669,7 +1669,7 @@ def getMetadata(self):
             'magnification': mag['magnification'],
             'mm_x': mag['mm_x'],
             'mm_y': mag['mm_y'],
-            'dtype': self.dtype,
+            'dtype': str(self.dtype),
         })
 
     @property

diff --git a/test/test_source_base.py b/test/test_source_base.py
@@ -1,4 +1,5 @@
 import io
+import json
 import os
 import re
 import sys
@@ -209,6 +210,9 @@ def testSourcesTilesAndMethods(source, filename):
         # This should be an image and a mime type
         assert len(ts.getAssociatedImage(ts.getAssociatedImagesList()[0])) == 2
     assert ts.getAssociatedImage('nosuchimage') is None
+    # Test the serializability of common methods
+    assert json.dumps(ts.getMetadata())
+    assert json.dumps(ts.getPixel(region=dict(left=0, top=0)))
     # Test module open method
     mod = sys.modules[sourceClass.__module__]
     assert mod.open(imagePath) is not None