refactor: code improvements & warnings fixes

1. Refactored the "_read_video_frame()" method
to be static to fix a warning, see [2].
2. Using the class name to access class-level constants.
3. Using module level "dunders" to state the author
and additional module information. This is probably a more
elegant solution compared to using comments and/or
a dedicated "creator()" method (the latter was removed).
More info at the "PEP 8 – Style Guide for Python Code", see [1].
4. Fixed a few additional warnings, see [3], [4] & [5].

[1] https://peps.python.org/pep-0008/#module-level-dunder-names
[2] Method '_read_video_frame' may be 'static'
[3] Ui_MainWindow::setupUi()
Shadows name 'MainWindow' from outer scope
[4] AnalogGaugeWidget::set_MinValue()
Shadows built-in name 'min'
[5] AnalogGaugeWidget::set_MaxValue()
Shadows built-in name 'max'

Signed-off-by: Pavel Bar <pbar@redhat.com>

Author: barpavel

README.md

@@ -49,28 +49,28 @@ $ python3 -m venv .venv
 
 Install the mandatory dependencies using the following command:
 ```bash
-$ pip install -r requirements.txt
+(.venv) $ pip install -r requirements.txt
 ```
 
 ## Execute
 Run the application:
 ```bash
-$ python app.py
+(.venv) $ python app.py
 ```
 or
 ```bash
-$ python app.py --play-video /path/to/your/video.mp4
+(.venv) $ python app.py --play-video /path/to/your/video.mp4
 ```
 Use `--help` to display the available options
 ```console
-$ python app.py --help
+(.venv) $ python app.py --help
 usage: app.py [-h] [--play-video path]
 
 Smart Car Dashboard GUI
 
 options:
-  -h, --help         show this help message and exit
-  --play-video path  [Optional] path to video file to play instead of camera
+  -h, --help            show this help message and exit
+  --play-video path     [Optional] path to video file to play instead of camera
 ```
 
 ## Screenshot

app.py

@@ -1,4 +1,8 @@
-# Developed By Sihab Sahariar
+__author__ = "Sihab Sahariar"
+__contact__ = "www.github.com/sihabsahariar"
+__credits__ = ["Pavel Bar"]
+__version__ = "1.0.1"
+
 import io
 import sys
 import argparse
@@ -671,7 +675,7 @@ def setupUi(self, MainWindow):
 
         self.webcam = QLabel(self.frame_map)
         self.webcam.setObjectName(u"webcam")
-        self.webcam.setGeometry(QRect(500, 40, self.WEBCAM_WIDTH, self.WEBCAM_HEIGHT))
+        self.webcam.setGeometry(QRect(500, 40, Ui_MainWindow.WEBCAM_WIDTH, Ui_MainWindow.WEBCAM_HEIGHT))
 
         MainWindow.setCentralWidget(self.centralwidget)
         self.show_dashboard()
@@ -689,30 +693,31 @@ def setupUi(self, MainWindow):
 )
         self.label_km.setAlignment(Qt.AlignCenter)
 
-    def _read_video_frame(self):
+    @staticmethod
+    def _read_video_frame():
         """Read and validate a video frame from the capture device.
-        
+
         Returns:
             numpy.ndarray: Valid image frame, or None if no valid frame available
         """
         ret, image = cap.read()
-        
+
         # Validate frame
         if not ret or image is None or image.size == 0:
             return None
-        
+
         return image
 
     def view_video(self):
-        image = self._read_video_frame()
+        image = Ui_MainWindow._read_video_frame()
 
         # Check if frame is valid
         if image is None:
             # Video ended or no frame available
             if self.video_path:
                 # For video files, restart from beginning (loop)
                 cap.set(cv2.CAP_PROP_POS_FRAMES, 0)
-                image = self._read_video_frame()
+                image = Ui_MainWindow._read_video_frame()
                 if image is None:
                     # If still no frame, stop the timer
                     self.quit_video()
@@ -729,8 +734,8 @@ def view_video(self):
         height, width, channel = image.shape
 
         # Calculate scaling to fit within target area while maintaining aspect ratio
-        scale_w = self.WEBCAM_WIDTH / width
-        scale_h = self.WEBCAM_HEIGHT / height
+        scale_w = Ui_MainWindow.WEBCAM_WIDTH / width
+        scale_h = Ui_MainWindow.WEBCAM_HEIGHT / height
         scale = min(scale_w, scale_h)  # Use smaller scale to fit entirely
 
         # Calculate new dimensions
@@ -887,8 +892,8 @@ def progress(self):
     args = parser.parse_args()
 
     app = QApplication(sys.argv)
-    MainWindow = QMainWindow()
+    main_app_window = QMainWindow()
     ui = Ui_MainWindow(video_path=args.play_video)
-    ui.setupUi(MainWindow)
-    MainWindow.show()
+    ui.setupUi(main_app_window)
+    main_app_window.show()
     sys.exit(app.exec_())

gauge.py

@@ -1,4 +1,7 @@
-# Sihab Sahariar (Fixed, 2023)
+__author__ = "Sihab Sahariar"
+__contact__ = "www.github.com/sihabsahariar"
+__credits__ = ["Pavel Bar"]
+__version__ = "1.0.1"
 
 import math
 
@@ -14,11 +17,7 @@
 
 
 class AnalogGaugeWidget(QWidget):
-    """Fetches rows from a Bigtable.
-    Args: 
-        none
-    
-    """
+    """Fetches rows from a Bigtable."""
     valueChanged = pyqtSignal(int)
 
     def __init__(self, parent=None):
@@ -140,9 +139,6 @@ def rescale_method(self):
         self.scale_fontsize = self.initial_scale_fontsize * self.widget_diameter // 400
         self.value_fontsize = self.initial_value_fontsize * self.widget_diameter // 400
 
-    def creator(self):
-        print("Sihab Sahariar | www.github.com/sihabsahariar")
-
     def change_value_needle_style(self, design):
         # prepared for multiple needle instrument
         self.value_needle = []
@@ -277,24 +273,24 @@ def set_scala_main_count(self, count):
         if not self.use_timer_event:
             self.update()
 
-    def set_MinValue(self, min):
-        if self.value < min:
-            self.value = min
-        if min >= self.value_max:
+    def set_MinValue(self, new_value_min):
+        if self.value < new_value_min:
+            self.value = new_value_min
+        if new_value_min >= self.value_max:
             self.value_min = self.value_max - 1
         else:
-            self.value_min = min
+            self.value_min = new_value_min
 
         if not self.use_timer_event:
             self.update()
 
-    def set_MaxValue(self, max):
-        if self.value > max:
-            self.value = max
-        if max <= self.value_min:
+    def set_MaxValue(self, new_value_max):
+        if self.value > new_value_max:
+            self.value = new_value_max
+        if new_value_max <= self.value_min:
             self.value_max = self.value_min + 1
         else:
-            self.value_max = max
+            self.value_max = new_value_max
 
         if not self.use_timer_event:
             self.update()

requirements.txt

@@ -1,7 +1,6 @@
 folium==0.17.0
 opencv-python-headless==4.10.0.84
 opencv-python
-python-qt5
 PyQt5==5.15.10
 PyQtWebEngine==5.15.7
 qtwidgets==1.1