encommon 0.13.0__py3-none-any.whl → 0.14.0__py3-none-any.whl

encommon/colors/test/test_colors.py

@@ -0,0 +1,189 @@
+"""
+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 import mark
+
+from ..colors import Colors
+from ...types import lattrs
+
+
+
+def test_Colors() -> None:
+    """
+    Perform various tests associated with relevant routines.
+    """
+
+    color = Colors('000001')
+
+
+    attrs = lattrs(color)
+
+    assert attrs == [
+        '_Colors__source']
+
+
+    assert repr(color) == (
+        "Colors('#000001')")
+
+    assert hash(color) > 0
+
+    assert str(color) == '#000001'
+
+
+    assert int(color) == 1
+    assert float(color) == 1.0
+
+    assert color + 1 == '000002'
+    assert color - 1 == '000000'
+
+    assert color == '000001'
+    assert color != '000000'
+    assert color != int
+
+    assert color > 0
+    assert color >= 1
+    assert color <= 1
+    assert color < 2
+
+    assert color > '000000'
+    assert color >= '000001'
+    assert color <= '000001'
+    assert color < '000002'
+
+
+
+@mark.parametrize(
+    'source,expect',
+    [('ff00cc', (255, 0, 204)),
+     ('ffffff', (255, 255, 255)),
+     ('000000', (0, 0, 0)),
+     ('ff0000', (255, 0, 0)),
+     ('00ff00', (0, 255, 0)),
+     ('0000ff', (0, 0, 255)),
+     ('808080', (128, 128, 128)),
+     ('ffff00', (255, 255, 0)),
+     ('00ffff', (0, 255, 255)),
+     ('ff00ff', (255, 0, 255)),
+     ('800080', (128, 0, 128))])
+def test_Colors_rgb(
+    source: str,
+    expect: tuple[int, ...],
+) -> None:
+    """
+    Perform various tests associated with relevant routines.
+
+    :param source: Source color used when converting values.
+    :param expect: Expected output from the testing routine.
+    """
+
+    assert Colors(source).rgb == expect
+
+
+
+@mark.parametrize(
+    'source,expect',
+    [('ff00cc', (52.1391, 25.6196, 59.3238)),
+     ('ffffff', (95.0500, 100.0000, 108.9000)),
+     ('000000', (0.0000, 0.0000, 0.0000)),
+     ('ff0000', (41.2400, 21.2600, 1.9300)),
+     ('00ff00', (35.7600, 71.5200, 11.9200)),
+     ('0000ff', (18.0500, 7.2200, 95.0500)),
+     ('808080', (20.5175, 21.5861, 23.5072)),
+     ('ffff00', (77.0000, 92.7800, 13.8500)),
+     ('00ffff', (53.8100, 78.7400, 106.9700)),
+     ('ff00ff', (59.2900, 28.4800, 96.9800)),
+     ('800080', (12.7984, 6.1477, 20.9342))])
+def test_Colors_xyz(
+    source: str,
+    expect: tuple[int, ...],
+) -> None:
+    """
+    Perform various tests associated with relevant routines.
+
+    :param source: Source color used when converting values.
+    :param expect: Expected output from the testing routine.
+    """
+
+    assert Colors(source).xyz == expect
+
+
+
+@mark.parametrize(
+    'source,expect',
+    [('ff00cc', (0.3803, 0.1869)),
+     ('ffffff', (0.3127, 0.3290)),
+     ('000000', (0.0000, 0.0000)),
+     ('ff0000', (0.6401, 0.3300)),
+     ('00ff00', (0.3000, 0.6000)),
+     ('0000ff', (0.1500, 0.0600)),
+     ('808080', (0.3127, 0.3290)),
+     ('ffff00', (0.4193, 0.5053)),
+     ('00ffff', (0.2247, 0.3287)),
+     ('ff00ff', (0.3209, 0.1542)),
+     ('800080', (0.3209, 0.1542))])
+def test_Colors_xy(
+    source: str,
+    expect: tuple[int, ...],
+) -> None:
+    """
+    Perform various tests associated with relevant routines.
+
+    :param source: Source color used when converting values.
+    :param expect: Expected output from the testing routine.
+    """
+
+    assert Colors(source).xy == expect
+
+
+
+@mark.parametrize(
+    'source,expect',
+    [('ff00cc', (312, 100, 50)),
+     ('ffffff', (0, 0, 100)),
+     ('000000', (0, 0, 0)),
+     ('ff0000', (0, 100, 50)),
+     ('00ff00', (120, 100, 50)),
+     ('0000ff', (240, 100, 50)),
+     ('808080', (0, 0, 50)),
+     ('ffff00', (60, 100, 50)),
+     ('00ffff', (180, 100, 50)),
+     ('ff00ff', (300, 100, 50)),
+     ('800080', (300, 100, 25))])
+def test_Colors_hsl(
+    source: str,
+    expect: tuple[int, ...],
+) -> None:
+    """
+    Perform various tests associated with relevant routines.
+
+    :param source: Source color used when converting values.
+    :param expect: Expected output from the testing routine.
+    """
+
+    assert Colors(source).hsl == expect
+
+
+
+def test_Colors_cover() -> None:
+    """
+    Perform various tests associated with relevant routines.
+    """
+
+    color1 = Colors('000001')
+    color2 = Colors('#000001')
+
+    assert not (color1 > None)  # type: ignore
+    assert not (color1 >= None)  # type: ignore
+    assert not (color1 <= None)  # type: ignore
+    assert not (color1 < None)  # type: ignore
+
+    assert color1 - color2 == 0
+    assert color1 - '000001' == 0
+    assert color1 + color2 == 2
+    assert color1 + '000001' == 2

encommon/config/config.py

@@ -67,8 +67,8 @@ class Config:
 
     def __init__(
         self,
-        *,
         files: Optional['PATHABLE'] = None,
+        *,
         paths: Optional['PATHABLE'] = None,
         cargs: Optional[dict[str, Any]] = None,
         sargs: Optional[dict[str, Any]] = None,
@@ -179,14 +179,69 @@ class Config:
         self,
     ) -> dict[str, Any]:
         """
