aiverify-moonshot 0.4.1__py3-none-any.whl → 0.4.2__py3-none-any.whl

moonshot/src/utils/log.py

@@ -0,0 +1,66 @@
+import logging
+import os
+from pathlib import Path
+
+
+def configure_logger(name: str):
+    """
+    Configures and returns a logger with a specified name.
+
+    This function creates a logger and sets its level to INFO. It also creates a console handler,
+    sets its level to INFO, and assigns a specific formatter to it. The formatter includes the
+    timestamp, log level, filename, function name, line number, and the log message. Finally, the
+    console handler is added to the logger.
+
+    Args:
+        name (str): The name of the logger to be created and configured.
+
+    Returns:
+        logging.Logger: The configured logger with the specified name.
+    """
+    log_extension = ".log"
+
+    # Read environment variable
+    log_filename = os.getenv("MS_LOG_NAME", "moonshot").lower()
+    log_level = os.getenv("MS_LOG_LEVEL", "INFO").upper()
+    log_write_to_file = os.getenv("MS_LOG_TO_FILE", "false").lower() == "true"
+
+    # Create a formatter
+    formatter = logging.Formatter(
+        "%(asctime)s [%(levelname)s][%(filename)s::%(funcName)s(%(lineno)d)] %(message)s"
+    )
+
+    # Check name is valid
+    if not name or not isinstance(name, str) or name is None:
+        name = Path(__file__).stem
+
+    # Check log level is valid
+    valid_log_levels = ["DEBUG", "INFO", "WARNING", "ERROR"]
+    if log_level not in valid_log_levels:
+        log_level = "INFO"
+
+    # Check log filename is valid
+    if not log_filename or not isinstance(log_filename, str) or log_filename is None:
+        log_filename = "moonshot"
+
+    logger = logging.getLogger(name)
+    logger.setLevel(log_level)
+    logger.propagate = False
+
+    # Create a console handler
+    console_handler = logging.StreamHandler()
+    console_handler.setLevel(log_level)
+    console_handler.setFormatter(formatter)
+    logger.addHandler(console_handler)
+
+    # Create a file handler if required
+    if log_write_to_file:
+        file_path = Path(".").joinpath(log_filename).with_suffix(log_extension)
+        file_handler = logging.FileHandler(
+            str(file_path)
+        )  # Convert Path object to string
+        file_handler.setLevel(log_level)
+        file_handler.setFormatter(formatter)
+        logger.addHandler(file_handler)
+
+    return logger

moonshot/src/utils/timeit.py

@@ -1,6 +1,11 @@
 import time
 from functools import wraps
 
+from moonshot.src.utils.log import configure_logger
+
+# Create a logger for this module
+logger = configure_logger(__name__)
+
 
 def timeit(func):
     @wraps(func)
@@ -19,7 +24,9 @@ def timeit(func):
         result = func(*args, **kwargs)
         end_time = time.perf_counter()
         total_time = end_time - start_time
-        print(f"[{func.__module__}] Running [{func.__name__}] took {total_time:.4f}s")
+        logger.debug(
+            f"[{func.__module__}] Running [{func.__name__}] took {total_time:.4f}s"
+        )
         return result
 
     return timeit_wrapper