decologr 0.3.6

Decorative Logger - A logging utility with emoji decorations

Decologr

A lightweight, decorative logger for Python

decologr - Decorative Logger

A single file logging utility with emoji decorations and structured message formatting.

setup_logging(verbose=True, project_name="myproject")
╭─────────── myproject ────────────╮
│  myproject Application Starting  │
╰──────────────────────────────────╯
[...] INFO     ℹ️ myproject starting up with log file
                             .../.myproject/logs/myproject-...

Features

• Emoji Decorations: Automatic emoji decorations based on log level and message content
• Rich Console Formatting: Beautiful, color-coded console output with syntax highlighting (optional)
• Structured Logging: Support for JSON, parameters, and formatted messages
• Project-Aware: Configurable project name for log file naming
• Backward Compatible: Static method interface for easy migration

Installation

pip install decologr

Optional: Rich Support

For enhanced console output with colors and syntax highlighting:

pip install decologr[rich]

Optional: Textual Support

For interactive log viewing in editors like JDXI:

pip install decologr[textual]

Or install from source:

cd decologr
pip install -e .

Quick Start

from decologr import Decologr, set_project_name, setup_logging

# Set project name (optional, defaults to "decologr")
set_project_name("myproject")

# Setup logging (optional)
setup_logging(verbose=True, project_name="myproject")

# Use Logger
Decologr.info("Hello, world!")
Decologr.error("Something went wrong", exception=ValueError("test"))
Decologr.json({"key": "value"})

Usage

Basic Logging

from decologr import Decologr

Decologr.info("Information message")
Decologr.warning("Warning message")
Decologr.error("Error message")
Decologr.debug("Debug message")

Logging with Exceptions

from decologr import Decologr
try:
    result = 1 / 0
except ZeroDivisionError as e:
    Decologr.error("Division failed", exception=e)

# With Rich installed, exceptions display with beautiful tracebacks
try:
    result = 1 / 0
except ZeroDivisionError as e:
    Decologr.error("Division failed", exception=e, use_rich_traceback=True)

# Using log_exception helper function
from decologr import log_exception
try:
    # some code
except Exception as ex:
    log_exception(ex, "Error initializing database", use_rich_traceback=True)

Rich Traceback Features (when Rich is installed):

• Syntax-highlighted code: Code snippets in tracebacks are syntax-highlighted
• Clear file paths: File paths and line numbers are clearly marked
• Better visualization: Improved formatting for stack frames
• Compact file logging: Standard format still logged to files

JSON Logging

from decologr import Decologr
data = {"user": "alice", "action": "login"}
Decologr.json(data)  # Compact JSON (or pretty if Rich is enabled)

# With Rich installed, enable pretty-printing
Decologr.json(data, pretty=True)  # Pretty-printed, syntax-highlighted JSON

# Force compact format
Decologr.json(data, pretty=False)  # Always compact JSON

# Auto-detect (uses Rich if available)
Decologr.json(data, pretty=None)  # Default behavior

Rich JSON Features (when Rich is installed):

• Pretty-printed formatting with proper indentation
• Syntax highlighting for keys, values, and structure
• Better readability for complex nested data
• Compact JSON still logged to files for efficient storage

Parameter Logging

from decologr import Decologr

Decologr.parameter("User ID", user_id)
Decologr.parameter("Settings", {"theme": "dark", "lang": "en"})

# With Rich installed, dictionaries display as tables
config = {
    "database": {"host": "localhost", "port": 5432},
    "cache": {"enabled": True, "ttl": 3600}
}
Decologr.parameter("Configuration", config, use_rich=True)

# Lists display as trees (especially nested structures)
users = [
    {"id": 1, "name": "Alice", "roles": ["admin"]},
    {"id": 2, "name": "Bob", "roles": ["user"]}
]
Decologr.parameter("Users", users, use_rich=True)

Rich Parameter Features (when Rich is installed):

• Tables for dictionaries: Key-value pairs displayed in formatted tables
• Trees for lists: Nested structures displayed as expandable trees
• Better visualization: Color-coded values, proper formatting
• Compact file logging: Still logs compact format to files

Header Messages

from decologr import Decologr
Decologr.header_message("Starting Processing")

# With Rich installed, headers display as formatted panels
Decologr.header_message("Starting Processing", use_rich=True)

# Custom title for Rich panel
Decologr.header_message("Processing Complete", title="[bold green]Success[/bold green]", use_rich=True)

# Different log levels show different border colors
Decologr.header_message("Warning Section", level=logging.WARNING, use_rich=True)
Decologr.header_message("Error Section", level=logging.ERROR, use_rich=True)

Rich Header Features (when Rich is installed):

• Formatted panels: Headers displayed as bordered panels
• Color-coded borders: Border color matches log level (INFO=blue, WARNING=yellow, ERROR=red)
• Custom titles: Optional custom titles for panels
• Better visual hierarchy: Clear separation and distinction
• Text file logging: Still logs separator lines to files

Configuration

Setting Project Name

from decologr import set_project_name, get_project_name

set_project_name("myproject")
print(get_project_name())  # "myproject"

Setup Logging

from decologr import setup_logging

