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

encommon/colors/__init__.py

@@ -7,8 +7,8 @@ is permitted, for more information consult the project license file.
 
 
 
-from .colors import Colors
+from .color import Color
 
 
 
-__all__ = ['Colors']
+__all__ = ['Color']

encommon/colors/{colors.py → color.py}

@@ -14,13 +14,13 @@ from ..types import strplwr
 
 
 
-class Colors:
+class Color:
     """
     Covert colors to various forms using provided hex value.
 
     Example
     -------
-    >>> color = Colors('#003333')
+    >>> color = Color('#003333')
     >>> color.rgb
     (0, 51, 51)
     >>> color.hsl
@@ -32,12 +32,12 @@ class Colors:
 
     Example
     -------
-    >>> color1 = Colors('#003333')
-    >>> color2 = Colors('#330000')
+    >>> color1 = Color('#003333')
+    >>> color2 = Color('#330000')
     >>> color1 - color2
-    Colors('#32CCCD')
+    Color('#32CCCD')
     >>> color1 + color2
-    Colors('#333333')
+    Color('#333333')
 
     :param source: Source color used when converting values.
     """
@@ -72,7 +72,7 @@ class Colors:
 
         color = self.__str__()
 
-        return f"Colors('{color}')"
+        return f"Color('{color}')"
 
 
     def __hash__(
@@ -130,8 +130,8 @@ class Colors:
 
     def __add__(
         self,
-        other: Union[int, str, 'Colors'],
-    ) -> 'Colors':
+        other: Union[int, str, 'Color'],
+    ) -> 'Color':
         """
         Built-in method for mathematically processing the value.
 
@@ -140,7 +140,7 @@ class Colors:
         """
 
         if isinstance(other, str):
-            other = Colors(other)
+            other = Color(other)
 
         source = self.__int__()
         _source = int(other)
@@ -149,13 +149,13 @@ class Colors:
 
         result = f'{outcome:06x}'
 
-        return Colors(result)
+        return Color(result)
 
 
     def __sub__(
         self,
-        other: Union[int, str, 'Colors'],
-    ) -> 'Colors':
+        other: Union[int, str, 'Color'],
+    ) -> 'Color':
         """
         Built-in method for mathematically processing the value.
 
@@ -164,7 +164,7 @@ class Colors:
         """
 
         if isinstance(other, str):
-            other = Colors(other)
+            other = Color(other)
 
         source = self.__int__()
         _source = int(other)
@@ -173,7 +173,7 @@ class Colors:
 
         result = f'{outcome:06x}'
 
-        return Colors(result)
+        return Color(result)
 
 
     def __eq__(
@@ -193,7 +193,7 @@ class Colors:
                 other = f'{other:06x}'
 
             if isinstance(other, str):
-                other = Colors(other)
+                other = Color(other)
 
             assert hasattr(other, 'source')
 
@@ -223,7 +223,7 @@ class Colors:
 
     def __gt__(
         self,
-        other: Union[int, str, 'Colors'],
+        other: Union[int, str, 'Color'],
     ) -> bool:
         """
         Built-in method for comparing this instance with another.
@@ -238,7 +238,7 @@ class Colors:
                 other = f'{other:06x}'
 
             if isinstance(other, str):
-                other = Colors(other)
+                other = Color(other)
 
             assert hasattr(other, 'source')
 
@@ -254,7 +254,7 @@ class Colors:
 
     def __ge__(
         self,
-        other: Union[int, str, 'Colors'],
+        other: Union[int, str, 'Color'],
     ) -> bool:
         """
         Built-in method for comparing this instance with another.
@@ -269,7 +269,7 @@ class Colors:
                 other = f'{other:06x}'
 
             if isinstance(other, str):
-                other = Colors(other)
+                other = Color(other)
 
             assert hasattr(other, 'source')
 
@@ -285,7 +285,7 @@ class Colors:
 
     def __lt__(
         self,
-        other: Union[int, str, 'Colors'],
+        other: Union[int, str, 'Color'],
     ) -> bool:
         """
         Built-in method for comparing this instance with another.
@@ -300,7 +300,7 @@ class Colors:
                 other = f'{other:06x}'
 
             if isinstance(other, str):
-                other = Colors(other)
+                other = Color(other)
 
             assert hasattr(other, 'source')
 
@@ -316,7 +316,7 @@ class Colors:
 
     def __le__(
         self,
-        other: Union[int, str, 'Colors'],
+        other: Union[int, str, 'Color'],
     ) -> bool:
         """
         Built-in method for comparing this instance with another.
@@ -331,7 +331,7 @@ class Colors:
                 other = f'{other:06x}'
 
             if isinstance(other, str):
-                other = Colors(other)
+                other = Color(other)
 
             assert hasattr(other, 'source')
 

encommon/colors/test/{test_colors.py → test_color.py}

@@ -9,27 +9,27 @@ is permitted, for more information consult the project license file.
 
 from pytest import mark
 
-from ..colors import Colors
+from ..color import Color
 from ...types import lattrs
 
 
 
-def test_Colors() -> None:
+def test_Color() -> None:
     """
     Perform various tests associated with relevant routines.
     """
 
-    color = Colors('000001')
+    color = Color('000001')
 
 
     attrs = lattrs(color)
 
     assert attrs == [
-        '_Colors__source']
+        '_Color__source']
 
 
     assert repr(color) == (
-        "Colors('#000001')")
+        "Color('#000001')")
 
     assert hash(color) > 0
 
