encommon 0.11.0__tar.gz → 0.12.0__tar.gz

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

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: encommon
-Version: 0.11.0
+Version: 0.12.0
 Summary: Enasis Network Common Library
 License: MIT
 Classifier: Programming Language :: Python :: 3
@@ -15,6 +15,7 @@ Requires-Dist: pydantic
 Requires-Dist: python-dateutil
 Requires-Dist: pyyaml
 Requires-Dist: snaptime
+Requires-Dist: sqlalchemy
 
 # Enasis Network Common Library
 

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

@@ -217,11 +217,10 @@ class Config:
         if self.__logger is not None:
             return self.__logger
 
-        enlogger = (
+        logger = Logger(
             self.params.enlogger)
 
-        self.__logger = (
-            Logger(params=enlogger))
+        self.__logger = logger
 
         return self.__logger
 
@@ -239,12 +238,9 @@ class Config:
         if self.__crypts is not None:
             return self.__crypts
 
-        encrypts = (
+        crypts = Crypts(
             self.params.encrypts)
 
-        assert encrypts is not None
-
-        self.__crypts = (
-            Crypts(params=encrypts))
+        self.__crypts = crypts
 
         return self.__crypts

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

@@ -7,6 +7,7 @@ is permitted, for more information consult the project license file.
 
 
 
+from copy import deepcopy
 from json import dumps
 from logging import CRITICAL
 from logging import DEBUG
@@ -337,11 +338,11 @@ class Logger:
 
     def __init__(
         self,
+        params: Optional['LoggerParams'] = None,
         *,
         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.
@@ -355,7 +356,7 @@ class Logger:
                 file_level=file_level,
                 file_path=file_path)
 
-        self.__params = params
+        self.__params = deepcopy(params)
 
         stdo_level = params.stdo_level
         file_level = params.file_level

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

@@ -44,7 +44,7 @@ def logger(
         file_level='info',
         file_path=f'{tmp_path}/test.log')
 
-    return Logger(params=params)
+    return Logger(params)
 
 
 

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

@@ -7,9 +7,11 @@ is permitted, for more information consult the project license file.
 
 
 
+from copy import deepcopy
 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
@@ -17,6 +19,7 @@ from cryptography.fernet import Fernet
 from ..types.strings import SEMPTY
 
 if TYPE_CHECKING:
+    from .params import CryptParams
     from .params import CryptsParams
 
 
@@ -53,13 +56,18 @@ class Crypts:
 
     def __init__(
         self,
-        params: 'CryptsParams',
+        params: Optional['CryptsParams'] = None,
     ) -> None:
         """
         Initialize instance for class using provided parameters.
         """
 
-        self.__params = params
+        from .params import CryptsParams
+
+        if params is None:
+            params = CryptsParams()
+
+        self.__params = deepcopy(params)
 
 
     @property
@@ -90,6 +98,9 @@ class Crypts:
 
         phrases = self.params.phrases
 
+        if unique not in phrases:
+            raise ValueError('unique')
+
         phrase = phrases[unique].phrase
 
         encrypt = (
@@ -134,6 +145,44 @@ class Crypts:
             .decode())
 
 
+    def create(
+        self,
+        unique: str,
+        params: 'CryptParams',
+    ) -> None:
+        """
+        Create a new phrase using the provided input parameters.
+
+        :param unique: Unique identifier of mapping passphrase.
+        :param params: Parameters for instantiating the instance.
+        """
+
+        phrases = self.params.phrases
+
+        if unique in phrases:
+            raise ValueError('unique')
+
+        phrases[unique] = params
+
+
+    def delete(
+        self,
+        unique: str,
+    ) -> None:
+        """
+        Delete the phrase from the internal dictionary reference.
+
+        :param unique: Unique identifier of mapping passphrase.
+        """
+
+        phrases = self.params.phrases
+
+        if unique not in phrases:
+            raise ValueError('unique')
+
+        del phrases[unique]
+
+
     @classmethod
     def keygen(
         cls: object,

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

@@ -33,4 +33,4 @@ class CryptsParams(BaseModel, extra='forbid'):
         Parameter is picked up by autodoc, please ignore.
     """
 
-    phrases: dict[str, CryptParams]
+    phrases: dict[str, CryptParams] = {}

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

@@ -14,6 +14,7 @@ from pytest import mark
 from pytest import raises
 
 from ..crypts import Crypts
+from ..params import CryptParams
 from ..params import CryptsParams
 from ...types import inrepr
 from ...types import instr
@@ -35,7 +36,7 @@ def crypts() -> Crypts:
     params = CryptsParams(
         phrases=source)
 
-    return Crypts(params=params)
+    return Crypts(params)
 
 
 
@@ -103,6 +104,28 @@ def test_Crypts_iterate(
 
 
 
+def test_Crypts_cover(
+    crypts: Crypts,
+) -> None:
+    """
+    Perform various tests associated with relevant routines.
+
+    :param crypts: Primary class instance for the encryption.
+    """
+
+
+    crypts = Crypts()
+
+
+    params = CryptParams(
+        phrase=Crypts.keygen())
+
+    crypts.create('testing', params)
+
+    crypts.delete('testing')
+
+
+
 def test_Crypts_raises(
     crypts: Crypts,
 ) -> None:
@@ -113,6 +136,16 @@ def test_Crypts_raises(
     """
 
 
+    _raises = raises(ValueError)
+
+    with _raises as reason:
+        crypts.encrypt('foo', 'dne')
+
+    _reason = str(reason.value)
+
+    assert _reason == 'unique'
+
+
     _raises = raises(ValueError)
 
     with _raises as reason:
@@ -132,3 +165,25 @@ def test_Crypts_raises(
     _reason = str(reason.value)
 
     assert _reason == 'version'
+
+
+    _raises = raises(ValueError)
+
+    params = CryptParams(phrase='foo')
+
+    with _raises as reason:
+        crypts.create('default', params)
+
+    _reason = str(reason.value)
+
+    assert _reason == 'unique'
+
+
+    _raises = raises(ValueError)
+
+    with _raises as reason:
+        crypts.delete('dne')
+
+    _reason = str(reason.value)
+
+    assert _reason == 'unique'

{encommon-0.11.0 → encommon-0.12.0}/encommon/times/params.py

@@ -68,7 +68,7 @@ class TimersParams(BaseModel, extra='forbid'):
         Parameter is picked up by autodoc, please ignore.
     """
 
-    timers: dict[str, TimerParams]
+    timers: dict[str, TimerParams] = {}
 
 
 
@@ -117,7 +117,7 @@ class WindowParams(BaseModel, extra='forbid'):
             stop = Times(stop)
 
         if anchor is not None:
-            anchor = Times(stop)
+            anchor = Times(anchor)
 
         if delay is not None:
             delay = float(delay)
@@ -152,4 +152,4 @@ class WindowsParams(BaseModel, extra='forbid'):
         Parameter is picked up by autodoc, please ignore.
     """
 
-    windows: dict[str, WindowParams]
+    windows: dict[str, WindowParams] = {}

{encommon-0.11.0 → encommon-0.12.0}/encommon/times/test/test_timers.py

@@ -8,6 +8,7 @@ is permitted, for more information consult the project license file.
 
 
 from pathlib import Path
+from time import sleep
 from typing import Any
 
 from pytest import fixture
@@ -16,6 +17,7 @@ from pytest import raises
 from ..params import TimerParams
 from ..params import TimersParams
 from ..timers import Timers
+from ..timers import TimersTable
 from ..times import Times
 from ...types import inrepr
 from ...types import instr
@@ -33,40 +35,45 @@ def timers(
     :returns: Newly constructed instance of related class.
     """
 
+
     source: dict[str, Any] = {
         'one': {'timer': 1},
         'two': {'timer': 1}}
 
+
     params = TimersParams(
         timers=source)
 
+    store = (
+        f'sqlite:///{tmp_path}'
+        '/cache.db')
+
     timers = Timers(
         params,
-        file=f'{tmp_path}/cache.db')
-
-    sqlite = timers.sqlite
-
-    sqlite.execute(
-        """
-        insert into timers
-        ("group", "unique",
-         "update")
-        values (
-         "default", "two",
-         "1970-01-01T00:00:00Z")
-        """)  # noqa: LIT003
-
-    sqlite.execute(
-        """
-        insert into timers
-        ("group", "unique",
-         "update")
-        values (
-         "default", "tre",
-         "1970-01-01T00:00:00Z")
-        """)  # noqa: LIT003
-
-    sqlite.commit()
+        store=store)
+
+    session = timers.store_session
+
+
+    timer = TimersTable(
+        group='default',
+        unique='two',
+        update='1970-01-01T00:00:00Z')
+
+    session.add(timer)
+
+    session.commit()
+
+
+    timer = TimersTable(
+        group='default',
+        unique='tre',
+        update='1970-01-01T00:00:00Z')
+
+    session.add(timer)
+
+    session.commit()
+
 
     timers.load_children()
 
@@ -88,10 +95,10 @@ def test_Timers(
 
     assert attrs == [
         '_Timers__params',
-        '_Timers__sqlite',
-        '_Timers__file',
-        '_Timers__table',
+        '_Timers__store',
         '_Timers__group',
+        '_Timers__store_engine',
+        '_Timers__store_session',
         '_Timers__timers']
 
 
@@ -108,13 +115,13 @@ def test_Timers(
 
     assert timers.params is not None
 
-    assert timers.sqlite is not None
+    assert timers.store[:6] == 'sqlite'
 
-    assert timers.file[-8:] == 'cache.db'
+    assert timers.group == 'default'
 
-    assert timers.table == 'timers'
+    assert timers.store_engine is not None
 
-    assert timers.group == 'default'
+    assert timers.store_session is not None
 
     assert len(timers.children) == 2
 
@@ -140,35 +147,23 @@ def test_Timers_cover(
     """
 
 
-    assert not timers.ready('one')
-
     assert timers.ready('two')
 
-
     timers.update('two', 'now')
 
     assert not timers.ready('two')
 
-    timers.load_children()
-
-    assert timers.ready('two')
-
-
-    timers.update('two', 'now')
 
-    assert not timers.ready('two')
+    timers = Timers()
 
-    timers.save_children()
-    timers.load_children()
 
-    assert not timers.ready('two')
+    params = TimerParams(timer=1)
 
+    timers.create('fur', params)
 
-    params = TimerParams(
-        timer=1,
-        start='-1s')
+    assert not timers.ready('fur')
 
-    timers.create('fur', params)
+    sleep(1)
 
     assert timers.ready('fur')
 

{encommon-0.11.0 → encommon-0.12.0}/encommon/times/test/test_windows.py

@@ -8,6 +8,7 @@ is permitted, for more information consult the project license file.
 
 
 from pathlib import Path
+from time import sleep
 from typing import Any
 
 from pytest import fixture
@@ -16,6 +17,7 @@ from pytest import raises
 from ..params import WindowParams
 from ..params import WindowsParams
 from ..windows import Windows
+from ..windows import WindowsTable
 from ...types import inrepr
 from ...types import instr
 
@@ -32,6 +34,7 @@ def windows(
     :returns: Newly constructed instance of related class.
     """
 
+
     source: dict[str, Any] = {
         'one': WindowParams(
             window='* * * * *',
@@ -44,46 +47,46 @@ def windows(
             stop=620,
             delay=10)}
 
+
     params = WindowsParams(
         windows=source)
 
+    store = (
+        f'sqlite:///{tmp_path}'
+        '/cache.db')
+
     windows = Windows(
         params,
         start=310,
         stop=610,
-        file=f'{tmp_path}/cache.db')
-
-    sqlite = windows.sqlite
-
-    sqlite.execute(
-        """
-        insert into windows
-        ("group", "unique",
-         "last", "next",
-         "update")
-        values (
-         "default", "two",
-         "1970-01-01T00:06:00Z",
-         "1970-01-01T00:07:00Z",
-         "1970-01-01T01:00:00Z")
-        """)  # noqa: LIT003
-
-    sqlite.commit()
-
-    sqlite.execute(
-        """
-        insert into windows
-        ("group", "unique",
-         "last", "next",
-         "update")
-        values (
-         "default", "tre",
-         "1970-01-01T00:06:00Z",
-         "1970-01-01T00:07:00Z",
-         "1970-01-01T01:00:00Z")
-        """)  # noqa: LIT003
-
-    sqlite.commit()
+        store=store)
+
+    session = windows.store_session
+
+
+    window = WindowsTable(
+        group='default',
+        unique='two',
+        last='1970-01-01T00:06:00Z',
+        next='1970-01-01T00:07:00Z',
+        update='1970-01-01T01:00:00Z')
+
+    session.add(window)
+
+    session.commit()
+
+
+    window = WindowsTable(
+        group='default',
+        unique='tre',
+        last='1970-01-01T00:06:00Z',
+        next='1970-01-01T00:07:00Z',
+        update='1970-01-01T01:00:00Z')
+
+    session.add(window)
+
+    session.commit()
+
 
     windows.load_children()
 
@@ -105,12 +108,12 @@ def test_Windows(
 
     assert attrs == [
         '_Windows__params',
+        '_Windows__store',
+        '_Windows__group',
+        '_Windows__store_engine',
+        '_Windows__store_session',
         '_Windows__start',
         '_Windows__stop',
-        '_Windows__sqlite',
-        '_Windows__file',
-        '_Windows__table',
-        '_Windows__group',
         '_Windows__windows']
 
 
@@ -127,19 +130,19 @@ def test_Windows(
 
     assert windows.params is not None
 
-    assert windows.start == (
-        '1970-01-01T00:05:10Z')
+    assert windows.store[:6] == 'sqlite'
 
-    assert windows.stop == (
-        '1970-01-01T00:10:10Z')
+    assert windows.group == 'default'
 
-    assert windows.sqlite is not None
+    assert windows.store_engine is not None
 
-    assert windows.file[-8:] == 'cache.db'
+    assert windows.store_session is not None
 
-    assert windows.table == 'windows'
+    assert windows.start == (
+        '1970-01-01T00:05:10Z')
 
-    assert windows.group == 'default'
+    assert windows.stop == (
+        '1970-01-01T00:10:10Z')
 
     assert len(windows.children) == 2
 
@@ -173,37 +176,22 @@ def test_Windows_cover(
     """
 
 
-    assert windows.ready('one')
-
     assert windows.ready('two')
 
-
     windows.update('two', '+1h')
 
     assert not windows.ready('two')
 
-    windows.load_children()
 
-    assert windows.ready('two')
+    windows = Windows()
 
+    params = WindowParams(window=1)
 
-    windows.update('two', '+1h')
-
-    assert not windows.ready('two')
-
-    windows.save_children()
-    windows.load_children()
-
-    assert not windows.ready('two')
-
+    windows.create('fur', params)
 
-    params = WindowParams(
-        window='* * * * *',
-        start=310,
-        stop=610,
-        delay=10)
+    assert not windows.ready('fur')
 
-    windows.create('fur', params)
+    sleep(2)
 
     assert windows.ready('fur')