Feature: add an option for a custom formatter in logging setup

[Yannick-Dayer]

Allow users to provide their own formatter instead of just a format string, allowing further customization of the logs.

Fixes #8.

---

📚 Documentation preview 📚: https://clapper--10.org.readthedocs.build/en/10/

[github-actions]

Coverage report

Click to see where and how coverage changed

File	Statements	Missing	Coverage	Coverage (new stmts)	Lines missing
src/clapper
logging.py
Project Total

This report was generated by python-coverage-comment-action

[Yannick-Dayer]

Usage example with colorlog:

# app.py
import clapper.click
import clapper.logging
import click
import colorlog

main_logger = clapper.logging.setup(
    logger_name="awesome",
    formatter=colorlog.ColoredFormatter(
        fmt="%(log_color)s[%(levelname)s] %(message)s (%(name)s, %(asctime)s)"
    ),
)
main_logger.setLevel("ERROR")


@click.command(
    entry_point_group="cli_group",
    cls=clapper.click.ConfigCommand,
)
@click.option(
    "--my-config",
    "-c",
    "my_config",
    entry_point_group="config_group",
    cls=clapper.click.ResourceOption,
)
@clapper.click.verbosity_option(
    main_logger,
    expose_value=False,
)  # The logger level is set here if -v is given
def awesome_cli(my_config: list[str] | None, **kwargs):
    """My Awesome CLI."""
    main_logger.error("App error sample (all is well).")
    main_logger.warning("App warning sample (all is well).")
    main_logger.info(f"App info sample: {my_config=}")
    main_logger.debug("App debug sample: Now exiting CLI app.")


if __name__ == "__main__":
    awesome_cli()

[anjos]

Beautiful! Looking great, thanks!

[Yannick-Dayer]

We can include this in the upcoming release, too.

[anjos]

LGTM, thanks!