encommon 0.6.0__py3-none-any.whl → 0.7.0__py3-none-any.whl

encommon/utils/__init__.py

@@ -14,6 +14,7 @@ from .paths import resolve_paths
 from .paths import stats_path
 from .sample import load_sample
 from .sample import prep_sample
+from .stdout import array_ansi
 from .stdout import kvpair_ansi
 from .stdout import make_ansi
 from .stdout import print_ansi
@@ -22,6 +23,7 @@ from .stdout import strip_ansi
 
 
 __all__ = [
+    'array_ansi',
     'fuzz_match',
     'kvpair_ansi',
     'load_sample',

encommon/utils/stdout.py

@@ -7,11 +7,18 @@ is permitted, for more information consult the project license file.
 
 
 
+from dataclasses import dataclass
 from re import compile
 from re import sub as re_sub
 from sys import stdout
 from typing import Any
 from typing import Literal
+from typing import Optional
+from typing import Union
+
+from encommon.times import Duration
+from encommon.times import Times
+from encommon.types import Empty
 
 from .common import JOINABLE
 
@@ -20,6 +27,40 @@ from .common import JOINABLE
 ANSICODE = compile(
     r'\x1b\[[^A-Za-z]*[A-Za-z]')
 
+ANSIARRAL = Union[
+    list[Any],
+    tuple[Any, ...],
+    set[Any]]
+
+ANSIARRAD = dict[Any, Any]
+
+ANSIARRAY = Union[
+    ANSIARRAL,
+    ANSIARRAD]
+
+
+
+@dataclass(frozen=True)
+class ArrayColors:
+    """
+    Colors used to colorize the provided array like object.
+    """
+
+    label: int = 37
+    key: int = 97
+
+    bool: int = 93
+    none: int = 33
+    str: int = 92
+    num: int = 93
+
+    times: int = 96
+    empty: int = 36
+    other: int = 91
+
+    colon: int = 37
+    hyphen: int = 37
+
 
 
 def print_ansi(
@@ -121,3 +162,174 @@ def strip_ansi(
     """  # noqa: D301 LIT102
 
     return re_sub(ANSICODE, '', string)
+
+
+
+def array_ansi(  # noqa: CFQ001, CFQ004
+    source: ANSIARRAY,
+    *,
+    indent: int = 0,
+    colors: ArrayColors = ArrayColors(),
+) -> str:
+    """
+    Print the ANSI colorized iterable to the standard output.
+
+    .. note::
+       This massive function should be refactored, possibly
+       into a class with methods where there are functions.
+
+    :param source: Value in supported and iterable formats.
+    :param indent: How many levels for initial indentation.
+    :param colors: Determine colors used with different types.
+    :returns: ANSI colorized string using inline directives.
+    """
+
+    output: list[str] = []
+
+    repeat = f'<c{colors.other}>REPEAT<c0>'
+
+
+    def _append(
+        prefix: str,
+        value: Any,  # noqa: ANN401
+        indent: int,
+        refers: set[int],
+    ) -> None:
+
+        if id(value) in refers:
+            return output.append(
+                f'{prefix} {repeat}')
+
+        refers.add(id(value))
+
+
+        types = {
+            'dict': dict,
+            'list': list,
+            'tuple': tuple,
+            'set': set}
+
+        for name, _type in types.items():
+
+            if not isinstance(value, _type):
+                continue
+
+            output.append(
+                f'{prefix} '
+                f'<c{colors.label}>{name}<c0>')
+
+            return _process(
+                source=value,
+                indent=indent + 2,
+                refers=refers)
+
+
+        value = _concrete(value)
+
+        output.append(
+            f'{prefix} {value}')
+
+
+    def _concrete(
+        source: Any,  # noqa: ANN401
+    ) -> str:
+
+        color = colors.other
+
+        if isinstance(source, bool):
+            color = colors.bool
+
+        if isinstance(source, int | float):
+            color = colors.num
+
+        elif isinstance(source, str):
+            color = colors.str
+
+        elif source is None:
+            color = colors.none
+
+        elif isinstance(source, Duration):
+            color = colors.times
+
+        elif isinstance(source, Times):
+            color = colors.times
+
+        elif source is Empty:
+            color = colors.empty
+
+        string = f'<c{color}>{source}<c0>'
+
+        if isinstance(source, str):
+            string = f"'{string}'"
+
+        return string
+
+
+    def _dict(
+        source: ANSIARRAD,
+        indent: int,
+        refers: Optional[set[int]] = None,
+    ) -> None:
+
+        assert isinstance(source, dict)
+
+        for key, value in source.items():
+
+            prefix = (
+                f'{" " * indent}'
+                f'<c{colors.key}>{key}'
+                f'<c{colors.colon}>:<c0>')
+
+            _append(
+                prefix, value, indent,
+                refers=refers or set())
+
+
+    def _list(
+        source: ANSIARRAL,
+        indent: int,
+        refers: Optional[set[int]] = None,
+    ) -> None:
+
+        assert isinstance(
+            source, (list, tuple, set))
+
+        for value in source:
+
+            prefix = (
+                f'{" " * indent}'
+                f'<c{colors.hyphen}>-<c0>')
+
+            _append(
+                prefix, value, indent,
+                refers=refers or set())
+
+
+    def _process(
+        source: ANSIARRAD | ANSIARRAL,
+        **kwargs: Any,
+    ) -> None:
+
+        if isinstance(source, dict):
+            return _dict(source, **kwargs)
+
+        return _list(source, **kwargs)
+
+
+    if isinstance(source, dict):
+        _dict(source, indent)
+
+    elif isinstance(source, list):
+        _list(source, indent)
+
+    elif isinstance(source, tuple):
+        _list(source, indent)
+
+    elif isinstance(source, set):
+        _list(source, indent)
+
+
+    _output = [
+        make_ansi(x) for x in output]
+
+    return '\n'.join(_output)

encommon/utils/test/test_stdout.py

@@ -9,10 +9,15 @@ is permitted, for more information consult the project license file.
 
 from _pytest.capture import CaptureFixture
 
+from ..stdout import array_ansi
 from ..stdout import kvpair_ansi
 from ..stdout import make_ansi
 from ..stdout import print_ansi
 from ..stdout import strip_ansi
+from ...times import Duration
+from ...times import Times
+from ...times.common import UNIXMPOCH
+from ...types import Empty
 
 
 
@@ -78,3 +83,149 @@ def test_strip_ansi() -> None:
     output = '\x1b[0;31mtest\x1b[0;0m'
 
     assert strip_ansi(output) == 'test'
+
+
+
+def test_array_ansi() -> None:  # noqa: CFQ001
+    """
+    Perform various tests associated with relevant routines.
+    """
+
+    simple = {
+        'str': 'value',
+        'list': [1, 2],
+        'bool': False}
+
+    repeat = {
+        'dict': simple | {
+            'dict': simple}}
+
+    source = {
+        'str': 'value',
+        'int': 1,
+        'float': 1.0,
+        'complex': complex(3, 1),
+        'list': [simple],
+        'tuple': (simple,),
+        'range': range(1, 3),
+        'dict1': simple,
+        'dict2': simple,
+        'dict3': simple,
+        'set': {1, 2, 3},
+        'frozenset': {1, 2, 3},
+        'bool': True,
+        'none': None,
+        '_private': None,
+        'repeat': repeat,
+        'Empty': Empty,
+        'Duration': Duration(190802),
+        'Times': Times(0)}
+
+
+    output = strip_ansi(
+        array_ansi(simple))
+
+    assert output == (
+        "str: 'value'\n"
+        'list: list\n'
+        '  - 1\n'
+        '  - 2\n'
+        'bool: False')
+
+
+    output = strip_ansi(
+        array_ansi([simple]))
+
+    assert output == (
+        '- dict\n'
+        "  str: 'value'\n"
+        '  list: list\n'
+        '    - 1\n'
+        '    - 2\n'
+        '  bool: False')
+
+
+    output = strip_ansi(
+        array_ansi((1, 2, 3)))
+
+    assert output == (
+        '- 1\n'
+        '- 2\n'
+        '- 3')
+
+
+    output = strip_ansi(
+        array_ansi({1, 2, 3}))
+
+    assert output == (
+        '- 1\n'
+        '- 2\n'
+        '- 3')
+
+
+    output = strip_ansi(
+        array_ansi(source))
+
+    assert output == (
+        "str: 'value'\n"
+        'int: 1\n'
+        'float: 1.0\n'
+        'complex: (3+1j)\n'
+        'list: list\n'
+        '  - dict\n'
+        "    str: 'value'\n"
+        '    list: list\n'
+        '      - 1\n'
+        '      - 2\n'
+        '    bool: False\n'
+        'tuple: tuple\n'
+        '  - dict\n'
+        "    str: 'value'\n"
+        '    list: list\n'
+        '      - 1\n'
+        '      - 2\n'
+        '    bool: False\n'
+        'range: range(1, 3)\n'
+        'dict1: dict\n'
+        "  str: 'value'\n"
+        '  list: list\n'
+        '    - 1\n'
+        '    - 2\n'
+        '  bool: False\n'
+        'dict2: dict\n'
+        "  str: 'value'\n"
+        '  list: list\n'
+        '    - 1\n'
+        '    - 2\n'
+        '  bool: False\n'
+        'dict3: dict\n'
+        "  str: 'value'\n"
+        '  list: list\n'
+        '    - 1\n'
+        '    - 2\n'
+        '  bool: False\n'
+        'set: set\n'
+        '  - 1\n'
+        '  - 2\n'
+        '  - 3\n'
+        'frozenset: set\n'
+        '  - 1\n'
+        '  - 2\n'
+        '  - 3\n'
+        'bool: True\n'
+        'none: None\n'
+        '_private: None\n'
+        'repeat: dict\n'
+        '  dict: dict\n'
+        "    str: 'value'\n"
+        '    list: list\n'
+        '      - 1\n'
+        '      - 2\n'
+        '    bool: False\n'
+        '    dict: dict\n'
+        '      str: REPEAT\n'
+        '      list: REPEAT\n'
+        '      bool: REPEAT\n'
+        'Empty: Empty\n'
+        'Duration: 2d5h\n'
+        f'Times: {UNIXMPOCH}')

encommon/version.txt

@@ -1 +1 @@
-0.6.0
+0.7.0

{encommon-0.6.0.dist-info → encommon-0.7.0.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: encommon
-Version: 0.6.0
+Version: 0.7.0
 Summary: Enasis Network Common Library
 License: MIT
 Classifier: Programming Language :: Python :: 3

{encommon-0.6.0.dist-info → encommon-0.7.0.dist-info}/RECORD

@@ -1,7 +1,7 @@
 encommon/__init__.py,sha256=VoXUcphq-gcXCraaU47EtXBftF6UVuQPMGr0fuCTt9A,525
 encommon/conftest.py,sha256=z5BMi6KjNuactDRgbh8J8w81V08Ptf6QK2o_bJANRs4,880
 encommon/py.typed,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
-encommon/version.txt,sha256=l6XW5UCmEg0Jw53bZn4Ojiusf8wv_vgTuC4I_WA2W84,6
+encommon/version.txt,sha256=ln2a-xATRmZxZvLnboGRC8GQSI19QdUMoAcunZLwDjI,6
 encommon/config/__init__.py,sha256=2ic7tK2lOQvqWmmQnMozqxCJcbyQ_sSEHmOUDUFan2U,710
 encommon/config/common.py,sha256=gaKBgkF7b7UIAhd0ESio0KpG8JfdRpz5BxNgKRptd6A,2041
 encommon/config/config.py,sha256=-wIkyA6YQGAly0WuXLaOYXENjZYRYgWk_VdUN8mMe8Q,4853
@@ -44,19 +44,19 @@ encommon/types/test/__init__.py,sha256=PjrnBYT0efyvbaGeNx94dm3tP3EVHUHSVs-VGeLEv
 encommon/types/test/test_dicts.py,sha256=UHMvrWKnz-bPscq0Vp2uoLLFv4slvQQL2sobe5WUZ7U,2673
 encommon/types/test/test_empty.py,sha256=YUn0ROFhrWLQ30uROVqroHW4BsnFbzUZjACs3aEvrrI,981
 encommon/types/test/test_strings.py,sha256=WHXf1dnK6Qs2_0UyGYztJxpS29bnR8WKjKsvVO2WCi4,407
-encommon/utils/__init__.py,sha256=qdr2RDKlmoGrgMhwJCaTrhQXmuD_lmDxlIxOUprnRVs,784
+encommon/utils/__init__.py,sha256=bBiDsBz8j-fHJ-P-AM4rZKqfiLNv5Q8KID8GfcvpWLA,833
 encommon/utils/common.py,sha256=UrowELh3PtDzpSS48nGhsAxTS_QUk96-KEJa4MlxiMA,466
 encommon/utils/match.py,sha256=4L2d2Cvr7vp3odkRCdNQ10OIW8DkEP55_NbQ6bdsReo,2462
 encommon/utils/paths.py,sha256=4EeaPsVwpv3pzoHeWmiSSGYZEud6hkD27kvbvgSpOPs,3236
 encommon/utils/sample.py,sha256=hOhS6A2aB9a5kXfrst7gUSQkxuqEo2J1AFyBsJZQhHE,3169
-encommon/utils/stdout.py,sha256=0C5NTg8fAB25s5oKmsmV2VSERn22QFCZjqJ1S75SXOM,2779
+encommon/utils/stdout.py,sha256=pPL68iE2oGk-hE3KGZjWE1vnOF6hflaarYPVZQnefHQ,7142
 encommon/utils/test/__init__.py,sha256=PjrnBYT0efyvbaGeNx94dm3tP3EVHUHSVs-VGeLEv5g,218
 encommon/utils/test/test_match.py,sha256=QagKpTFdRo23-Y55fSaJrSMpt5jIebScKbz0h8tivrI,1124
 encommon/utils/test/test_paths.py,sha256=0ls9gWJ2B487Dr1fHDDFCZPA7gxtv56nFEYHrTkNX-U,1892
 encommon/utils/test/test_sample.py,sha256=iNV9IxXmA5KJat3jKRiZH3iutHrT6bsibwti60AhICk,1464
-encommon/utils/test/test_stdout.py,sha256=a060uA8oEHFGoVqdwB5iYxdl4R2TRSgr6Z7pMEbxibs,1675
-encommon-0.6.0.dist-info/LICENSE,sha256=otnXKCtMjPlbHs0wgZ_BWULrp3g_2dWQJ6icRk9nkgg,1071
-encommon-0.6.0.dist-info/METADATA,sha256=OJ2Y0-tAC9HmFKQmrcyR5oQHFAVU1rxD9Rt2ssceXAs,2671
-encommon-0.6.0.dist-info/WHEEL,sha256=GJ7t_kWBFywbagK5eo9IoUwLW6oyOeTKmQ-9iHFVNxQ,92
-encommon-0.6.0.dist-info/top_level.txt,sha256=bP8q7-5tLDNm-3XPlqn_bDENfYNug5801H_xfz3BEAM,9
-encommon-0.6.0.dist-info/RECORD,,
+encommon/utils/test/test_stdout.py,sha256=U3YD8XIfVjjh_vNxN1UJqOWyp7_OFtJVl2K5oMziPu8,4878
+encommon-0.7.0.dist-info/LICENSE,sha256=otnXKCtMjPlbHs0wgZ_BWULrp3g_2dWQJ6icRk9nkgg,1071
+encommon-0.7.0.dist-info/METADATA,sha256=as7cVGwmjhknmAnTKkAOi6hrVIXU07tWU0t83L4Fn_4,2671
+encommon-0.7.0.dist-info/WHEEL,sha256=GJ7t_kWBFywbagK5eo9IoUwLW6oyOeTKmQ-9iHFVNxQ,92
+encommon-0.7.0.dist-info/top_level.txt,sha256=bP8q7-5tLDNm-3XPlqn_bDENfYNug5801H_xfz3BEAM,9
+encommon-0.7.0.dist-info/RECORD,,