Merge pull request #1639 from naylor-b/serialize

Fix for unserializable object failure when running n2

openmdao/core/tests/test_group.py

@@ -26,10 +26,6 @@
 except ImportError:
     PETScVector = None
 
-try:
-    from openmdao.vectors.petsc_vector import PETScVector
-except ImportError:
-    PETScVector = None
 
 arr_order_1x1 = np.array([1, 2, 3, 4])
 arr_2x4 = np.array([[0, 1, 2, 3], [10, 11, 12, 13]])

openmdao/core/tests/test_serialize.py

@@ -0,0 +1,28 @@
+import unittest
+
+import openmdao.api as om
+
+class BadOptionComp(om.ExplicitComponent):
+
+    def initialize(self):
+        self.options.declare('bad', recordable=False)
+
+    def setup(self):
+        self.add_input('x')
+        self.add_output('y')
+
+
+class SerializeTestCase(unittest.TestCase):
+    def test_serialize_n2(self):
+        p = om.Problem()
+
+        p.model.add_subsystem('foo', BadOptionComp(bad=object()))
+
+        p.setup()
+        p.final_setup()
+
+        om.n2(p, show_browser=False)
+
+
+if __name__ == '__main__':
+    unittest.main()

openmdao/recorders/sqlite_recorder.py

@@ -19,7 +19,7 @@
 from openmdao.utils.mpi import MPI
 from openmdao.utils.record_util import dict_to_structured_array
 from openmdao.utils.options_dictionary import OptionsDictionary
-from openmdao.utils.general_utils import simple_warning, make_serializable
+from openmdao.utils.general_utils import simple_warning, make_serializable, default_noraise
 from openmdao.core.driver import Driver
 from openmdao.core.system import System
 from openmdao.core.problem import Problem
@@ -612,7 +612,7 @@ def record_viewer_data(self, model_viewer_data, key='Driver'):
             The unique ID to use for this data in the table.
         """
         if self.connection:
-            json_data = json.dumps(model_viewer_data, default=make_serializable)
+            json_data = json.dumps(model_viewer_data, default=default_noraise)
 
             # Note: recorded to 'driver_metadata' table for legacy/compatibility reasons.
             try:

openmdao/utils/general_utils.py

@@ -830,6 +830,8 @@ def make_serializable(o):
     """
     Recursively convert numpy types to native types for JSON serialization.
 
+    This function should NOT be passed into json.dump or json.dumps as the 'default' arg.
+
     Parameters
     ----------
     o : object
@@ -852,6 +854,36 @@ def make_serializable(o):
         return o
 
 
+def default_noraise(o):
+    """
+    Try to convert some extra types during JSON serialization.
+
+    This is intended to be passed to json.dump or json.dumps as the 'default' arg.  It will
+    attempt to convert values if possible, but if no conversion works, will return
+    'unserializable object (<type>)' instead of raising a TypeError.
+
+    Parameters
+    ----------
+    o : object
+        the object to be converted
+
+    Returns
+    -------
+    object
+        The converted object.
+    """
+    if isinstance(o, _container_classes):
+        return [make_serializable(item) for item in o]
+    elif isinstance(o, np.ndarray):
+        return o.tolist()
+    elif isinstance(o, np.number):
+        return o.item()
+    elif hasattr(o, '__dict__'):
+        return o.__class__.__name__
+    else:
+        return f"unserializable object ({type(o).__name__})"
+
+
 def make_set(str_data, name=None):
     """
     Construct a set containing the specified character strings.

openmdao/visualization/n2_viewer/n2_viewer.py

@@ -24,7 +24,7 @@
 from openmdao.recorders.case_reader import CaseReader
 from openmdao.solvers.nonlinear.newton import NewtonSolver
 from openmdao.utils.class_util import overrides_method
-from openmdao.utils.general_utils import simple_warning, make_serializable
+from openmdao.utils.general_utils import simple_warning, default_noraise
 from openmdao.utils.mpi import MPI
 from openmdao.visualization.html_utils import read_files, write_script, DiagramWriter
 from openmdao.utils.general_utils import warn_deprecation
@@ -416,7 +416,7 @@ def n2(data_source, outfile='n2.html', show_browser=True, embeddable=False,
         warn_deprecation("'use_declare_partial_info' is now the"
                          " default and the option is ignored.")
 
-    raw_data = json.dumps(model_data, default=make_serializable).encode('utf8')
+    raw_data = json.dumps(model_data, default=default_noraise).encode('utf8')
     b64_data = str(base64.b64encode(zlib.compress(raw_data)).decode("ascii"))
     model_data = 'var compressedModel = "%s";' % b64_data