spacr.logger — spacr 0.5.0 documentation

# Source code for spacr.logger

    import logging
    import functools
    import os

    # Automatically configure logging

    def configure_logger(log_file_name='spacr.log'):
        # Determine a safe location for the log file
        home_dir = os.path.expanduser("~")  # Get the user's home directory
        log_file_path = os.path.join(home_dir, log_file_name)  # Save log file in home directory

        # Setup logging configuration
        logging.basicConfig(
            filename=log_file_path,
            level=logging.INFO,
            format='%(asctime)s - %(name)s - %(levelname)s - %(message)s'
        )

    # Call the function to configure the logger
    configure_logger()

    # Create a logger instance for this module

    logger = logging.getLogger(__name__)

    # Decorator to log function calls

    def log_function_call(func):
        @functools.wraps(func)
        def wrapper(*args, **kwargs):
            args_repr = [repr(a) for a in args]  # Arguments passed to the function
            kwargs_repr = [f"{k}={v!r}" for k, v in kwargs.items()]  # Keyword arguments
            signature = ", ".join(args_repr + kwargs_repr)  # Construct the signature for logging
            logger.info(f"Calling {func.__name__}({signature})")  # Log function call
            try:
                result = func(*args, **kwargs)  # Execute the function
                logger.info(f"{func.__name__} returned {result!r}")  # Log the result
                return result
            except Exception as e:
                logger.exception(f"Exception occurred in {func.__name__}")  # Log any exceptions
                raise  # Re-raise the exception after logging it
        return wrapper