Logment

pip install logment

A library for Python 3 that logs augmented comments (logments).

A logment is a comment line of the form #<symbol> <message> where a known symbol corresponds to a log level.

The Basics

To use logment simply import it before the modules you'd like to augment:

import logment
from test import add
logment.register()

add(1, 2) # logs a warning

Inside test.add we warn using a comment that starts with ! - it can references variables via f-string syntax.

def add(x, y):
    #! adding {x} and {y}
    return x + y

Register Handlers

A handler is a function with the signature (module, level, message).

• module : The name of the module where the message was logged.
• level : A value representing the logging level (e.g. 10 is DEBUG).
• message : The text content of the comment.

Handlers can be added using logment.handler:

import logment
import logging


@logment.register
def printer(module, level, message):
  level = logging.getLevelName(level)
  print(f'{module}[{level}] {message}')

Adding New Levels

Create a level with logment.level(symbol, level, name).

logment.level('$$$', 0, 'MONEY!')

Get the level and name for a symbol:

assert logment.level('$$$') == (0, 'MONEY!')