More code cleanup

More idiomatic Python 3
Inherited method declaration compatible with parent

Author: rdoursenaud

TODO.md

@@ -1,6 +1,7 @@
 - [x] [mzuther] implement basic functionality
 - [x] [rdoursenaud] port to python 3 and pyside 2
 - [x] [rdoursenaud] cleanup code and make it PEP008 compliant
+- [ ] [rdoursenaud] write pytest unit tests only looking at the protocol docs
 - [ ] [rdoursenaud] properly handle invalid config file
 - [ ] [rdoursenaud] disallow start if MIDI ports are not set in the GUI
 - [ ] [rdoursenaud] don't freeze GUI while "Waiting for MIDI input from host..."

src/PythonMcu.py

@@ -50,15 +50,17 @@
 class PythonMcu(QFrame):
     # noinspection PyUnresolvedReferences
     def __init__(self, parent=None):
-        super(PythonMcu, self).__init__(parent)
+        super().__init__(parent)
 
-        self._mcu_emulated_model = None
-        self._mcu_midi_input = None
-        self._mcu_midi_output = None
-        self._hardware_controller = None
         self._controller_midi_input = None
         self._controller_midi_output = None
+        self._hardware_controller = None
+        self._hardware_controller_class = None
         self._mcu_connection = None
+        self._mcu_emulated_model = None
+        self._mcu_midi_input = None
+        self._mcu_midi_output = None
+        self._mcu_model_id = None
 
         font = QFont()
         font.setStyleHint(QFont.TypeWriter, QFont.PreferAntialias)

src/PythonMcu/Hardware/MidiControllerTemplate.py

@@ -33,8 +33,7 @@
 from PythonMcu.Midi.MidiConnection import MidiConnection
 
 
-class MidiControllerTemplate(object):
-
+class MidiControllerTemplate:
     MIDI_MANUFACTURER_ID = None
     MIDI_DEVICE_ID = None
 
@@ -47,7 +46,7 @@ class MidiControllerTemplate(object):
         0x00: 'off',
         0x01: 'flashing',
         0x7F: 'on'
-        }
+    }
 
     def __init__(self, midi_input_name, midi_output_name, callback_log):
         self.callback_log = callback_log
@@ -79,11 +78,11 @@ def __init__(self, midi_input_name, midi_output_name, callback_log):
         self.meter_bridge_available = True
 
         self.display_7seg_characters = []
-        for counter in range(4):
+        for _ in range(4):
             self.display_7seg_characters.append(' ')
 
         self.display_timecode_characters = []
-        for counter in range(20):
+        for _ in range(20):
             self.display_timecode_characters.append(' ')
 
     @staticmethod
@@ -145,7 +144,7 @@ def send_midi_control_change(self, channel, cc_number, cc_value):
         self.midi.send_control_change(channel, cc_number, cc_value)
 
     def send_midi_sysex(self, data):
-        assert(type(data) is list)
+        assert isinstance(data, list)
 
         header = []
         header.extend(self.MIDI_MANUFACTURER_ID)
@@ -215,8 +214,8 @@ def _decode_7seg_character(character_code):
 
         if character_code < 0x20:
             return chr(character_code + 0x40), dot
-        else:
-            return chr(character_code), dot
+
+        return chr(character_code), dot
 
     def set_display_timecode(self, position, character_code):
         character = self._decode_7seg_character(character_code)
@@ -262,11 +261,11 @@ def get_lcd_characters(self, line):
 
         if self._show_overlay[line]:
             return self._lcd_overlay_characters[line]
-        else:
-            return self._lcd_characters[line]
+
+        return self._lcd_characters[line]
 
     def show_menu(self, line, menu_strings):
-        assert(len(menu_strings) == 8)
+        assert len(menu_strings) == 8
 
         menu_string_temp = ''
         for menu_string in menu_strings:
@@ -280,7 +279,7 @@ def hide_menu(self, line):
 
     def show_overlay(self, line, overlay_characters):
         line %= 2
-        assert(len(overlay_characters) == 56)
+        assert len(overlay_characters) == 56
 
         self._show_overlay[line] = True
         self._lcd_overlay_characters[line] = overlay_characters

src/PythonMcu/Hardware/NovationZeROSLMkII.py

@@ -170,8 +170,8 @@ def _enter_ableton_mode(self):
         self.send_midi_sysex([0x01, 0x01])
 
         # clear all LEDs and switch off "transport" mode
-        self.send_midi_control_change(self._MIDI_CC_CLEAR_ALL_LEDS, 0x00)
-        self.send_midi_control_change(self._MIDI_CC_BUTTON_MODE_TRANSPORT, 0x00)
+        self.send_midi_control_change(cc_number=self._MIDI_CC_CLEAR_ALL_LEDS, cc_value=0x00)
+        self.send_midi_control_change(cc_number=self._MIDI_CC_BUTTON_MODE_TRANSPORT, cc_value=0x00)
 
     def _leave_ableton_mode(self):
         self._log('Leaving "Ableton" mode...', True)
@@ -180,8 +180,8 @@ def _leave_ableton_mode(self):
         self.send_midi_sysex([0x01, 0x00])
 
         # clear all LEDs and switch off "transport" mode
