encommon 0.10.0__tar.gz → 0.11.0__tar.gz

{encommon-0.10.0/encommon.egg-info → encommon-0.11.0}/PKG-INFO

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

{encommon-0.10.0 → encommon-0.11.0}/encommon/config/__init__.py

@@ -7,9 +7,6 @@ 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 .config import Config
 from .files import ConfigFile
 from .files import ConfigFiles
@@ -20,6 +17,9 @@ from .params import LoggerParams
 from .params import Params
 from .paths import ConfigPath
 from .paths import ConfigPaths
+from .utils import config_load
+from .utils import config_path
+from .utils import config_paths
 
 
 

{encommon-0.10.0 → encommon-0.11.0}/encommon/config/config.py

@@ -13,11 +13,11 @@ 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 .utils import config_paths
 from ..crypts import Crypts
 from ..types import merge_dicts
 from ..types import setate
@@ -35,6 +35,16 @@ class Config:
        Configuration loaded from files is validated with the
        Pydantic model :class:`encommon.config.Params`.
 
+    .. testsetup::
+       >>> from pathlib import Path
+       >>> path = str(getfixture('tmpdir'))
+
+    Example
+    -------
+    >>> config = Config()
+    >>> config.config
+    {'enconfig': None, 'enlogger': None, 'encrypts': None}
+
     :param files: Complete or relative path to config files.
     :param paths: Complete or relative path to config paths.
     :param cargs: Configuration arguments in dictionary form,
@@ -200,6 +210,8 @@ class Config:
     ) -> Logger:
         """
         Initialize the Python logging library using parameters.
+
+        :returns: Instance of Python logging library created.
         """
 
         if self.__logger is not None:
@@ -220,6 +232,8 @@ class Config:
     ) -> Crypts:
         """
         Initialize the encryption instance using the parameters.
+
+        :returns: Instance of the encryption instance created.
         """
 
         if self.__crypts is not None:
@@ -228,6 +242,8 @@ class Config:
         encrypts = (
             self.params.encrypts)
 
+        assert encrypts is not None
+
         self.__crypts = (
             Crypts(params=encrypts))
 

{encommon-0.10.0 → encommon-0.11.0}/encommon/config/files.py

@@ -13,9 +13,9 @@ 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 .utils import config_load
+from .utils import config_path
+from .utils import config_paths
 from ..types import merge_dicts
 
 if TYPE_CHECKING:

{encommon-0.10.0 → encommon-0.11.0}/encommon/config/logger.py

@@ -26,8 +26,7 @@ from typing import Literal
 from typing import Optional
 from typing import TYPE_CHECKING
 
-from .common import LOGLEVELS
-from .common import config_path
+from .utils import config_path
 from ..times import Times
 from ..types import Empty
 from ..types.strings import COMMAD
@@ -45,6 +44,13 @@ if TYPE_CHECKING:
 LOGR_FILE = 'encommon.logger.file'
 LOGR_STDO = 'encommon.logger.stdo'
 
+LOGLEVELS = Literal[
+    'critical',
+    'debug',
+    'error',
+    'info',
+    'warning']
+
 LOGSEVERS = {
     'critical': int(CRITICAL),
     'debug': int(DEBUG),
@@ -270,6 +276,7 @@ class FileFormatter(Formatter):
         Specifically overrides method for formatting exceptions.
 
         :param ei: Exception information provided by the logger.
+        :returns: String representation for the filesystem path.
         """
 
         reason = super().formatException(ei)
@@ -316,6 +323,8 @@ class Logger:
     :param params: Parameters for instantiating the instance.
     """
 
+    __params: 'LoggerParams'
+
     __stdo_level: Optional[LOGLEVELS]
     __file_level: Optional[LOGLEVELS]
     __file_path: Optional[Path]
@@ -338,10 +347,19 @@ class Logger:
         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
+        from .params import LoggerParams
+
+        if params is None:
+            params = LoggerParams(
+                stdo_level=stdo_level,
+                file_level=file_level,
+                file_path=file_path)
+
+        self.__params = params
+
+        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)
@@ -359,6 +377,19 @@ class Logger:
         self.__logr_file = logr_file
 
 
