encommon 1.1.1__tar.gz → 2.0.0__tar.gz

{encommon-1.1.1/encommon.egg-info → encommon-2.0.0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: encommon
-Version: 1.1.1
+Version: 2.0.0
 Summary: Enasis Network Common Library
 License: MIT
 Classifier: Programming Language :: Python :: 3
@@ -11,6 +11,7 @@ Description-Content-Type: text/markdown
 License-File: LICENSE
 Requires-Dist: croniter
 Requires-Dist: cryptography
+Requires-Dist: pydantic
 Requires-Dist: python-dateutil
 Requires-Dist: pyyaml
 Requires-Dist: snaptime

{encommon-1.1.1 → encommon-2.0.0}/encommon/config/common.py

@@ -9,6 +9,7 @@ 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 yaml import SafeLoader
@@ -22,6 +23,15 @@ from ..utils.paths import resolve_paths
 
 
 
+LOGLEVELS = Literal[
+    'critical',
+    'debug',
+    'error',
+    'info',
+    'warning']
+
+
+
 def config_load(
     path: str | Path,
 ) -> dict[str, Any]:

{encommon-1.1.1 → encommon-2.0.0}/encommon/config/config.py

@@ -9,11 +9,15 @@ 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 .common import config_paths
 from .files import ConfigFiles
 from .logger import Logger
+from .params import ConfigFileParams
 from .paths import ConfigPaths
+from ..crypts.crypts import Crypts
 from ..types.dicts import merge_dicts
 from ..utils.common import PATHABLE
 
@@ -23,19 +27,27 @@ class Config:
     """
     Contain the configurations from the arguments and files.
 
+    .. note::
+       Configuration loaded from files is validated with the
+       Pydantic model :class:`.ConfigFileParams`.
+
     :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,
         which will override contents from the config files.
+    :param model: Override default config validation model.
     """
 
     __files: ConfigFiles
     __paths: ConfigPaths
     __cargs: dict[str, Any]
 
+    __model: Callable  # type: ignore
+
     __config: Optional[dict[str, Any]]
     __merged: Optional[dict[str, Any]]
     __logger: Optional[Logger]
+    __crypts: Optional[Crypts]
 
 
     def __init__(
@@ -44,6 +56,7 @@ class Config:
         files: Optional[PATHABLE] = None,
         paths: Optional[PATHABLE] = None,
         cargs: Optional[dict[str, Any]] = None,
+        model: Optional[Callable] = None,  # type: ignore
     ) -> None:
         """
         Initialize instance for class using provided parameters.
@@ -53,13 +66,26 @@ class Config:
         paths = paths or []
         cargs = cargs or {}
 
+        paths = list(config_paths(paths))
+
+        self.__model = (
+            model or ConfigFileParams)
+
         self.__files = ConfigFiles(files)
         self.__cargs = deepcopy(cargs)
-        self.__paths = ConfigPaths(paths)
 
         self.__config = None
+
+        enconfig = self.config['enconfig']
+
+        if enconfig['paths']:
+            paths.extend(enconfig['paths'])
+
+        self.__paths = ConfigPaths(paths)
+
         self.__merged = None
         self.__logger = None
+        self.__crypts = None
 
 
     @property
@@ -101,6 +127,19 @@ class Config:
         return self.__cargs
 
 
+    @property
+    def model(
+        self,
+    ) -> Callable:  # type: ignore
+        """
+        Return the property for attribute from the class instance.
+
+        :returns: Property for attribute from the class instance.
+        """
+
+        return self.__model
+
+
     @property
     def config(
         self,
@@ -138,7 +177,10 @@ class Config:
             force=True)
 
 
-        self.__config = merged
+        config = self.__model(**merged)
+
+
+        self.__config = config.model_dump()
 
         return deepcopy(self.__config)
 
@@ -187,11 +229,28 @@ class Config:
         if self.__logger is not None:
             return self.__logger
 
-        enlogger = self.config.get('enlogger', {})
+        enlogger = (
+            self.config['enlogger'] or {})
 
-        self.__logger = Logger(
-            stdo_level=enlogger.get('stdo_level'),
-            file_level=enlogger.get('file_level'),
-            file_path=enlogger.get('file_path'))
+        self.__logger = Logger(**enlogger)
 
         return self.__logger
+
+
+    @property
+    def crypts(
+        self,
+    ) -> Crypts:
+        """
+        Initialize the encryption instance using the parameters.
+        """
+
+        if self.__crypts is not None:
+            return self.__crypts
+
+        encrypts = (
+            self.config['encrypts'] or {})
+
+        self.__crypts = Crypts(**encrypts)
+
+        return self.__crypts

{encommon-1.1.1 → encommon-2.0.0}/encommon/config/logger.py

@@ -25,6 +25,7 @@ from typing import Any
 from typing import Literal
 from typing import Optional
 
+from .common import LOGLEVELS
 from .common import config_path
 from ..times.common import PARSABLE
 from ..times.times import Times
@@ -36,13 +37,6 @@ from ..utils.stdout import kvpair_ansi
 LOGGER_FILE = 'encommon.logger.file'
 LOGGER_STDO = 'encommon.logger.stdo'
 
-LOGLEVELS = Literal[
-    'critical',
-    'debug',
-    'error',
-    'info',
-    'warning']
-
 LOGSEVERS = {
     'critical': int(CRITICAL),
     'debug': int(DEBUG),

encommon-2.0.0/encommon/config/params.py

@@ -0,0 +1,46 @@
+"""
+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 typing import Optional
+
+from pydantic import BaseModel
+
+from .common import LOGLEVELS
+from ..crypts.params import CryptsParams
+
+
+
+class ConfigParams(BaseModel):
+    """
+    Process and validate the common configuration parameters.
+    """
+
+    paths: Optional[list[str]] = None
+
+
+
+class LoggerParams(BaseModel):
+    """
+    Process and validate the common configuration parameters.
+    """
+
+    stdo_level: Optional[LOGLEVELS] = None
+    file_level: Optional[LOGLEVELS] = None
+    file_path: Optional[str] = None
+
+
+
+class ConfigFileParams(BaseModel):
+    """
+    Process and validate the common configuration parameters.
+    """
+
+    enconfig: Optional[ConfigParams] = None
+    enlogger: Optional[LoggerParams] = None
+    encrypts: Optional[CryptsParams] = None

{encommon-1.1.1 → encommon-2.0.0}/encommon/config/test/test_config.py

@@ -12,6 +12,7 @@ from pathlib import Path
 from ..config import Config
 from ..logger import Logger
 from ... import ENPYRWS
+from ...crypts.crypts import Crypts
 from ...utils.sample import load_sample
 from ...utils.sample import prep_sample
 
@@ -37,29 +38,40 @@ def test_Config(  # noqa: CFQ001
     (config_path
         .joinpath('one.yml')
         .write_text(
-            'stdo_level: info\n'))
+            'enconfig:\n'
+            f'  paths: ["{config_path}"]\n'
+            'enlogger:\n'
+            '  stdo_level: info\n'))
 
     (config_path
         .joinpath('two.yml')
         .write_text(
-            'stdo_level: debug\n'
-            'file_level: info\n'))
+            'encrypts:\n'
+            '  phrases:\n'
+            '    default: fernetpassphrase\n'
+            'enlogger:\n'
+            '  stdo_level: debug\n'
+            '  file_level: info\n'))
 
 
     config = Config(
         files=[
             f'{config_path}/one.yml',
             f'{config_path}/two.yml'],
-        paths=[config_path, tmp_path],
-        cargs={'file_level': 'warning'})
+        cargs={
+            'enlogger': {
+                'file_level': 'warning'}})
 