-        self.send_midi_control_change(self._MIDI_CC_CLEAR_ALL_LEDS, 0x00)
-        self.send_midi_control_change(self._MIDI_CC_BUTTON_MODE_TRANSPORT, 0x00)
+        self.send_midi_control_change(cc_number=self._MIDI_CC_CLEAR_ALL_LEDS, cc_value=0x00)
+        self.send_midi_control_change(cc_number=self._MIDI_CC_BUTTON_MODE_TRANSPORT, cc_value=0x00)
 
     # --- MIDI processing ---
     def receive_midi(self, status, message):
@@ -274,25 +274,28 @@ def receive_midi(self, status, message):
                 message_string.append('%02X' % byte)
             self._log(' '.join(message_string))
 
-    def send_midi_control_change(self, cc_number, cc_value, channel=None):
+    def send_midi_control_change(self, channel=None, cc_number=None, cc_value=None):
         if not self._is_connected:
             return
 
+        if channel:
+            raise ValueError("The channel is fixed for this device!")
+
         MidiControllerTemplate.send_midi_control_change(self, self._MIDI_DEVICE_CHANNEL, cc_number, cc_value)
 
     @staticmethod
     def get_preferred_midi_input():
         if os.name == 'nt':
             return 'ZeRO MkII: Port 2'
-        else:
-            return 'ZeRO MkII MIDI 2'
+
+        return 'ZeRO MkII MIDI 2'
 
     @staticmethod
     def get_preferred_midi_output():
         if os.name == 'nt':
             return 'ZeRO MkII: Port 2'
-        else:
-            return 'ZeRO MkII MIDI 2'
+
+        return 'ZeRO MkII MIDI 2'
 
     # --- registration of MIDI controls ---
     def register_control(self, mcu_command, midi_switch, midi_led=None):
@@ -319,8 +322,8 @@ def set_lcd_directly(self, line, lcd_string):
             lcd_string = lcd_string.ljust(72)[:72]
 
         lcd_characters = []
-        for n in range(len(lcd_string)):
-            lcd_characters.append(ord(lcd_string[n]))
+        for index, string in enumerate(lcd_string):
+            lcd_characters.append(ord(string))
 
         self._update_lcd_raw(line, lcd_characters)
 
@@ -332,9 +335,9 @@ def update_lcd(self):
                 self._lcd_strings[line] = new_string
                 hex_codes = []
 
-                for n in range(len(new_string)):
-                    hex_codes.append(ord(new_string[n]))
-                    if (n % 7) == 6:
+                for index, string in enumerate(new_string):
+                    hex_codes.append(ord(string))
+                    if index % 7 == 6:
                         hex_codes.append(0x20)
                         hex_codes.append(0x20)
 
@@ -350,7 +353,7 @@ def _update_lcd_raw(self, line, hex_codes):
         if not self._is_connected:
             return
 
-        assert (len(hex_codes) == 72)
+        assert len(hex_codes) == 72
 
         line %= 2
         if line == 0:
@@ -395,25 +398,25 @@ def _set_led(self, led_id, led_status):
 
         MidiControllerTemplate.send_midi_control_change(self, self._MIDI_DEVICE_CHANNEL, led_id, led_status)
 
-    def set_vpot_led_ring(self, vpot_id, center_led, mode, position):
-        vpot_mode = None
-        if mode == self.VPOT_MODE_WRAP:
-            vpot_mode = 0x00
-        elif mode == self.VPOT_MODE_BOOST_CUT:
-            vpot_mode = 0x20
-        elif mode == self.VPOT_MODE_SPREAD:
-            vpot_mode = 0x30
-        elif mode == self.VPOT_MODE_SINGLE_DOT:
-            vpot_mode = 0x40
+    def set_vpot_led_ring(self, vpot_id, vpot_center_led, vpot_mode, vpot_position):
+        mode = None
+        if vpot_mode == self.VPOT_MODE_WRAP:
+            mode = 0x00
+        elif vpot_mode == self.VPOT_MODE_BOOST_CUT:
+            mode = 0x20
+        elif vpot_mode == self.VPOT_MODE_SPREAD:
+            mode = 0x30
+        elif vpot_mode == self.VPOT_MODE_SINGLE_DOT:
+            mode = 0x40
 
-        self._vpot_modes[vpot_id] = vpot_mode
-        self._vpot_positions[vpot_id] = position
+        self._vpot_modes[vpot_id] = mode
+        self._vpot_positions[vpot_id] = vpot_position
 
-        self._set_led(self._MIDI_CC_ENCODER_MODE + vpot_id, vpot_mode)
-        self._set_led(self._MIDI_CC_ENCODER_LIGHTS + vpot_id, position)
+        self._set_led(self._MIDI_CC_ENCODER_MODE + vpot_id, mode)
+        self._set_led(self._MIDI_CC_ENCODER_LIGHTS + vpot_id, vpot_position)
 
     def all_leds_off(self):