# Setup with default project name
logger = setup_logging()

# Setup with custom project name
logger = setup_logging(project_name="myproject", verbose=True)

# Enable Rich formatting (if Rich is installed)
logger = setup_logging(use_rich=True, project_name="myproject")

# Auto-detect Rich (uses Rich if available, otherwise falls back to plain)
logger = setup_logging(use_rich=None, project_name="myproject")

Rich Integration

When Rich is installed and enabled, decologr provides:

• Color-coded log levels: DEBUG (dim white), INFO (blue), WARNING (yellow), ERROR (red), CRITICAL (bold red)
• Syntax highlighting: Automatic highlighting for code, file paths, and structured data
• Beautiful tracebacks: Enhanced exception display with syntax highlighting
• Markup support: Rich markup in log messages for additional formatting

Rich formatting is optional - decologr works perfectly without it, maintaining full backward compatibility.

Textual Log Viewer

When Textual is installed, decologr provides a beautiful log viewer component that can be integrated into programs like JDXI Editor:

from decologr.viewer import create_log_viewer_widget
from pathlib import Path

# Create a viewer line_edit for embedding in your editor
log_file = Path("~/.decologr/logs/myproject.log")
viewer = create_log_viewer_widget(log_file=log_file)

# Or run standalone viewer
from decologr.viewer import run_log_viewer
run_log_viewer(log_file)

Textual Viewer Features:

• Color-coded log levels: Visual distinction for DEBUG, INFO, WARNING, ERROR, CRITICAL
• Search functionality: Filter logs by text content
• Level filtering: Show only logs above a certain level
• Formatted display: Clean, readable table format
• Auto-scroll: Automatically scrolls to latest logs
• Embeddable: Can be integrated into editors and applications

Standalone Usage:

python -m decologr.viewer <log_file>
# Or use the most recent log file automatically
python -m decologr.viewer

API Reference

Logger Class

All methods are static methods:

• Decologr.info(message, *args, level=logging.INFO, stacklevel=3, silent=False)
• Decologr.debug(message, *args, level=logging.DEBUG, stacklevel=3, silent=False)
• Decologr.warning(message, *args, exception=None, level=logging.WARNING, stacklevel=4, silent=False, use_rich_traceback=None) - Log warning
  • use_rich_traceback=True: Use Rich traceback formatting (requires Rich)
  • use_rich_traceback=False: Always use standard traceback
  • use_rich_traceback=None: Auto-detect (uses Rich if available)
• Decologr.error(message, *args, exception=None, level=logging.ERROR, stacklevel=4, silent=False, use_rich_traceback=None) - Log error
  • use_rich_traceback=True: Use Rich traceback formatting (requires Rich)
  • use_rich_traceback=False: Always use standard traceback
  • use_rich_traceback=None: Auto-detect (uses Rich if available)
• Decologr.json(data, silent=False, pretty=None) - Log JSON data
  • pretty=True: Use Rich pretty-printing (requires Rich)
  • pretty=False: Always use compact format
  • pretty=None: Auto-detect (uses Rich if available)
• Decologr.parameter(message, parameter, float_precision=2, max_length=300, level=logging.INFO, stacklevel=4, silent=False, use_rich=None) - Log structured parameter
  • use_rich=True: Use Rich tables/trees (requires Rich)
  • use_rich=False: Always use text-based formatting
  • use_rich=None: Auto-detect (uses Rich if available)
• Decologr.header_message(message, level=logging.INFO, silent=False, stacklevel=3, use_rich=None, title=None) - Log header message
  • use_rich=True: Use Rich panel formatting (requires Rich)
  • use_rich=False: Always use text-based separator lines
  • use_rich=None: Auto-detect (uses Rich if available)
  • title: Optional custom title for Rich panel
• Decologr.debug_info(successes, failures, stacklevel=3)

Functions

• setup_logging(verbose=False, project_name="decologr", use_rich=None) - Setup logging configuration
  • use_rich: If True, use Rich formatting (requires Rich to be installed)
  • use_rich: If None, auto-detect and use Rich if available
  • use_rich: If False, use plain text formatting
• log_exception(exception, message, stacklevel=4, use_rich_traceback=None) - Log exception with message
  • use_rich_traceback: Control Rich traceback formatting (same as error/warning methods)
• cleanup_logging(logger) - Clean up logging handlers
• set_project_name(project_name) - Set the project name for logging
• get_project_name() - Get the current project name

Example Output:

from decologr import Decologr, set_project_name, setup_logging

# Set project name (optional, defaults to "decologr")
set_project_name("myproject")
# Setup logging (optional)
setup_logging(verbose=True, project_name="myproject")
╭─────────── myproject ────────────╮
│  myproject Application Starting  │
╰──────────────────────────────────╯
[...] INFO     ℹ️ myproject starting up with log file
                             .../.myproject/logs/myproject-...
<Logger myproject (INFO)>
# Use Logger
Decologr.info("Hello, world!") 
                    INFO     ℹ️ Hello, world!
Decologr.error("Something went wrong", exception=ValueError("test"))
{
  "key": "value"
}

License

MIT License

Author

Originally part of the JDXi Editor project.