eazylogger 24.9.27

A simple module to add color to Python log messages.

EazyLogger

A simple module to add color to Python log messages.

Table of Contents

• Installation
• Logger
• Examples:
  • Basic Example
  • Using Parameters

Installation

Binary installer is available at the Python Package Index (PyPi).

pip install eazylogger

Logger

Logger(name, msg_fmt="[%(levelname)s] - %(message)s (%(name)s)", info_fmt="%(message)s")

Logger class with color-coded log messages.

Parameters

• name : str
  • String expression representing the name of the logger class.

• msg_fmt : str, default [%(levelname)s] - %(message)s (%(name)s)
  • String expression representing how the debug, warning, error, and critical log messages are formatted. Defaults to "[%(levelname)s] - %(message)s (%(name)s)".

• info_fmt : str, default %(message)s
  • String expression representing how the info and success messages are formatted. Defaults to "%(message)s".

---

Examples

• Basic Example
• Using parameters:
  • name

Basic Example

1. Import and instantiate Logger class:

   # main.py
   from eazylogger import Logger
   logger = Logger(__name__)
   

2. Logging methods:

   # main.py
   logger.debug("Example debug message")
   logger.info("Example info message")
   logger.warn("Example warning message")
   logger.error("Example error message")
   logger.critical("Example critical message")
   logger.success("Example success message")
   

Using Parameters

• name:

  logger = Logger("customName")
  logger.debug("Example debug message with customName")
  

  [DEBUG] - Example debug message with customName (customName)
  

• msg_fmt:

  • Sets the message format for logger.debug, logger.warn, logger.error, and logger.critical.

  • For full list of keyword arguments see the docs

  logger = Logger(
    __name__,
    msg_fmt="%(asctime)s %(message)s [%(pathname)s]",
  )
  logger.debug("Example debug message with custom msg_fmt")
  

  2000-01-01 12:00:00,000 Example debug message with custom msg_fmt [~\main.py]
  

• info_fmt

  • Sets the message format for logger.info and logger.success.

  logger = Logger(
    __name__,
    info_fmt="[%(levelname)s] - %(message)s (%(name)s)",
  )
  logger.info("Example info message with custom info_fmt")
  

  [INFO] - Example info message with custom info_fmt (__main__)