JrGoodle/clowder

View on GitHub
clowder/util/console.py

Summary

Maintainability
A
0 mins
Test Coverage
"""console utilities

.. codeauthor:: Joe DeCapo <joe@polka.cat>

"""

import sys
from functools import wraps
from io import StringIO
from typing import Any, List, Optional

from rich.console import Console as RichConsole


def disable_output(func):
    """Disable Console output for wrapped function"""

    @wraps(func)
    def wrapper(*args, **kwargs):
        """Wrapper"""

        CONSOLE.print_output = False
        try:
            retval = func(*args, **kwargs)
            CONSOLE.print_output = True
            return retval
        except:  # noqa
            CONSOLE.print_output = True
            raise

    return wrapper


class Console:
    """Console class"""

    def __init__(self):
        self._queue: List[str] = []
        self.print_output: bool = True
        self._stdout: RichConsole = RichConsole(force_terminal=True,
                                                # color_system='256',
                                                width=160)
        self._stderr: RichConsole = RichConsole(file=sys.stderr,
                                                force_terminal=True,
                                                # color_system='256',
                                                width=160)
        self._stringio: RichConsole = RichConsole(file=StringIO(),
                                                  width=160)

    @property
    def stdout_console(self) -> RichConsole:
        return self._stdout

    def stderr(self, output: Any = '', force: bool = False) -> None:
        if output is None:
            return
        if self.print_output or force:
            self._stderr.log(output)

    def stdout(self, output: Any = '', force: bool = False) -> None:
        if output is None:
            return
        if self.print_output or force:
            self._stdout.print(output)

    def print_exception(self, force: bool = False) -> None:
        if self.print_output or force:
            self._stderr.print_exception()

    def delete_lines(self, count: int = 1, force: bool = False) -> None:
        if self.print_output or force:
            for _ in range(count):
                print('\033[A                             \033[A')

    def enqueue_stdout(self, output: Any = '', newline: bool = False) -> None:
        if output is None:
            return
        if isinstance(output, list):
            self._queue += output
        elif isinstance(output, str):
            self._queue.append(output)

        if newline:
            self._queue.append('')

    def flush_stdout(self, force: bool = False) -> None:
        if self.print_output or force:
            self._stdout.print('\n'.join(self._queue))
        self._queue = []

    @property
    def width(self) -> int:
        width = self._stdout.width
        return width

    @staticmethod
    def _debug_console(console: RichConsole) -> None:
        print(console.encoding)
        print(console.color_system)
        print(console.width)
        print(console.is_terminal)
        print(console.is_dumb_terminal)

    def _pretty_log_message(self, output: Any) -> Optional[str]:
        if output is None:
            return None
        self._stringio.print(output)
        output = self._stringio.file.getvalue()
        return output

    @property
    def _pretty_traceback(self) -> str:
        self._stringio.print_exception()
        output = self._stringio.file.getvalue()
        return output


CONSOLE: Console = Console()