encommon 0.7.6__py3-none-any.whl → 0.8.0__py3-none-any.whl

encommon/config/__init__.py

@@ -14,6 +14,8 @@ from .config import Config
 from .files import ConfigFile
 from .files import ConfigFiles
 from .logger import Logger
+from .params import ConfigParams
+from .params import LoggerParams
 from .params import Params
 from .paths import ConfigPath
 from .paths import ConfigPaths
@@ -24,9 +26,11 @@ __all__ = [
     'Config',
     'ConfigFile',
     'ConfigFiles',
+    'ConfigParams',
     'ConfigPath',
     'ConfigPaths',
     'Logger',
+    'LoggerParams',
     'Params',
     'config_load',
     'config_path',

encommon/config/common.py

@@ -11,15 +11,20 @@ from pathlib import Path
 from typing import Any
 from typing import Literal
 from typing import Optional
+from typing import TYPE_CHECKING
 
 from yaml import SafeLoader
 from yaml import load
 
 from .. import PROJECT
 from .. import WORKSPACE
-from ..utils.common import PATHABLE
-from ..utils.paths import resolve_path
-from ..utils.paths import resolve_paths
+from ..utils import read_text
+from ..utils import resolve_path
+from ..utils import resolve_paths
+
+if TYPE_CHECKING:
+    from ..utils.common import PATHABLE
+    from ..utils.common import REPLACE
 
 
 
@@ -42,9 +47,8 @@ def config_load(
     :returns: New resolved filesystem path object instance.
     """
 
-    loaded = (
-        config_path(path)
-        .read_text(encoding='utf-8'))
+    loaded = read_text(
+        config_path(path))
 
     parsed = load(loaded, SafeLoader)
 
@@ -58,7 +62,7 @@ def config_path(
     path: str | Path,
 ) -> Path:
     """
-    Resolve the provided path and replace the magic keywords.
+    Resolve the provided path replacing the magic keywords.
 
     .. note::
        This function simply wraps one from utils subpackage.
@@ -68,19 +72,19 @@ def config_path(
     """
 
     replace = {
-        'PROJECT': str(PROJECT),
-        'WORKSPACE': str(WORKSPACE)}
+        'PROJECT': PROJECT,
+        'WORKSPACE': WORKSPACE}
 
     return resolve_path(path, replace)
 
 
 
 def config_paths(
-    paths: PATHABLE,
-    replace: Optional[dict[str, str]] = None,
+    paths: 'PATHABLE',
+    replace: Optional['REPLACE'] = None,
 ) -> tuple[Path, ...]:
     """
-    Resolve the provided paths and replace the magic keywords.
+    Resolve the provided paths replacing the magic keywords.
 
     .. note::
        This function simply wraps one from utils subpackage.
@@ -90,7 +94,7 @@ def config_paths(
     """
 
     replace = {
-        'PROJECT': str(PROJECT),
-        'WORKSPACE': str(WORKSPACE)}
+        'PROJECT': PROJECT,
+        'WORKSPACE': WORKSPACE}
 
     return resolve_paths(paths, replace)

encommon/config/config.py

@@ -11,15 +11,18 @@ from copy import deepcopy
 from typing import Any
 from typing import Callable
 from typing import Optional
+from typing import TYPE_CHECKING
 
 from .common import config_paths
 from .files import ConfigFiles
 from .logger import Logger
 from .params import Params
 from .paths import ConfigPaths
-from ..crypts.crypts import Crypts
-from ..types.dicts import merge_dicts
-from ..utils.common import PATHABLE
+from ..crypts import Crypts
+from ..types import merge_dicts
+
+if TYPE_CHECKING:
+    from ..utils.common import PATHABLE
 
 
 
@@ -52,8 +55,8 @@ class Config:
     def __init__(
         self,
         *,
-        files: Optional[PATHABLE] = None,
-        paths: Optional[PATHABLE] = None,
+        files: Optional['PATHABLE'] = None,
+        paths: Optional['PATHABLE'] = None,
         cargs: Optional[dict[str, Any]] = None,
         model: Optional[Callable] = None,  # type: ignore
     ) -> None:

encommon/config/files.py

@@ -11,12 +11,15 @@ from copy import deepcopy
 from pathlib import Path
 from typing import Any
 from typing import Optional
+from typing import TYPE_CHECKING
 
 from .common import config_load
 from .common import config_path
 from .common import config_paths
 from ..types import merge_dicts
-from ..utils.common import PATHABLE
+
+if TYPE_CHECKING:
+    from ..utils.common import PATHABLE
 
 
 
@@ -63,7 +66,7 @@ class ConfigFiles:
 
     def __init__(
         self,
-        paths: PATHABLE,
+        paths: 'PATHABLE',
         force: bool = False,
     ) -> None:
         """
@@ -89,13 +92,16 @@ class ConfigFiles:
         :returns: Configuration in dictionary format for files.
         """
 
-        if self.__merged is not None:
-            return deepcopy(self.__merged)
+        config = self.config
+        merged = self.__merged
+
+        if merged is not None:
+            return deepcopy(merged)
 
-        merged: dict[str, Any] = {}
+        merged = {}
 
 
-        for _, file in self.config.items():
+        for file in config.values():
 
             source = file.config
 
@@ -107,4 +113,4 @@ class ConfigFiles:
 
         self.__merged = merged
 
-        return deepcopy(self.__merged)
+        return deepcopy(merged)

encommon/config/logger.py

@@ -28,18 +28,22 @@ from typing import TYPE_CHECKING
 
 from .common import LOGLEVELS
 from .common import config_path
-from ..times.common import PARSABLE
-from ..times.times import Times
-from ..types.empty import Empty
-from ..utils.stdout import kvpair_ansi
+from ..times import Times
+from ..types import Empty
+from ..types.strings import COMMAD
+from ..types.strings import COMMAS
+from ..types.strings import SPACED
+from ..utils import kvpair_ansi
+from ..utils.common import JOINABLE
 
 if TYPE_CHECKING:
     from .params import LoggerParams
+    from ..times.common import PARSABLE
 
 
 
-LOGGER_FILE = 'encommon.logger.file'
-LOGGER_STDO = 'encommon.logger.stdo'
+LOGR_FILE = 'encommon.logger.file'
+LOGR_STDO = 'encommon.logger.stdo'
 
 LOGSEVERS = {
     'critical': int(CRITICAL),
@@ -79,7 +83,7 @@ class Message:
     def __init__(
         self,
         level: LOGLEVELS,
-        time: Optional[PARSABLE] = None,
+        time: Optional['PARSABLE'] = None,
         **kwargs: Any,
     ) -> None:
         """
@@ -90,7 +94,10 @@ class Message:
         self.__time = Times(time)
         self.__fields = {}
 
-        for key, value in kwargs.items():
+        items = kwargs.items()
+
+        for key, value in items:
+
 
             if (hasattr(value, '__len__')
                     and not len(value)):
@@ -99,10 +106,21 @@ class Message:
             if value in [None, Empty]:
                 continue
 
-            if (key == 'elapsed'
-                    and isinstance(value, float)):
+
+            if isinstance(value, JOINABLE):
+
+                values = sorted(
+                    str(x) for x in value)
+
+                value = COMMAD.join(values)
+
+
+            if (isinstance(value, float)
+                    and key == 'elapsed'):
+
                 value = round(value, 2)
 
+
             value = str(value)
 
             self.__fields[key] = value
@@ -123,7 +141,7 @@ class Message:
 
         fields |= dict(self.__fields)
 
-        message = ', '.join([
+        message = COMMAS.join([
             f'{k}="{v}"' for k, v
             in fields.items()])
 
@@ -205,11 +223,16 @@ class Message:
 
         output: list[str] = []
 
-        for key, value in fields.items():
-            output.append(
-                kvpair_ansi(key, value))
+        items = fields.items()
+
+        for field, value in items:
+
+            _value = kvpair_ansi(
+                field, value)
+
+            output.append(_value)
 
-        return ' '.join(output)
+        return SPACED.join(output)
 
 
     @property
@@ -235,7 +258,7 @@ class Message:
 
 class FileFormatter(Formatter):
     """
-    Supplement class for built-in logging exception formatter.
+    Supplement class for built-in logger exception formatter.
     """
 
 
@@ -299,8 +322,8 @@ class Logger:
 
     __started: bool
 
-    __logger_stdo: _Logger
-    __logger_file: _Logger
+    __logr_stdo: _Logger
+    __logr_file: _Logger
 
 
     def __init__(
@@ -329,8 +352,11 @@ class Logger:
 
         self.__started = False
 
-        self.__logger_stdo = getLogger(LOGGER_STDO)
-        self.__logger_file = getLogger(LOGGER_FILE)
+        logr_stdo = getLogger(LOGR_STDO)
+        logr_file = getLogger(LOGR_FILE)
+
+        self.__logr_stdo = logr_stdo
+        self.__logr_file = logr_file
 
 
     @property
@@ -395,7 +421,7 @@ class Logger:
         :returns: Value for the attribute from class instance.
         """
 
-        return self.__logger_stdo
+        return self.__logr_stdo
 
 
     @property
@@ -408,7 +434,7 @@ class Logger:
         :returns: Value for the attribute from class instance.
         """
 
-        return self.__logger_file
+        return self.__logr_file
 
 
     def start(
@@ -422,39 +448,47 @@ class Logger:
         file_level = self.__file_level
         file_path = self.__file_path
 
-        logger_stdo = self.__logger_stdo
-        logger_file = self.__logger_file
+        logr_stdo = self.__logr_stdo
+        logr_file = self.__logr_file
+
 
+        logr_root = getLogger()
 
-        logger_root = getLogger()
-        logger_root.setLevel(NOTSET)
+        logr_root.setLevel(NOTSET)
 
-        logger_stdo.handlers = [NullHandler()]
-        logger_file.handlers = [NullHandler()]
+        logr_stdo.handlers = [NullHandler()]
+        logr_file.handlers = [NullHandler()]
 
 
         if stdo_level is not None:
 
-            stdoh = StreamHandler()
-            format = Formatter('%(message)s')
             level = LOGSEVERS[stdo_level]
 
-            stdoh.setLevel(level)
-            stdoh.setFormatter(format)
+            handstdo = StreamHandler()
+
+            format = Formatter(
+                '%(message)s')
+
+            logr_stdo.handlers = [handstdo]
 
-            logger_stdo.handlers = [stdoh]
+            handstdo.setLevel(level)
+            handstdo.setFormatter(format)
 
 
         if file_path and file_level:
 
-            fileh = FileHandler(file_path)
-            format = FileFormatter('%(message)s')
             level = LOGSEVERS[file_level]
 
-            fileh.setLevel(level)
-            fileh.setFormatter(format)
+            handfile = (
+                FileHandler(file_path))
 
-            logger_file.handlers = [fileh]
+            format = FileFormatter(
+                '%(message)s')
+
+            logr_file.handlers = [handfile]
+
+            handfile.setLevel(level)
+            handfile.setFormatter(format)
 
 
         self.__started = True
@@ -467,11 +501,11 @@ class Logger:
         Deinitialize the Python logging library using parameters.
         """
 
-        logger_stdo = self.__logger_stdo
-        logger_file = self.__logger_file
+        logr_stdo = self.__logr_stdo
+        logr_file = self.__logr_file
 
-        logger_stdo.handlers = [NullHandler()]
-        logger_file.handlers = [NullHandler()]
+        logr_stdo.handlers = [NullHandler()]
+        logr_file.handlers = [NullHandler()]
 
         self.__started = False
 
@@ -484,9 +518,9 @@ class Logger:
         **kwargs: Any,
     ) -> None:
         """
-        Prepare keyword arguments and log to the relevant outputs.
+        Prepare keyword arguments and log to configured output.
 
-        :param exc_info: Optional exception to include with trace.
+        :param exc_info: Optional exception included with trace.
         :param kwargs: Keyword arguments for populating message.
         """
 
@@ -497,19 +531,21 @@ class Logger:
         file_level = self.__file_level
         file_path = self.__file_path
 
-        logger_stdo = self.__logger_stdo
-        logger_file = self.__logger_file
+        logr_stdo = self.__logr_stdo
+        logr_file = self.__logr_file
 
         message = Message(level, **kwargs)
 
         if stdo_level is not None:
-            logger_stdo.log(
+
+            logr_stdo.log(
                 level=LOGSEVERS[level],
                 msg=message.stdo_output,
                 exc_info=exc_info)
 
         if file_path and file_level:
-            logger_file.log(
+
+            logr_file.log(
                 level=LOGSEVERS[level],
                 msg=message.file_output,
                 exc_info=exc_info)
@@ -517,94 +553,64 @@ class Logger:
 
     def log_c(
         self,
-        *,
-        exc_info: Optional[Exception] = None,
         **kwargs: Any,
     ) -> None:
         """
-        Prepare keyword arguments and log to the relevant outputs.
+        Prepare keyword arguments and log to configured output.
 
-        :param exc_info: Optional exception to include with trace.
         :param kwargs: Keyword arguments for populating message.
         """
 
-        self.log(
-            level='critical',
-            exc_info=exc_info,
-            **kwargs)
+        self.log('critical', **kwargs)
 
 
     def log_d(
         self,
-        *,
-        exc_info: Optional[Exception] = None,
         **kwargs: Any,
     ) -> None:
         """
-        Prepare keyword arguments and log to the relevant outputs.
+        Prepare keyword arguments and log to configured output.
 
-        :param exc_info: Optional exception to include with trace.
         :param kwargs: Keyword arguments for populating message.
         """
 
-        self.log(
-            level='debug',
-            exc_info=exc_info,
-            **kwargs)
+        self.log('debug', **kwargs)
 
 
     def log_e(
         self,
-        *,
-        exc_info: Optional[Exception] = None,
         **kwargs: Any,
     ) -> None:
         """
-        Prepare keyword arguments and log to the relevant outputs.
+        Prepare keyword arguments and log to configured output.
 
-        :param exc_info: Optional exception to include with trace.
         :param kwargs: Keyword arguments for populating message.
         """
 
-        self.log(
-            level='error',
-            exc_info=exc_info,
-            **kwargs)
+        self.log('error', **kwargs)
 
 
     def log_i(
         self,
-        *,
-        exc_info: Optional[Exception] = None,
         **kwargs: Any,
     ) -> None:
         """
-        Prepare keyword arguments and log to the relevant outputs.
+        Prepare keyword arguments and log to configured output.
 
-        :param exc_info: Optional exception to include with trace.
         :param kwargs: Keyword arguments for populating message.
         """
 
-        self.log(
-            level='info',
-            exc_info=exc_info,
-            **kwargs)
+        self.log('info', **kwargs)
 
 
     def log_w(
         self,
-        *,
-        exc_info: Optional[Exception] = None,
         **kwargs: Any,
     ) -> None:
         """
-        Prepare keyword arguments and log to the relevant outputs.
+        Prepare keyword arguments and log to configured output.
 
-        :param exc_info: Optional exception to include with trace.
         :param kwargs: Keyword arguments for populating message.
         """
 
-        self.log(
-            level='warning',
-            exc_info=exc_info,
-            **kwargs)
+        self.log('warning', **kwargs)

encommon/config/params.py

@@ -12,7 +12,7 @@ from typing import Optional
 from pydantic import BaseModel
 
 from .common import LOGLEVELS
-from ..crypts.params import CryptsParams
+from ..crypts import CryptsParams
 
 
 

encommon/config/paths.py

@@ -12,11 +12,14 @@ from glob import glob
 from pathlib import Path
 from typing import Any
 from typing import Optional
+from typing import TYPE_CHECKING
 
 from .common import config_path
 from .common import config_paths
 from .files import ConfigFile
-from ..utils.common import PATHABLE
+
+if TYPE_CHECKING:
+    from ..utils.common import PATHABLE
 
 
 
@@ -71,7 +74,7 @@ class ConfigPaths:
 
     def __init__(
         self,
-        paths: PATHABLE,
+        paths: 'PATHABLE',
         force: bool = False,
     ) -> None:
         """
@@ -97,19 +100,24 @@ class ConfigPaths:
         :returns: Configuration in dictionary format for paths.
         """
 
-        if self.__merged is not None:
-            return deepcopy(self.__merged)
+        config = self.config
+        merged = self.__merged
+
+        if merged is not None:
+            return deepcopy(merged)
+
+        merged = {}
 
-        merged: dict[str, Any] = {}
 
+        for path in config.values():
 
-        for _, path in self.config.items():
+            items = path.config.items()
 
-            for key, file in path.config.items():
+            for key, file in items:
 
                 merged[key] = file.config
 
 
         self.__merged = merged
 
-        return deepcopy(self.__merged)
+        return deepcopy(merged)

encommon/config/test/test_common.py

@@ -9,6 +9,7 @@ is permitted, for more information consult the project license file.
 
 from ..common import config_load
 from ..common import config_path
+from ..common import config_paths
 from ... import PROJECT
 from ... import WORKSPACE
 
@@ -19,9 +20,11 @@ def test_config_load() -> None:
     Perform various tests associated with relevant routines.
     """
 
-    path = 'PROJECT/../.yamllint'
+    loaded = config_load(
+        'PROJECT/../.yamllint')
 
-    assert len(config_load(path)) == 2
+    assert list(loaded) == [
+        'extends', 'rules']
 
 
 
@@ -30,5 +33,25 @@ def test_config_path() -> None:
     Perform various tests associated with relevant routines.
     """
 
-    assert config_path('PROJECT') == PROJECT
-    assert config_path('WORKSPACE') == WORKSPACE
+
+    path = config_path('PROJECT')
+
+    assert path == PROJECT
+
+
+    path = config_path('WORKSPACE')
+
+    assert path == WORKSPACE
+
+
+
+def test_config_paths() -> None:
+    """
+    Perform various tests associated with relevant routines.
+    """
+
+    paths = config_paths([
+        'PROJECT', 'WORKSPACE'])
+
+    assert paths == (
+        PROJECT, WORKSPACE)