Skip to main content
Help us improve Python packaging – donate today!

Log formatting with colors!

Project Description

Latest PyPI version https://travis-ci.org/borntyping/colorlog.png

colorlog.ColoredFormatter is a formatter for use with pythons logging module.

It allows colors to be placed in the format string, which is mostly useful when paired with a StreamHandler that is outputting to a terminal. This is accomplished by added a set of terminal color codes to the record before it is used to format the string.

Codes

The following values are made availible for use in the format string:

  • fg_{colorname}, bg_{colorname}: Foreground and background colors. The colors names are black, red, green, yellow, blue, purple, cyan and white.
  • bold: Bold output.
  • reset: Clear all formatting (both foreground and background colors).
  • log_color: Return the color associated with the records level (from color_levels).

Arguments

ColoredFormatter takes several arguments:

  • format: The format string used to output the message (required).
  • datefmt: An optional date format passed to the base class. See logging.Formatter.
  • reset: Implicitly adds a color reset code to the message output, unless the output already ends with one. Defaults to True.
  • log_colors: A mapping of record level names to color names. The defaults can be found in colorlog.default_log_colors, or the below example.
  • style: Availible on Python 3.2 and above. See logging.Formatter.

Examples

The following code creates a ColoredFormatter for use in a logging setup, passing each arguments defaults to the constructor:

from colorlog import ColoredFormatter

formatter = ColoredFormatter(
        "%(log_color)s%(levelname)-8s%(reset)s %(blue)s%(message)s",
        datefmt=None,
        reset=True,
        color_levels={
                'DEBUG':    'cyan',
                'INFO':     'green',
                'WARNING':  'yellow',
                'ERROR':    'red',
                'CRITICAL': 'red',
        }
)

With dictConfig

logging.config.dictConfig({
        'formatters': {
                'colored': {
                        '()': 'colorlog.ColoredFormatter',
                        'format': "%(log_color)s%(levelname)-8s%(reset)s %(blue)s%(message)s"
                }
        },

        ...
})

A full example dictionary can be found in tests/test_colorlog.py.

With fileConfig

...

[formatters]
keys=color

[formatter_color]
class=colorlog.ColoredFormatter
format=%(log_color)s%(levelname)-8s%(reset)s %(bg_blue)s[%(name)s]%(reset)s %(message)s from fileConfig
datefmt=%m-%d %H:%M:%S

...

An instance of ColoredFormatter created with those arguments will then be used by any handlers that are configured to use the color formatter.

A full example configuration can be found in tests/test_config.ini.

Compatibility

colorlog works on Python 2.6 and above, including Python 3.

Tests

Tests similar to the above examples are found in tests/test_colorlog.py. They require colorlog to be installed or otherwise available to Python.

tox will run the tests under all compatible python versions.

Licence

colorlog is distributed under the MIT Licence.

Release history Release notifications

History Node

3.1.4

History Node

3.1.3

History Node

3.1.2

History Node

3.1.1

History Node

3.1.0

History Node

3.0.1

History Node

3.0.0

History Node

2.10.0

History Node

2.9.0

History Node

2.8.0

History Node

2.7.0

History Node

2.6.3

History Node

2.6.2

History Node

2.6.1

History Node

2.6.0

History Node

2.5.0

History Node

2.4.0

History Node

2.3.1

History Node

2.3.0

History Node

2.2.0

History Node

2.1.1

History Node

2.1.0

History Node

2.0.0

This version
History Node

1.8

History Node

1.7

History Node

1.6

History Node

1.5

History Node

1.4

History Node

1.3

History Node

1.2

History Node

1.1

History Node

1.0

History Node

0.6

History Node

0.5

History Node

0.4

History Node

0.3

History Node

0.2

History Node

0.1

Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Filename, size & hash SHA256 hash help File type Python version Upload date
colorlog-1.8.tar.gz (4.5 kB) Copy SHA256 hash SHA256 Source None Jun 6, 2013

Supported by

Elastic Elastic Search Pingdom Pingdom Monitoring Google Google BigQuery Sentry Sentry Error logging CloudAMQP CloudAMQP RabbitMQ AWS AWS Cloud computing Fastly Fastly CDN DigiCert DigiCert EV certificate StatusPage StatusPage Status page