-        Return the configuration in dictionary format for files.
+        Return the configuration dumped from the Pydantic model.
 
-        :returns: Configuration in dictionary format for files.
+        :returns: Configuration dumped from the Pydantic model.
         """
 
         return self.params.model_dump()
 
 
+    @property
+    def basic(
+        self,
+    ) -> dict[str, Any]:
+        """
+        Return the configuration source loaded from the objects.
+
+        :returns: Configuration source loaded from the objects.
+        """
+
+        files = self.files
+
+        ferged = files.merged
+
+        merge_dicts(
+            dict1=ferged,
+            dict2=self.cargs,
+            force=True)
+
+        return deepcopy(ferged)
+
+
+    @property
+    def merge(
+        self,
+    ) -> dict[str, Any]:
+        """
+        Return the configuration source loaded from the objects.
+
+        :returns: Configuration source loaded from the objects.
+        """
+
+        files = self.files
+        paths = self.paths
+
+        ferged = files.merged
+        perged = paths.merged
+
+        merge_dicts(
+            dict1=ferged,
+            dict2=self.cargs,
+            force=True)
+
+        values = perged.values()
+
+        for merge in values:
+
+            merge_dicts(
+                dict1=ferged,
+                dict2=merge,
+                force=False)
+
+        return deepcopy(ferged)
+
+
     @property
     def model(
         self,
@@ -215,20 +270,12 @@ class Config:
         if params is not None:
             return params
 
-
-        merged = self.files.merged
-
-        merge_dicts(
-            dict1=merged,
-            dict2=self.cargs,
-            force=True)
-
-        params = self.model(**merged)
-
+        params = self.model(
+            **self.basic)
 
         self.__params = params
 
-        return params
+        return self.__params
 
 
     @property
@@ -241,11 +288,14 @@ class Config:
         :returns: Instance of Python logging library created.
         """
 
-        if self.__logger is not None:
-            return self.__logger
+        logger = self.__logger
+        params = self.params
+
+        if logger is not None:
+            return logger
 
         logger = Logger(
-            self.params.enlogger)
+            params.enlogger)
 
         self.__logger = logger
 
