code cleanup and formatting

Signed-off-by: Guilherme Costa <guiherme.costa@blockstec.com>

Author: Guilherme Costa

BlocksScreen/lib/panels/widgets/sensorWidget.py

@@ -53,9 +53,7 @@ def __init__(self, parent, sensor_name: str):
         self.filament_state: SensorWidget.FilamentState = (
             SensorWidget.FilamentState.PRESENT
         )
-        self.sensor_state: SensorWidget.SensorState = (
-            SensorWidget.SensorState.ON
-        )
+        self.sensor_state: SensorWidget.SensorState = SensorWidget.SensorState.ON
         self._icon_label = None
         self._text_label = None
         self._text = self.name
@@ -68,7 +66,6 @@ def __init__(self, parent, sensor_name: str):
         )
         self.setupUI()
         self.toggle_button.stateChange.connect(self.toggle_sensor_state)
-        
 
     @property
     def type(self) -> SensorType:
@@ -98,43 +95,40 @@ def text(self, new_text) -> None:
         if self._text_label is not None:
             self._text_label.setText(f"{new_text}")
             self._text = new_text
-            
+
     @QtCore.pyqtSlot(FilamentState, name="change_fil_sensor_state")
     def change_fil_sensor_state(self, state: FilamentState):
+        """Invert the filament state in response to a Klipper update"""
         if not isinstance(state, SensorWidget.FilamentState):
             return
         self.filament_state = SensorWidget.FilamentState(not state.value)
         self.update()
-    
-    
+
     def toggle_button_state(self, state: ToggleAnimatedButton.State) -> None:
+        """Called when the Klipper firmware reports an update to the filament sensor state"""
         if state.value != self.sensor_state.value:
             self.sensor_state = self.SensorState(state.value)
-            self.toggle_button.state = ToggleAnimatedButton.State(self.sensor_state.value)
+            self.toggle_button.state = ToggleAnimatedButton.State(
+                self.sensor_state.value
+            )
             self.repaint()
-            
-    @QtCore.pyqtSlot(ToggleAnimatedButton.State, name="state-change")       
+
+    @QtCore.pyqtSlot(ToggleAnimatedButton.State, name="state-change")
     def toggle_sensor_state(self, state: ToggleAnimatedButton.State) -> None:
+        """Emit the appropriate G-Code command to change the filament sensor state."""
         if state.value != self.sensor_state.value:
             self.sensor_state = self.SensorState(state.value)
-            self.run_gcode_signal.emit(f"SET_FILAMENT_SENSOR SENSOR={self.text} ENABLE={int(self.sensor_state.value)}")
+            self.run_gcode_signal.emit(
+                f"SET_FILAMENT_SENSOR SENSOR={self.text} ENABLE={int(self.sensor_state.value)}"
+            )
             self.repaint()
-        
+
     def resizeEvent(self, a0: QtGui.QResizeEvent) -> None:
+        """Handle widget resize events."""
         return super().resizeEvent(a0)
 
     def paintEvent(self, a0: QtGui.QPaintEvent) -> None:
         """Re-implemented method, paint widget"""
