encommon 0.7.2__tar.gz → 0.7.4__tar.gz

{encommon-0.7.2/encommon.egg-info → encommon-0.7.4}/PKG-INFO

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

{encommon-0.7.2 → encommon-0.7.4}/encommon/config/config.py

@@ -90,9 +90,9 @@ class Config:
         self,
     ) -> ConfigFiles:
         """
-        Return the property for attribute from the class instance.
+        Return the value for the attribute from class instance.
 
-        :returns: Property for attribute from the class instance.
+        :returns: Value for the attribute from class instance.
         """
 
         return self.__files
@@ -103,9 +103,9 @@ class Config:
         self,
     ) -> ConfigPaths:
         """
-        Return the property for attribute from the class instance.
+        Return the value for the attribute from class instance.
 
-        :returns: Property for attribute from the class instance.
+        :returns: Value for the attribute from class instance.
         """
 
         return self.__paths
@@ -116,9 +116,9 @@ class Config:
         self,
     ) -> dict[str, Any]:
         """
-        Return the property for attribute from the class instance.
+        Return the value for the attribute from class instance.
 
-        :returns: Property for attribute from the class instance.
+        :returns: Value for the attribute from class instance.
         """
 
         return self.__cargs
@@ -142,9 +142,9 @@ class Config:
         self,
     ) -> Callable:  # type: ignore
         """
-        Return the property for attribute from the class instance.
+        Return the value for the attribute from class instance.
 
-        :returns: Property for attribute from the class instance.
+        :returns: Value for the attribute from class instance.
         """
 
         return self.__model
@@ -191,10 +191,8 @@ class Config:
         enlogger = (
             self.params.enlogger)
 
-        assert enlogger is not None
-
-        self.__logger = Logger(
-            **enlogger.model_dump())
+        self.__logger = (
+            Logger(params=enlogger))
 
         return self.__logger
 
@@ -213,9 +211,7 @@ class Config:
         encrypts = (
             self.params.encrypts)
 
-        assert encrypts is not None
-
-        self.__crypts = Crypts(
-            **encrypts.model_dump())
+        self.__crypts = (
+            Crypts(params=encrypts))
 
         return self.__crypts

{encommon-0.7.2 → encommon-0.7.4}/encommon/config/logger.py

@@ -24,6 +24,7 @@ from pathlib import Path
 from typing import Any
 from typing import Literal
 from typing import Optional
+from typing import TYPE_CHECKING
 
 from .common import LOGLEVELS
 from .common import config_path
@@ -32,6 +33,9 @@ from ..times.times import Times
 from ..types.empty import Empty
 from ..utils.stdout import kvpair_ansi
 
+if TYPE_CHECKING:
+    from .params import LoggerParams
+
 
 
 LOGGER_FILE = 'encommon.logger.file'
@@ -143,9 +147,9 @@ class Message:
         self,
     ) -> LOGLEVELS:
         """
-        Return the property for attribute from the class instance.
+        Return the value for the attribute from class instance.
 
-        :returns: Property for attribute from the class instance.
+        :returns: Value for the attribute from class instance.
         """
 
         return self.__level
@@ -156,9 +160,9 @@ class Message:
         self,
     ) -> Times:
         """
-        Return the property for attribute from the class instance.
+        Return the value for the attribute from class instance.
 
-        :returns: Property for attribute from the class instance.
+        :returns: Value for the attribute from class instance.
         """
 
         return Times(self.__time)
@@ -169,9 +173,9 @@ class Message:
         self,
     ) -> dict[str, str]:
         """
-        Return the property for attribute from the class instance.
+        Return the value for the attribute from class instance.
 
-        :returns: Property for attribute from the class instance.
+        :returns: Value for the attribute from class instance.
         """
 
         return dict(self.__fields)
@@ -283,9 +287,10 @@ class Logger:
     >>> logger.start()
     >>> logger.log_i(message='testing')
 
-    :param stdo_level: Minimum log message severity level.
-    :param file_level: Minimum log message severity level.
+    :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.
     """
 
     __stdo_level: Optional[LOGLEVELS]
@@ -304,11 +309,17 @@ class Logger:
         stdo_level: Optional[LOGLEVELS] = None,
         file_level: Optional[LOGLEVELS] = None,
         file_path: Optional[str | Path] = None,
+        params: Optional['LoggerParams'] = None,
     ) -> None:
         """
         Initialize instance for class using provided parameters.
         """
 
+        if params is not None:
+            stdo_level = params.stdo_level
+            file_level = params.file_level
+            file_path = params.file_path
+
         if file_path is not None:
             file_path = config_path(file_path)
 
@@ -327,9 +338,9 @@ class Logger:
         self,
     ) -> Optional[LOGLEVELS]:
         """
