Give all MIDIMessage objects a useful repr()

Author: jepler

adafruit_midi/channel_pressure.py

@@ -28,6 +28,7 @@ class ChannelPressure(MIDIMessage):
     :param int pressure: The pressure, 0-127.
     """
 
+    _message_slots = ['pressure', 'channel']
     _STATUS = 0xD0
     _STATUSMASK = 0xF0
     LENGTH = 2

adafruit_midi/control_change.py

@@ -30,6 +30,7 @@ class ControlChange(MIDIMessage):
 
     """
 
+    _message_slots = ['control', 'value', 'channel']
     _STATUS = 0xB0
     _STATUSMASK = 0xF0
     LENGTH = 3

adafruit_midi/midi_continue.py

@@ -24,6 +24,7 @@
 
 class Continue(MIDIMessage):
     """Continue MIDI message."""
+    _message_slots = []
 
     _STATUS = 0xFB
     _STATUSMASK = 0xFF

adafruit_midi/midi_message.py

@@ -285,6 +285,18 @@ def from_bytes(cls, msg_bytes):
         representation of the MIDI message."""
         return cls()
 
+    def __str__(self):
+        """Print an instance"""
+        cls = self.__class__
+        if slots := getattr(cls, '_message_slots', None):
+            args = ", ".join(f"{name}={repr(getattr(self, name, None))}"
+                for name in slots)
+        else:
+            args = "..."
+        return f"{self.__class__.__name__}({args})"
+
+    __repr__ = __str__
+
 
 # DO NOT try to register these messages
 class MIDIUnknownEvent(MIDIMessage):
@@ -296,6 +308,7 @@ class MIDIUnknownEvent(MIDIMessage):
     or because it is not imported.
     """
 
+    _message_slots = ['status']
     LENGTH = -1
 
     def __init__(self, status):
@@ -316,6 +329,8 @@ class MIDIBadEvent(MIDIMessage):
 
     LENGTH = -1
 
+    _message_slots = ['msg_bytes', 'exception']
+
     def __init__(self, msg_bytes, exception):
         self.data = bytes(msg_bytes)
         self.exception_text = repr(exception)

adafruit_midi/mtc_quarter_frame.py

@@ -41,6 +41,8 @@ class MtcQuarterFrame(MIDIMessage):
     :param value: The quarter frame value for the specified type.
     """
 
+    _message_slots = ['msgtype', 'value']
+
     _STATUS = 0xF1
     _STATUSMASK = 0xFF
     LENGTH = 2

adafruit_midi/note_off.py

@@ -31,6 +31,7 @@ class NoteOff(MIDIMessage):  # pylint: disable=duplicate-code
 
     """
 
+    _message_slots = ['note', 'velocity', 'channel']
     _STATUS = 0x80
     _STATUSMASK = 0xF0
     LENGTH = 3

adafruit_midi/note_on.py

@@ -31,6 +31,8 @@ class NoteOn(MIDIMessage):
         to a Note Off, defaults to 127.
     """
 
+    _message_slots = ['note', 'velocity', 'channel']
+
     _STATUS = 0x90
     _STATUSMASK = 0xF0
     LENGTH = 3

adafruit_midi/pitch_bend.py

@@ -29,6 +29,7 @@ class PitchBend(MIDIMessage):
         bend from 0 through 8192 (midpoint, no bend) to 16383.
     """
 
+    _message_slots = ['pitch_bend', 'channel']
     _STATUS = 0xE0
     _STATUSMASK = 0xF0
     LENGTH = 3

adafruit_midi/polyphonic_key_pressure.py

@@ -30,6 +30,7 @@ class PolyphonicKeyPressure(MIDIMessage):
     :param int pressure: The pressure, 0-127.
     """
 
+    _message_slots = ['note', 'pressure', 'channel']
     _STATUS = 0xA0
     _STATUSMASK = 0xF0
     LENGTH = 3

adafruit_midi/program_change.py

@@ -28,6 +28,7 @@ class ProgramChange(MIDIMessage):
     :param int patch: The new program/patch number to use, 0-127.
     """
 
+    _message_slots = ['patch', 'channel']
     _STATUS = 0xC0
     _STATUSMASK = 0xF0
     LENGTH = 2

adafruit_midi/start.py

@@ -28,6 +28,6 @@ class Start(MIDIMessage):
     _STATUS = 0xFA
     _STATUSMASK = 0xFF
     LENGTH = 1
-
+    _message_slots=[]
 
 Start.register_message_type()

adafruit_midi/stop.py

@@ -28,6 +28,6 @@ class Stop(MIDIMessage):
     _STATUS = 0xFC
     _STATUSMASK = 0xFF
     LENGTH = 1
-
+    _message_slots=[]
 
 Stop.register_message_type()

adafruit_midi/system_exclusive.py

@@ -32,6 +32,7 @@ class SystemExclusive(MIDIMessage):
     This message can only be parsed if it fits within the input buffer in :class:MIDI.
     """
 
+    _message_slots = ['manufacturer_id', 'data']
     _STATUS = 0xF0
     _STATUSMASK = 0xFF
     LENGTH = -1

adafruit_midi/timing_clock.py

@@ -34,6 +34,6 @@ class TimingClock(MIDIMessage):
     _STATUS = 0xF8
     _STATUSMASK = 0xFF
     LENGTH = 1
-
+    _slots = []
 
 TimingClock.register_message_type()