add module_wrapper

csst_common/wrapper.py

@@ -3,6 +3,8 @@ import time
 import traceback
 from collections import namedtuple
 
+from astropy import time
+
 from csst_common.data_manager import CsstMsDataManager
 from csst_common.file_recorder import FileRecorder
 from csst_common.status import CsstStatus
@@ -54,6 +56,49 @@ def l1ppl_module(func):
     return call_l1ppl_module
 
 
+def module_wrapper(func):
+    @functools.wraps(func)
+    def call_module(logger, tstamp=None, *args, **kwargs):
+        logger.info(f"=====================================================")
+        t_start = time.time()
+        logger.info(f"Starting Module: **{func.__name__}**")
+        # logger.info(f"Additional arguments: {args} {kwargs}")
+        try:
+            # if the module finishes
+            status, fr, *output = func(*args, **kwargs)
+        except Exception as e:
+            # if the module raises error
+            exc_info = traceback.format_exc()  # traceback info
+            logger.error(f"Error occurs! \n{exc_info}")
+            status = CsstStatus.ERROR  # default status if exceptions occur
+            fr = FileRecorder()  # default FileRecorder if exceptions occur
+            output = [exc_info, ]  # default output if exceptions occur
+        finally:
+            t_stop = time.time()
+            t_cost = t_stop - t_start
+            if status in [CsstStatus.PERFECT, CsstStatus.WARNING, CsstStatus.ERROR]:
+                # perfect / warning / error
+                logger.info(f"Module finished with status: {status} - time cost: {t_cost:.1f} sec")
+            else:
+                # invalid status
+                logger.error(f"Invalid status: {status}")
+            # record exception traceback info
+            logger.info(
+                f"ModuleResult: \n"
+                f"   - name: {func.__name__}\n"
+                f"   - status: {status}\n"
+                f"   - additional output: {output}\n"
+                f"   - fr: [{fr.summary}]\n{fr}\n"
+            )
+            # write time stamp
+            if tstamp is not None:
+                with open(tstamp, "a+") as f:
+                    f.write(f"{time.Time.now().isot}+08:00\n")
+            return ModuleResult(func.__name__, t_cost, status, fr, output)
+
+    return call_module
+
+
 if __name__ == "__main__":
     @l1ppl_module
     def call_add(dm, a, b):
@@ -62,6 +107,7 @@ if __name__ == "__main__":
         else:
             return ModuleResult(CsstStatus.ERROR, None, (a, b))
 
+
     dm = CsstMsDataManager()
     print(call_add(dm, 1., 2.))
     print(call_add(dm, 1., None))