-        # if (
-        #     self._scaled_select_on_pixmap is not None
-        #     and self._scaled_select_off_pixmap is not None
-        # ):  # Update the toggle button pixmap which indicates the sensor state
-        #     self._button_icon_label.setPixmap(
-        #         self._scaled_select_on_pixmap
-        #         if self.sensor_state == SensorWidget.SensorState.ON
-        #         else self._scaled_select_off_pixmap
-        #     )
-
         style_painter = QtWidgets.QStylePainter(self)
         style_painter.setRenderHint(style_painter.RenderHint.Antialiasing, True)
         style_painter.setRenderHint(
@@ -153,23 +147,21 @@ def paintEvent(self, a0: QtGui.QPaintEvent) -> None:
         _font.setPointSize(20)
         style_painter.setFont(_font)
 
-        label_name = self._text_label_name_ 
-        label_detected = self._text_label_detected 
-        label_state = self._text_label_state 
+        label_name = self._text_label_name_
+        label_detected = self._text_label_detected
+        label_state = self._text_label_state
 
         palette = label_name.palette()
-        palette.setColor(
-            palette.ColorRole.WindowText, QtGui.QColorConstants.White
-        )        
+        palette.setColor(palette.ColorRole.WindowText, QtGui.QColorConstants.White)
         style_painter.drawItemText(
             label_name.geometry(),
             label_name.alignment(),
             palette,
             True,
             label_name.text(),
-            QtGui.QPalette.ColorRole.WindowText
+            QtGui.QPalette.ColorRole.WindowText,
         )
-        
+
         _font.setPointSize(16)
         style_painter.setFont(_font)
         filament_text = self.filament_state.name.capitalize()
@@ -180,9 +172,9 @@ def paintEvent(self, a0: QtGui.QPaintEvent) -> None:
             palette,
             True,
             f"Filament: {tab_spacer}{filament_text}",
-            QtGui.QPalette.ColorRole.WindowText
+            QtGui.QPalette.ColorRole.WindowText,
         )
-        
+
         sensor_state_text = self.sensor_state.name.capitalize()
         tab_spacer += 3 * "\t"
         style_painter.drawItemText(
@@ -191,7 +183,7 @@ def paintEvent(self, a0: QtGui.QPaintEvent) -> None:
             palette,
             True,
             f"Enable: {tab_spacer}{sensor_state_text}",
-            QtGui.QPalette.ColorRole.WindowText
+            QtGui.QPalette.ColorRole.WindowText,
         )
         style_painter.end()
 
@@ -203,14 +195,12 @@ def _setupUI(self):
         self.sensor_vertical_layout = QtWidgets.QVBoxLayout()
         self.sensor_vertical_layout.setObjectName("sensorVerticalLayout")
         self._icon_label = BlocksLabel(self)
-        size_policy.setHeightForWidth(
-            self._icon_label.sizePolicy().hasHeightForWidth()
-        )
+        size_policy.setHeightForWidth(self._icon_label.sizePolicy().hasHeightForWidth())
         parent_width = self.parentWidget().width()
         self._icon_label.setSizePolicy(size_policy)
         self._icon_label.setMinimumSize(120, 100)
         self._icon_label.setMinimumSize(120, 100)
-        
+
         self._icon_label.setPixmap(
             self.icon_pixmap_fp
             if self.filament_state == self.FilamentState.PRESENT
@@ -236,10 +226,9 @@ def _setupUI(self):
         )
         self._text_label_detected.setMinimumSize(parent_width, 20)
 
-
         self._text_label_detected.setPalette(palette)
         self._text_label_detected.setText(f"Filament: {self.filament_state}")
