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

encommon/config/paths.py

@@ -10,13 +10,13 @@ is permitted, for more information consult the project license file.
 from copy import deepcopy
 from glob import glob
 from pathlib import Path
-from typing import Any
 from typing import Optional
 from typing import TYPE_CHECKING
 
 from .files import ConfigFile
 from .utils import config_path
 from .utils import config_paths
+from ..types import DictStrAny
 from ..types import sort_dict
 
 if TYPE_CHECKING:
@@ -70,7 +70,7 @@ class ConfigPaths:
     paths: tuple[Path, ...]
     config: dict[str, ConfigPath]
 
-    __merged: Optional[dict[str, Any]]
+    __merge: Optional[DictStrAny]
 
 
     def __init__(
@@ -88,13 +88,13 @@ class ConfigPaths:
             str(x): ConfigPath(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 paths.
 
@@ -102,12 +102,12 @@ class ConfigPaths:
         """
 
         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 path in config.values():
@@ -116,11 +116,11 @@ class ConfigPaths:
 
             for key, file in items:
 
-                merged[key] = file.config
+                merge[key] = file.config
 
 
-        merged = sort_dict(merged)
+        merge = sort_dict(merge)
 
-        self.__merged = merged
+        self.__merge = merge
 
-        return deepcopy(merged)
+        return deepcopy(merge)

encommon/config/test/__init__.py

@@ -13,4 +13,4 @@ from pathlib import Path
 
 SAMPLES = (
     Path(__file__).parent
-    .joinpath('samples'))
+    / 'samples')

encommon/config/test/test_config.py

@@ -11,12 +11,10 @@ from pathlib import Path
 from typing import TYPE_CHECKING
 
 from . import SAMPLES
-from ..logger import Logger
-from ..params import Params
 from ... import PROJECT
-from ...crypts import Crypts
 from ...types import inrepr
 from ...types import instr
+from ...types import lattrs
 from ...utils import load_sample
 from ...utils import prep_sample
 from ...utils.sample import ENPYRWS
@@ -38,7 +36,7 @@ def test_Config(
     """
 
 
-    attrs = list(config.__dict__)
+    attrs = lattrs(config)
 
     assert attrs == [
         '_Config__model',
@@ -62,39 +60,68 @@ def test_Config(
         config)
 
 
-    assert instr(
-        'files.ConfigFiles object',
-        config.files)
+    assert config.files.merge
 
-    assert instr(
-        'paths.ConfigPaths object',
-        config.paths)
+    assert config.paths.merge
 
     assert len(config.cargs) == 1
 
     assert len(config.sargs) == 1
 
-    assert len(config.config) == 3
-
     assert len(config.basic) == 3
 
     assert len(config.merge) == 5
 
-    assert config.model is Params
+    assert callable(config.model)
 
-    assert isinstance(config.params, Params)
+    assert config.params
 
-    assert isinstance(config.logger, Logger)
+    assert len(config.config) == 3
+
+    assert config.logger
 
-    assert isinstance(config.crypts, Crypts)
+    assert config.crypts
 
 
     replaces = {
         'pytemp': tmp_path,
         'PROJECT': PROJECT}
 
+
+    sample_path = (
+        SAMPLES / 'basic.json')
+
+    sample = load_sample(
+        path=sample_path,
+        update=ENPYRWS,
+        content=config.basic,
+        replace=replaces)
+
+    expect = prep_sample(
+        content=config.basic,
+        replace=replaces)
+
+    assert expect == sample
+
+
+    sample_path = (
+        SAMPLES / 'merge.json')
+
+    sample = load_sample(
+        path=sample_path,
+        update=ENPYRWS,
+        content=config.merge,
+        replace=replaces)
+
+    expect = prep_sample(
+        content=config.merge,
+        replace=replaces)
+
+    assert expect == sample
+
+
     sample_path = (
-        f'{SAMPLES}/config.json')
+        SAMPLES / 'config.json')
 
     sample = load_sample(
         path=sample_path,
@@ -106,7 +133,7 @@ def test_Config(
         content=config.config,
         replace=replaces)
 
-    assert sample == expect
+    assert expect == sample
 
 
 

encommon/config/test/test_files.py

@@ -16,6 +16,7 @@ from ..files import ConfigFile
 from ..files import ConfigFiles
 from ...types import inrepr
 from ...types import instr
+from ...types import lattrs
 
 
 
@@ -49,7 +50,7 @@ def test_ConfigFile(
         f'{config_path}/config.yml')
 
 
-    attrs = list(file.__dict__)
+    attrs = lattrs(file)
 
     assert attrs == [
         'path',
@@ -83,12 +84,12 @@ def test_ConfigFiles(
     """
 
 
-    attrs = list(files.__dict__)
+    attrs = lattrs(files)
 
     assert attrs == [
         'paths',
         'config',
-        '_ConfigFiles__merged']
+        '_ConfigFiles__merge']
 
 
     assert inrepr(
@@ -106,7 +107,7 @@ def test_ConfigFiles(
 
     assert len(files.config) == 2
 
-    assert files.merged == {
+    assert files.merge == {
         'name': 'Bruce Wayne'}
 
 
@@ -120,7 +121,7 @@ def test_ConfigFiles_cover(
     :param files: Custom fixture for the configuration files.
     """
 
-    merged1 = files.merged
-    merged2 = files.merged
+    merge1 = files.merge
+    merge2 = files.merge
 
-    assert merged1 is not merged2
+    assert merge1 is not merge2

encommon/config/test/test_logger.py

@@ -16,11 +16,12 @@ from pytest import fixture
 from ..logger import Logger
 from ..logger import Message
 from ..params import LoggerParams
-from ...times import Times
+from ...times import Time
 from ...times.common import UNIXMPOCH
 from ...times.common import UNIXSPOCH
 from ...types import inrepr
 from ...types import instr
+from ...types import lattrs
 from ...utils import strip_ansi
 
 
@@ -70,7 +71,7 @@ def test_Message() -> None:
         elapsed=3.69420)
 
 
-    attrs = list(message.__dict__)
+    attrs = lattrs(message)
 
     assert attrs == [
         '_Message__level',
@@ -140,7 +141,7 @@ def test_Logger(
     """
 
 
-    attrs = list(logger.__dict__)
+    attrs = lattrs(logger)
 
     assert attrs == [
         '_Logger__params',
@@ -163,19 +164,19 @@ def test_Logger(
         logger)
 
 
-    assert logger.params is not None
+    assert logger.params
 
     assert logger.stdo_level == 'info'
 
     assert logger.file_level == 'info'
 
-    assert logger.file_path is not None
+    assert logger.file_path
 
-    assert logger.started is False
+    assert not logger.started
 
-    assert logger.logger_stdo is not None
+    assert logger.logger_stdo
 
-    assert logger.logger_file is not None
+    assert logger.logger_file
 
 
     logger.log_d(msg='pytest')
@@ -197,7 +198,7 @@ def test_Logger_cover(
     :param caplog: pytest object for capturing log message.
     """
 
-    times = Times('now')
+    time = Time('now')
 
 
     def _logger_logs() -> None:
@@ -206,7 +207,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)
+        logger.log_i(elapsed=time)
 
 
     def _logger_stdo() -> _CAPLOG:

encommon/config/test/test_paths.py

@@ -17,6 +17,7 @@ from ..paths import ConfigPaths
 from ... import PROJECT
 from ...types import inrepr
 from ...types import instr
+from ...types import lattrs
 from ...utils import load_sample
 from ...utils import prep_sample
 from ...utils.sample import ENPYRWS
@@ -52,7 +53,7 @@ def test_ConfigPath(
     path = ConfigPath(config_path)
 
 
-    attrs = list(path.__dict__)
+    attrs = lattrs(path)
 
     assert attrs == [
         'path',
@@ -86,11 +87,11 @@ def test_ConfigPaths(
     """
 
 
-    attrs = list(paths.__dict__)
+    attrs = lattrs(paths)
 
     assert attrs == [
         'paths', 'config',
-        '_ConfigPaths__merged']
+        '_ConfigPaths__merge']
 
 
     assert inrepr(
@@ -113,19 +114,19 @@ def test_ConfigPaths(
         'PROJECT': PROJECT}
 
     sample_path = (
-        f'{SAMPLES}/paths.json')
+        SAMPLES / 'paths.json')
 
     sample = load_sample(
         path=sample_path,
         update=ENPYRWS,
-        content=paths.merged,
+        content=paths.merge,
         replace=replaces)
 
     expect = prep_sample(
-        content=paths.merged,
+        content=paths.merge,
         replace=replaces)
 
-    assert sample == expect
+    assert expect == sample
 
 
 
@@ -138,7 +139,7 @@ def test_ConfigPaths_cover(
     :param paths: Custom fixture for the configuration paths.
     """
 
-    merged1 = paths.merged
-    merged2 = paths.merged
+    merge1 = paths.merge
+    merge2 = paths.merge
 
-    assert merged1 is not merged2
+    assert merge1 is not merge2

encommon/config/utils.py

@@ -8,7 +8,6 @@ is permitted, for more information consult the project license file.
 
 
 from pathlib import Path
-from typing import Any
 from typing import Optional
 from typing import TYPE_CHECKING
 
@@ -17,6 +16,7 @@ from yaml import load
 
 from .. import PROJECT
 from .. import WORKSPACE
+from ..types import DictStrAny
 from ..utils import read_text
 from ..utils import resolve_path
 from ..utils import resolve_paths
@@ -29,7 +29,7 @@ if TYPE_CHECKING:
 
 def config_load(
     path: str | Path,
-) -> dict[str, Any]:
+) -> DictStrAny:
     """
     Load configuration using the directory or file provided.
 

encommon/crypts/crypts.py

@@ -48,7 +48,7 @@ class Crypts:
     >>> crypts.decrypt(encrypt)
     'example'
 
-    :param params: Parameters for instantiating the instance.
+    :param params: Parameters used to instantiate the class.
     """
 
     __params: 'CryptsParams'
@@ -154,7 +154,7 @@ class Crypts:
         Create a new phrase using the provided input parameters.
 
         :param unique: Unique identifier of mapping passphrase.
-        :param params: Parameters for instantiating the instance.
+        :param params: Parameters used to instantiate the class.
         """
 
         phrases = self.params.phrases

encommon/crypts/params.py

@@ -7,8 +7,11 @@ is permitted, for more information consult the project license file.
 
 
 
+from typing import Annotated
 from typing import Optional
 
+from pydantic import Field
+
 from ..types import BaseModel
 
 
@@ -20,24 +23,38 @@ _CRYPTS = dict[str, 'CryptParams']
 class CryptParams(BaseModel, extra='forbid'):
     """
     Process and validate the core configuration parameters.
-
-    :param phrase: Passphrases that are used in operations.
-    :param data: Keyword arguments passed to Pydantic model.
-        Parameter is picked up by autodoc, please ignore.
     """
 
-    phrase: str
+    phrase: Annotated[
+        str,
+        Field(...,
+              description='Passphrase for the operations',
+              min_length=1)]
+
+
+    def __init__(
+        self,
+        phrase: str,
+    ) -> None:
+        """
+        Initialize instance for class using provided parameters.
+        """
+
+        super().__init__(**{
+            'phrase': phrase})
 
 
 
 class CryptsParams(BaseModel, extra='forbid'):
     """
     Process and validate the core configuration parameters.
-
-    :param phrases: Passphrases that are used in operations.
     """
 
-    phrases: _CRYPTS
+    phrases: Annotated[
+        _CRYPTS,
+        Field(...,
+              description='Passphrases for the operations',
+              min_length=0)]
 
 
     def __init__(
@@ -48,8 +65,7 @@ class CryptsParams(BaseModel, extra='forbid'):
         Initialize instance for class using provided parameters.
         """
 
-        if phrases is None:
-            phrases = {}
+        phrases = phrases or {}
 
-        super().__init__(
-            phrases=phrases)
+        super().__init__(**{
+            'phrases': phrases})

encommon/crypts/test/test_crypts.py

@@ -7,8 +7,6 @@ is permitted, for more information consult the project license file.
 
 
 
-from typing import Any
-
 from pytest import fixture
 from pytest import mark
 from pytest import raises
@@ -16,8 +14,10 @@ from pytest import raises
 from ..crypts import Crypts
 from ..params import CryptParams
 from ..params import CryptsParams
+from ...types import DictStrAny
 from ...types import inrepr
 from ...types import instr
+from ...types import lattrs
 
 
 
@@ -29,7 +29,7 @@ def crypts() -> Crypts:
     :returns: Newly constructed instance of related class.
     """
 
-    source: dict[str, Any] = {
+    source: DictStrAny = {
         'default': {'phrase': Crypts.keygen()},
         'secrets': {'phrase': Crypts.keygen()}}
 
@@ -50,7 +50,7 @@ def test_Crypts(
     """
 
 
-    attrs = list(crypts.__dict__)
+    attrs = lattrs(crypts)
 
     assert attrs == [
         '_Crypts__params']
@@ -67,7 +67,7 @@ def test_Crypts(
         crypts)
 
 
-    assert crypts.params is not None
+    assert crypts.params
 
     assert len(crypts.keygen()) == 44
 

encommon/crypts/test/test_hashes.py

@@ -10,6 +10,7 @@ is permitted, for more information consult the project license file.
 from ..hashes import Hashes
 from ...types import inrepr
 from ...types import instr
+from ...types import lattrs
 
 
 
@@ -21,7 +22,7 @@ def test_Hashes() -> None:
     hashes = Hashes('string')
 
 
-    attrs = list(hashes.__dict__)
+    attrs = lattrs(hashes)
 
     assert attrs == [
         '_Hashes__string']

encommon/times/__init__.py

@@ -16,9 +16,9 @@ from .parse import parse_time
 from .parse import shift_time
 from .parse import since_time
 from .parse import string_time
+from .time import 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
@@ -32,7 +32,7 @@ __all__ = [
     'TimerParams',
     'Timers',
     'TimersParams',
-    'Times',
+    'Time',
     'Window',
     'WindowParams',
     'Windows',

encommon/times/common.py

@@ -13,7 +13,7 @@ from typing import TYPE_CHECKING
 from typing import Union
 
 if TYPE_CHECKING:
-    from .times import Times
+    from .time import Time
 
 
 
@@ -33,7 +33,7 @@ NUMERIC = Union[int, float]
 
 PARSABLE = Union[
     str, NUMERIC,
-    datetime, 'Times']
+    datetime, 'Time']
 
 SCHEDULE = Union[
     str, dict[str, int]]