encommon 0.6.0__tar.gz → 0.7.1__tar.gz

{encommon-0.6.0/encommon.egg-info → encommon-0.7.1}/PKG-INFO

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

{encommon-0.6.0 → encommon-0.7.1}/encommon/config/logger.py

@@ -60,7 +60,7 @@ class Message:
     -------
     >>> message = Message('info', '1970-01-01', foo='bar')
     >>> strip_ansi(message.stdo_output)
-    'level="info" time="1970-01-01T00:00:00+0000" foo="bar"'
+    'level="info" time="1970-01-01T00:00:00Z" foo="bar"'
 
     :param level: Severity which log message is classified.
     :param time: What time the log message actually occurred.
@@ -95,6 +95,10 @@ class Message:
             if value in [None, Empty]:
                 continue
 
+            if (key == 'elapsed'
+                    and isinstance(value, float)):
+                value = round(value, 2)
+
             value = str(value)
 
             self.__fields[key] = value
@@ -190,6 +194,11 @@ class Message:
         fields |= dict(self.__fields)
 
 
+        fields['time'] = (
+            fields['time']
+            .replace('+0000', 'Z'))
+
+
         output: list[str] = []
 
         for key, value in fields.items():

{encommon-0.6.0 → encommon-0.7.1}/encommon/config/test/test_logger.py

@@ -14,7 +14,6 @@ from _pytest.logging import LogCaptureFixture
 
 from ..logger import Logger
 from ..logger import Message
-from ...times.common import UNIXEPOCH
 from ...times.common import UNIXMPOCH
 from ...utils.stdout import strip_ansi
 
@@ -35,7 +34,8 @@ def test_Message() -> None:
         int=1,
         list=[1, '2', 3],
         none=None,
-        string='foo')
+        string='foo',
+        elapsed=0.69420)
 
     attrs = list(message.__dict__)
 
@@ -60,7 +60,8 @@ def test_Message() -> None:
         'float="1.0", '
         'int="1", '
         'list="[1, \'2\', 3]", '
-        'string="foo")')
+        'string="foo", '
+        'elapsed="0.69")')
 
     assert str(message) == repr(message)
 
@@ -73,19 +74,21 @@ def test_Message() -> None:
         'float': '1.0',
         'int': '1',
         'list': "[1, '2', 3]",
-        'string': 'foo'}
+        'string': 'foo',
+        'elapsed': '0.69'}
 
 
     output = strip_ansi(message.stdo_output)
 
     assert output == (
         'level="info"'
-        f' time="{UNIXEPOCH}"'
+        ' time="1970-01-01T00:00:00Z"'
         ' dict="{\'foo\': \'bar\'}"'
         ' float="1.0"'
         ' int="1"'
         ' list="[1, \'2\', 3]"'
-        ' string="foo"')
+        ' string="foo"'
+        ' elapsed="0.69"')
 
 
     assert message.file_output == (
@@ -95,7 +98,8 @@ def test_Message() -> None:
         ' "float": "1.0",'
         ' "int": "1",'
         ' "list": "[1, \'2\', 3]",'
-        ' "string": "foo"}')
+        ' "string": "foo",'
+        ' "elapsed": "0.69"}')
 
 
 

{encommon-0.6.0 → encommon-0.7.1}/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-0.7.1/encommon/utils/stdout.py

