change default repr to 'eval' + adjust HTML formatting

murrayrm · murrayrm · commit e0a612f7ddf3 · 2025-01-12T17:28:33.000-08:00
diff --git a/control/iosys.py b/control/iosys.py
@@ -31,7 +31,7 @@
     'iosys.indexed_system_name_suffix': '$indexed',
     'iosys.converted_system_name_prefix': '',
     'iosys.converted_system_name_suffix': '$converted',
-    'iosys.repr_format': 'info',
+    'iosys.repr_format': 'eval',
 }
 
 
diff --git a/control/nlsys.py b/control/nlsys.py
@@ -784,7 +784,7 @@ def outfcn(t, x, u, params):
 
     def __str__(self):
         import textwrap
-        out = super().__str__()
+        out = InputOutputSystem.__str__(self)
 
         out += f"\n\nSubsystems ({len(self.syslist)}):\n"
         for sys in self.syslist:
@@ -845,7 +845,7 @@ def cxn_string(signal, gain, first):
                     cxn, width=78, initial_indent=" * ",
                     subsequent_indent="     ")) + "\n"
 
-        return out[:-1]
+        return out
 
     def _update_params(self, params, warning=False):
         for sys in self.syslist:
@@ -1087,7 +1087,7 @@ def unused_signals(self):
     def connection_table(self, show_names=False, column_width=32):
         """Print table of connections inside an interconnected system model.
 
-        Intended primarily for :class:`InterconnectedSystems` that have been
+        Intended primarily for :class:`InterconnectedSystem`'s that have been
         connected implicitly using signal names.
 
         Parameters
diff --git a/control/statesp.py b/control/statesp.py
@@ -1483,9 +1483,38 @@ def __init__(self, io_sys, ss_sys=None, connection_type=None):
             outputs=io_sys.output_labels, states=io_sys.state_labels,
             params=io_sys.params, remove_useless_states=False)
 
-        # Use StateSpace.__call__ to evaluate at a given complex value
-        def __call__(self, *args, **kwargs):
-            return StateSpace.__call__(self, *args, **kwargs)
+    # Use StateSpace.__call__ to evaluate at a given complex value
+    def __call__(self, *args, **kwargs):
+        return StateSpace.__call__(self, *args, **kwargs)
+
+    def __str__(self):
+        string = InterconnectedSystem.__str__(self) + "\n"
+        string += "\n\n".join([
+            "{} = {}".format(Mvar,
+                               "\n    ".join(str(M).splitlines()))
+            for Mvar, M in zip(["A", "B", "C", "D"],
+                               [self.A, self.B, self.C, self.D])])
+        return string
+
+    # Use InputOutputSystem repr for 'eval' since we can't recreate structure
+    # (without this, StateSpace._repr_eval_ gets used...)
+    def _repr_eval_(self):
+        return InputOutputSystem._repr_eval_(self)
+
+    def _repr_html_(self):
+        syssize = self.nstates + max(self.noutputs, self.ninputs)
+        if syssize > config.defaults['statesp.latex_maxsize']:
+            return None
+        elif config.defaults['statesp.latex_repr_type'] == 'partitioned':
+            return InterconnectedSystem._repr_info_(self, html=True) + \
+                "\n" + StateSpace._latex_partitioned(self)
+        elif config.defaults['statesp.latex_repr_type'] == 'separate':
+            return InterconnectedSystem._repr_info_(self, html=True) + \
+                "\n" + StateSpace._latex_separate(self)
+        else:
+            raise ValueError(
+                "Unknown statesp.latex_repr_type '{cfg}'".format(
+                    cfg=config.defaults['statesp.latex_repr_type']))
 
     # The following text needs to be replicated from StateSpace in order for
     # this entry to show up properly in sphinx doccumentation (not sure why,
diff --git a/control/tests/config_test.py b/control/tests/config_test.py
@@ -320,15 +320,11 @@ def test_system_indexing(self):
         sys2 = sys[1:, 1:]
         assert sys2.name == 'PRE' + sys.name + 'POST'
 
-    def test_legacy_repr_format(self):
+    def test_repr_format(self):
         from ..statesp import StateSpace
         from numpy import array
 
         sys = ct.ss([[1]], [[1]], [[1]], [[0]])
-        with pytest.raises(SyntaxError, match="invalid syntax"):
-            new = eval(repr(sys))               # iosys is default
-
-        ct.use_legacy_defaults('0.10.1')        # loadable is default
         new = eval(repr(sys))
         for attr in ['A', 'B', 'C', 'D']:
             assert getattr(sys, attr) == getattr(sys, attr)
diff --git a/control/tests/iosys_test.py b/control/tests/iosys_test.py
@@ -2357,12 +2357,18 @@ def test_iosys_repr(fcn, spec, expected, missing, format):
         if missing is not None:
             assert re.search(missing, out) is None
 
-        # Make sure we can change the default format back to 'info'
-        sys.repr_format = None
+    elif format == 'info':
+        assert out == info_expected
+
+    # Make sure we can change back to the default format
+    sys.repr_format = None
 
-    # Test 'info', either set explicitly or via config.defaults
+    # Make sure the default format is OK
     out = repr(sys)
-    assert out == info_expected
+    if ct.config.defaults['iosys.repr_format'] == 'info':
+        assert out == info_expected
+    elif ct.config.defaults['iosys.repr_format'] == 'eval':
+        assert re.search(expected, out) != None
 
 
 @pytest.mark.parametrize("fcn", [ct.ss, ct.tf, ct.frd, ct.nlsys, fs.flatsys])
diff --git a/control/tests/namedio_test.py b/control/tests/namedio_test.py
@@ -34,7 +34,7 @@ def test_named_ss():
     assert sys.input_labels == ['u[0]', 'u[1]']
     assert sys.output_labels == ['y[0]', 'y[1]']
     assert sys.state_labels == ['x[0]', 'x[1]']
-    assert ct.InputOutputSystem.__repr__(sys) == \
+    assert ct.iosys_repr(sys, format='info') == \
         "<StateSpace sys[0]: ['u[0]', 'u[1]'] -> ['y[0]', 'y[1]']>"
 
     # Pass the names as arguments
@@ -46,7 +46,7 @@ def test_named_ss():
     assert sys.input_labels == ['u1', 'u2']
     assert sys.output_labels == ['y1', 'y2']
     assert sys.state_labels == ['x1', 'x2']
-    assert ct.InputOutputSystem.__repr__(sys) == \
+    assert ct.iosys_repr(sys, format='info') == \
         "<StateSpace system: ['u1', 'u2'] -> ['y1', 'y2']>"
 
     # Do the same with rss
@@ -56,7 +56,7 @@ def test_named_ss():
     assert sys.input_labels == ['u1']
     assert sys.output_labels == ['y1', 'y2']
     assert sys.state_labels == ['x1', 'x2', 'x3']
-    assert ct.InputOutputSystem.__repr__(sys) == \
+    assert ct.iosys_repr(sys, format='info') == \
         "<StateSpace random: ['u1'] -> ['y1', 'y2']>"
 
 
diff --git a/control/tests/nlsys_test.py b/control/tests/nlsys_test.py
@@ -227,11 +227,6 @@ def test_ICsystem_str():
         r"Outputs \(2\): \['y1', 'y2'\]" + "\n" + \
         r"States \(4\): \['sys1_x\[0\].*'sys2_x\[1\]'\]" + "\n" + \
         "\n" + \
-        r"A = \[\[.*\]\]" + "\n\n" + \
-        r"B = \[\[.*\]\]" + "\n\n" + \
-        r"C = \[\[.*\]\]" + "\n\n" + \
-        r"D = \[\[.*\]\]" + "\n" + \
-        "\n" + \
         r"Subsystems \(2\):" + "\n" + \
         r" \* <StateSpace sys1: \[.*\] -> \['y\[0\]', 'y\[1\]']>" + "\n" + \
         r" \* <StateSpace sys2: \['u\[0\]', 'u\[1\]'] -> \[.*\]>" + "\n" + \
@@ -245,6 +240,11 @@ def test_ICsystem_str():
         "\n\n" + \
         r"Outputs:" + "\n" + \
         r" \* y1 <- sys2.y\[0\]" + "\n" + \
-        r" \* y2 <- sys2.y\[1\]"
+        r" \* y2 <- sys2.y\[1\]" + \
+        "\n\n" + \
+        r"A = \[\[.*\]\]" + "\n\n" + \
+        r"B = \[\[.*\]\]" + "\n\n" + \
+        r"C = \[\[.*\]\]" + "\n\n" + \
+        r"D = \[\[.*\]\]"
 
     assert re.match(ref, str(sys), re.DOTALL)
diff --git a/examples/repr_gallery.ipynb b/examples/repr_gallery.ipynb
diff --git a/examples/repr_gallery.py b/examples/repr_gallery.py

Original file line number	Diff line number	Diff line change
`@@ -31,7 +31,7 @@`
`31`	`31`	`'iosys.indexed_system_name_suffix': '$indexed',`
`32`	`32`	`'iosys.converted_system_name_prefix': '',`
`33`	`33`	`'iosys.converted_system_name_suffix': '$converted',`
`34`		`- 'iosys.repr_format': 'info',`
	`34`	`+ 'iosys.repr_format': 'eval',`
`35`	`35`	`}`
`36`	`36`
`37`	`37`