logging_extras

A collection of useful logging tools for Python 3.

Installation

The majority of the tools in this library require no additional dependencies. To install the library with the base functionality use the following command.

pip install logging-extras

To use the MQTT* classes, install the library with the following command.

pip install logging-extras[mqtt]

Tools

• MQTTConfig - A configuration class for an MQTT connection.
• MQTThandler - A logging handler that publishes logs to an MQTT broker.
• MQTTSubscriber - A logging listener that subscribes to an MQTT broker and logs messages.
• RelativeTimeFilter - A logging filter that adds a relative time to the log record.
• DiffTimeFilter - A logging filter that adds a time difference to the log record.
• TieredFormatter - A logging formatter that allows for different formatting based on the log level.
• log_function_call - A decorator that logs the arguments and return value of a function call.

Examples

log_function_call

from logger_extras import log_function_call

@log_function_call(level=logging.INFO)
def add(a, b):
    return a + b

_ = add(1, 2)
# This will log the following:
# 2021-08-03 12:00:00,000 - INFO - Calling __main__.add(a=1, b=2)
# 2021-08-03 12:00:00,000 - INFO - '__main__.add' returned 3