-        
+
         self._text_label_state = QtWidgets.QLabel(parent=self)
         size_policy.setHeightForWidth(
             self._text_label_state.sizePolicy().hasHeightForWidth()
@@ -248,19 +237,29 @@ def _setupUI(self):
 
         self._text_label_state.setPalette(palette)
         self._text_label_state.setText(f"Enable: {self.sensor_state.name}")
-        
+
         self._icon_label.setSizePolicy(size_policy)
         self.toggle_button = ToggleAnimatedButton(self)
-        self.toggle_button.setMinimumSize(100,50)
+        self.toggle_button.setMinimumSize(100, 50)
         self.toggle_button.state = ToggleAnimatedButton.State.ON
 
-        self.sensor_vertical_layout.addWidget(self._icon_label, alignment=QtCore.Qt.AlignmentFlag.AlignCenter)
-        self.sensor_vertical_layout.addWidget(self._text_label_name_,alignment=QtCore.Qt.AlignmentFlag.AlignCenter)
+        self.sensor_vertical_layout.addWidget(
+            self._icon_label, alignment=QtCore.Qt.AlignmentFlag.AlignCenter
+        )
+        self.sensor_vertical_layout.addWidget(
+            self._text_label_name_, alignment=QtCore.Qt.AlignmentFlag.AlignCenter
+        )
         self.sensor_vertical_layout.addStretch()
-        self.sensor_vertical_layout.addWidget(self._text_label_state,alignment=QtCore.Qt.AlignmentFlag.AlignLeft)
+        self.sensor_vertical_layout.addWidget(
+            self._text_label_state, alignment=QtCore.Qt.AlignmentFlag.AlignLeft
+        )
         self.sensor_vertical_layout.addStretch()
-        self.sensor_vertical_layout.addWidget(self._text_label_detected,alignment=QtCore.Qt.AlignmentFlag.AlignLeft)
+        self.sensor_vertical_layout.addWidget(
+            self._text_label_detected, alignment=QtCore.Qt.AlignmentFlag.AlignLeft
+        )
         self.sensor_vertical_layout.addStretch()
-        self.sensor_vertical_layout.addWidget(self.toggle_button,alignment=QtCore.Qt.AlignmentFlag.AlignCenter)
-        
+        self.sensor_vertical_layout.addWidget(
+            self.toggle_button, alignment=QtCore.Qt.AlignmentFlag.AlignCenter
+        )
+
         self.setLayout(self.sensor_vertical_layout)

BlocksScreen/lib/panels/widgets/sensorsPanel.py

@@ -17,17 +17,16 @@ class SensorsWindow(QtWidgets.QWidget):
     request_back: typing.ClassVar[QtCore.pyqtSignal] = QtCore.pyqtSignal(
         name="request_back"
     )
+
     def __init__(self, parent):
         super(SensorsWindow, self).__init__(parent)
         self.model = EntryListModel()
         self.entry_delegate = EntryDelegate()
         self.sensor_tracking_widget = {}
         self.current_widget = None
         self.sensor_list: list[SensorWidget] = []
-        self.setupUi()
-        self.setAttribute(
-            QtCore.Qt.WidgetAttribute.WA_TranslucentBackground, True
-        )
+        self._setupUi()
+        self.setAttribute(QtCore.Qt.WidgetAttribute.WA_TranslucentBackground, True)
         self.setAttribute(QtCore.Qt.WidgetAttribute.WA_AcceptTouchEvents, True)
         self.setTabletTracking(True)
         self.fs_back_button.clicked.connect(self.request_back)
@@ -38,20 +37,21 @@ def reset_view_model(self) -> None:
         """
         self.model.clear()
         self.entry_delegate.clear()
-        
+
     @QtCore.pyqtSlot(dict, name="handle_available_fil_sensors")
     def handle_available_fil_sensors(self, sensors: dict) -> None:
-        """Handle available filament sensors, create `SensorWidget` for each detected
-        sensor
-        """
+        """Handle available filament sensors, create `SensorWidget` for each detected sensor"""
         if not isinstance(sensors, dict):
             return
         self.reset_view_model()
         filtered_sensors = list(
-        filter(
-            lambda printer_obj: str(printer_obj).startswith("filament_switch_sensor")
-            or str(printer_obj).startswith("filament_motion_sensor") or str(printer_obj).startswith("cutter_sensor"),
-            sensors.keys(),
+            filter(
+                lambda printer_obj: str(printer_obj).startswith(
+                    "filament_switch_sensor"
+                )
+                or str(printer_obj).startswith("filament_motion_sensor")
+                or str(printer_obj).startswith("cutter_sensor"),
+                sensors.keys(),
             )
         )
         if filtered_sensors:
@@ -61,26 +61,22 @@ def handle_available_fil_sensors(self, sensors: dict) -> None:
         else:
             self.no_update_placeholder.show()
 
-
-
     @QtCore.pyqtSlot(str, str, bool, name="handle_fil_state_change")
     def handle_fil_state_change(
         self, sensor_name: str, parameter: str, value: bool
     ) -> None:
+        """Handle Klipper signals for filament sensor changes"""
         _item = self.sensor_tracking_widget.get(sensor_name)
         if _item:
             if parameter == "filament_detected":
-                state = SensorWidget.FilamentState(not value) 
-                _item.change_fil_sensor_state(
-                        state
-                )
+                state = SensorWidget.FilamentState(not value)
+                _item.change_fil_sensor_state(state)
             elif parameter == "enabled":
                 _item.toggle_button_state(SensorWidget.SensorState(value))
-                    
+
     def showEvent(self, event: QtGui.QShowEvent | None) -> None:
         """Re-add clients to update list"""
         return super().showEvent(event)
-    
 
     @QtCore.pyqtSlot(ListItem, name="on-item-clicked")
     def on_item_clicked(self, item: ListItem) -> None:
@@ -89,18 +85,17 @@ def on_item_clicked(self, item: ListItem) -> None:
         """
         if not item:
             return
-        
+
         if self.current_widget:
             self.current_widget.hide()
-        
+
         name_id = item.text
         current_widget = self.sensor_tracking_widget.get(name_id)
         if current_widget is None:
             return
         self.current_widget = current_widget
         self.current_widget.show()
 
-
     def create_sensor_widget(self, name: str) -> SensorWidget:
         """Creates a sensor row to be added to the QListWidget
 
@@ -110,7 +105,6 @@ def create_sensor_widget(self, name: str) -> SensorWidget:
         _item_widget = SensorWidget(self.infobox_frame, name)
         self.info_box_layout.addWidget(_item_widget)
 
-
         if self.current_widget:
             _item_widget.hide()
         else:
@@ -122,23 +116,21 @@ def create_sensor_widget(self, name: str) -> SensorWidget:
             right_text="",
             right_icon=self.pixmap,
             left_icon=None,
-            callback= None,
+            callback=None,
             selected=False,
             allow_check=False,
             _lfontsize=17,
             _rfontsize=12,
             height=80,
-            notificate=False
+            notificate=False,
         )
         _item_widget.run_gcode_signal.connect(self.run_gcode_signal)
         self.sensor_tracking_widget[name_id] = _item_widget
         self.model.add_item(item)
-        
+
         return _item_widget
 
-    def paintEvent(self, a0: QtGui.QPaintEvent) -> None: ...
-    
-    def setupUi(self) -> None:
+    def _setupUi(self) -> None:
         """Setup UI for updatePage"""
         font_id = QtGui.QFontDatabase.addApplicationFont(
             ":/font/media/fonts for text/Momcake-Bold.ttf"
@@ -320,9 +312,7 @@ def setupUi(self) -> None:
         )
         self.fs_sensors_list.setAutoScroll(False)
         self.fs_sensors_list.setProperty("showDropIndicator", False)
-        self.fs_sensors_list.setDefaultDropAction(
-            QtCore.Qt.DropAction.IgnoreAction
-        )
+        self.fs_sensors_list.setDefaultDropAction(QtCore.Qt.DropAction.IgnoreAction)
         self.fs_sensors_list.setAlternatingRowColors(False)
         self.fs_sensors_list.setSelectionMode(
             QtWidgets.QAbstractItemView.SelectionMode.NoSelection
@@ -350,7 +340,7 @@ def setupUi(self) -> None:
         self.sensor_buttons_frame.setLayout(self.sensor_buttons_layout)
 
         self.main_content_layout.addWidget(self.sensor_buttons_frame, 0)
-        
+
         self.infobox_frame = BlocksCustomFrame()
         self.infobox_frame.setMinimumSize(QtCore.QSize(250, 300))
         self.infobox_frame.setMaximumSize(QtCore.QSize(450, 500))
@@ -379,4 +369,4 @@ def setupUi(self) -> None:
         self.infobox_frame.setLayout(self.info_box_layout)
         self.main_content_layout.addWidget(self.infobox_frame, 1)
         self.update_page_content_layout.addLayout(self.main_content_layout, 1)
-        self.setLayout(self.update_page_content_layout) 
+        self.setLayout(self.update_page_content_layout)