-        Return the property for attribute from the class instance.
+        Return the value for the attribute from class instance.
 
-        :returns: Property for attribute from the class instance.
+        :returns: Value for the attribute from class instance.
         """
 
         return self.__stdo_level
@@ -340,9 +351,9 @@ class Logger:
         self,
     ) -> Optional[LOGLEVELS]:
         """
-        Return the property for attribute from the class instance.
+        Return the value for the attribute from class instance.
 
-        :returns: Property for attribute from the class instance.
+        :returns: Value for the attribute from class instance.
         """
 
         return self.__file_level
@@ -353,9 +364,9 @@ class Logger:
         self,
     ) -> Optional[Path]:
         """
-        Return the property for attribute from the class instance.
+        Return the value for the attribute from class instance.
 
-        :returns: Property for attribute from the class instance.
+        :returns: Value for the attribute from class instance.
         """
 
         return self.__file_path
@@ -366,9 +377,9 @@ class Logger:
         self,
     ) -> bool:
         """
-        Return the property for attribute from the class instance.
+        Return the value for the attribute from class instance.
 
-        :returns: Property for attribute from the class instance.
+        :returns: Value for the attribute from class instance.
         """
 
         return self.__started
@@ -379,9 +390,9 @@ class Logger:
         self,
     ) -> _Logger:
         """
-        Return the property for attribute from the class instance.
+        Return the value for the attribute from class instance.
 
-        :returns: Property for attribute from the class instance.
+        :returns: Value for the attribute from class instance.
         """
 
         return self.__logger_stdo
@@ -392,9 +403,9 @@ class Logger:
         self,
     ) -> _Logger:
         """
-        Return the property for attribute from the class instance.
+        Return the value for the attribute from class instance.
 
-        :returns: Property for attribute from the class instance.
+        :returns: Value for the attribute from class instance.
         """
 
         return self.__logger_file

{encommon-0.7.2 → encommon-0.7.4}/encommon/config/params.py

@@ -33,8 +33,8 @@ class LoggerParams(BaseModel, extra='forbid'):
     """
     Process and validate the common configuration parameters.
 
-    :param stdo_level: Minimum log message severity level.
-    :param file_level: Minimum log message severity level.
+    :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 data: Keyword arguments passed to Pydantic model.
         Parameter is picked up by autodoc, please ignore.

{encommon-0.7.2 → encommon-0.7.4}/encommon/config/test/test_config.py