-        self.send_midi_control_change(self._MIDI_CC_CLEAR_ALL_LEDS, 0x00)
+        self.send_midi_control_change(cc_number=self._MIDI_CC_CLEAR_ALL_LEDS, cc_value=0x00)
 
     # --- pedal handling ---
     def on_control_pedal(self, status):

src/PythonMcu/MackieControl/MackieHostControl.py

@@ -208,19 +208,19 @@ def connect(self):
             self.send_midi_sysex(sysex_message)
 
             return
-        else:
-            # let's make sure the MIDI input buffer is empty
-            self._midi.process_input_buffer(use_callback=False)
 
-            if self._mcu_connection == self.WAIT_FOR_MIDI_DATA:
-                self._log('Waiting for MIDI input from host...', True)
+        # let's make sure the MIDI input buffer is empty
+        self._midi.process_input_buffer(use_callback=False)
+
+        if self._mcu_connection == self.WAIT_FOR_MIDI_DATA:
+            self._log('Waiting for MIDI input from host...', True)
 
-                # wait for some MIDI input from the host (all data are
-                # left in the MIDI input buffer!)
-                while self._midi.buffer_is_empty():
-                    time.sleep(0.1)
+            # wait for some MIDI input from the host (all data are
+            # left in the MIDI input buffer!)
+            while self._midi.buffer_is_empty():
+                time.sleep(0.1)
 
-            self.go_online()
+        self.go_online()
 
     def disconnect(self):
         self._log('Disconnecting...', True)
@@ -271,27 +271,25 @@ def _calculate_response_from_challenge(challenge_bytes):
     def get_mcu_model_from_id(model_id):
         if model_id == 0x10:
             return 'Logic Control'
-        elif model_id == 0x11:
+        if model_id == 0x11:
             return 'Logic Control XT'
-        elif model_id == 0x14:
+        if model_id == 0x14:
             return 'Mackie Control'
-        elif model_id == 0x15:
+        if model_id == 0x15:
             return 'Mackie Control XT'
-        else:
-            return None
+        return None
 
     @staticmethod
     def get_mcu_id_from_model(model):
         if model == 'Logic Control':
             return 0x10
-        elif model == 'Logic Control XT':
+        if model == 'Logic Control XT':
             return 0x11
-        elif model == 'Mackie Control':
+        if model == 'Mackie Control':
             return 0x14
-        elif model == 'Mackie Control XT':
+        if model == 'Mackie Control XT':
             return 0x15
-        else:
-            return None
+        return None
 
     @staticmethod
     def get_preferred_mcu_model():
@@ -305,15 +303,15 @@ def get_preferred_mcu_model_id():
     def get_preferred_midi_input():
         if os.name == 'nt':
             return 'In From MIDI Yoke:  2'
-        else:
-            return 'mcu'
+
+        return 'mcu'
 
     @staticmethod
     def get_preferred_midi_output():
         if os.name == 'nt':
             return 'Out To MIDI Yoke:  1'
-        else:
-            return 'mcu'
+
+        return 'mcu'
 
     # --- MIDI processing ---
     def process_midi_input(self):
@@ -331,7 +329,7 @@ def receive_midi(self, status, message):
                 self.send_midi_sysex(sysex_message)
 
                 return
-            elif message[5] == 0x02:
+            if message[5] == 0x02:
                 self._log('Received "Host Connection Reply".')
                 if (message[6:13] == self._serial_number_bytes) and (message[13:17] == self._response_bytes):
                     self._log('Sending "Host Connection Confirmation"...', True)
@@ -356,7 +354,7 @@ def receive_midi(self, status, message):
                     self.send_midi_sysex(sysex_message)
 
                 return
-            elif message[5:] == [0x13, 0x00, 0x0F7]:
+            if message[5:] == [0x13, 0x00, 0x0F7]:
                 self._log('Received "Version Request".')
                 self._log('Sending "Version Reply"...', True)
 
@@ -365,22 +363,22 @@ def receive_midi(self, status, message):
                 self.send_midi_sysex(sysex_message)
 
                 return
-            elif message[5:] == [0x0F, 0x7F, 0x0F7]:
+            if message[5:] == [0x0F, 0x7F, 0x0F7]:
                 self._log('Received "Go Offline".', True)
                 self.go_offline()
 
                 return
-            elif message[5:] == [0x61, 0x0F7]:
+            if message[5:] == [0x61, 0x0F7]:
                 self._log('Received "Faders To Minimum".', True)
                 self.faders_to_minimum()
 
                 return
-            elif message[5:] == [0x62, 0x0F7]:
+            if message[5:] == [0x62, 0x0F7]:
                 self._log('Received "All LEDs Off".', True)
                 self.all_leds_off()
 
                 return
-            elif message[5:] == [0x63, 0x0F7]:
+            if message[5:] == [0x63, 0x0F7]:
                 self._log('Received "Reset".', True)
                 self.reset()
 
@@ -445,7 +443,7 @@ def receive_midi(self, status, message):
             self._log(output.strip())
 
     def send_midi_sysex(self, data):
-        assert(type(data) is list)
+        assert isinstance(data, list)
 
         header = [0x00, 0x00, 0x66, self._mcu_model_id]