+    @property
+    def params(
+        self,
+    ) -> 'LoggerParams':
+        """
+        Return the Pydantic model containing the configuration.
+
+        :returns: Pydantic model containing the configuration.
+        """
+
+        return self.__params
+
+
     @property
     def stdo_level(
         self,

{encommon-0.10.0 → encommon-0.11.0}/encommon/config/params.py

@@ -7,11 +7,12 @@ is permitted, for more information consult the project license file.
 
 
 
+from pathlib import Path
 from typing import Optional
 
 from pydantic import BaseModel
 
-from .common import LOGLEVELS
+from .logger import LOGLEVELS
 from ..crypts import CryptsParams
 
 
@@ -45,6 +46,25 @@ class LoggerParams(BaseModel, extra='forbid'):
     file_path: Optional[str] = None
 
 
+    def __init__(
+        self,
+        stdo_level: Optional[LOGLEVELS] = None,
+        file_level: Optional[LOGLEVELS] = None,
+        file_path: Optional[str | Path] = None,
+    ) -> None:
+        """
+        Initialize instance for class using provided parameters.
+        """
+
+        if file_path is not None:
+            file_path = str(file_path)
+
+        super().__init__(
+            stdo_level=stdo_level,
+            file_level=file_level,
+            file_path=file_path)
+
+
 
 class Params(BaseModel, extra='forbid'):
     """

{encommon-0.10.0 → encommon-0.11.0}/encommon/config/paths.py

@@ -14,9 +14,9 @@ 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 import config_path
+from .utils import config_paths
 
 if TYPE_CHECKING:
     from ..utils.common import PATHABLE

{encommon-0.10.0 → encommon-0.11.0}/encommon/config/test/test_logger.py

@@ -142,6 +142,7 @@ def test_Logger(
     attrs = list(logger.__dict__)
 
     assert attrs == [
+        '_Logger__params',
         '_Logger__stdo_level',
         '_Logger__file_level',
         '_Logger__file_path',
@@ -161,6 +162,8 @@ def test_Logger(
         logger)
 
 
+    assert logger.params is not None
+
     assert logger.stdo_level == 'info'
 
     assert logger.file_level == 'info'

encommon-0.10.0/encommon/config/test/test_common.py → encommon-0.11.0/encommon/config/test/test_utils.py

@@ -7,9 +7,9 @@ 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 ..utils import config_load
+from ..utils import config_path
+from ..utils import config_paths
 from ... import PROJECT
 from ... import WORKSPACE
 

encommon-0.10.0/encommon/config/common.py → encommon-0.11.0/encommon/config/utils.py

@@ -9,7 +9,6 @@ is permitted, for more information consult the project license file.
 
 from pathlib import Path
 from typing import Any
-from typing import Literal
 from typing import Optional
 from typing import TYPE_CHECKING
 
@@ -28,15 +27,6 @@ if TYPE_CHECKING:
 
 
 
-LOGLEVELS = Literal[
-    'critical',
-    'debug',
-    'error',
-    'info',
-    'warning']
-
-
-
 def config_load(
     path: str | Path,
 ) -> dict[str, Any]:
@@ -90,6 +80,7 @@ def config_paths(
        This function simply wraps one from utils subpackage.
 
     :param paths: Complete or relative paths for processing.
+    :param replace: Optional values to replace in the path.
     :returns: New resolved filesystem path object instances.
     """
 

{encommon-0.10.0 → encommon-0.11.0}/encommon/conftest.py

@@ -38,7 +38,8 @@ def config_factory(
             '  stdo_level: info\n'
             'encrypts:\n'
             '  phrases:\n'
-            '    default: phrase\n'))
+            '    default:\n'
+            '      phrase: phrase\n'))
 
     config_log = f'{tmp_path}/config.log'
 

{encommon-0.10.0 → encommon-0.11.0}/encommon/crypts/crypts.py

@@ -10,7 +10,6 @@ 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
@@ -31,52 +30,49 @@ class Crypts:
     """
     Encrypt and decrypt values using passphrase dictionary.
 
+    .. testsetup::
+       >>> from .params import CryptsParams
+
     Example
     -------
     >>> phrase = Crypts.keygen()
-    >>> crypts = Crypts({'default': phrase})
+    >>> source = {'default': {'phrase': phrase}}
+    >>> params = CryptsParams(phrases=source)
+    >>> crypts = Crypts(params)
     >>> encrypt = crypts.encrypt('example')
+    >>> encrypt
+    '$ENCRYPT;1.0;default;...
     >>> crypts.decrypt(encrypt)
     'example'
 
-    :param phrases: Passphrases that are used in operations.
     :param params: Parameters for instantiating the instance.
     """
 
-    __phrases: dict[str, str]
+    __params: 'CryptsParams'
 
 
     def __init__(
         self,
-        phrases: Optional[dict[str, str]] = None,
-        params: Optional['CryptsParams'] = None,
+        params: 'CryptsParams',
     ) -> 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')
-
-        self.__phrases = dict(phrases)
+        self.__params = params
 
 
     @property
-    def phrases(
+    def params(
         self,
-    ) -> dict[str, str]:
+    ) -> 'CryptsParams':
         """
-        Return the value for the attribute from class instance.
+        Return the Pydantic model containing the configuration.
 
-        :returns: Value for the attribute from class instance.
+        :returns: Pydantic model containing the configuration.
         """
 
