loggerric 1.5.2

A logging utility for Python. Developed for personal use.

loggerric

loggerric is a lightweight Python utility library providing advanced logging, for CLI applications. It offers colorful, formatted output to make debugging, logging and tracking easier.

---

Features

• Logging: Structured logging with levels: INFO, WARN, ERROR, DEBUG with highlight.
• Log2File: Fully automatic logging to file, with various options for customization.
• Debug Decorator: Lightly debug and semi-benchmark any function using the decorator.
• Pretty Printing: Pretty print variables like arrays and dictionaries.
• Tables: Log datasets via CLI colored tables with headers and autosizing.
• Progress Bars: Real-time CLI progress bars with ETA calculations.
• Prompts: Interactive user input with optional choices and defaults.
• Timers: Measure execution time of code snippets.
• Timestamps: Optional, can be used independently, and support rolling differences.

---

Installation

pip install loggerric

---

Usage

Log To File

from loggerric import LogToFile, LogToFileLevel

LogToFile.set_dump_location('C:/Users/MyCoolUsername/Desktop', 'important_log') # Don't include the extension

# Control file logging from anywhere
LogToFile.start_logging()
LogToFile.stop_logging()

# Decide what should be logged to file
LogToFile.enable(LogToFileLevel.INFO, ...)
LogToFile.disable(LogToFileLevel.TIMER, ...)

Logging

from loggerric import Log, LogLevel

# Pretty print dictionaries or arrays, including subdicts
Log.pretty_print({ 'name': 'John Doe' }, indent=4)

# Print out a formatted table
headers = ['Item', 'Stock', 'Price']
rows = [('Cola', '25', '$2.99'), ('GPU', '3', '$995.00'), ('Feather', '2,500', '$0.29')]
Log.table(headers, rows, table_name='Store Items')

Log.info("This is an info message", "This is also a message", ..., highlight=['This', 'message'])
Log.warn("This is a warning", ..., highlight='warning')
Log.error("This is an error", ..., quit_after_log=True, highlight='error')
Log.debug("This is a debug message", ..., highlight='debug')

# Enable or disable specific logging levels
Log.disable(LogLevel.DEBUG, LogLevel.WARN, ...)
Log.enable(LogLevel.DEBUG, ...)

# Debug function using decorator
@Log.debugdec(log_return_value=True, log_args=True)
def my_func(a:int, b:int):
    return a + b
my_function(6, 7)

Progress Bar

from loggerric import ProgressBar
from time import sleep

end_val = 50
bar = ProgressBar(end_value=end_val, name='Downloading', bar_length=40)
for i in range(1, end_val + 1):
    sleep(0.05)
    bar.update(i)

Prompt

from loggerric import prompt

# Simple input
name = prompt("Enter your name")

# Input with options
choice = prompt("Choose a letter", options=['a', 'b', 'c'], default='b', loop_until_valid=True, case_sensitive=False)

Timer

from loggerric import Timer
from time import sleep

with Timer(name='Calculation Timer'):
    sleep(1.5)

Timestamp

from loggerric import Timestamp, Log

Timestamp.set_format('{HH}:{MM}:{SS}.{MS} T+{dm}ms')

Log.info(Timestamp.get())