Replace prints with logging (#191)

Author: l1va

main.py

@@ -12,7 +12,7 @@
 
     # add shared libraries to LD_LIBRARY_PATH
     os.environ["LD_LIBRARY_PATH"] = shared_libs + ":" + prev_ld_path
-    print("LD_LIBRARY_PATH:", os.environ["LD_LIBRARY_PATH"])
+    logging.debug("LD_LIBRARY_PATH: %s", os.environ["LD_LIBRARY_PATH"])
 
 
 import logging
@@ -36,18 +36,19 @@
 from src.gui_utils import read_plane
 
 logging.basicConfig(
-    filename="interface.log",
-    filemode="w+",
     level=logging.INFO,
     format="%(asctime)s %(message)s",
+    handlers=[
+        logging.FileHandler("interface.log", mode="w+"),
+        logging.StreamHandler(sys.stdout),
+    ],
 )
 
 
 def excepthook(exc_type, exc_value, exc_tb):
     tb = "".join(traceback.format_exception(exc_type, exc_value, exc_tb))
-    print("error catched!:")
-    print("error message:\n", tb)
-    logging.error(tb)
+    logging.error("error caught!")
+    logging.error("error message:\n%s", tb)
     QtWidgets.QApplication.quit()
 
 
@@ -136,7 +137,7 @@ def create_project(project_path: str):
     # sys.exit(app.exec_())
     sys.excepthook = excepthook
     ret = app.exec_()
-    print("event loop exited")
+    logging.info("event loop exited")
 
     s = sett()
     if os.path.isfile(s.colorizer.copy_stl_file):

src/bug_report.py

@@ -1,3 +1,4 @@
+import logging
 import os
 import shutil
 import zipfile
@@ -19,6 +20,8 @@
 from src.settings import sett, save_splanes_to_file, PathBuilder
 from src.client import send_bug_report
 
+logger = logging.getLogger(__name__)
+
 
 class bugReportDialog(QWidget):
     def __init__(self, controller):
@@ -190,4 +193,4 @@ def cleaningTempFiles(self):
             self.image_list.setText("")
             self.error_description.setText("")
         except Exception as e:
-            print(str(e))
+            logger.error(str(e))

src/client.py

@@ -1,9 +1,12 @@
 import src.server_api.pyapi.srv_bug.srv_bug_pb2 as srv_bug_pb2
+import logging
 import src.server_api.pyapi.srv_bug.srv_bug_pb2_grpc as srv_bug_pb2_grpc
 import grpc
 import os
 import yaml
 
+logger = logging.getLogger(__name__)
+
 CHUNK_SIZE = 1024 * 1024  # 1MB
 
 
@@ -40,12 +43,12 @@ def send_bug_report(filename, error_description):
 
         # check if file exists
         if not os.path.exists(filename):
-            print("File not found: %s" % filename)
+            logger.error("File not found: %s", filename)
             return False
 
         msgs = prepare_bug(filename, error_description)
 
-        print("prepared to call rpc")
+        logger.info("prepared to call rpc")
         response = stub.AddBug(msgs)
-        print(response)
+        logger.info("%s", response)
         return True

src/controller.py

@@ -43,18 +43,20 @@
 )
 import src.settings as settings
 
+logger = logging.getLogger(__name__)
+
 try:
     from src.bug_report import bugReportDialog
-except:
-    print("bug reporting is unavailable")
+except Exception:
+    logger.warning("bug reporting is unavailable")
 
 # try import of private hardware module
 try:
     import src.hardware.service as service
     import src.hardware.calibration as calibration
     import src.hardware.printer as printer
 except Exception as e:
-    print(f"hardware module is unavailable: {e}")
+    logger.warning("hardware module is unavailable: %s", e)
 
 
 class MainController:
@@ -81,14 +83,14 @@ def __init__(self, view, model):
                     self.printer, PathBuilder.calibration_file()
                 ),
             )
-        except:
-            print("printer is not initialized")
+        except Exception:
+            logger.warning("printer is not initialized")
 
         # bug reporting might be unavailable
         try:
             self.bugReportDialog = bugReportDialog(self)
-        except:
-            print("bug reporting is unavailable")
+        except Exception:
+            logger.warning("bug reporting is unavailable")
         self._connect_signals()
 
     def _connect_signals(self):
@@ -216,7 +218,7 @@ def create_printer(self):
                 PathBuilder.calibration_file()
             )
         except AttributeError:
-            print("hardware module is unavailable, skip")
+            logger.warning("hardware module is unavailable, skip")
 
         # show info dialog
         showInfoDialog(
@@ -255,7 +257,7 @@ def choose_printer_path(self):
                     PathBuilder.calibration_file()
                 )
             except AttributeError:
-                print("hardware module is unavailable, skip")
+                logger.warning("hardware module is unavailable, skip")
 
     def moving_figure(self, sourceParent, previousRow):
         if sourceParent.row() != -1:
@@ -592,12 +594,12 @@ def load_stl(self, filename, colorize=False):
 
     def load_gcode(self, filename, is_from_stl):
         def work():
-            print("start parsing gcode")
+            logger.info("start parsing gcode")
             start_time = time.time()
             gc = self.model.load_gcode(filename)
-            print("finish parsing gcode")
+            logger.info("finish parsing gcode")
             end_time = time.time()
-            print("spent time for gcode loading: ", end_time - start_time, "s")
+            logger.info("spent time for gcode loading: %s s", end_time - start_time)
 
             return gc
 
@@ -637,12 +639,12 @@ def slice_stl(self, slicing_type):
 
         def work():
             start_time = time.time()
-            print("start slicing")
+            logger.info("start slicing")
             p = Process(PathBuilder.slicing_cmd())
             p.wait()
-            print("finished command")
+            logger.info("finished command")
             end_time = time.time()
-            print("spent time for slicing: ", end_time - start_time, "s")
+            logger.info("spent time for slicing: %s s", end_time - start_time)
 
             if p.returncode == 2:
                 # panic
@@ -672,7 +674,7 @@ def work():
         # load gcode without calibration
         self.view.picture_slider.setValue(0)
         self.load_gcode(PathBuilder.gcodevis_file(), True)
-        print("loaded gcode")
+        logger.info("loaded gcode")
         self.update_interface(sett().slicing.stl_filename)
 
     def check_calibration_data_catalog(self):
@@ -708,8 +710,10 @@ def show_online_documentation(self):
 
     def save_settings(self, slicing_type, filename=""):
         s = sett()