@@ -88,8 +88,12 @@ def test_Config(  # noqa: CFQ001
 
     assert _config1 is not _config2
 
+
+    sample_path = Path(
+        f'{SAMPLES}/config.json')
+
     sample = load_sample(
-        path=SAMPLES.joinpath('config.json'),
+        path=sample_path,
         update=ENPYRWS,
         content=_config1,
         replace={
@@ -108,8 +112,12 @@ def test_Config(  # noqa: CFQ001
 
     assert _params1 is _params2
 
+
+    sample_path = Path(
+        f'{SAMPLES}/params.json')
+
     sample = load_sample(
-        path=SAMPLES.joinpath('params.json'),
+        path=sample_path,
         update=ENPYRWS,
         content=_params1.model_dump(),
         replace={

{encommon-0.7.2 → encommon-0.7.4}/encommon/config/test/test_files.py

@@ -87,8 +87,11 @@ def test_ConfigFiles(
 
     assert _merged1 is not _merged2
 
+    sample_path = Path(
+        f'{SAMPLES}/files.json')
+
     sample = load_sample(
-        path=SAMPLES.joinpath('files.json'),
+        path=sample_path,
         update=ENPYRWS,
         content=_merged1,
         replace={

{encommon-0.7.2 → encommon-0.7.4}/encommon/config/test/test_paths.py

@@ -80,8 +80,11 @@ def test_ConfigPaths(
 
     assert _merged1 is not _merged2
 
+    sample_path = Path(
+        f'{SAMPLES}/paths.json')
+
     sample = load_sample(
-        path=SAMPLES.joinpath('paths.json'),
+        path=sample_path,
         update=ENPYRWS,
         content=_merged1,
         replace={

{encommon-0.7.2 → encommon-0.7.4}/encommon/crypts/crypts.py

@@ -10,9 +10,14 @@ is permitted, for more information consult the project license file.
 from re import compile
 from re import match as re_match
 from re import sub as re_sub
+from typing import Optional
+from typing import TYPE_CHECKING
 
 from cryptography.fernet import Fernet
 
+if TYPE_CHECKING:
+    from .params import CryptsParams
+
 
 
 ENCRYPT = compile(
@@ -33,6 +38,7 @@ class Crypts:
     'example'
 
     :param phrases: Passphrases that are used in operations.
+    :param params: Parameters for instantiating the instance.
     """
 
     __phrases: dict[str, str]
@@ -40,12 +46,18 @@ class Crypts:
 
     def __init__(
         self,
-        phrases: dict[str, str],
+        phrases: Optional[dict[str, str]] = None,
+        params: Optional['CryptsParams'] = None,
     ) -> None:
         """
         Initialize instance for class using provided parameters.
         """
 
+        phrases = phrases or {}
+
+        if params is not None:
+            phrases |= params.phrases
+
         if 'default' not in phrases:
             raise ValueError('default')
 
@@ -57,9 +69,9 @@ class Crypts:
         self,
     ) -> dict[str, str]:
         """
-        Return the property for attribute from the class instance.
+        Return the value for the attribute from class instance.
 
-        :returns: Property for attribute from the class instance.
+        :returns: Value for the attribute from class instance.
         """
 
         return dict(self.__phrases)

{encommon-0.7.2 → encommon-0.7.4}/encommon/crypts/hashes.py

@@ -55,9 +55,9 @@ class Hashes:
         self,
     ) -> str:
         """
-        Return the property for attribute from the class instance.
+        Return the value for the attribute from class instance.
 
-        :returns: Property for attribute from the class instance.
+        :returns: Value for the attribute from class instance.
         """
 
         return self.__string
@@ -68,9 +68,9 @@ class Hashes:
         self,
     ) -> str:
         """
-        Return the property for attribute from the class instance.
+        Return the value for the attribute from class instance.
 
-        :returns: Property for attribute from the class instance.
+        :returns: Value for the attribute from class instance.
         """
 
         encode = self.__string.encode()
@@ -83,9 +83,9 @@ class Hashes:
         self,
     ) -> str:
         """
-        Return the property for attribute from the class instance.
+        Return the value for the attribute from class instance.
 
-        :returns: Property for attribute from the class instance.
+        :returns: Value for the attribute from class instance.
         """
 
         string = self.__string.encode()
@@ -98,9 +98,9 @@ class Hashes:
         self,
     ) -> str:
         """
-        Return the property for attribute from the class instance.
+        Return the value for the attribute from class instance.
 
-        :returns: Property for attribute from the class instance.
+        :returns: Value for the attribute from class instance.
         """
 
         string = self.__string.encode()
@@ -113,9 +113,9 @@ class Hashes:
         self,
     ) -> str:
         """
-        Return the property for attribute from the class instance.
+        Return the value for the attribute from class instance.
 
-        :returns: Property for attribute from the class instance.
+        :returns: Value for the attribute from class instance.
         """
 
         string = self.__string.encode()
@@ -128,9 +128,9 @@ class Hashes:
         self,
     ) -> str:
         """
-        Return the property for attribute from the class instance.
+        Return the value for the attribute from class instance.
 
-        :returns: Property for attribute from the class instance.
+        :returns: Value for the attribute from class instance.
         """
 
         string = self.__string
@@ -144,9 +144,9 @@ class Hashes:
         self,
     ) -> str:
         """
-        Return the property for attribute from the class instance.
+        Return the value for the attribute from class instance.
 
-        :returns: Property for attribute from the class instance.
+        :returns: Value for the attribute from class instance.
         """
 
         string = self.__string.encode()

{encommon-0.7.2 → encommon-0.7.4}/encommon/times/duration.py

@@ -278,9 +278,9 @@ class Duration:
         self,
     ) -> float:
         """
-        Return the property for attribute from the class instance.
+        Return the value for the attribute from class instance.
 
-        :returns: Property for attribute from the class instance.
+        :returns: Value for the attribute from class instance.
         """
 
         return self.__source
@@ -291,9 +291,9 @@ class Duration:
         self,
     ) -> bool:
         """
-        Return the property for attribute from the class instance.
+        Return the value for the attribute from class instance.
 
-        :returns: Property for attribute from the class instance.
+        :returns: Value for the attribute from class instance.
         """
 
         return self.__smart
@@ -304,9 +304,9 @@ class Duration:
         self,
     ) -> int:
         """
-        Return the property for attribute from the class instance.
+        Return the value for the attribute from class instance.
 
-        :returns: Property for attribute from the class instance.
+        :returns: Value for the attribute from class instance.
         """
 
         return self.__groups

{encommon-0.7.2 → encommon-0.7.4}/encommon/times/parse.py

@@ -73,7 +73,7 @@ def parse_time(  # noqa: CFQ004
 
     :param source: Time in various forms that will be parsed.
     :param anchor: Optional relative time; for snap notation.
-    :param format: Optional format for the timestamp string.
+    :param format: Optional format when source is timestamp.
     :param tzname: Name of the timezone associated to source.
         This is not relevant in timezone included in source.
     :returns: Python datetime object containing related time.

{encommon-0.7.2 → encommon-0.7.4}/encommon/times/timers.py

@@ -19,6 +19,7 @@ if TYPE_CHECKING:
     from sqlite3 import Connection
 
 
+
 TABLE = (
     """
     create table
@@ -159,9 +160,9 @@ class Timers:
         self,
     ) -> dict[str, float]:
         """
-        Return the property for attribute from the class instance.
+        Return the value for the attribute from class instance.
 
-        :returns: Property for attribute from the class instance.
+        :returns: Value for the attribute from class instance.
         """
 
         return dict(self.__timers)
@@ -172,9 +173,9 @@ class Timers:
         self,
     ) -> 'Connection':
         """
-        Return the property for attribute from the class instance.
+        Return the value for the attribute from class instance.
 
-        :returns: Property for attribute from the class instance.
+        :returns: Value for the attribute from class instance.
         """
 
         return self.__cache_file
@@ -185,9 +186,9 @@ class Timers:
         self,
     ) -> dict[str, Times]:
         """
-        Return the property for attribute from the class instance.
+        Return the value for the attribute from class instance.
 
-        :returns: Property for attribute from the class instance.
+        :returns: Value for the attribute from class instance.
         """
 
         return dict(self.__cache_dict)
@@ -198,9 +199,9 @@ class Timers:
         self,
     ) -> str:
         """
-        Return the property for attribute from the class instance.
+        Return the value for the attribute from class instance.
 
-        :returns: Property for attribute from the class instance.
+        :returns: Value for the attribute from class instance.
         """
 
         return self.__cache_name
@@ -231,7 +232,7 @@ class Timers:
         cache = caches[unique]
         timer = timers[unique]
 
-        ready = cache.elapsed >= timer
+        ready = cache.since >= timer
 
         if ready and update:
             self.update(unique)
@@ -278,7 +279,7 @@ class Timers:
         timers = self.__timers
         caches = self.__cache_dict
 
-        if unique in caches:
+        if unique in timers:
             raise ValueError('unique')
 
         timers[unique] = float(minimum)

{encommon-0.7.2 → encommon-0.7.4}/encommon/times/times.py

@@ -34,7 +34,7 @@ class Times:
 
     :param source: Time in various forms that will be parsed.
     :param anchor: Optional relative time; for snap notation.
-    :param format: Optional format for the timestamp string.
+    :param format: Optional format when source is timestamp.
     :param tzname: Name of the timezone associated to source.
         This is not relevant in timezone included in source.
     """
@@ -260,9 +260,9 @@ class Times:
         self,
     ) -> datetime:
         """
-        Return the property for attribute from the class instance.
+        Return the value for the attribute from class instance.
 
-        :returns: Property for attribute from the class instance.
+        :returns: Value for the attribute from class instance.
         """
 
         return self.__source
@@ -403,7 +403,7 @@ class Times:
         """
         Return the timestamp using provided format for instance.
 
-        :param format: Optional format for the timestamp string.
+        :param format: Optional format when source is timestamp.
         :param tzname: Name of the timezone associated to source.
             This is not relevant in timezone included in source.
         :returns: Timestamp using provided format for instance.

{encommon-0.7.2 → encommon-0.7.4}/encommon/times/window.py

@@ -109,9 +109,9 @@ class Window:
         self,
     ) -> SCHEDULE:
         """
-        Return the property for attribute from the class instance.
+        Return the value for the attribute from class instance.
 
-        :returns: Property for attribute from the class instance.
+        :returns: Value for the attribute from class instance.
         """
 
         return copy(self.__schedule)
@@ -122,9 +122,9 @@ class Window:
         self,
     ) -> Times:
         """
-        Return the property for attribute from the class instance.
+        Return the value for the attribute from class instance.
 
-        :returns: Property for attribute from the class instance.
+        :returns: Value for the attribute from class instance.
         """
 
         return Times(self.__start)
@@ -135,9 +135,9 @@ class Window:
         self,
     ) -> Times:
         """
-        Return the property for attribute from the class instance.
+        Return the value for the attribute from class instance.
 
-        :returns: Property for attribute from the class instance.
+        :returns: Value for the attribute from class instance.
         """
 
         return Times(self.__stop)
@@ -148,9 +148,9 @@ class Window:
         self,
     ) -> Times:
         """
-        Return the property for attribute from the class instance.
+        Return the value for the attribute from class instance.
 
-        :returns: Property for attribute from the class instance.
+        :returns: Value for the attribute from class instance.
         """
 
         return Times(self.__anchor)
@@ -161,9 +161,9 @@ class Window:
         self,
     ) -> float:
         """
-        Return the property for attribute from the class instance.
+        Return the value for the attribute from class instance.
 
-        :returns: Property for attribute from the class instance.
+        :returns: Value for the attribute from class instance.
         """
 
         return self.__delay
@@ -174,9 +174,9 @@ class Window:
         self,
     ) -> Times:
         """
-        Return the property for attribute from the class instance.
+        Return the value for the attribute from class instance.
 
-        :returns: Property for attribute from the class instance.
+        :returns: Value for the attribute from class instance.
         """
 
         return Times(self.__winext)
@@ -187,9 +187,9 @@ class Window:
         self,
     ) -> Times:
         """
-        Return the property for attribute from the class instance.
+        Return the value for the attribute from class instance.
 
-        :returns: Property for attribute from the class instance.
+        :returns: Value for the attribute from class instance.
         """
 
         return Times(self.__wilast)
@@ -200,9 +200,9 @@ class Window:
         self,
     ) -> bool:
         """
-        Return the property for attribute from the class instance.
+        Return the value for the attribute from class instance.
 
-        :returns: Property for attribute from the class instance.
+        :returns: Value for the attribute from class instance.
         """
 
         return self.__walked

{encommon-0.7.2 → encommon-0.7.4}/encommon/utils/sample.py

@@ -20,11 +20,11 @@ from .. import WORKSPACE
 
 
 def prep_sample(
-    content: Any,  # noqa: ANN401
+    content: Any,
     *,
     default: Callable[[Any], str] = str,
-    replace: Optional[dict[str, str]] = None,
-) -> Any:  # noqa: ANN401
+    replace: Optional[dict[str, str | Path]] = None,
+) -> Any:
     """
     Return the content after processing using JSON functions.
 
@@ -55,10 +55,14 @@ def prep_sample(
     replace = replace or {}
 
     replace |= {
-        'PROJECT': str(PROJECT.resolve()),
-        'WORKSPACE': str(WORKSPACE.resolve())}
+        'PROJECT': PROJECT,
+        'WORKSPACE': WORKSPACE}
 
     for old, new in replace.items():
+
+        if isinstance(new, Path):
+            new = str(new)
+
         content = content.replace(
             new, f'_/{prefix}/{old}/_')
 
@@ -72,8 +76,8 @@ def load_sample(
     update: bool = False,
     *,
     default: Callable[[Any], str] = str,
-    replace: Optional[dict[str, str]] = None,
-) -> Any:  # noqa: ANN401
+    replace: Optional[dict[str, str | Path]] = None,
+) -> Any:
     """
     Load the sample file and compare using provided content.
 
