pocketutils.misc.console

Complexity

Total Complexity

23

Size/Duplication

Total Lines	165
Duplicated Lines	0 %

Importance

Changes

0

19 Methods

Rating	Name	Duplication	Size	Complexity
A	ColorConsole._stream()	0	3	1
A	ColorConsoleBuilder.build()	0	17	2
A	ColorConsoleBuilder.top()	0	3	1
A	ColorConsoles.default()	0	13	2
A	AbstractColorConsole.format()	0	2	1
A	ColorConsoleBuilder.pad_bottom()	0	3	1
A	ColorConsoleBuilder.bottom()	0	3	1
A	ColorConsole.__init__()	0	17	1
A	ColorConsoleBuilder.pad_top()	0	3	1
A	AbstractColorConsole._reset()	0	3	1
A	ColorConsoleBuilder.right()	0	3	1
A	ColorConsoleBuilder.__init__()	0	6	1
A	AbstractColorConsole._stream()	0	3	1
A	ColorConsoleBuilder.left()	0	3	1
A	ColorConsoleBuilder.width()	0	3	1
A	ColorConsole.format()	0	21	2
A	ColorConsoleBuilder.add()	0	3	1
A	AbstractColorConsole.print()	0	3	2
A	ColorConsoles.new()	0	3	1

"""
Experimental replacement for fancy consoles.
"""
import abc
import logging
import sys
from typing import Callable, Optional, TypeVar, Generic, Sequence

from colorama import Style, Fore

Unable to import 'colorama'

from pocketutils.core.input_output import Writeable
from pocketutils.misc.messages import *

Mapping was imported with wildcard, but is not used.

SmartEnum was imported with wildcard, but is not used.

MsgFormatter was imported with wildcard, but is not used.

The usage of wildcard imports like pocketutils.misc.messages should generally be avoided.

MsgFormatterSimple was imported with wildcard, but is not used.

Enum was imported with wildcard, but is not used.

logger = logging.getLogger("pocketutils")
L = TypeVar("L", covariant=True)

Class name "L" doesn't conform to PascalCase naming style ('[^\\W\\da-z][^\\W_]+$' pattern)

M = TypeVar("M", covariant=True)

Class name "M" doesn't conform to PascalCase naming style ('[^\\W\\da-z][^\\W_]+$' pattern)

class AbstractColorConsole(Generic[L, M], metaclass=abc.ABCMeta):

Missing class docstring

    def print(self, *lines: str, level: L, mod: Optional[M] = None) -> None:

Missing function or method docstring

        for line in self.format(*lines, level=level, mod=mod):
            self._stream.write(line)

    @property
    def _stream(self) -> Writeable:
        raise NotImplementedError()

    @property
    def _reset(self) -> int:
        return Style.RESET_ALL

    def format(self, *lines: str, level: L, mod: Optional[M] = None) -> Sequence[str]:

Missing function or method docstring

        raise NotImplementedError()


class ColorConsole(AbstractColorConsole[MsgLevel, bool]):

Missing class docstring

Too many instance attributes (9/7)

Value 'AbstractColorConsole' is unsubscriptable

    def __init__(

Too many arguments (10/5)

        self,

Wrong hanging indentation before block (add 4 spaces).

        stream: Writeable,

Wrong hanging indentation before block (add 4 spaces).

        top: str,

Wrong hanging indentation before block (add 4 spaces).

        bottom: str,

Wrong hanging indentation before block (add 4 spaces).

        left: str,

Wrong hanging indentation before block (add 4 spaces).

        right: str,

Wrong hanging indentation before block (add 4 spaces).

        pad_top: int,

Wrong hanging indentation before block (add 4 spaces).

        pad_bottom: int,

Wrong hanging indentation before block (add 4 spaces).

        width: int,

Wrong hanging indentation before block (add 4 spaces).

        mapping: Callable[[MsgLevel], int],

Wrong hanging indentation before block (add 4 spaces).

    ):
        self._the_stream = stream
        self._top, self._bottom, self._left, self._right = top, bottom, left, right
        self._pad_top, self._pad_bottom = pad_top, pad_bottom
        self._width = width
        self._mapping = mapping

    def format(self, *lines: str, level: MsgLevel, mod: Optional[bool] = None) -> Sequence[str]:

