coloured-logger 1.0.2

A coloured logger for Python

ColouredLogger

coloured-logger is a Python package that provides a customised logger with coloured output and the ability to set verbosity levels dynamically.

Installation

You can install My Coloured Logger using pip:

pip install coloured-logger

Usage

As all the good loggers you simply use it as the standard logger

from coloured_logger import Logger

logger = Logger(__name__) # Or any other name you want

logger.info("This is an informational message.")
logger.debug("This debug message won't be displayed.")

Colour scheme is customisable by user using the ANSI escape codes for colours. These are typically defined in terms of foreground and background colours, and each color has an associated numeric code. Here is a common mapping:

Colour codes

Most terminals support 8 and 16 colours, as well as 256 (8-bit) colours. These colours are set by the user, but have commonly defined meanings.

8-16 Colours

Colour Name	Foreground Colour Code	Background Colour Code
Black	30	40
Red	31	41
Green	32	42
Yellow	33	43
Blue	34	44
Magenta	35	45
Cyan	36	46
White	37	47
Default	39	49
Reset	0	0

Note: the Reset colour is the reset code that resets all colours and text effects, Use Default colour to reset colours only.

Most terminals, apart from the basic set of 8 colors, also support the "bright" or "bold" colours. These have their own set of codes, mirroring the normal colours, but with an additional ;1 in their codes:

# Set style to bold, red foreground.
\x1b[1;31mHello
# Set style to dimmed white foreground with red background.
\x1b[2;37;41mWorld

A simplified configuration

The user can simply define a python dictionary in order to change logger colours with a simplified colour scheme.

Configure logger colours

In order to configure the logger colours, the user can use the following code

from coloured_logger import Logger

my_custom_colours = {
    "WARNING": 4,  # Yellow background with blue text
    "INFO": 2,     # Green text
    "DEBUG": 6,    # Cyan text
    "CRITICAL": 1, # Red text
    "ERROR": 5     # Magenta text
}

# This can change the logger level
logger_level = "DEBUG"

logger = Logger(__name__, my_custom_colours, logger_level)