add __repr__ for NamedSignal

murrayrm · murrayrm · commit 8081ac35bdaf · 2025-02-02T21:30:22.000-08:00
diff --git a/control/iosys.py b/control/iosys.py
@@ -108,6 +108,16 @@ def _parse_key(self, key, labels=None, level=0):
     def __getitem__(self, key):
         return super().__getitem__(self._parse_key(key))
 
+    def __repr__(self):
+        out = "NamedSignal(\n"
+        out += repr(np.array(self))             # NamedSignal -> array
+        if self.signal_labels is not None:
+            out += f",\nsignal_labels={self.signal_labels}"
+        if self.trace_labels is not None:
+            out += f",\ntrace_labels={self.trace_labels}"
+        out += "\n)"
+        return out
+
 
 class InputOutputSystem():
     """Base class for input/output systems.
diff --git a/control/tests/namedio_test.py b/control/tests/namedio_test.py
@@ -363,3 +363,19 @@ def test_negative_system_spec():
     np.testing.assert_allclose(negfbk_negsig.B, negfbk_negsys.B)
     np.testing.assert_allclose(negfbk_negsig.C, negfbk_negsys.C)
     np.testing.assert_allclose(negfbk_negsig.D, negfbk_negsys.D)
+
+
+# Named signal representations
+def test_named_signal_repr():
+    from numpy import array
+    from ..iosys import NamedSignal
+    sys = ct.rss(
+        states=2, inputs=['u1', 'u2'], outputs=['y1', 'y2'],
+        state_prefix='xi')
+    resp = sys.step_response(np.linspace(0, 1, 3))
+
+    for signal in ['inputs', 'outputs', 'states']:
+        sig_orig = getattr(resp, signal)
+        sig_eval = eval(repr(sig_orig))
+        assert sig_eval.signal_labels == sig_orig.signal_labels
+        assert sig_eval.trace_labels == sig_orig.trace_labels