-    assert len(config.__dict__) == 6
+    assert len(config.__dict__) == 8
 
     assert hasattr(config, '_Config__files')
     assert hasattr(config, '_Config__paths')
     assert hasattr(config, '_Config__cargs')
+    assert hasattr(config, '_Config__model')
     assert hasattr(config, '_Config__config')
     assert hasattr(config, '_Config__merged')
+    assert hasattr(config, '_Config__logger')
+    assert hasattr(config, '_Config__crypts')
 
 
     assert list(config.files.paths) == [
@@ -70,10 +82,13 @@ def test_Config(  # noqa: CFQ001
         Path(f'{config_path}')]
 
     assert config.cargs == {
-        'file_level': 'warning'}
+        'enlogger': {
+            'file_level': 'warning'}}
 
+    assert hasattr(config.model, 'model_dump')
 
-    assert len(config.config) == 2
+
+    assert len(config.config) == 3
 
     _config1 = config.config
     _config2 = config.config
@@ -135,3 +150,13 @@ def test_Config(  # noqa: CFQ001
     _logger2 = config.logger
 
     assert _logger1 is _logger2
+
+
+    crypts = config.crypts
+
+    assert isinstance(crypts, Crypts)
+
+    _crypts1 = config.crypts
+    _crypts2 = config.crypts
+
+    assert _crypts1 is _crypts2

{encommon-1.1.1/encommon/crypt → encommon-2.0.0/encommon/crypts}/__init__.py

@@ -7,11 +7,11 @@ is permitted, for more information consult the project license file.
 
 
 
-from .crypt import Crypt
+from .crypts import Crypts
 from .hashes import Hashes
 
 
 
 __all__ = [
-    'Crypt',
+    'Crypts',
     'Hashes']

encommon-1.1.1/encommon/crypt/crypt.py → encommon-2.0.0/encommon/crypts/crypts.py

@@ -20,40 +20,40 @@ ENCRYPT = compile(
 
 
 
-class Crypt:
+class Crypts:
     """
     Encrypt and decrypt values using passphrase dictionary.
 
     Example
     -------
-    >>> phrase = Crypt.keygen()
-    >>> crypt = Crypt({'default': phrase})
-    >>> encrypt = crypt.encrypt('example')
-    >>> crypt.decrypt(encrypt)
+    >>> phrase = Crypts.keygen()
+    >>> crypts = Crypts({'default': phrase})
+    >>> encrypt = crypts.encrypt('example')
+    >>> crypts.decrypt(encrypt)
     'example'
 
-    :param mapping: Passphrases that are used in operations.
+    :param phrases: Passphrases that are used in operations.
     """
 
-    __phrase: dict[str, str]
+    __phrases: dict[str, str]
 
 
     def __init__(
         self,
-        mapping: dict[str, str],
+        phrases: dict[str, str],
     ) -> None:
         """
         Initialize instance for class using provided parameters.
         """
 
-        if 'default' not in mapping:
+        if 'default' not in phrases:
             raise ValueError('default')
 
-        self.__phrase = dict(mapping)
+        self.__phrases = dict(phrases)
 
 
     @property
-    def mapping(
+    def phrases(
         self,
     ) -> dict[str, str]:
         """
@@ -62,7 +62,7 @@ class Crypt:
         :returns: Property for attribute from the class instance.
         """
 
-        return dict(self.__phrase)
+        return dict(self.__phrases)
 
 
     def encrypt(
@@ -78,7 +78,7 @@ class Crypt:
         :returns: Encrypted value using the relevant passphrase.
         """
 
-        phrase = self.__phrase[unique]
+        phrase = self.__phrases[unique]
 
         encrypt = (
             Fernet(phrase)
@@ -112,7 +112,7 @@ class Crypt:
         if version != '1.0':
             raise ValueError('version')
 
-        phrase = self.__phrase[unique]
+        phrase = self.__phrases[unique]
 
         return (
             Fernet(phrase)

encommon-2.0.0/encommon/crypts/params.py

@@ -0,0 +1,19 @@
+"""
+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 pydantic import BaseModel
+
+
+
+class CryptsParams(BaseModel):
+    """
+    Process and validate the common configuration parameters.
+    """
+
+    phrases: dict[str, str]

encommon-1.1.1/encommon/crypt/test/test_crypt.py → encommon-2.0.0/encommon/crypts/test/test_crypts.py

@@ -10,37 +10,37 @@ is permitted, for more information consult the project license file.
 from pytest import mark
 from pytest import raises
 
-from ..crypt import Crypt
+from ..crypts import Crypts
 
 
 
 _PHRASES = {
-    'default': Crypt.keygen(),
-    'secrets': Crypt.keygen()}
+    'default': Crypts.keygen(),
+    'secrets': Crypts.keygen()}
 
 
 
-def test_Crypt() -> None:
+def test_Crypts() -> None:
     """
     Perform various tests associated with relevant routines.
     """
 
 
-    crypt = Crypt(_PHRASES)
+    crypts = Crypts(_PHRASES)
 
-    assert len(crypt.__dict__) == 1
+    assert len(crypts.__dict__) == 1
 
-    assert hasattr(crypt, '_Crypt__phrase')
+    assert hasattr(crypts, '_Crypts__phrases')
 
 
-    assert repr(crypt).startswith(
-        '<encommon.crypt.crypt.Crypt')
+    assert repr(crypts).startswith(
+        '<encommon.crypts.crypts.Crypts')
 
-    assert str(crypt).startswith(
-        '<encommon.crypt.crypt.Crypt')
+    assert str(crypts).startswith(
+        '<encommon.crypts.crypts.Crypts')
 
 
-    assert crypt.mapping == _PHRASES
+    assert crypts.phrases == _PHRASES
 
 
 
@@ -48,7 +48,7 @@ def test_Crypt() -> None:
     'value,unique',
     [('foo', 'default'),
      ('foo', 'secrets')])
-def test_Crypt_iterate(
+def test_Crypts_iterate(
     value: str,
     unique: str,
 ) -> None:
@@ -59,43 +59,43 @@ def test_Crypt_iterate(
     :param unique: Unique identifier of mapping passphrase.
     """
 
-    crypt = Crypt(_PHRASES)
+    crypts = Crypts(_PHRASES)
 
-    encrypt = crypt.encrypt(value, unique)
+    encrypt = crypts.encrypt(value, unique)
 
     split = encrypt.split(';')
 
     assert split[1] == '1.0'
     assert split[2] == unique
 
-    decrypt = crypt.decrypt(encrypt)
+    decrypt = crypts.decrypt(encrypt)
 
     assert decrypt == value
 
 
 
-def test_Crypt_raises() -> None:
+def test_Crypts_raises() -> None:
     """
     Perform various tests associated with relevant routines.
     """
 
 
     with raises(ValueError) as reason:
-        Crypt({'foo': 'bar'})
+        Crypts({'foo': 'bar'})
 
     assert str(reason.value) == 'default'
 
 
-    crypt = Crypt(_PHRASES)
+    crypts = Crypts(_PHRASES)
 
 
     with raises(ValueError) as reason:
-        crypt.decrypt('foo')
+        crypts.decrypt('foo')
 
     assert str(reason.value) == 'string'
 
 
     with raises(ValueError) as reason:
-        crypt.decrypt('$ENCRYPT;1.1;f;oo')
+        crypts.decrypt('$ENCRYPT;1.1;f;oo')
 
     assert str(reason.value) == 'version'

{encommon-1.1.1/encommon/crypt → encommon-2.0.0/encommon/crypts}/test/test_hashes.py

@@ -25,10 +25,10 @@ def test_Hashes() -> None:
 
 
     assert repr(hashes).startswith(
-        '<encommon.crypt.hashes.Hashes')
+        '<encommon.crypts.hashes.Hashes')
 
     assert str(hashes).startswith(
-        '<encommon.crypt.hashes.Hashes')
+        '<encommon.crypts.hashes.Hashes')
 
 
     assert hashes.string == 'string'

encommon-2.0.0/encommon/version.txt

@@ -0,0 +1 @@
+2.0.0

{encommon-1.1.1 → encommon-2.0.0/encommon.egg-info}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: encommon
-Version: 1.1.1
+Version: 2.0.0
 Summary: Enasis Network Common Library
 License: MIT
 Classifier: Programming Language :: Python :: 3
@@ -11,6 +11,7 @@ Description-Content-Type: text/markdown
 License-File: LICENSE
 Requires-Dist: croniter
 Requires-Dist: cryptography
+Requires-Dist: pydantic
 Requires-Dist: python-dateutil
 Requires-Dist: pyyaml
 Requires-Dist: snaptime

{encommon-1.1.1 → encommon-2.0.0}/encommon.egg-info/SOURCES.txt

@@ -18,6 +18,7 @@ encommon/config/common.py
 encommon/config/config.py
 encommon/config/files.py
 encommon/config/logger.py
+encommon/config/params.py
 encommon/config/paths.py
 encommon/config/test/__init__.py
 encommon/config/test/test_common.py
@@ -25,12 +26,13 @@ encommon/config/test/test_config.py
 encommon/config/test/test_files.py
 encommon/config/test/test_logger.py
 encommon/config/test/test_paths.py
-encommon/crypt/__init__.py
-encommon/crypt/crypt.py
-encommon/crypt/hashes.py
-encommon/crypt/test/__init__.py
-encommon/crypt/test/test_crypt.py
-encommon/crypt/test/test_hashes.py
+encommon/crypts/__init__.py
+encommon/crypts/crypts.py
+encommon/crypts/hashes.py
+encommon/crypts/params.py
+encommon/crypts/test/__init__.py
+encommon/crypts/test/test_crypts.py
+encommon/crypts/test/test_hashes.py
 encommon/times/__init__.py
 encommon/times/common.py
 encommon/times/parse.py

{encommon-1.1.1 → encommon-2.0.0}/encommon.egg-info/requires.txt

@@ -1,5 +1,6 @@
 croniter
 cryptography
+pydantic
 python-dateutil
 pyyaml
 snaptime

{encommon-1.1.1 → encommon-2.0.0}/reqs-install.txt

@@ -1,5 +1,6 @@
 croniter
 cryptography
+pydantic
 python-dateutil
 pyyaml
 snaptime

{encommon-1.1.1 → encommon-2.0.0}/setup.cfg

@@ -10,7 +10,7 @@ ignore =
 	SFS301,
 	W503,
 per-file-ignores = 
-	encommon/crypt/hashes.py:S324,
+	encommon/crypts/hashes.py:S324,
 	encommon/utils/sample.py:ANN401,SIM114,
 
 [mypy]

encommon-1.1.1/encommon/version.txt

@@ -1 +0,0 @@
-1.1.1