#20 refactor logging methods to use common _log function

Author: grongierisc

src/iop/_common.py

@@ -203,87 +203,74 @@ def _get_properties(cls):
         except:
             pass
         return ret
-
-    def log_info(self, message):
-        """ Write a log entry of type "info". Log entries can be viewed in the management portal.
-        
-        Parameters:
-        message: a string that is written to the log.
+    
+    def _log(self) -> (str,str):
+        """ Get the class name and method name of the calling method.
+        Returns a tuple of the class name and the method name.
         """
-
         current_class = self.__class__.__name__
         current_method = None
         try:
             frame = traceback.extract_stack()[-2]
             current_method = frame.name
         except:
             pass
+        return current_class, current_method
+    
+    def trace(self, message):
+        """ Write a log entry of type "trace". Log entries can be viewed in the management portal.
+        
+        Parameters:
+        message: a string that is written to the log.
+        """
+        current_class, current_method = self._log()
+        iris.cls("Ens.Util.Log").LogTrace(current_class, current_method, message,1)
+
+    def log_info(self, message):
+        """ Write a log entry of type "info". Log entries can be viewed in the management portal.
+        
+        Parameters:
+        message: a string that is written to the log.
+        """
+
+        current_class, current_method = self._log()
         iris.cls("Ens.Util.Log").LogInfo(current_class, current_method, message)
-        return
 
     def log_alert(self, message):
         """ Write a log entry of type "alert". Log entries can be viewed in the management portal.
         
         Parameters:
         message: a string that is written to the log.
         """
-        current_class = self.__class__.__name__
-        current_method = None
-        try:
-            frame = traceback.extract_stack()[-2]
-            current_method = frame.name
-        except:
-            pass
+        current_class, current_method = self._log()
         iris.cls("Ens.Util.Log").LogAlert(current_class, current_method, message)
-        return
 
     def log_warning(self, message):
         """ Write a log entry of type "warning". Log entries can be viewed in the management portal.
         
         Parameters:
         message: a string that is written to the log.
         """
-        current_class = self.__class__.__name__
-        current_method = None
-        try:
-            frame = traceback.extract_stack()[-2]
-            current_method = frame.name
-        except:
-            pass
+        current_class, current_method = self._log()
         iris.cls("Ens.Util.Log").LogWarning(current_class, current_method, message)
-        return
 
     def log_error(self, message):
         """ Write a log entry of type "error". Log entries can be viewed in the management portal.
         
         Parameters:
         message: a string that is written to the log.
         """
-        current_class = self.__class__.__name__
-        current_method = None
-        try:
-            frame = traceback.extract_stack()[-2]
-            current_method = frame.name
-        except:
-            pass
+        current_class, current_method = self._log()
         iris.cls("Ens.Util.Log").LogError(current_class, current_method, message)
-        return
 
     def log_assert(self, message):
         """ Write a log entry of type "assert". Log entries can be viewed in the management portal.
         
         Parameters:
         message: a string that is written to the log.
         """
-        current_class = self.__class__.__name__
-        current_method = None
-        try:
-            frame = traceback.extract_stack()[-2]
-            current_method = frame.name
-        except:
-            pass
+        current_class, current_method = self._log()
         iris.cls("Ens.Util.Log").LogAssert(current_class, current_method, message)
-        return
 
     def LOGINFO(self, message):
         """ DECAPRETED : use log_info