@@ -0,0 +1,338 @@
+"""
+Functions and routines associated with Enasis Network Common Library.
+
+This file is part of Enasis Network software eco-system. Distribution
+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
+
+
+
+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(
+    string: str = '',
+    method: Literal['stdout', 'print'] = 'stdout',
+    output: bool = True,
+) -> str:
+    """
+    Print the ANSI colorized string to the standard output.
+
+    Example
+    -------
+    >>> print_ansi('<c91>ERROR<c0>')
+    '\\x1b[0;91mERROR\\x1b[0;0m'
+
+    :param string: String processed using inline directives.
+    :param method: Which method for standard output is used.
+    :param output: Whether or not hte output should be print.
+    :returns: ANSI colorized string using inline directives.
+    """  # noqa: D301 LIT102
+
+    string = make_ansi(string)
+
+    if output is True:
+        if method == 'stdout':
+            stdout.write(f'{string}\n')
+        else:
+            print(string)  # noqa: T201
+
+    return string
+
+
+
+def make_ansi(
+    string: str,
+) -> str:
+    """
+    Parse the string and replace directives with ANSI codes.
+
+    Example
+    -------
+    >>> make_ansi('<c91>ERROR<c0>')
+    '\\x1b[0;91mERROR\\x1b[0;0m'
+
+    :param string: String containing directives to replace.
+    :returns: Provided string with the directives replaced.
+    """  # noqa: D301 LIT102
+
+    pattern = r'\<c([\d\;]+)\>'
+    replace = r'\033[0;\1m'
+
+    return re_sub(pattern, replace, string)
+
+
+
+def kvpair_ansi(
+    key: str,
+    value: Any,  # noqa: ANN401
+) -> str:
+    """
+    Process and colorize keys and values for standard output.
+
+    Example
+    -------
+    >>> kvpair_ansi('k', 'v')
+    '\\x1b[0;90mk\\x1b[0;37m="\\x1b[0;0m...
+
+    :param key: String value to use for the key name portion.
+    :param value: String value to use for the value portion.
+    :returns: ANSI colorized string using inline directives.
+    """  # noqa: D301 LIT102
+
+    if isinstance(value, JOINABLE):  # type: ignore
+        value = ','.join([
+            str(x) for x in value])
+
+    elif not isinstance(value, str):
+        value = str(value)
+
+    return make_ansi(
+        f'<c90>{key}<c37>="<c0>'
+        f'{value}<c37>"<c0>')
+
+
+
+def strip_ansi(
+    string: str,
+) -> str:
+    """
+    Return the provided string with the ANSI codes removed.
+
+    Example
+    -------
+    >>> strip_ansi('\\x1b[0;91mERROR\\x1b[0;0m')
+    'ERROR'
+
+    :param string: String which contains ANSI codes to strip.
+    :returns: Provided string with the ANSI codes removed.
+    """  # 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}')
+
+
+        if isinstance(value, list | tuple | dict):
+            refers.add(id(value))
+
+
+        types = {
+            'list': list,
+            'tuple': tuple,
+            'dict': dict,
+            'frozenset': frozenset,
+            '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-0.7.1/encommon/utils/test/test_stdout.py

@@ -0,0 +1,231 @@
+"""
+Functions and routines associated with Enasis Network Common Library.
+
+This file is part of Enasis Network software eco-system. Distribution
+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
+
+
+
+def test_print_ansi(
+    capsys: CaptureFixture[str],
+) -> None:
+    """
+    Perform various tests associated with relevant routines.
+
+    :param capsys: pytest object for capturing print message.
+    """
+
+    print_ansi('<c91>test<c0>', 'print')
+
+    output = capsys.readouterr().out
+
+    assert strip_ansi(output) == 'test\n'
+
+
+
+def test_make_ansi() -> None:
+    """
+    Perform various tests associated with relevant routines.
+    """
+
+    output = make_ansi('<c31>test<c0>')
+
+    assert output == (
+        '\x1b[0;31mtest\x1b[0;0m')
+
+
+
+def test_kvpair_ansi() -> None:
+    """
+    Perform various tests associated with relevant routines.
+    """
+
+    output = kvpair_ansi('key', 'value')
+
+    assert output == (
+        '\x1b[0;90mkey\x1b[0;37m="\x1b'
+        '[0;0mvalue\x1b[0;37m"\x1b[0;0m')
+
+    output = kvpair_ansi('key', [1, 2])
+
+    assert output == (
+        '\x1b[0;90mkey\x1b[0;37m="\x1b'
+        '[0;0m1,2\x1b[0;37m"\x1b[0;0m')
+
+    output = kvpair_ansi('key', None)
+
+    assert output == (
+        '\x1b[0;90mkey\x1b[0;37m="\x1b'
+        '[0;0mNone\x1b[0;37m"\x1b[0;0m')
+
+
+
+def test_strip_ansi() -> None:
+    """
+    Perform various tests associated with relevant routines.
+    """
+
+    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: 'value'\n"
+        '      list: REPEAT\n'
+        '      bool: False\n'
+        'Empty: Empty\n'
+        'Duration: 2d5h\n'
+        f'Times: {UNIXMPOCH}')

encommon-0.7.1/encommon/version.txt

@@ -0,0 +1 @@
+0.7.1

{encommon-0.6.0 → encommon-0.7.1/encommon.egg-info}/PKG-INFO

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

{encommon-0.6.0 → encommon-0.7.1}/setup.cfg

@@ -12,6 +12,8 @@ ignore =
 per-file-ignores = 
 	encommon/crypts/hashes.py:S324,
 	encommon/times/timers.py:S608,
+	encommon/utils/stdout.py:SIM114,
+	encommon/utils/test/test_stdout.py:LIT015,
 
 [mypy]
 mypy_path = stubs

encommon-0.6.0/encommon/utils/stdout.py

