rich/docs/source/logging.rst

23 lines
834 B
ReStructuredText

Logging Handler
===============
Rich supplies a :ref:`logging handler<logging>` which will format and colorize text written by Python's logging module.
Here's an example of how to set up a rich logger::
import logging
from rich.logging import RichHandler
FORMAT = "%(message)s"
logging.basicConfig(
level="NOTSET", format=FORMAT, datefmt="[%X]", handlers=[RichHandler()]
)
log = logging.getLogger("rich")
log.info("Hello, World!")
Rich logs won't process console markup by default, but you can enable markup per log statement with the ``extras`` argument as follows::
log.error("[bold red blink]Server is shutting down![/]", extras={"markup": True})
There are a number of options you can use to configure logging output, see the :class:`~rich.logging.RichHandler` reference for details.