logger.py

"""Simple logging to stdout the same way Proton does"""

import os
import sys

from enum import Enum
from pathlib import Path


# Enums
class LogLevel(Enum):
    """Enum and mapping (level -> color) for log levels"""

    RESET = '\u001b[0m'
    INFO = '\u001b[34m'
    WARN = '\u001b[33m'
    CRIT = '\u001b[31m'
    DEBUG = '\u001b[35m'


class Log:
    """Log to stderr for steam dumps"""

    pfx = f'ProtonFixes[{os.getpid()}]'
    is_tty = os.isatty(sys.stderr.fileno())

    _cache_root = Path(os.getenv('XDG_CACHE_HOME', '~/.cache')).expanduser()
    _log_dir = _cache_root / 'protonfixes'
    try:
        _log_dir.mkdir(parents=True, exist_ok=True)
        logfile = _log_dir / 'protonfixes.log'
    except Exception:
        # Fallback if the cache dir can't be created for any reason
        logfile = Path('/tmp/protonfixes.log')

    @classmethod
    def __colorize(cls, msg: str, level: LogLevel) -> str:
        if not cls.is_tty:
            return msg
        color = level.value
        reset = LogLevel.RESET.value
        return f'{color}{msg}{reset}'

    @classmethod
    def __call__(cls, msg: str) -> None:
        """Allows the Log instance to be called directly"""
        cls.log(msg)

    @classmethod
    def log(cls, msg: str = '', level: LogLevel = LogLevel.INFO) -> None:
        """Prints the log message to stdout the same way as Proton"""
        # To terminal
        print(
            cls.__colorize(f'{cls.pfx} {level.name}: {msg}', level),
            file=sys.stderr,
            flush=True,
        )

        # To log file
        with open(cls.logfile, 'a', buffering=1, encoding='utf-8') as testfile:
            print(f'{cls.pfx} {level.name}: {msg}', file=testfile)

    @classmethod
    def info(cls, msg: str) -> None:
        """Wrapper for printing info messages"""
        cls.log(msg, LogLevel.INFO)

    @classmethod
    def warn(cls, msg: str) -> None:
        """Wrapper for printing warning messages"""
        cls.log(msg, LogLevel.WARN)

    @classmethod
    def crit(cls, msg: str) -> None:
        """Wrapper for printing critical messages"""
        cls.log(msg, LogLevel.CRIT)

    @classmethod
    def debug(cls, msg: str) -> None:
        """Wrapper for printing debug messages"""
        if 'DEBUG' not in os.environ:
            return
        cls.log(msg, LogLevel.DEBUG)


log = Log()