lazy-log-formatter 0.10.5

A pre-commit script to make log lines lazier

Lazy log formatter

A tool that automatically converts f-strings in Python logging calls into lazy logging calls for consistency with Python documentation, improved performance and linting compliance.

See PyPI page for more details. See Changelog for release notes.

Example:

# Before (f-string in log call; not recommended)
logger.info(f"On {datetime.now()} temperature in {city} is {temp:.2f}°C.")

# After lazy-log-formatter
logger.info("On %s temperature in %s is %.2f°C.", datetime.now(), city, temp)

# Prints: On 2024-06-01 12:00:00 temperature in Madrid is 21.50°C.

Why this tool?

In Python, the recommended way to log variable data is to use format-string placeholders and pass values separately:

import logging
logging.warning('%s before you %s', 'Look', 'leap!')

This approach:

• ensures string formatting and interpolation are only performed if the message is actually emitted (e.g. based on the logging level),
• is consistent with Python’s logging design and documentation,
• prevents linting alerts (e.g. Pylint’s W1203: Use %s formatting in logging functions).

References

• Logging should be lazy
• logging-format-interpolation
• Why it matters how you log in Python

Features

• Scans Python files for f-strings used in logging calls.
• Provides an option to automatically convert f-strings in logging calls to lazy logging calls.
• Can be integrated as a pre-commit hook to enforce logging best practices in codebases.

Installation

Install from PyPI:

pip install lazy-log-formatter

Usage

You can either run the tool as a Python module, use it as a pre-commit hook, run the entry point script:

python -m lazy_log.cli [OPTIONS] [PATH...]

or

lazy-log-formatter [OPTIONS] [PATH...]

Pre-commit integration

Add the following to your .pre-commit-config.yaml:

- repo: https://github.com/dmar1n/lazy-log-formatter
  rev: 0.10.5
  hooks:
    - id: lazy-log-formatter
      args: ['--fix']

Command-line options

You can run the tool from the command line using the following options:

Option	Description
--fix	Converts f-strings in log calls to lazy logging syntax
--exclude [PATTERN...]	Excludes files/directories matching one or more patterns
PATH [PATH...]	One or more paths to scan (defaults to current directory)

Examples

Check all Python files in the current directory and subdirectories:

python -m lazy_log.cli .

Fix all Python files in the current directory and subdirectories:

python -m lazy_log.cli . --fix

Check all Python files in two directories:

python -m lazy_log.cli lazy_log/ tests/

Check specific files:

python -m lazy_log.cli lazy_log/cli.py tests/data/test.py

Exclude specific files or directories:

python -m lazy_log.cli tests/data --exclude "*.pyc" "__pycache__/*" 

Fix issues in all Python files in a directory:

python -m lazy_log.cli mydir --fix

Example transformations

Simple f-string

# Before
logger.info(f'Hello {name}')

# After
logger.info('Hello %s', name)

Multiple variables

# Before
logger.info(f'Hello {name} {surname}')

# After
logger.info('Hello %s %s', name, surname)

Class-based logging example

import logging
from datetime import datetime


def log_and_return_datetime():
    now = datetime.now()
    logging.info(f"Current datetime: {now}")
    return now


class DateTimeLogger:
    def __init__(self):
        self._logger = logging.getLogger(self.__class__.__name__)

    def log_datetime(self):
        now = datetime.now()
        self._logger.info(f"Current datetime: {now}")
        return now

After running the formatter without --fix, the output will be:

F-strings found in '...\tests\data\test.py':
 - F-string in logging call at ...\tests\data\test.py:8: f'Current datetime: {now}'
 - F-string in logging call at ...\tests\data\test.py:18: f'Current datetime: {now}'

After running the formatter with --fix, the output will be:

F-strings found and fixed in '...\tests\data\test.py'.

The transformed code will be:

import logging
from datetime import datetime


def log_and_return_datetime():
    now = datetime.now()
    logging.info("Current datetime: %s", now)
    return now


class DateTimeLogger:
    def __init__(self):
        self._logger = logging.getLogger(self.__class__.__name__)

    def log_datetime(self):
        now = datetime.now()
        self._logger.info("Current datetime: %s", now)
        return now

Notes

Code formatting with Black

When transforming code, the tool uses Black to reformat the modified files. If your project already uses Black, the changes produced by this tool will be consistent with Black’s formatting style.

Detection of log calls

The tool includes logic to detect logging calls based on the assumption that your logger instances follow common naming conventions (e.g., logger.info(...), log.info(...)). If a logger variable does not contain the substring "log" in its name, the tool will ignore it.

Other logging libraries

Only works with the native Python logging module. Other libraries, such as loguru, do not support lazy calls.

For loguru, see Lazy evaluation of expensive functions:

logger.opt(lazy=True).debug("If sink level <= DEBUG: {x}", x=lambda: expensive_function(2**64))