Introduction to Rich-Logger

The Rich-Logger library is an advanced logging tool for Python that offers a variety of APIs to enhance the logging experience. With rich-logger, you can format your logs in stylish ways, filter them according to the log levels, and even output logs to various destinations. Below, we delve into the various APIs provided by `rich-logger` and demonstrate their usage with code snippets. Furthermore, an application example is provided to showcase how these APIs can be utilized effectively.

Basic Setup

from rich_logger import RichLogger

# Initialize the logger
logger = RichLogger("my_app")
logger.info("This is an info message.")

Custom Log Levels

logger.set_level("DEBUG")

logger.debug("This is a debug message.")
logger.info("This is an info message after setting log level to DEBUG.")

Adding Custom Handlers

from rich_logger.handlers import FileHandler

file_handler = FileHandler("app.log")
logger.add_handler(file_handler)

logger.info("This message will be logged to both the console and the file.")

Formatting Logs

from rich_logger.formatters import SimpleFormatter

simple_formatter = SimpleFormatter("%(asctime)s - %(name)s - %(levelname)s - %(message)s")
file_handler.set_formatter(simple_formatter)

logger.info("This log message will follow the custom format.")

Filtering Logs

from rich_logger.filters import LevelFilter

error_filter = LevelFilter("ERROR")
logger.add_filter(error_filter)

logger.info("This info message will be filtered out.")
logger.error("This error message will be logged.")

Application Example

from rich_logger import RichLogger
from rich_logger.handlers import FileHandler
from rich_logger.formatters import SimpleFormatter
from rich_logger.filters import LevelFilter

def setup_logging():
    logger = RichLogger("my_app")
    file_handler = FileHandler("app.log")
    simple_formatter = SimpleFormatter("%(asctime)s - %(name)s - %(levelname)s - %(message)s")
    file_handler.set_formatter(simple_formatter)
    error_filter = LevelFilter("ERROR")
    logger.add_filter(error_filter)
    logger.add_handler(file_handler)
    return logger

def main():
    logger = setup_logging()
    logger.info("Starting the application...")
    # Simulating some operations
    logger.debug("This debug message will be filtered out.")
    logger.error("An error occurred!")

if __name__ == "__main__":
    main()

Implementing rich-logger will not only make your logs more readable but also help you manage them more efficiently. With customizable handlers, filters, and formatters, you have complete control over your logging system. Whether you are building a small script or a large application, having a rich logging system in place can significantly improve debugging and monitoring capabilities.

Hash: be56dc1ea03dcaef52c193795f133d3c403d287db10988af6243216ce36588c4