Source code for bohicalog.handlers.telegram.formatters

# -*- coding: utf-8 -*-

"""
Formatters for :mod:`bohicalog.handlers.telegram`.
"""

import logging

from .utils import escape_html

__all__ = ["TelegramFormatter", "MarkdownFormatter", "HTMLFormatter"]


class TelegramFormatter(logging.Formatter):
    """Base formatter class suitable for use with `TelegramHandler`"""

    fmt = "%(asctime)s %(levelname)s\n[%(name)s:%(funcName)s]\n%(message)s"
    parse_mode = None

    def __init__(self, fmt=None, *args, **kwargs):
        """
        :param fmt: format string
        :param args: positional arguments
        :param kwargs: keyword arguments
        """
        super(TelegramFormatter, self).__init__(fmt or self.fmt, *args, **kwargs)


class MarkdownFormatter(TelegramFormatter):
    """Markdown formatter for telegram."""

    fmt = "`%(asctime)s` *%(levelname)s*\n[%(name)s:%(funcName)s]\n%(message)s"
    parse_mode = "Markdown"  # type: ignore

    def formatException(self, *args, **kwargs):
        """
        Format exception as markdown.

        :param args: positional arguments
        :param kwargs: keyword arguments
        """
        string = super(MarkdownFormatter, self).formatException(*args, **kwargs)
        return "```\n%s\n```" % string


class EMOJI:
    """Emoji constants."""

    WHITE_CIRCLE = "\U000026AA"
    BLUE_CIRCLE = "\U0001F535"
    RED_CIRCLE = "\U0001F534"


class HTMLFormatter(TelegramFormatter):
    """HTML formatter for telegram."""

    fmt = "<code>%(asctime)s</code> <b>%(levelname)s</b>\nFrom %(name)s:%(funcName)s\n%(message)s"
    parse_mode = "HTML"  # type: ignore

    def __init__(self, *args, **kwargs):
        """
        :param args: positional arguments
        :param kwargs: keyword arguments
        """
        self.use_emoji = kwargs.pop("use_emoji", False)
        super(HTMLFormatter, self).__init__(*args, **kwargs)

    def format(self, record):
        """
        Format the record.

        :param logging.LogRecord record:
        """
        super(HTMLFormatter, self).format(record)

        if record.funcName:
            record.funcName = escape_html(str(record.funcName))
        if record.name:
            record.name = escape_html(str(record.name))
        if record.msg:
            record.msg = escape_html(record.getMessage())
        if self.use_emoji:
            if record.levelno == logging.DEBUG:
                record.levelname += " " + EMOJI.WHITE_CIRCLE
            elif record.levelno == logging.INFO:
                record.levelname += " " + EMOJI.BLUE_CIRCLE
            else:
                record.levelname += " " + EMOJI.RED_CIRCLE

        if hasattr(self, "_style"):
            return self._style.format(record)
        else:
            # py2.7 branch
            return self._fmt % record.__dict__

    def formatException(self, *args, **kwargs):
        """Format exception as html."""
        string = super(HTMLFormatter, self).formatException(*args, **kwargs)
        return "<pre>%s</pre>" % escape_html(string)

    def formatStack(self, *args, **kwargs):
        """Format stack as html."""
        string = super(HTMLFormatter, self).formatStack(*args, **kwargs)
        return "<pre>%s</pre>" % escape_html(string)