I04_1-150: extracted message instantiation in a factory class

Author: IsabellaRey

dls_barcode/gui/main_window.py

@@ -8,11 +8,11 @@
 from dls_barcode.camera import CameraScanner, CameraSwitch, NoNewBarcodeMessage
 from dls_util import Beeper
 from dls_util.file import FileManager
-from dls_util.message import MessageType, Message
 from .barcode_table import BarcodeTable
 from .image_frame import ImageFrame
 from .record_table import ScanRecordTable
 from .message_display import MessageDisplay
+from .message_factory import MessageFactory
 
 
 RESULT_TIMER_PERIOD = 1000 # ms
@@ -207,28 +207,13 @@ def _read_message_queue(self):
                     if not self._test_timer_is_running():
                         self._start_test_timer()
                     elif self._has_test_timer_timeout():
-                        self._message_display.display_message(self._get_duplicate_barcode_message())
+                        self._message_display.display_message(MessageFactory.duplicate_barcode_message())
                 else:
                     self._reset_test_timer()
-                    self._message_display.display_message(self._get_message_from_scanner_msg(scanner_msg))
+                    self._message_display.display_message(MessageFactory.from_scanner_message(scanner_msg))
             except queue.Empty:
                 return
 
-    def _get_duplicate_barcode_message(self):
-        return Message(MessageType.WARNING, "Puck barcode already in database")
-
-    def _get_message_from_scanner_msg(self, scanner_msg):
-        return Message(MessageType.WARNING, scanner_msg.content())
-
-    def _get_puck_recorded_message(self):
-        return Message(MessageType.INFO, "Puck barcode recorded")
-
-    def _get_scan_timeout_message(self):
-        return Message(MessageType.WARNING, "Scan timeout")
-
-    def _get_scan_completed_message(self):
-        return Message(MessageType.INFO, "Scan completed")
-
     def _reset_test_timer(self):
         self._test_timer = None
 
@@ -267,15 +252,15 @@ def _read_side_scan(self):
         if self._record_table.unique_side_barcode(plate): # if new side barcode
             self.original_plate = plate
             self._latest_holder_image = holder_image
-            self._message_display.display_message(self._get_puck_recorded_message())
+            self._message_display.display_message(MessageFactory.puck_recorded_message())
             self._camera_switch.restart_live_capture_from_top()
         else:
-            self._message_display.display_message(self._get_duplicate_barcode_message())
+            self._message_display.display_message(MessageFactory.duplicate_barcode_message())
 
     def _read_top_scan(self):
         if self._result_queue.empty():
             if self._camera_switch.is_top_scan_timeout():
-                self._message_display.display_message(self._get_scan_timeout_message())
+                self._message_display.display_message(MessageFactory.scan_timeout_message())
                 print("\n*** Scan timeout ***")
                 self._camera_switch.restart_live_capture_from_side()
             return
@@ -291,6 +276,6 @@ def _read_top_scan(self):
         # Barcodes successfully read
         Beeper.beep()
         print("Scan Completed")
-        self._message_display.display_message(self._get_scan_completed_message())
+        self._message_display.display_message(MessageFactory.scan_completed_message())
         self._camera_switch.restart_live_capture_from_side()
 

dls_barcode/gui/message_factory.py

@@ -0,0 +1,23 @@
+from dls_util.message import MessageType, Message
+
+
+class MessageFactory:
+    @staticmethod
+    def duplicate_barcode_message():
+        return Message(MessageType.WARNING, "Puck barcode already in database", lifetime=3)
+
+    @staticmethod
+    def from_scanner_message(scanner_msg):
+        return Message(MessageType.WARNING, scanner_msg.content())
+
+    @staticmethod
+    def puck_recorded_message():
+        return Message(MessageType.INFO, "Puck barcode recorded")
+
+    @staticmethod
+    def scan_timeout_message():
+        return Message(MessageType.WARNING, "Scan timeout")
+
+    @staticmethod
+    def scan_completed_message():
+        return Message(MessageType.INFO, "Scan completed")