Introduction to with-local-logger

The with-local-logger module is a robust utility for managing local logging within Python applications. It allows developers to efficiently log information, warnings, and errors, making debugging and monitoring more straightforward. This comprehensive guide explains how to use the with-local-logger module and showcases various APIs with code snippets.

APIs and Usage

1. Initializing the Logger

To start using with-local-logger, you first need to initialize the logger:

import with_local_logger

logger = with_local_logger.LocalLogger(name="my_logger", level="DEBUG")

2. Logging Messages

Logging different types of messages:

logger.debug("This is a debug message")
logger.info("This is an info message")
logger.warning("This is a warning message")
logger.error("This is an error message")
logger.critical("This is a critical message")

3. Adding Context to Logs

You can add context to logs for better tracking:

with logger.contextualize(user_id=123):
    logger.info("User logged in")

4. Formatting Logs

Customize the log format:

logger.set_format("{asctime} - {name} - {levelname} - {message}")

5. Redirecting Log Output

Redirect logs to a file:

logger.set_handler("file", filename="app.log")

6. Filtering Logs by Level

Filter logs to only show warnings and errors:

logger.set_level("WARNING")

Application Example

Here’s an example of a simple application using with-local-logger:

import with_local_logger

def main():
    logger = with_local_logger.LocalLogger(name="app_logger", level="INFO")
    logger.info("Application started")
    
    try:
        result = 10 / 0
    except ZeroDivisionError as e:
        logger.error(f"An error occurred: {e}")
    
    with logger.contextualize(user_id=42):
        logger.info("Processing user data")

    logger.info("Application finished")

if __name__ == "__main__":
    main()

In this example, the logger is initialized at the start of the application. Different types of messages are logged, context is added to some logs, and an error situation is handled and logged. This demonstrates the utility and flexibility of the with-local-logger module.

Hash: 8ed043ca8fae4806c2283cd395f975c5235c5807db1a97c30d2ac9a32bf83779