-        print(
-            f"saving settings of stl file {self.model.opened_stl} {s.slicing.stl_file}"
+        logger.info(
+            "saving settings of stl file %s %s",
+            self.model.opened_stl,
+            s.slicing.stl_file,
         )
         # s.slicing.stl_file = self.model.opened_stl
         tf = vtk.vtkTransform()

src/entry_window.py

@@ -1,4 +1,5 @@
 import os, math
+import logging
 from PyQt5.QtWidgets import (
     QWidget,
     QVBoxLayout,
@@ -33,6 +34,8 @@
 import src.locales as locales
 import shutil
 
+logger = logging.getLogger(__name__)
+
 
 class EntryWindow(QWidget):
     # entry window is a window that is shown before main window
@@ -228,7 +231,7 @@ def load_recent_projects_root(self) -> str:
         return ""
 
     def create_new_project(self):
-        print("Creating new project...")
+        logger.info("Creating new project...")
         # check if project name is empty
         if self.project_name_text_edit.text() == "":
             showErrorDialog(locales.getLocale().ProjectNameCannotBeEmpty)
@@ -249,7 +252,7 @@ def create_new_project(self):
         full_path = pathlib.Path(
             self.project_directory_edit.text(), self.project_name_text_edit.text()
         )
-        print(full_path)
+        logger.info("%s", full_path)
 
         # check if project already exists
         if full_path.exists():
@@ -282,7 +285,7 @@ def open_existing_project_via_directory(self):
         self.open_existing_project(selected_project)
 
     def open_existing_project(self, selected_project):
-        print(f"Opening {selected_project}...")
+        logger.info("Opening %s...", selected_project)
 
         update_last_open_project(self.recent_projects, selected_project)
 

src/figure_editor.py

@@ -2,6 +2,7 @@
 Provides a class creating a new window to edit parameters of custom figures
 """
 
+import logging
 import sys
 from typing import List, Callable, Dict, Tuple, Optional, Union
 from functools import partial
@@ -27,6 +28,8 @@
 from src.settings import sett
 from src.locales import getLocale
 
+logger = logging.getLogger(__name__)
+
 
 class FigureEditor(QWidget):
     """
@@ -344,10 +347,10 @@ def update(self, pos, orient, scale):
 if __name__ == "__main__":
 
     def handle1(d):
-        print(1, d)
+        logger.debug("handler1 %s", d)
 
     def handle2(d):
-        print(2, d)
+        logger.debug("handler2 %s", d)
 
     app = QApplication(sys.argv)
     f1 = PlaneEditor(handle1, None)

src/interactor_style.py

@@ -1,6 +1,10 @@
+import logging
 import vtk
 
 
+logger = logging.getLogger(__name__)
+
+
 class ActorInteractorStyle(vtk.vtkInteractorStyleTrackballActor):
     def __init__(self, onChange, parent=None):
         self.WorkingActor = None
@@ -15,10 +19,10 @@ def __init__(self, onChange, parent=None):
         # self.AddObserver('MouseWheelBackwardEvent', self.bimodal_mouse_handler)
 
     def onPressEvent(self, obj, event):
-        print("INSIDE!")
+        logger.debug("INSIDE!")
         # pos2d = obj.GetEventPosition()
         clickPos = self.GetInteractor().GetEventPosition()
-        print(clickPos)
+        logger.debug("%s", clickPos)
 
         picker = vtk.vtkPropPicker()
         picker.Pick(clickPos[0], clickPos[1], 0, self.GetDefaultRenderer())
@@ -29,7 +33,7 @@ def onPressEvent(self, obj, event):
         if self.NewPickedActor != self.WorkingActor:
             return
 
-        print("BEFORE ON LEFT")
+        logger.debug("BEFORE ON LEFT")
 
         if event == "LeftButtonPressEvent":
             self.OnLeftButtonDown()

src/settings.py

@@ -130,7 +130,7 @@ def compare_files(file1_path, file2_path):
             return False
 
     except FileNotFoundError:
-        print("Error during file comparison!")
+        logging.error("Error during file comparison!")
         return True
 
 
@@ -232,7 +232,7 @@ def load_settings(filename=""):
 
 def read_settings(filename=""):
     if not filename:
-        print("retrieving settings")
+        logging.debug("retrieving settings")
         if getattr(sys, "frozen", False):
             app_path = path.dirname(sys.executable)
             # uncomment if you want some protection that nothing would be broken
@@ -280,7 +280,7 @@ def save_settings(filename=""):
 
     temp = prepare_temp_settings(_sett)
 
-    print(f"saving settings to {filename}")
+    logging.info("saving settings to %s", filename)
     with open(filename, "w") as f:
         f.write(temp)
 
@@ -307,7 +307,7 @@ def get_version(settings_filename):
         version = settings["common"]["version"]
         return version
     except Exception as e:
-        print("Error reading version")
+        logging.error("Error reading version")
         return ""
 
 
@@ -322,7 +322,7 @@ def set_version(settings_filename, version):
             yaml.dump(settings, settings_file, default_flow_style=False)
 
     except Exception as e:
-        print("Error writing version")
+        logging.error("Error writing version")
 
 
 def paths_transfer_in_settings(initial_settings_filename, final_settings_filename):
@@ -418,15 +418,15 @@ def has_same_attributes(self, other):
             if attr in ignore_attributes:
                 continue
             if not hasattr(other, attr):
-                print(f"Attribute {attr} not found in other")
+                logging.warning("Attribute %s not found in other", attr)
                 return False
 
         # try to compare attributes from right to left
         for attr in other.__dict__:
             if attr in ignore_attributes:
                 continue
             if not hasattr(self, attr):
-                print(f"Attribute {attr} not found in self")
+                logging.warning("Attribute %s not found in self", attr)
                 return False
 
         return True

src/settings_widget.py

@@ -1,3 +1,4 @@
+import logging
 from PyQt5 import QtCore
 from PyQt5 import QtGui
 from PyQt5.QtWidgets import (
@@ -19,6 +20,8 @@
 from src.settings import sett, APP_PATH, Settings, read_settings
 from src.qt_utils import ClickableLineEdit, LineEdit
 
+logger = logging.getLogger(__name__)
+
 import os.path as path
 import logging
 import re
@@ -357,7 +360,7 @@ def remove_row(key, row_idx):
                 row_idx = self.__elements[key]["row_idx"]
                 remove_row(key, row_idx)
             except KeyError:
-                print(f"Key {key} not found in elements")
+                logger.warning("Key %s not found in elements", key)
                 pass
 
         self.__current_row = 1