Missing function or method docstring

        color = str(self._mapping(level))
        width = self._width
        reset = str(self._reset)
        if mod:
            top, bottom, left, right = self._top, self._bottom, self._left, self._right
            pad_top = ["" for _ in range(self._pad_top)]
            pad_bottom = ["" for _ in range(self._pad_bottom)]
        else:
            top, bottom, left, right = "", "", "", ""
            pad_top, pad_bottom = [], []

        def cl(text: str):

Function name "cl" doesn't conform to snake_case naming style ('([^\\W\\dA-Z][^\\WA-Z]2,|_[^\\WA-Z]*|__[^\\WA-Z\\d_][^\\WA-Z]+__)$' pattern)

            return color + left + text.center(width - len(left) - len(right)) + right + reset

        return [
            *pad_top,
            color + top * width + reset,
            *[cl(line) for line in lines],
            color + bottom * width + reset,
            *pad_bottom,
        ]

    @property
    def _stream(self) -> Writeable:
        return self._the_stream


class ColorConsoleBuilder:

Too many instance attributes (8/7)

Missing class docstring

    def __init__(self):
        self._mapping = {}
        self._width = 100
        self._top, self._bottom = "-", "-"
        self._left, self._right = "", ""
        self._pad_top, self._pad_bottom = 1, 1

    def add(self, level: MsgLevel, color: int) -> __qualname__:

Missing function or method docstring

Undefined variable '__qualname__'

        self._mapping[level] = color
        return self

    def width(self, w: int) -> __qualname__:

Argument name "w" doesn't conform to snake_case naming style ('([^\\W\\dA-Z][^\\WA-Z]2,|_[^\\WA-Z]*|__[^\\WA-Z\\d_][^\\WA-Z]+__)$' pattern)

Missing function or method docstring

        self._width = w
        return self

    def top(self, top: str) -> __qualname__:

Missing function or method docstring

        self._top = top
        return self

    def bottom(self, bottom: str) -> __qualname__:

Missing function or method docstring

        self._bottom = bottom
        return self

    def left(self, left: str) -> __qualname__:

Missing function or method docstring

        self._left = left
        return self

    def right(self, right: str) -> __qualname__:

Missing function or method docstring

        self._right = right
        return self

    def pad_top(self, i: int) -> __qualname__:

Missing function or method docstring

        self._pad_top = i
        return self

    def pad_bottom(self, i: int) -> __qualname__:

Missing function or method docstring

        self._pad_bottom = i
        return self

    def build(self, sink: Optional[Writeable] = None) -> ColorConsole:

Missing function or method docstring

        if sink is None:
            sink = sys.stdout

        def fn(level: MsgLevel):

Function name "fn" doesn't conform to snake_case naming style ('([^\\W\\dA-Z][^\\WA-Z]2,|_[^\\WA-Z]*|__[^\\WA-Z\\d_][^\\WA-Z]+__)$' pattern)

            return self._mapping[level]

        return ColorConsole(
            sink,
            self._top,
            self._bottom,
            self._left,
            self._right,
            self._pad_top,
            self._pad_bottom,
            self._width,
            fn,
        )


class ColorConsoles:

Missing class docstring

    @classmethod
    def new(cls) -> ColorConsoleBuilder:

Missing function or method docstring

        return ColorConsoleBuilder()

    @classmethod
    def default(cls) -> ColorConsoleBuilder:

Missing function or method docstring

        mapping = {
            MsgLevel.INFO: Style.BRIGHT,
            MsgLevel.NOTICE: Fore.BLUE,
            MsgLevel.SUCCESS: Fore.GREEN,
            MsgLevel.WARNING: Fore.MAGENTA,
            MsgLevel.FAILURE: Fore.RED,
        }
        builder = ColorConsoleBuilder()
        for k, v in mapping.items():

Variable name "v" doesn't conform to snake_case naming style ('([^\\W\\dA-Z][^\\WA-Z]2,|_[^\\WA-Z]*|__[^\\WA-Z\\d_][^\\WA-Z]+__)$' pattern)

            builder.add(k, v)
        return builder


__all__ = ["AbstractColorConsole", "ColorConsole", "ColorConsoles"]