simba-uw-tf-dev 4.6.2__py3-none-any.whl → 4.7.1__py3-none-any.whl

simba/utils/printing.py

@@ -1,124 +1,124 @@
-__author__ = "Simon Nilsson; sronilsson@gmail.com"
-
-try:
-    from typing import Literal
-except:
-    from typing_extensions import Literal
-
-
-import logging
-import time
-from typing import Optional
-
-from simba.utils.enums import Defaults, TagNames
-
-
-def stdout_success(msg: str, source: Optional[str] = "", elapsed_time: Optional[str] = None) -> None:
-    """
-    Helper to parse msg of completed operation to SimBA main interface.
-
-    :param str msg: Message to be parsed.
-    :param Optional[str] source: Optional string indicating the source method or function of the msg for logging.
-    :param Optional[str] elapsed_time: Optional string indicating the runtime of the completed operation.
-    :return None:
-    """
-
-    log_event(logger_name=f"{source}.{stdout_success.__name__}", log_type=TagNames.COMPLETE.value, msg=msg)
-    if elapsed_time:
-        print(f"SIMBA COMPLETE: {msg} (elapsed time: {elapsed_time}s) {Defaults.STR_SPLIT_DELIMITER.value}{TagNames.COMPLETE.value}")
-    else:
-        print(f"SIMBA COMPLETE: {msg} {Defaults.STR_SPLIT_DELIMITER.value}{TagNames.COMPLETE.value}")
-
-
-def stdout_warning(msg: str, elapsed_time: Optional[str] = None) -> None:
-    """
-    Helper to parse warning msg to SimBA main interface.
-
-    :param str msg: Message to be parsed.
-    :param Optional[str] source: Optional string indicating the source method or function of the msg for logging.
-    :param elapsed_time: Optional string indicating the runtime.
-    :return None:
-    """
-
-    if elapsed_time:
-        print(f"SIMBA WARNING: {msg} (elapsed time: {elapsed_time}s) {Defaults.STR_SPLIT_DELIMITER.value}{TagNames.WARNING.value}")
-    else:
-        print(f"SIMBA WARNING: {msg} {Defaults.STR_SPLIT_DELIMITER.value}{TagNames.WARNING.value}")
-
-
-def stdout_trash(msg: str, source: Optional[str] = "", elapsed_time: Optional[str] = None) -> None:
-    """
-    Helper to parse msg of delete operation to SimBA main interface.
-
-    :param str msg: Message to be parsed.
-    :param Optional[str] source: Optional string indicating the source method or function of the operation for logging.
-    :param elapsed_time: Optional string indicating the runtime.
-    :return None:
-    """
-
-    log_event(logger_name=f"{source}.{stdout_trash.__name__}", log_type=TagNames.TRASH.value, msg=msg)
-    if elapsed_time:
-        print(f"SIMBA COMPLETE: {msg} (elapsed time: {elapsed_time}s) {Defaults.STR_SPLIT_DELIMITER.value}{TagNames.TRASH.value}")
-    else:
-        print(f"SIMBA COMPLETE: {msg} {Defaults.STR_SPLIT_DELIMITER.value}{TagNames.TRASH.value}")
-
-
-def stdout_information(msg: str, source: Optional[str] = "", elapsed_time: Optional[str] = None) -> None:
-    """
-    Helper to parse information msg to SimBA main interface. E.g., how many monitors and their resolutions which is available.
-
-    :param str msg: Message to be parsed.
-    :param Optional[str] source: Optional string indicating the source method or function of the operation for logging.
-    :param elapsed_time: Optional string indicating the runtime.
-    :return None:
-    """
-
-    log_event(logger_name=f"{source}.{stdout_trash.__name__}", log_type=TagNames.INFORMATION.value, msg=msg)
-    if elapsed_time:
-        print(f"SIMBA COMPLETE: {msg} (elapsed time: {elapsed_time}s) {Defaults.STR_SPLIT_DELIMITER.value}{TagNames.INFORMATION.value}")
-    else:
-        print(f"{msg} {Defaults.STR_SPLIT_DELIMITER.value}{TagNames.INFORMATION.value}")
-
-
-class SimbaTimer(object):
-    """Timer class for keeping track of start and end-times of calls"""
-
-    def __init__(self, start: bool = False):
-        if start:
-            self.start_timer()
-
-    def start_timer(self):
-        self.timer = time.time()
-
-    def stop_timer(self):
-        if not hasattr(self, "timer"):
-            self.elapsed_time = -1
-            self.elapsed_time_str = "-1"
-        else:
-            self.elapsed_time = round(time.time() - self.timer, 4)
-            self.elapsed_time_str = str(self.elapsed_time)
-
-
-def log_event(logger_name: str, log_type: Literal["CLASS_INIT", "error", "warning"], msg: str):
-    logger = logging.getLogger(str(logger_name))
-    if log_type == TagNames.CLASS_INIT.value:
-        logger.info(f"{TagNames.CLASS_INIT.value}||{msg}")
-    elif log_type == TagNames.ERROR.value:
-        logger.error(f"{TagNames.ERROR.value}||{msg}")
-    elif log_type == TagNames.WARNING.value:
-        logger.warning(f"{TagNames.WARNING.value}||{msg}")
-    elif log_type == TagNames.TRASH.value:
-        logger.info(f"{TagNames.TRASH.value}||{msg}")
-    elif log_type == TagNames.COMPLETE.value:
-        logger.info(f"{TagNames.COMPLETE.value}||{msg}")
-
-
-def perform_timing(func):
-    def decorator(*args, **kwargs):
-        timer = SimbaTimer(start=True)
-        results = func(*args, **kwargs, _timer=timer)
-        timer.stop_timer()
-        results["timer"] = timer.elapsed_time_str
-        return results
-
-    return decorator
+__author__ = "Simon Nilsson; sronilsson@gmail.com"
+
+try:
+    from typing import Literal
+except:
+    from typing_extensions import Literal
+
+import logging
+import time
+from datetime import datetime
+from typing import Optional
+
+from simba.utils.enums import Defaults, TagNames
+
+
+def stdout_success(msg: str, source: Optional[str] = "", elapsed_time: Optional[str] = None) -> None:
+    """
+    Helper to parse msg of completed operation to SimBA main interface.
+
+    :param str msg: Message to be parsed.
+    :param Optional[str] source: Optional string indicating the source method or function of the msg for logging.
+    :param Optional[str] elapsed_time: Optional string indicating the runtime of the completed operation.
+    :return None:
+    """
+
+    log_event(logger_name=f"{source}.{stdout_success.__name__}", log_type=TagNames.COMPLETE.value, msg=msg)
+    if elapsed_time:
+        print(f"[{datetime.now().strftime('%H:%M:%S')}] SIMBA COMPLETE: {msg} (elapsed time: {elapsed_time}s) {Defaults.STR_SPLIT_DELIMITER.value}{TagNames.COMPLETE.value}")
+    else:
+        print(f"[{datetime.now().strftime('%H:%M:%S')}] SIMBA COMPLETE: {msg} {Defaults.STR_SPLIT_DELIMITER.value}{TagNames.COMPLETE.value}")
+
+
+def stdout_warning(msg: str, elapsed_time: Optional[str] = None) -> None:
+    """
+    Helper to parse warning msg to SimBA main interface.
+
+    :param str msg: Message to be parsed.
+    :param Optional[str] source: Optional string indicating the source method or function of the msg for logging.
+    :param elapsed_time: Optional string indicating the runtime.
+    :return None:
+    """
+
+    if elapsed_time:
+        print(f"[{datetime.now().strftime('%H:%M:%S')}] SIMBA WARNING: {msg} (elapsed time: {elapsed_time}s) {Defaults.STR_SPLIT_DELIMITER.value}{TagNames.WARNING.value}")
+    else:
+        print(f"[{datetime.now().strftime('%H:%M:%S')}] SIMBA WARNING: {msg} {Defaults.STR_SPLIT_DELIMITER.value}{TagNames.WARNING.value}")
+
+
+def stdout_trash(msg: str, source: Optional[str] = "", elapsed_time: Optional[str] = None) -> None:
+    """
+    Helper to parse msg of delete operation to SimBA main interface.
+
+    :param str msg: Message to be parsed.
+    :param Optional[str] source: Optional string indicating the source method or function of the operation for logging.
+    :param elapsed_time: Optional string indicating the runtime.
+    :return None:
+    """
+
+    log_event(logger_name=f"{source}.{stdout_trash.__name__}", log_type=TagNames.TRASH.value, msg=msg)
+    if elapsed_time:
+        print(f"[{datetime.now().strftime('%H:%M:%S')}] SIMBA COMPLETE: {msg} (elapsed time: {elapsed_time}s) {Defaults.STR_SPLIT_DELIMITER.value}{TagNames.TRASH.value}")
+    else:
+        print(f"[{datetime.now().strftime('%H:%M:%S')}] SIMBA COMPLETE: {msg} {Defaults.STR_SPLIT_DELIMITER.value}{TagNames.TRASH.value}")
+
+
+def stdout_information(msg: str, source: Optional[str] = "", elapsed_time: Optional[str] = None) -> None:
+    """
+    Helper to parse information msg to SimBA main interface. E.g., how many monitors and their resolutions which is available.
+
+    :param str msg: Message to be parsed.
+    :param Optional[str] source: Optional string indicating the source method or function of the operation for logging.
+    :param elapsed_time: Optional string indicating the runtime.
+    :return None:
+    """
+
+    log_event(logger_name=f"{source}.{stdout_trash.__name__}", log_type=TagNames.INFORMATION.value, msg=msg)
+    if elapsed_time:
+        print(f"[{datetime.now().strftime('%H:%M:%S')}] SIMBA COMPLETE: {msg} (elapsed time: {elapsed_time}s) {Defaults.STR_SPLIT_DELIMITER.value}{TagNames.INFORMATION.value}")
+    else:
+        print(f"[{datetime.now().strftime('%H:%M:%S')}] {msg} {Defaults.STR_SPLIT_DELIMITER.value}{TagNames.INFORMATION.value}")
+
+
+class SimbaTimer(object):
+    """Timer class for keeping track of start and end-times of calls"""
+
+    def __init__(self, start: bool = False):
+        if start:
+            self.start_timer()
+
+    def start_timer(self):
+        self.timer = time.time()
+
+    def stop_timer(self):
+        if not hasattr(self, "timer"):
+            self.elapsed_time = -1
+            self.elapsed_time_str = "-1"
+        else:
+            self.elapsed_time = round(time.time() - self.timer, 4)
+            self.elapsed_time_str = str(self.elapsed_time)
+
+
+def log_event(logger_name: str, log_type: Literal["CLASS_INIT", "error", "warning"], msg: str):
+    logger = logging.getLogger(str(logger_name))
+    if log_type == TagNames.CLASS_INIT.value:
+        logger.info(f"{TagNames.CLASS_INIT.value}||{msg}")
+    elif log_type == TagNames.ERROR.value:
+        logger.error(f"{TagNames.ERROR.value}||{msg}")
+    elif log_type == TagNames.WARNING.value:
+        logger.warning(f"{TagNames.WARNING.value}||{msg}")
+    elif log_type == TagNames.TRASH.value:
+        logger.info(f"{TagNames.TRASH.value}||{msg}")
+    elif log_type == TagNames.COMPLETE.value:
+        logger.info(f"{TagNames.COMPLETE.value}||{msg}")
+
+
+def perform_timing(func):
+    def decorator(*args, **kwargs):
+        timer = SimbaTimer(start=True)
+        results = func(*args, **kwargs, _timer=timer)
+        timer.stop_timer()
+        results["timer"] = timer.elapsed_time_str
+        return results
+
+    return decorator