@@ -115,7 +119,7 @@ def load_sample(
             dumps(content, indent=2))
 
 
-    def _load_sample() -> Any:  # noqa: ANN401
+    def _load_sample() -> Any:
         return loads(
             path.read_text(
                 encoding='utf-8'))
@@ -124,7 +128,7 @@ def load_sample(
     if path.exists():
         loaded = _load_sample()
 
-    if not path.exists():  # noqa: SIM114
+    if not path.exists():
         _save_sample()
 
     elif (update is True

encommon-0.7.4/encommon/version.txt

@@ -0,0 +1 @@
+0.7.4

{encommon-0.7.2 → encommon-0.7.4/encommon.egg-info}/PKG-INFO

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

{encommon-0.7.2 → encommon-0.7.4}/setup.cfg

@@ -12,6 +12,7 @@ ignore =
 per-file-ignores = 
 	encommon/crypts/hashes.py:S324,
 	encommon/times/timers.py:S608,
+	encommon/utils/sample.py:ANN401,SIM114,
 	encommon/utils/stdout.py:SIM114,
 	encommon/utils/test/test_stdout.py:LIT015,
 
@@ -21,7 +22,7 @@ strict = True
 
 [coverage:report]
 exclude_lines = 
-	pragma: no cover
+	NOCVR
 	if TYPE_CHECKING
 
 [egg_info]

encommon-0.7.2/encommon/version.txt

@@ -1 +0,0 @@
-0.7.2