Verbose Logging Levels

1.7 · active · verified Sun Apr 12

The `verboselogs` package extends Python's standard `logging` module by introducing additional log levels: NOTICE, SPAM, SUCCESS, and VERBOSE. These levels are strategically positioned within the existing hierarchy (e.g., NOTICE between WARNING and INFO, VERBOSE between INFO and DEBUG) to provide more granular control over log output. Version 1.7 is currently active, and its release cadence has been stable, with the last update in 2017.

Warnings

gotcha Mixing standard `logging.getLogger()` with `verboselogs.VerboseLogger()` for the same logger name can lead to unexpected behavior if not handled carefully. Always ensure you consistently use `VerboseLogger` for loggers where custom levels are expected, or explicitly call `verboselogs.install()` to patch the root logger.
Fix: Use `logger = verboselogs.VerboseLogger('my_logger_name')` for all instances where custom levels are required, or call `verboselogs.install()` early in your application to make `logging.getLogger()` return a `VerboseLogger` instance.
gotcha When integrating with other logging configuration methods (e.g., `logging.basicConfig` or file-based configurations), ensure that the log level of handlers and formatters is set appropriately to allow the new, lower `SPAM` and `VERBOSE` levels to pass through. Default configurations often filter out anything below `INFO` or `WARNING`.
Fix: Explicitly set `setLevel()` on your handlers and the logger itself to `verboselogs.SPAM`, `verboselogs.VERBOSE`, or `logging.DEBUG` to ensure all desired messages are processed. For example, `handler.setLevel(verboselogs.SPAM)`.

Install

pip install verboselogs Install latest version

Imports

VerboseLogger
```
from verboselogs import VerboseLogger
```
NOTICE
```
import verboselogs; verboselogs.NOTICE
```
SPAM
```
import verboselogs; verboselogs.SPAM
```
SUCCESS
```
import verboselogs; verboselogs.SUCCESS
```
VERBOSE
```
import verboselogs; verboselogs.VERBOSE
```

Quickstart

Initialize a VerboseLogger, add a stream handler, and set the logging level to VERBOSE to see messages from VERBOSE and higher levels, including custom levels like SPAM, NOTICE, and SUCCESS. The example demonstrates logging at various levels.

import logging
import verboselogs

logger = verboselogs.VerboseLogger('my-app')
logger.addHandler(logging.StreamHandler())
logger.setLevel(verboselogs.VERBOSE)

logger.spam('This is a SPAM message.')
logger.verbose('This is a VERBOSE message, providing detailed info.')
logger.debug('This is a standard DEBUG message.')
logger.info('This is a standard INFO message.')
logger.notice('This is a NOTICE message, between INFO and WARNING.')
logger.success('This is a SUCCESS message, confirming an operation.')
logger.warning('This is a standard WARNING message.')

view raw JSON →