enh: add string representation method to Channel class #266

src/vitabel/timeseries.py

@@ -580,6 +580,10 @@ def __init__(
             offset=offset,
         )
 
+    def __repr__(self) -> str:
+        """A string representation of the channel."""
+        return f"{self.__class__.__name__}({self.name})"
+
     def data_hash(self) -> str:
         """Return a hash representing the data and the metadata of this channel."""
         data = {

tests/test_timeseries.py

@@ -288,6 +288,14 @@ def test_channel_time_only():
     assert channel.is_time_only()
 
 
+def test_channel_repr():
+    time = np.arange(0, 1, 0.1)
+    data = np.sin(2 * np.pi * time)
+    channel = Channel(name="HR", time_index=time, data=data)
+
+    assert repr(channel) == "Channel(HR)"
+
+
 def test_channel_get_data():
     time = np.arange(0, 5, 0.1)
     data = np.sin(2 * np.pi * time)