update state space system repr() to include signal/system names

murrayrm · murrayrm · commit 50762986d330 · 2025-01-12T17:27:13.000-08:00
diff --git a/control/iosys.py b/control/iosys.py
@@ -250,6 +250,44 @@ def __str__(self):
             str += f"States ({self.nstates}): {self.state_labels}"
         return str
 
+    def _label_repr(self, show_count=True):
+        out, count = "", 0
+
+        # Include the system name if not generic
+        if not self._generic_name_check():
+            name_spec = f"name='{self.name}'"
+            count += len(name_spec)
+            out += name_spec
+
+        # Include the state, output, and input names if not generic
+        for sig_name, sig_default, sig_labels in zip(
+                ['states', 'outputs', 'inputs'],
+                ['x', 'y', 'u'],        # TODO: replace with defaults
+                [self.state_labels, self.output_labels, self.input_labels]):
+            if sig_name == 'states' and self.nstates is None:
+                continue
+
+            # Check if the signal labels are generic
+            if any([re.match(r'^' + sig_default + r'\[\d*\]$', label) is None
+                    for label in sig_labels]):
+                spec = f"{sig_name}={sig_labels}"
+            elif show_count:
+                spec = f"{sig_name}={len(sig_labels)}"
+
+            # Append the specification string to the output, with wrapping
+            if count == 0:
+                count = len(spec)       # no system name => suppress comma
+            elif count + len(spec) > 72:
+                # TODO: check to make sure a single line is enough (minor)
+                out += ",\n"
+                count = len(spec)
+            else:
+                out += ", "
+                count += len(spec) + 2
+            out += spec
+
+        return out
+
     # Find a list of signals by name, index, or pattern
     def _find_signals(self, name_list, sigdict):
         if not isinstance(name_list, (list, tuple)):
diff --git a/control/statesp.py b/control/statesp.py
@@ -392,11 +392,19 @@ def __str__(self):
     # represent to implement a re-loadable version
     def __repr__(self):
         """Print state-space system in loadable form."""
-        # TODO: add input/output names (?)
-        return "StateSpace({A}, {B}, {C}, {D}{dt})".format(
+        out = "StateSpace(\n{A},\n{B},\n{C},\n{D}".format(
             A=self.A.__repr__(), B=self.B.__repr__(),
-            C=self.C.__repr__(), D=self.D.__repr__(),
-            dt=(isdtime(self, strict=True) and ", {}".format(self.dt)) or '')
+            C=self.C.__repr__(), D=self.D.__repr__())
+
+        if config.defaults['control.default_dt'] != self.dt:
+            out += ",\ndt={dt}".format(
+                dt='None' if self.dt is None else self.dt)
+
+        if len(labels := self._label_repr()) > 0:
+            out += ",\n" + labels
+
+        out += ")"
+        return out
 
     def _latex_partitioned_stateless(self):
         """`Partitioned` matrix LaTeX representation for stateless systems
diff --git a/control/tests/statesp_test.py b/control/tests/statesp_test.py
@@ -735,17 +735,23 @@ def test_lft(self):
 
     def test_repr(self, sys322):
         """Test string representation"""
-        ref322 = "\n".join(["StateSpace(array([[-3.,  4.,  2.],",
-                            "       [-1., -3.,  0.],",
-                            "       [ 2.,  5.,  3.]]), array([[ 1.,  4.],",
-                            "       [-3., -3.],",
-                            "       [-2.,  1.]]), array([[ 4.,  2., -3.],",
-                            "       [ 1.,  4.,  3.]]), array([[-2.,  4.],",
-                            "       [ 0.,  1.]]){dt})"])
+        ref322 = "\n".join(
+            ["StateSpace(",
+             "array([[-3.,  4.,  2.],",
+             "       [-1., -3.,  0.],",
+             "       [ 2.,  5.,  3.]]),",
+             "array([[ 1.,  4.],",
+             "       [-3., -3.],",
+             "       [-2.,  1.]]),",
+             "array([[ 4.,  2., -3.],",
+             "       [ 1.,  4.,  3.]]),",
+             "array([[-2.,  4.],",
+             "       [ 0.,  1.]]){dt},",
+             "name='sys322', states=3, outputs=2, inputs=2)"])
         assert repr(sys322) == ref322.format(dt='')
         sysd = StateSpace(sys322.A, sys322.B,
                           sys322.C, sys322.D, 0.4)
-        assert repr(sysd), ref322.format(dt=" == 0.4")
+        assert repr(sysd), ref322.format(dt="\ndt=0.4")
         array = np.array  # noqa
         sysd2 = eval(repr(sysd))
         np.testing.assert_allclose(sysd.A, sysd2.A)