@@ -262,11 +312,14 @@ class Config:
         :returns: Instance of the encryption instance created.
         """
 
-        if self.__crypts is not None:
-            return self.__crypts
+        crypts = self.__crypts
+        params = self.params
+
+        if crypts is not None:
+            return crypts
 
         crypts = Crypts(
-            self.params.encrypts)
+            params.encrypts)
 
         self.__crypts = crypts
 

encommon/config/files.py

@@ -17,6 +17,7 @@ from .utils import config_load
 from .utils import config_path
 from .utils import config_paths
 from ..types import merge_dicts
+from ..types import sort_dict
 
 if TYPE_CHECKING:
     from ..utils.common import PATHABLE
@@ -111,6 +112,8 @@ class ConfigFiles:
                 force=False)
 
 
+        merged = sort_dict(merged)
+
         self.__merged = merged
 
         return deepcopy(merged)

encommon/config/logger.py

@@ -122,6 +122,11 @@ class Message:
                 value = COMMAD.join(values)
 
 
+            if (isinstance(value, Times)
+                    and key == 'elapsed'):
+                value = value.since
+
+
             if (isinstance(value, float)
                     and key == 'elapsed'):
 

encommon/config/params.py

@@ -10,10 +10,9 @@ is permitted, for more information consult the project license file.
 from pathlib import Path
 from typing import Optional
 
-from pydantic import BaseModel
-
 from .logger import LOGLEVELS
 from ..crypts import CryptsParams
+from ..types import BaseModel
 
 
 

encommon/config/paths.py

@@ -17,6 +17,7 @@ from typing import TYPE_CHECKING
 from .files import ConfigFile
 from .utils import config_path
 from .utils import config_paths
+from ..types import sort_dict
 
 if TYPE_CHECKING:
     from ..utils.common import PATHABLE
@@ -118,6 +119,8 @@ class ConfigPaths:
                 merged[key] = file.config
 
 
+        merged = sort_dict(merged)
+
         self.__merged = merged
 
         return deepcopy(merged)

encommon/config/test/test_config.py

@@ -13,13 +13,13 @@ from typing import TYPE_CHECKING
 from . import SAMPLES
 from ..logger import Logger
 from ..params import Params
-from ... import ENPYRWS
 from ... import PROJECT
 from ...crypts import Crypts
 from ...types import inrepr
 from ...types import instr
 from ...utils import load_sample
 from ...utils import prep_sample
+from ...utils.sample import ENPYRWS
 
 if TYPE_CHECKING:
     from ..config import Config
@@ -76,6 +76,10 @@ def test_Config(
 
     assert len(config.config) == 3
 
+    assert len(config.basic) == 3
+
+    assert len(config.merge) == 5
+
     assert config.model is Params
 
     assert isinstance(config.params, Params)

encommon/config/test/test_logger.py

@@ -16,6 +16,7 @@ from pytest import fixture
 from ..logger import Logger
 from ..logger import Message
 from ..params import LoggerParams
+from ...times import Times
 from ...times.common import UNIXMPOCH
 from ...times.common import UNIXSPOCH
 from ...types import inrepr
@@ -196,6 +197,8 @@ def test_Logger_cover(
     :param caplog: pytest object for capturing log message.
     """
 
+    times = Times('now')
+
 
     def _logger_logs() -> None:
         logger.log_d(msg='pytest')