@@ -71,7 +71,7 @@ def test_Colors() -> None:
      ('00ffff', (0, 255, 255)),
      ('ff00ff', (255, 0, 255)),
      ('800080', (128, 0, 128))])
-def test_Colors_rgb(
+def test_Color_rgb(
     source: str,
     expect: tuple[int, ...],
 ) -> None:
@@ -82,7 +82,7 @@ def test_Colors_rgb(
     :param expect: Expected output from the testing routine.
     """
 
-    assert Colors(source).rgb == expect
+    assert Color(source).rgb == expect
 
 
 
@@ -99,7 +99,7 @@ def test_Colors_rgb(
      ('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(
+def test_Color_xyz(
     source: str,
     expect: tuple[int, ...],
 ) -> None:
@@ -110,7 +110,7 @@ def test_Colors_xyz(
     :param expect: Expected output from the testing routine.
     """
 
-    assert Colors(source).xyz == expect
+    assert Color(source).xyz == expect
 
 
 
@@ -127,7 +127,7 @@ def test_Colors_xyz(
      ('00ffff', (0.2247, 0.3287)),
      ('ff00ff', (0.3209, 0.1542)),
      ('800080', (0.3209, 0.1542))])
-def test_Colors_xy(
+def test_Color_xy(
     source: str,
     expect: tuple[int, ...],
 ) -> None:
@@ -138,7 +138,7 @@ def test_Colors_xy(
     :param expect: Expected output from the testing routine.
     """
 
-    assert Colors(source).xy == expect
+    assert Color(source).xy == expect
 
 
 
@@ -155,7 +155,7 @@ def test_Colors_xy(
      ('00ffff', (180, 100, 50)),
      ('ff00ff', (300, 100, 50)),
      ('800080', (300, 100, 25))])
-def test_Colors_hsl(
+def test_Color_hsl(
     source: str,
     expect: tuple[int, ...],
 ) -> None:
@@ -166,17 +166,17 @@ def test_Colors_hsl(
     :param expect: Expected output from the testing routine.
     """
 
-    assert Colors(source).hsl == expect
+    assert Color(source).hsl == expect
 
 
 
-def test_Colors_cover() -> None:
+def test_Color_cover() -> None:
     """
     Perform various tests associated with relevant routines.
     """
 
-    color1 = Colors('000001')
-    color2 = Colors('#000001')
+    color1 = Color('000001')
+    color2 = Color('#000001')
 
     assert not (color1 > None)  # type: ignore
     assert not (color1 >= None)  # type: ignore

encommon/config/config.py

@@ -8,7 +8,6 @@ is permitted, for more information consult the project license file.
 
 
 from copy import deepcopy
-from typing import Any
 from typing import Callable
 from typing import Optional
 from typing import TYPE_CHECKING
@@ -19,6 +18,7 @@ from .params import Params
 from .paths import ConfigPaths
 from .utils import config_paths
 from ..crypts import Crypts
+from ..types import DictStrAny
 from ..types import merge_dicts
 from ..types import setate
 
@@ -55,8 +55,8 @@ class Config:
 
     __files: ConfigFiles
     __paths: ConfigPaths
-    __cargs: dict[str, Any]
-    __sargs: dict[str, Any]
+    __cargs: DictStrAny
+    __sargs: DictStrAny
 
     __model: Callable  # type: ignore
 
@@ -70,8 +70,8 @@ class Config:
         files: Optional['PATHABLE'] = None,
         *,
         paths: Optional['PATHABLE'] = None,
-        cargs: Optional[dict[str, Any]] = None,
-        sargs: Optional[dict[str, Any]] = None,
+        cargs: Optional[DictStrAny] = None,
+        sargs: Optional[DictStrAny] = None,
         model: Optional[Callable] = None,  # type: ignore
     ) -> None:
         """
@@ -133,14 +133,14 @@ class Config:
     @property
     def cargs(
         self,
-    ) -> dict[str, Any]:
+    ) -> DictStrAny:
         """
         Return the value for the attribute from class instance.
 
         :returns: Value for the attribute from class instance.
         """
 
-        returned: dict[str, Any] = {}
+        returned: DictStrAny = {}
 
         cargs = deepcopy(self.__cargs)
 
@@ -155,14 +155,14 @@ class Config:
     @property
     def sargs(
         self,
-    ) -> dict[str, Any]:
+    ) -> DictStrAny:
         """
         Return the value for the attribute from class instance.
 
         :returns: Value for the attribute from class instance.
         """
 
-        returned: dict[str, Any] = {}
+        returned: DictStrAny = {}
 
         sargs = deepcopy(self.__sargs)
 
@@ -174,23 +174,10 @@ class Config:
         return deepcopy(returned)
 
 
-    @property
-    def config(
-        self,
-    ) -> dict[str, Any]:
-        """
-        Return the configuration dumped from the Pydantic model.
-
-        :returns: Configuration dumped from the Pydantic model.
-        """
-
-        return self.params.model_dump()
-
-
     @property
     def basic(
         self,
-    ) -> dict[str, Any]:
+    ) -> DictStrAny:
         """
         Return the configuration source loaded from the objects.
 
@@ -199,7 +186,7 @@ class Config:
 
         files = self.files
 
-        ferged = files.merged
+        ferged = files.merge
 
         merge_dicts(
             dict1=ferged,
@@ -212,7 +199,7 @@ class Config:
     @property
     def merge(
         self,
-    ) -> dict[str, Any]:
+    ) -> DictStrAny:
         """
         Return the configuration source loaded from the objects.
 
@@ -222,8 +209,8 @@ class Config:
         files = self.files
         paths = self.paths
 
-        ferged = files.merged
-        perged = paths.merged
+        ferged = files.merge
+        perged = paths.merge
 
         merge_dicts(
             dict1=ferged,
@@ -278,6 +265,19 @@ class Config:
         return self.__params
 
 
+    @property
+    def config(
+        self,
+    ) -> DictStrAny:
+        """
+        Return the configuration dumped from the Pydantic model.
+
+        :returns: Configuration dumped from the Pydantic model.
+        """
+
+        return self.params.endumped
+
+
     @property
     def logger(
         self,

encommon/config/files.py

@@ -9,13 +9,13 @@ is permitted, for more information consult the project license file.
 
 from copy import deepcopy
 from pathlib import Path
-from typing import Any
 from typing import Optional
 from typing import TYPE_CHECKING
 
 from .utils import config_load
 from .utils import config_path
 from .utils import config_paths
+from ..types import DictStrAny
 from ..types import merge_dicts
 from ..types import sort_dict
 
@@ -32,7 +32,7 @@ class ConfigFile:
     """
 
     path: Path
-    config: dict[str, Any]
+    config: DictStrAny
 
 
     def __init__(
@@ -62,7 +62,7 @@ class ConfigFiles:
     paths: tuple[Path, ...]
     config: dict[str, ConfigFile]
 
-    __merged: Optional[dict[str, Any]]
+    __merge: Optional[DictStrAny]
 
 
     def __init__(
@@ -80,13 +80,13 @@ class ConfigFiles:
             str(x): ConfigFile(x)
             for x in self.paths}
 
-        self.__merged = None
+        self.__merge = None
 
 
     @property
-    def merged(
+    def merge(
         self,
-    ) -> dict[str, Any]:
+    ) -> DictStrAny:
         """
         Return the configuration in dictionary format for files.
 
@@ -94,12 +94,12 @@ class ConfigFiles:
         """
 
         config = self.config
-        merged = self.__merged
+        merge = self.__merge
 
-        if merged is not None:
-            return deepcopy(merged)
+        if merge is not None:
+            return deepcopy(merge)
 
-        merged = {}
+        merge = {}
 
 
         for file in config.values():
@@ -107,13 +107,13 @@ class ConfigFiles:
             source = file.config
 
             merge_dicts(
-                dict1=merged,
+                dict1=merge,
                 dict2=deepcopy(source),
                 force=False)
 
 
-        merged = sort_dict(merged)
+        merge = sort_dict(merge)
 
-        self.__merged = merged
+        self.__merge = merge
 
-        return deepcopy(merged)
+        return deepcopy(merge)

encommon/config/logger.py

@@ -28,7 +28,7 @@ from typing import Optional
 from typing import TYPE_CHECKING
 
 from .utils import config_path
-from ..times import Times
+from ..times import Time
 from ..types import Empty
 from ..types.strings import COMMAD
 from ..types.strings import COMMAS
@@ -83,7 +83,7 @@ class Message:
     """
 
     __level: LOGLEVELS
-    __time: Times
+    __time: Time
     __fields: dict[str, str] = {}
 
 
@@ -98,7 +98,7 @@ class Message:
         """
 
         self.__level = level
-        self.__time = Times(time)
+        self.__time = Time(time)
         self.__fields = {}
 
         items = kwargs.items()
@@ -122,7 +122,7 @@ class Message:
                 value = COMMAD.join(values)
 
 
-            if (isinstance(value, Times)
+            if (isinstance(value, Time)
                     and key == 'elapsed'):
                 value = value.since
 
@@ -188,14 +188,14 @@ class Message:
     @property
     def time(
         self,
-    ) -> Times:
+    ) -> Time:
         """
         Return the value for the attribute from class instance.
 
         :returns: Value for the attribute from class instance.
         """
 
-        return Times(self.__time)
+        return Time(self.__time)
 
 
     @property
@@ -329,7 +329,7 @@ class Logger:
     :param stdo_level: Minimum level for the message to pass.
     :param file_level: Minimum level for the message to pass.
     :param file_path: Enables writing to the filesystem path.
-    :param params: Parameters for instantiating the instance.
+    :param params: Parameters used to instantiate the class.
     """
 
     __params: 'LoggerParams'

encommon/config/params.py

@@ -8,8 +8,12 @@ is permitted, for more information consult the project license file.
 
 
 from pathlib import Path
+from typing import Annotated
+from typing import Any
 from typing import Optional
 
+from pydantic import Field
+
 from .logger import LOGLEVELS
 from ..crypts import CryptsParams
 from ..types import BaseModel
@@ -19,61 +23,74 @@ from ..types import BaseModel
 class ConfigParams(BaseModel, extra='forbid'):
     """
     Process and validate the core configuration parameters.
-
-    :param paths: Complete or relative path to config paths.
-    :param data: Keyword arguments passed to Pydantic model.
-        Parameter is picked up by autodoc, please ignore.
     """
 
-    paths: Optional[list[str]] = None
+    paths: Annotated[
+        Optional[list[str]],
+        Field(None,
+              description='Location of configuration files',
+              min_length=1)]
 
 
 
 class LoggerParams(BaseModel, extra='forbid'):
     """
     Process and validate the core configuration parameters.
-
-    :param stdo_level: Minimum level for the message to pass.
-    :param file_level: Minimum level for the message to pass.
-    :param file_path: Enables writing to the filesystem path.
     """
 
-    stdo_level: Optional[LOGLEVELS] = None
-    file_level: Optional[LOGLEVELS] = None
-    file_path: Optional[str] = None
+    stdo_level: Annotated[
+        Optional[LOGLEVELS],
+        Field(None,
+              description='Minimum logging message level',
+              min_length=1)]
+
+    file_level: Annotated[
+        Optional[LOGLEVELS],
+        Field(None,
+              description='Minimum logging message level',
+              min_length=1)]
+
+    file_path: Annotated[
+        Optional[str],
+        Field(None,
+              description='Enable output to the log file',
+              min_length=1)]
 
 
     def __init__(
         self,
-        stdo_level: Optional[LOGLEVELS] = None,
-        file_level: Optional[LOGLEVELS] = None,
-        file_path: Optional[str | Path] = None,
+        /,
+        **data: Any,
     ) -> None:
         """
         Initialize instance for class using provided parameters.
         """
 
-        if file_path is not None:
-            file_path = str(file_path)
+        file_path = data.get('file_path')
 
-        super().__init__(
-            stdo_level=stdo_level,
-            file_level=file_level,
-            file_path=file_path)
+        if isinstance(file_path, Path):
+            data['file_path'] = str(file_path)
+
+        super().__init__(**data)
 
 
 
 class Params(BaseModel, extra='forbid'):
     """
     Process and validate the core configuration parameters.
-
-    :param enconfig: Configuration for the Config instance.
-    :param enlogger: Configuration for the Logger instance.
-    :param encrypts: Configuration for the Crypts instance.
-    :param data: Keyword arguments passed to Pydantic model.
-        Parameter is picked up by autodoc, please ignore.
     """
 
-    enconfig: Optional[ConfigParams] = None
-    enlogger: Optional[LoggerParams] = None
-    encrypts: Optional[CryptsParams] = None
+    enconfig: Annotated[
+        Optional[ConfigParams],
+        Field(None,
+              description='Parameters for Config instance')]
+
+    enlogger: Annotated[
+        Optional[LoggerParams],
+        Field(None,
+              description='Parameters for Logger instance')]
+
+    encrypts: Annotated[
+        Optional[CryptsParams],
+        Field(None,
+              description='Parameters for Crypts instance')]