-        return dict(self.__phrases)
+        return self.__params
 
 
     def encrypt(
@@ -92,7 +88,9 @@ class Crypts:
         :returns: Encrypted value using the relevant passphrase.
         """
 
-        phrase = self.__phrases[unique]
+        phrases = self.params.phrases
+
+        phrase = phrases[unique].phrase
 
         encrypt = (
             Fernet(phrase)
@@ -115,6 +113,8 @@ class Crypts:
         :returns: Decrypted value using the relevant passphrase.
         """
 
+        phrases = self.params.phrases
+
         value = crypt_clean(value)
 
         if not re_match(ENCRYPT, value):
@@ -126,7 +126,7 @@ class Crypts:
         if version != '1.0':
             raise ValueError('version')
 
-        phrase = self.__phrases[unique]
+        phrase = phrases[unique].phrase
 
         return (
             Fernet(phrase)
@@ -157,6 +157,7 @@ def crypt_clean(
     Return the parsed and normalized encrypted string value.
 
     :param value: String value that will returned decrypted.
+    :returns: Parsed and normalized encrypted string value.
     """
 
     return re_sub(r'[\n\s]', SEMPTY, value)

{encommon-0.10.0 → encommon-0.11.0}/encommon/crypts/params.py

@@ -11,6 +11,19 @@ from pydantic import BaseModel
 
 
 
+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
+
+
+
 class CryptsParams(BaseModel, extra='forbid'):
     """
     Process and validate the core configuration parameters.
@@ -20,4 +33,4 @@ class CryptsParams(BaseModel, extra='forbid'):
         Parameter is picked up by autodoc, please ignore.
     """
 
-    phrases: dict[str, str]
+    phrases: dict[str, CryptParams]

{encommon-0.10.0 → encommon-0.11.0}/encommon/crypts/test/test_crypts.py

@@ -7,6 +7,8 @@ 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
@@ -26,12 +28,12 @@ def crypts() -> Crypts:
     :returns: Newly constructed instance of related class.
     """
 
-    phrases = {
-        'default': Crypts.keygen(),
-        'secrets': Crypts.keygen()}
+    source: dict[str, Any] = {
+        'default': {'phrase': Crypts.keygen()},
+        'secrets': {'phrase': Crypts.keygen()}}
 
     params = CryptsParams(
-        phrases=phrases)
+        phrases=source)
 
     return Crypts(params=params)
 
@@ -50,7 +52,7 @@ def test_Crypts(
     attrs = list(crypts.__dict__)
 
     assert attrs == [
-        '_Crypts__phrases']
+        '_Crypts__params']
 
 
     assert inrepr(
@@ -64,7 +66,7 @@ def test_Crypts(
         crypts)
 
 
-    assert len(crypts.phrases) == 2
+    assert crypts.params is not None
 
     assert len(crypts.keygen()) == 44
 
@@ -111,20 +113,6 @@ def test_Crypts_raises(
     """
 
 
-    _raises = raises(ValueError)
-
-    with _raises as reason:
-        Crypts({'foo': 'bar'})
-
-    _reason = str(reason.value)
-
-    assert _reason == 'default'
-
-
-    crypts = Crypts(
-        crypts.phrases)
-
-
     _raises = raises(ValueError)
 
     with _raises as reason:

{encommon-0.10.0 → encommon-0.11.0}/encommon/times/__init__.py

@@ -7,24 +7,36 @@ is permitted, for more information consult the project license file.
 
 
 
-from .common import findtz
 from .duration import Duration
+from .params import TimerParams
+from .params import TimersParams
+from .params import WindowParams
+from .params import WindowsParams
 from .parse import parse_time
 from .parse import shift_time
 from .parse import since_time
 from .parse import string_time
+from .timer import Timer
 from .timers import Timers
 from .times import Times
+from .utils import findtz
 from .window import Window
+from .windows import Windows
 
 
 
 __all__ = [
     'Duration',
-    'findtz',
+    'Timer',
+    'TimerParams',
     'Timers',
+    'TimersParams',
     'Times',
     'Window',
+    'WindowParams',
+    'Windows',
+    'WindowsParams',
+    'findtz',
     'parse_time',
     'shift_time',
     'since_time',

encommon-0.11.0/encommon/times/common.py

@@ -0,0 +1,63 @@
+"""
+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 datetime import datetime
+from re import compile
+from typing import TYPE_CHECKING
+from typing import Union
+
+if TYPE_CHECKING:
+    from .times import Times
+
+
+
+NUMERISH = compile(
+    r'^\-?\d+(\.\d+)?$')
+
+SNAPABLE = compile(
+    r'^(\-|\+)[\d\@a-z\-\+]+$')
+
+STRINGNOW = {
+    'None', 'null', 'now'}
+
+
+
+NUMERIC = Union[int, float]
+
+PARSABLE = Union[
+    str, NUMERIC,
+    datetime, 'Times']
+
+SCHEDULE = Union[
+    str, dict[str, int]]
+
+
+
+UNIXEPOCH = (
+    '1970-01-01T00:00:00+0000')
+
+UNIXMPOCH = (
+    '1970-01-01T00:00:00.000000+0000')
+
+UNIXSPOCH = (
+    '1970-01-01T00:00:00Z')
+
+UNIXHPOCH = (
+    '01/01/1970 12:00AM UTC')
+
+
+
+STAMP_SIMPLE = (
+    '%Y-%m-%dT%H:%M:%S%z')
+
+STAMP_SUBSEC = (
+    '%Y-%m-%dT%H:%M:%S.%f%z')
+
+STAMP_HUMAN = (
+    '%m/%d/%Y %I:%M%p %Z')