LightweightDebugMessages

Overview

The LightweightDebugMessages class is a lightweight class that adds a simple console printing for debugging messages that can be enabled or disabled via a parameter to classes by inheriting LightweightDebugMessages as a superclass to a user class.

Quick Example

A short example of a class using LightweightDebugMessages:

 1#!/usr/bin/env python3
 2from lightweightdebugmessages import LightweightDebugMessages
 3
 4
 5
 6class MyClass(LightweightDebugMessages):
 7
 8    def some_method(self):
 9        print("some_method():")
10        self.debug_message(0, f"This is a normal message that should always be printed")
11        self.debug_message(2, f"This message is printed if debug_level is >= 2")
12        self.debug_message(5, f" This message is printed if debug_level is >= 5")
13        print("")
14        return
15
16
17
18# create an instance of the class
19data = MyClass()
20
21# Default debug_level is 0, so this prints only 1 message
22data.some_method()
23
24# Increase debug level:
25data.debug_level = 2
26data.some_method()

See the Quick Start guide for a more comprehensive starting tutorial and the Examples for additional use case examples.

Test Coverage

Coverage Report