@@ -1,123 +0,0 @@
-"""
-Functions and routines associated with Enasis Network Common Library.
-
-This file is part of Enasis Network software eco-system. Distribution
-is permitted, for more information consult the project license file.
-"""
-
-
-
-from re import compile
-from re import sub as re_sub
-from sys import stdout
-from typing import Any
-from typing import Literal
-
-from .common import JOINABLE
-
-
-
-ANSICODE = compile(
-    r'\x1b\[[^A-Za-z]*[A-Za-z]')
-
-
-
-def print_ansi(
-    string: str = '',
-    method: Literal['stdout', 'print'] = 'stdout',
-    output: bool = True,
-) -> str:
-    """
-    Print the ANSI colorized string to the standard output.
-
-    Example
-    -------
-    >>> print_ansi('<c91>ERROR<c0>')
-    '\\x1b[0;91mERROR\\x1b[0;0m'
-
-    :param string: String processed using inline directives.
-    :param method: Which method for standard output is used.
-    :param output: Whether or not hte output should be print.
-    :returns: ANSI colorized string using inline directives.
-    """  # noqa: D301 LIT102
-
-    string = make_ansi(string)
-
-    if output is True:
-        if method == 'stdout':
-            stdout.write(f'{string}\n')
-        else:
-            print(string)  # noqa: T201
-
-    return string
-
-
-
-def make_ansi(
-    string: str,
-) -> str:
-    """
-    Parse the string and replace directives with ANSI codes.
-
-    Example
-    -------
-    >>> make_ansi('<c91>ERROR<c0>')
-    '\\x1b[0;91mERROR\\x1b[0;0m'
-
-    :param string: String containing directives to replace.
-    :returns: Provided string with the directives replaced.
-    """  # noqa: D301 LIT102
-
-    pattern = r'\<c([\d\;]+)\>'
-    replace = r'\033[0;\1m'
-
-    return re_sub(pattern, replace, string)
-
-
-
-def kvpair_ansi(
-    key: str,
-    value: Any,  # noqa: ANN401
-) -> str:
-    """
-    Process and colorize keys and values for standard output.
-
-    Example
-    -------
-    >>> kvpair_ansi('k', 'v')
-    '\\x1b[0;90mk\\x1b[0;37m="\\x1b[0;0m...
-
-    :param key: String value to use for the key name portion.
-    :param value: String value to use for the value portion.
-    :returns: ANSI colorized string using inline directives.
-    """  # noqa: D301 LIT102
-
-    if isinstance(value, JOINABLE):  # type: ignore
-        value = ','.join([
-            str(x) for x in value])
-
-    elif not isinstance(value, str):
-        value = str(value)
-
-    return make_ansi(
-        f'<c90>{key}<c37>="<c0>'
-        f'{value}<c37>"<c0>')
-
-
-
-def strip_ansi(
-    string: str,
-) -> str:
-    """
-    Return the provided string with the ANSI codes removed.
-
-    Example
-    -------
-    >>> strip_ansi('\\x1b[0;91mERROR\\x1b[0;0m')
-    'ERROR'
-
-    :param string: String which contains ANSI codes to strip.
-    :returns: Provided string with the ANSI codes removed.
-    """  # noqa: D301 LIT102
-
-    return re_sub(ANSICODE, '', string)

encommon-0.6.0/encommon/utils/test/test_stdout.py

@@ -1,80 +0,0 @@
-"""
-Functions and routines associated with Enasis Network Common Library.
-
-This file is part of Enasis Network software eco-system. Distribution
-is permitted, for more information consult the project license file.
-"""
-
-
-
-from _pytest.capture import CaptureFixture
-
-from ..stdout import kvpair_ansi
-from ..stdout import make_ansi
-from ..stdout import print_ansi
-from ..stdout import strip_ansi
-
-
-
-def test_print_ansi(
-    capsys: CaptureFixture[str],
-) -> None:
-    """
-    Perform various tests associated with relevant routines.
-
-    :param capsys: pytest object for capturing print message.
-    """
-
-    print_ansi('<c91>test<c0>', 'print')
-
-    output = capsys.readouterr().out
-
-    assert strip_ansi(output) == 'test\n'
-
-
-
-def test_make_ansi() -> None:
-    """
-    Perform various tests associated with relevant routines.
-    """
-
-    output = make_ansi('<c31>test<c0>')
-
-    assert output == (
-        '\x1b[0;31mtest\x1b[0;0m')
-
-
-
-def test_kvpair_ansi() -> None:
-    """
-    Perform various tests associated with relevant routines.
-    """
-
-    output = kvpair_ansi('key', 'value')
-
-    assert output == (
-        '\x1b[0;90mkey\x1b[0;37m="\x1b'
-        '[0;0mvalue\x1b[0;37m"\x1b[0;0m')
-
-    output = kvpair_ansi('key', [1, 2])
-
-    assert output == (
-        '\x1b[0;90mkey\x1b[0;37m="\x1b'
-        '[0;0m1,2\x1b[0;37m"\x1b[0;0m')
-
-    output = kvpair_ansi('key', None)
-
-    assert output == (
-        '\x1b[0;90mkey\x1b[0;37m="\x1b'
-        '[0;0mNone\x1b[0;37m"\x1b[0;0m')
-
-
-
-def test_strip_ansi() -> None:
-    """
-    Perform various tests associated with relevant routines.
-    """
-
-    output = '\x1b[0;31mtest\x1b[0;0m'
-
-    assert strip_ansi(output) == 'test'

encommon-0.6.0/encommon/version.txt

@@ -1 +0,0 @@
-0.6.0