@@ -203,6 +206,7 @@ def test_Logger_cover(
         logger.log_e(msg='pytest')
         logger.log_i(msg='pytest')
         logger.log_w(msg='pytest')
+        logger.log_i(elapsed=times)
 
 
     def _logger_stdo() -> _CAPLOG:
@@ -229,16 +233,16 @@ def test_Logger_cover(
 
     _logger_logs()
 
-    assert len(_logger_stdo()) == 5
-    assert len(_logger_file()) == 5
+    assert len(_logger_stdo()) == 6
+    assert len(_logger_file()) == 6
 
     logger.stop()
 
 
     _logger_logs()
 
-    assert len(_logger_stdo()) == 5
-    assert len(_logger_file()) == 5
+    assert len(_logger_stdo()) == 6
+    assert len(_logger_file()) == 6
 
 
     logger.start()
@@ -256,13 +260,14 @@ def test_Logger_cover(
     assert message in str(stdo)
     assert message in str(file)
 
-    assert len(_logger_stdo()) == 6
-    assert len(_logger_file()) == 6
+    assert len(_logger_stdo()) == 7
+    assert len(_logger_file()) == 7
+
 
     logger.stop()
 
 
     _logger_logs()
 
-    assert len(_logger_stdo()) == 6
-    assert len(_logger_file()) == 6
+    assert len(_logger_stdo()) == 7
+    assert len(_logger_file()) == 7

encommon/config/test/test_paths.py

@@ -14,12 +14,12 @@ from pytest import fixture
 from . import SAMPLES
 from ..paths import ConfigPath
 from ..paths import ConfigPaths
-from ... import ENPYRWS
 from ... import PROJECT
 from ...types import inrepr
 from ...types import instr
 from ...utils import load_sample
 from ...utils import prep_sample
+from ...utils.sample import ENPYRWS
 
 
 

encommon/config/utils.py

@@ -84,8 +84,14 @@ def config_paths(
     :returns: New resolved filesystem path object instances.
     """
 
+    if replace is None:
+        replace = {}
+
+    replace = dict(replace)
+
     replace = {
         'PROJECT': PROJECT,
         'WORKSPACE': WORKSPACE}
 
-    return resolve_paths(paths, replace)
+    return resolve_paths(
+        paths, replace)

encommon/conftest.py

@@ -27,31 +27,42 @@ def config_factory(
     :returns: Newly constructed instance of related class.
     """
 
+    content = (
+        f"""
+
+        enconfig:
+          paths:
+            - '{SAMPLES}/stark'
+            - '{SAMPLES}/wayne'
+
+        enlogger:
+          stdo_level: info
+
+        encrypts:
+          phrases:
+            default:
+              phrase: phrase
+
+        """)  # noqa: LIT003
+
+    config_path = (
+        tmp_path / 'config.yml')
+
+    config_log = (
+        tmp_path / 'config.log')
+
     save_text(
-        f'{tmp_path}/config.yml',
-        content=(
-            'enconfig:\n'
-            '  paths:\n'
-            f"    - '{SAMPLES}/stark'\n"
-            f"    - '{SAMPLES}/wayne'\n"
-            'enlogger:\n'
-            '  stdo_level: info\n'
-            'encrypts:\n'
-            '  phrases:\n'
-            '    default:\n'
-            '      phrase: phrase\n'))
-
-    config_log = f'{tmp_path}/config.log'
-
-    cargs = {
-        'enlogger/file_path': config_log,
-        'enlogger/file_level': 'info'}
-
-    sargs = {
-        'custom/parameter': 'fart'}
+        config_path, content)
+
+    logger = {
+        'file_path': config_log,
+        'file_level': 'info'}
+
+    cargs = {'enlogger': logger}
+    sargs = {'cus/tom': 'fart'}
 
     return Config(
-        files=f'{tmp_path}/config.yml',
+        config_path,
         cargs=cargs,
         sargs=sargs)
 

encommon/crypts/params.py

@@ -7,7 +7,13 @@ is permitted, for more information consult the project license file.
 
 
 
-from pydantic import BaseModel
+from typing import Optional
+
+from ..types import BaseModel
+
+
+
+_CRYPTS = dict[str, 'CryptParams']
 
 
 
@@ -29,8 +35,21 @@ class CryptsParams(BaseModel, extra='forbid'):
     Process and validate the core configuration parameters.
 
     :param phrases: Passphrases that are used in operations.
-    :param data: Keyword arguments passed to Pydantic model.
-        Parameter is picked up by autodoc, please ignore.
     """
 
-    phrases: dict[str, CryptParams] = {}
+    phrases: _CRYPTS
+
+
+    def __init__(
+        self,
+        phrases: Optional[_CRYPTS] = None,
+    ) -> None:
+        """
+        Initialize instance for class using provided parameters.
+        """
+
+        if phrases is None:
+            phrases = {}
+
+        super().__init__(
+            phrases=phrases)

encommon/times/__init__.py

@@ -19,6 +19,7 @@ from .parse import string_time
 from .timer import Timer
 from .timers import Timers
 from .times import Times
+from .unitime import unitime
 from .utils import findtz
 from .window import Window
 from .windows import Windows
@@ -40,4 +41,5 @@ __all__ = [
     'parse_time',
     'shift_time',
     'since_time',
-    'string_time']
+    'string_time',
+    'unitime']

encommon/times/common.py

@@ -24,7 +24,8 @@ SNAPABLE = compile(
     r'^(\-|\+)[\d\@a-z\-\+]+$')
 
 STRINGNOW = {
-    'None', 'null', 'now'}
+    'None', None,
+    'null', 'now'}