encommon 0.5.0__tar.gz → 0.6.0__tar.gz

{encommon-0.5.0/encommon.egg-info → encommon-0.6.0}/PKG-INFO

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

{encommon-0.5.0 → encommon-0.6.0}/encommon/config/config.py

@@ -155,9 +155,9 @@ class Config:
         self,
     ) -> Params:
         """
-        Return the configuration in the object format for files.
+        Return the Pydantic model containing the configuration.
 
-        :returns: Configuration in the object format for files.
+        :returns: Pydantic model containing the configuration.
         """
 
         if self.__params is not None:

{encommon-0.5.0 → encommon-0.6.0}/encommon/conftest.py

@@ -21,6 +21,7 @@ def config_path(
     Construct the directory and files needed for the tests.
 
     :param tmp_path: pytest object for temporal filesystem.
+    :returns: New resolved filesystem path object instance.
     """
 
 
@@ -40,4 +41,4 @@ def config_path(
         .write_text('name: Tony Stark'))
 
 
-    return tmp_path
+    return tmp_path.resolve()

{encommon-0.5.0 → encommon-0.6.0}/encommon/times/test/test_timers.py

@@ -7,6 +7,7 @@ is permitted, for more information consult the project license file.
 
 
 
+from pathlib import Path
 from time import sleep
 
 from pytest import raises
@@ -25,8 +26,10 @@ def test_Timers() -> None:
     attrs = list(timers.__dict__)
 
     assert attrs == [
-        '_Timers__timing',
-        '_Timers__caches']
+        '_Timers__timers',
+        '_Timers__cache_file',
+        '_Timers__cache_name',
+        '_Timers__cache_dict']
 
 
     assert repr(timers).startswith(
@@ -36,7 +39,11 @@ def test_Timers() -> None:
         '<encommon.times.timers.Timers')
 
 
-    assert timers.timing == {'one': 1}
+    assert timers.timers == {'one': 1}
+    assert timers.cache_file is not None
+    assert len(timers.cache_dict) == 1
+    assert timers.cache_name is not None
+
 
     assert not timers.ready('one')
     sleep(1.1)
@@ -50,6 +57,42 @@ def test_Timers() -> None:
 
 
 
+def test_Timers_cache(
+    tmp_path: Path,
+) -> None:
+    """
+    Perform various tests associated with relevant routines.
+
+    :param tmp_path: pytest object for temporal filesystem.
+    """
+
+    cache_file = (
+        f'{tmp_path}/timers.db')
+
+    timers1 = Timers(
+        timers={'one': 1},
+        cache_file=cache_file)
+
+    assert not timers1.ready('one')
+
+    sleep(0.75)
+
+    timers2 = Timers(
+        timers={'one': 1},
+        cache_file=cache_file)
+
+    assert not timers1.ready('one')
+    assert not timers2.ready('one')
+
+    sleep(0.25)
+
+    timers2.load_cache()
+
+    assert timers1.ready('one')
+    assert timers2.ready('one')
+
+
+
 def test_Timers_raises() -> None:
     """
     Perform various tests associated with relevant routines.

encommon-0.6.0/encommon/times/timers.py

@@ -0,0 +1,287 @@
+"""
+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 sqlite3 import connect as SQLite
+from typing import Optional
+from typing import TYPE_CHECKING
+
+from .common import NUMERIC
+from .common import PARSABLE
+from .times import Times
+
+if TYPE_CHECKING:
+    from sqlite3 import Connection
+
+
+TABLE = (
+    """
+    create table
+     if not exists
+     {0} (
+      "unique" text not null,
+      "update" text not null,
+     primary key ("unique"));
+    """)  # noqa: LIT003
+
+
+
+class Timers:
+    """
+    Track timers on unique key and determine when to proceed.
+
+    .. warning::
+       This class will use an in-memory database for cache,
+       unless a cache file is explicity defined.
+
+    .. testsetup::
+       >>> from time import sleep
+
+    Example
+    -------
+    >>> timers = Timers({'one': 1})
+    >>> timers.ready('one')
+    False
+    >>> sleep(1)
+    >>> timers.ready('one')
+    True
+
+    :param timers: Seconds that are used for each of timers.
+    :param cache_file: Optional path to SQLite database for
+        cache. This will allow for use between executions.
+    :param cache_name: Optional override default table name.
+    """
+
+    __timers: dict[str, float]
+    __cache_file: 'Connection'
+    __cache_name: str
+    __cache_dict: dict[str, Times]
+
+
+    def __init__(
+        self,
+        timers: Optional[dict[str, NUMERIC]] = None,
+        cache_file: str = ':memory:',
+        cache_name: str = 'encommon_timers',
+    ) -> None:
+        """
+        Initialize instance for class using provided parameters.
+        """
+
+        timers = timers or {}
+
+
+        self.__timers = {
+            k: float(v)
+            for k, v in
+            timers.items()}
+
+
+        cached = SQLite(cache_file)
+
+        cached.execute(
+            TABLE.format(cache_name))
+
+        cached.commit()
+
+        self.__cache_file = cached
+        self.__cache_name = cache_name
+
+
+        self.__cache_dict = {
+            x: Times()
+            for x in
+            self.__timers}
+
+
+        self.load_cache()
+        self.save_cache()
+
+
+    def load_cache(
+        self,
+    ) -> None:
+        """
+        Load the timers cache from the database into attribute.
+        """
+
+        cached = self.__cache_file
+        table = self.__cache_name
+        cachem = self.__cache_dict
+
+        cursor = cached.execute(
+            f'select * from {table}'
+            ' order by "unique" asc')
+
+        records = cursor.fetchall()
+
+        for record in records:
+
+            unique = record[0]
+            update = record[1]
+
+            times = Times(update)
+
+            cachem[unique] = times
+
+
+    def save_cache(
+        self,
+    ) -> None:
+        """
+        Save the timers cache from the attribute into database.
+        """
+
+        cached = self.__cache_file
+        table = self.__cache_name
+        cachem = self.__cache_dict
+
+        insert = [
+            (k, str(v)) for k, v
+            in cachem.items()]
+
+        cached.executemany(
+            (f'replace into {table}'
+             ' ("unique", "update")'
+             ' values (?, ?)'),
+            tuple(insert))
+
+        cached.commit()
+
+
+    @property
+    def timers(
+        self,
+    ) -> dict[str, float]:
+        """
+        Return the property for attribute from the class instance.
+
+        :returns: Property for attribute from the class instance.
+        """
+
+        return dict(self.__timers)
+
+
+    @property
+    def cache_file(
+        self,
+    ) -> 'Connection':
+        """
+        Return the property for attribute from the class instance.
+
+        :returns: Property for attribute from the class instance.
+        """
+
+        return self.__cache_file
+
+
+    @property
+    def cache_dict(
+        self,
+    ) -> dict[str, Times]:
+        """
+        Return the property for attribute from the class instance.
+
+        :returns: Property for attribute from the class instance.
+        """
+
+        return dict(self.__cache_dict)
+
+
+    @property
+    def cache_name(
+        self,
+    ) -> str:
+        """
+        Return the property for attribute from the class instance.
+
+        :returns: Property for attribute from the class instance.
+        """
+
+        return self.__cache_name
+
+
+    def ready(
+        self,
+        unique: str,
+        update: bool = True,
+    ) -> bool:
+        """
+        Determine whether or not the appropriate time has passed.
+
+        .. note::
+           For performance reasons, this method will not notice
+           changes within the database unless refreshed first.
+
+        :param unique: Unique identifier for the timer in mapping.
+        :param update: Determines whether or not time is updated.
+        """
+
+        timers = self.__timers
+        caches = self.__cache_dict
+
+        if unique not in caches:
+            raise ValueError('unique')
+
+        cache = caches[unique]
+        timer = timers[unique]
+
+        ready = cache.elapsed >= timer
+
+        if ready and update:
+            self.update(unique)
+
+        return ready
+
+
+    def update(
+        self,
+        unique: str,
+        started: Optional[PARSABLE] = None,
+    ) -> None:
+        """
+        Update the existing timer from mapping within the cache.
+
+        :param unique: Unique identifier for the timer in mapping.
+        :param started: Override the start time for timer value.
+        """
+
+        caches = self.__cache_dict
+
+        if unique not in caches:
+            raise ValueError('unique')
+
+        caches[unique] = Times(started)
+
+        self.save_cache()
+
+
+    def create(
+        self,
+        unique: str,
+        minimum: int | float,
+        started: Optional[PARSABLE] = None,
+    ) -> None:
+        """
+        Update the existing timer from mapping within the cache.
+
+        :param unique: Unique identifier for the timer in mapping.
+        :param minimum: Determines minimum seconds that must pass.
+        :param started: Determines when the time starts for timer.
+        """
+
+        timers = self.__timers
+        caches = self.__cache_dict
+
+        if unique in caches:
+            raise ValueError('unique')
+
+        timers[unique] = float(minimum)
+        caches[unique] = Times(started)
+
+        self.save_cache()

encommon-0.6.0/encommon/version.txt

@@ -0,0 +1 @@
+0.6.0

{encommon-0.5.0 → encommon-0.6.0/encommon.egg-info}/PKG-INFO

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

{encommon-0.5.0 → encommon-0.6.0}/setup.cfg

@@ -11,6 +11,7 @@ ignore =
 	W503,
 per-file-ignores = 
 	encommon/crypts/hashes.py:S324,
+	encommon/times/timers.py:S608,
 
 [mypy]
 mypy_path = stubs

encommon-0.5.0/encommon/times/timers.py

@@ -1,144 +0,0 @@
-"""
-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 .common import NUMERIC
-from .common import PARSABLE
-from .times import Times
-
-
-
-class Timers:
-    """
-    Track timers on unique key and determine when to proceed.
-
-    .. testsetup::
-       >>> from time import sleep
-
-    Example
-    -------
-    >>> timing = {'test': 1}
-    >>> timers = Timers(timing)
-    >>> timers.ready('test')
-    False
-    >>> sleep(1)
-    >>> timers.ready('test')
-    True
-
-    :param timing: Seconds that are used for each of timers.
-    """
-
-    __timing: dict[str, float]
-    __caches: dict[str, Times]
-
-
-    def __init__(
-        self,
-        timing: Optional[dict[str, NUMERIC]] = None,
-    ) -> None:
-        """
-        Initialize instance for class using provided parameters.
-        """
-
-        timing = timing or {}
-
-        self.__timing = {
-            k: float(v)
-            for k, v in timing.items()}
-
-        self.__caches = {
-            x: Times()
-            for x in self.__timing}
-
-
-    @property
-    def timing(
-        self,
-    ) -> dict[str, float]:
-        """
-        Return the property for attribute from the class instance.
-
-        :returns: Property for attribute from the class instance.
-        """
-
-        return dict(self.__timing)
-
-
-    def ready(
-        self,
-        unique: str,
-        update: bool = True,
-    ) -> bool:
-        """
-        Determine whether or not the appropriate time has passed.
-
-        :param unique: Unique identifier for the timer in mapping.
-        :param update: Determines whether or not time is updated.
-        """
-
-        timer = self.__timing
-        cache = self.__caches
-
-        if unique not in cache:
-            raise ValueError('unique')
-
-        _cache = cache[unique]
-        _timer = timer[unique]
-
-        ready = _cache.elapsed >= _timer
-
-        if ready and update:
-            self.update(unique)
-
-        return ready
-
-
-    def update(
-        self,
-        unique: str,
-        started: Optional[PARSABLE] = None,
-    ) -> None:
-        """
-        Update the existing timer from mapping within the cache.
-
-        :param unique: Unique identifier for the timer in mapping.
-        :param started: Override the start time for timer value.
-        """
-
-        cache = self.__caches
-
-        if unique not in cache:
-            raise ValueError('unique')
-
-        cache[unique] = Times(started)
-
-
-    def create(
-        self,
-        unique: str,
-        minimum: int | float,
-        started: Optional[PARSABLE] = None,
-    ) -> None:
-        """
-        Update the existing timer from mapping within the cache.
-
-        :param unique: Unique identifier for the timer in mapping.
-        :param minimum: Determines minimum seconds that must pass.
-        :param started: Determines when the time starts for timer.
-        """
-
-        timer = self.__timing
-        cache = self.__caches
-
-        if unique in cache:
-            raise ValueError('unique')
-
-        timer[unique] = float(minimum)
-        cache[unique] = Times(started)

encommon-0.5.0/encommon/version.txt

@@ -1 +0,0 @@
-0.5.0