encommon 0.5.0__py3-none-any.whl → 0.6.0__py3-none-any.whl

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/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/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/times/timers.py

@@ -7,59 +7,155 @@ 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
     -------
-    >>> timing = {'test': 1}
-    >>> timers = Timers(timing)
-    >>> timers.ready('test')
+    >>> timers = Timers({'one': 1})
+    >>> timers.ready('one')
     False
     >>> sleep(1)
-    >>> timers.ready('test')
+    >>> timers.ready('one')
     True
 
-    :param timing: Seconds that are used for each of timers.
+    :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.
     """
 
-    __timing: dict[str, float]
-    __caches: dict[str, Times]
+    __timers: dict[str, float]
+    __cache_file: 'Connection'
+    __cache_name: str
+    __cache_dict: dict[str, Times]
 
 
     def __init__(
         self,
-        timing: Optional[dict[str, NUMERIC]] = None,
+        timers: Optional[dict[str, NUMERIC]] = None,
+        cache_file: str = ':memory:',
+        cache_name: str = 'encommon_timers',
     ) -> None:
         """
         Initialize instance for class using provided parameters.
         """
 
-        timing = timing or {}
+        timers = timers or {}
 
-        self.__timing = {
+
+        self.__timers = {
             k: float(v)
-            for k, v in timing.items()}
+            for k, v in
+            timers.items()}
+
+
+        cached = SQLite(cache_file)
+
+        cached.execute(
+            TABLE.format(cache_name))
 
-        self.__caches = {
+        cached.commit()
+
+        self.__cache_file = cached
+        self.__cache_name = cache_name
+
+
+        self.__cache_dict = {
             x: Times()
-            for x in self.__timing}
+            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 timing(
+    def timers(
         self,
     ) -> dict[str, float]:
         """
@@ -68,7 +164,46 @@ class Timers:
         :returns: Property for attribute from the class instance.
         """
 
-        return dict(self.__timing)
+        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(
@@ -79,20 +214,24 @@ class Timers:
         """
         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.
         """
 
-        timer = self.__timing
-        cache = self.__caches
+        timers = self.__timers
+        caches = self.__cache_dict
 
-        if unique not in cache:
+        if unique not in caches:
             raise ValueError('unique')
 
-        _cache = cache[unique]
-        _timer = timer[unique]
+        cache = caches[unique]
+        timer = timers[unique]
 
-        ready = _cache.elapsed >= _timer
+        ready = cache.elapsed >= timer
 
         if ready and update:
             self.update(unique)
@@ -112,12 +251,14 @@ class Timers:
         :param started: Override the start time for timer value.
         """
 
-        cache = self.__caches
+        caches = self.__cache_dict
 
-        if unique not in cache:
+        if unique not in caches:
             raise ValueError('unique')
 
-        cache[unique] = Times(started)
+        caches[unique] = Times(started)
+
+        self.save_cache()
 
 
     def create(
@@ -134,11 +275,13 @@ class Timers:
         :param started: Determines when the time starts for timer.
         """
 
-        timer = self.__timing
-        cache = self.__caches
+        timers = self.__timers
+        caches = self.__cache_dict
 
-        if unique in cache:
+        if unique in caches:
             raise ValueError('unique')
 
-        timer[unique] = float(minimum)
-        cache[unique] = Times(started)
+        timers[unique] = float(minimum)
+        caches[unique] = Times(started)
+
+        self.save_cache()

encommon/version.txt

@@ -1 +1 @@
-0.5.0
+0.6.0

{encommon-0.5.0.dist-info → encommon-0.6.0.dist-info}/METADATA

@@ -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.dist-info → encommon-0.6.0.dist-info}/RECORD

@@ -1,10 +1,10 @@
 encommon/__init__.py,sha256=VoXUcphq-gcXCraaU47EtXBftF6UVuQPMGr0fuCTt9A,525
-encommon/conftest.py,sha256=TNLox448WJSUkG5Lx2PM7LWvLHiaaOvxm6tx6o02pBc,810
+encommon/conftest.py,sha256=z5BMi6KjNuactDRgbh8J8w81V08Ptf6QK2o_bJANRs4,880
 encommon/py.typed,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
-encommon/version.txt,sha256=oK1QZAE5pST4ZZEVcUW_HUZ06pwGW_6iFVjw97BEMMg,6
+encommon/version.txt,sha256=l6XW5UCmEg0Jw53bZn4Ojiusf8wv_vgTuC4I_WA2W84,6
 encommon/config/__init__.py,sha256=2ic7tK2lOQvqWmmQnMozqxCJcbyQ_sSEHmOUDUFan2U,710
 encommon/config/common.py,sha256=gaKBgkF7b7UIAhd0ESio0KpG8JfdRpz5BxNgKRptd6A,2041
-encommon/config/config.py,sha256=pvvz5lzqaXJV-9-8v8XPXVP8vpHiZ9lzGLx05pjW5gk,4855
+encommon/config/config.py,sha256=-wIkyA6YQGAly0WuXLaOYXENjZYRYgWk_VdUN8mMe8Q,4853
 encommon/config/files.py,sha256=2DHz7GKOjF8FC26tY0V-E9svNMrlkSUshb2gfxqGgSo,2313
 encommon/config/logger.py,sha256=2y-VFzgM2pZzEYq48XfvrDPrtUcxyP9QjbH5OG7fv5o,13449
 encommon/config/params.py,sha256=IWQ-UzR8x6VxkcUddC3qhI612IFMfLW44jEjRePXK0c,1825
@@ -26,14 +26,14 @@ encommon/times/__init__.py,sha256=w6LeTybgdsi0oM1EL9ARbAqevX7Tn46JYhbXNAaWzB0,59
 encommon/times/common.py,sha256=xLB_GLahYKT-YrVq90RUzmiodJQ4__1YihgZZTnadgg,2506
 encommon/times/duration.py,sha256=8p-L9OItO80nnd35FYrAXbiUS8RJzavI21lXBrtLaH0,9872
 encommon/times/parse.py,sha256=ZzranxftlB6bZJ1ivkoUxD53TUfXDDUdpq9jsSJN-88,6411
-encommon/times/timers.py,sha256=4p2zJIieZZ8pMaKAv5CQdxUOPjVDd2f9QCpARB8gGnQ,3212
+encommon/times/timers.py,sha256=yOVr6deGE5iatNWUwNQCzaXjMlLeYlolx4MmKT0MSHc,6312
 encommon/times/times.py,sha256=Dfu6ztUsV4X4vHzOC7ds8jtYy0AVj4_R5xB6H-yzemE,9432
 encommon/times/window.py,sha256=Fx_OJfU9B0IctCyaJ5XH_HxzhGlzeRATwuhI-HlsTPA,8023
 encommon/times/test/__init__.py,sha256=PjrnBYT0efyvbaGeNx94dm3tP3EVHUHSVs-VGeLEv5g,218
 encommon/times/test/test_common.py,sha256=nizxgB1scLDEm2o66waK1Ar_Dl5BBMTC-GRV7iDk0_U,1477
 encommon/times/test/test_duration.py,sha256=rmAhW2otHzQDHF0mBSETHnnL2OSbeAFYEHpDlaUSRnI,3901
 encommon/times/test/test_parse.py,sha256=TuZG_UbIEez4Ww35vdKIie_yaKp-PiUhsNmr1ZUoGvo,4308
-encommon/times/test/test_timers.py,sha256=F8asiUbMcIXkSstrOhQ9wrmdM2oTFAAM4sL50eQB4IA,1456
+encommon/times/test/test_timers.py,sha256=z-ONyKtkAZ1A7w8qgpgx07r-Vsl5jY-pe2oneSF7hyo,2314
 encommon/times/test/test_times.py,sha256=DJBmRHCPkMLL9-bmc2DMhhf8zcr2rsTVAAQPavD_UmE,1986
 encommon/times/test/test_window.py,sha256=EWjXR8XREYwKrH-221CBAUwLF9GpvHtuF_CSMdQtUXI,4735
 encommon/types/__init__.py,sha256=l2WKtDs6uC9I3dIGnrzJvz-4JLEETUJOfT509XyMQWs,420
@@ -55,8 +55,8 @@ encommon/utils/test/test_match.py,sha256=QagKpTFdRo23-Y55fSaJrSMpt5jIebScKbz0h8t
 encommon/utils/test/test_paths.py,sha256=0ls9gWJ2B487Dr1fHDDFCZPA7gxtv56nFEYHrTkNX-U,1892
 encommon/utils/test/test_sample.py,sha256=iNV9IxXmA5KJat3jKRiZH3iutHrT6bsibwti60AhICk,1464
 encommon/utils/test/test_stdout.py,sha256=a060uA8oEHFGoVqdwB5iYxdl4R2TRSgr6Z7pMEbxibs,1675
-encommon-0.5.0.dist-info/LICENSE,sha256=otnXKCtMjPlbHs0wgZ_BWULrp3g_2dWQJ6icRk9nkgg,1071
-encommon-0.5.0.dist-info/METADATA,sha256=NJL3BwQ7cUm7Azf7NS1-ttm5v0ST4LW6G9tYD0NlIXA,2671
-encommon-0.5.0.dist-info/WHEEL,sha256=GJ7t_kWBFywbagK5eo9IoUwLW6oyOeTKmQ-9iHFVNxQ,92
-encommon-0.5.0.dist-info/top_level.txt,sha256=bP8q7-5tLDNm-3XPlqn_bDENfYNug5801H_xfz3BEAM,9
-encommon-0.5.0.dist-info/RECORD,,
+encommon-0.6.0.dist-info/LICENSE,sha256=otnXKCtMjPlbHs0wgZ_BWULrp3g_2dWQJ6icRk9nkgg,1071
+encommon-0.6.0.dist-info/METADATA,sha256=OJ2Y0-tAC9HmFKQmrcyR5oQHFAVU1rxD9Rt2ssceXAs,2671
+encommon-0.6.0.dist-info/WHEEL,sha256=GJ7t_kWBFywbagK5eo9IoUwLW6oyOeTKmQ-9iHFVNxQ,92
+encommon-0.6.0.dist-info/top_level.txt,sha256=bP8q7-5tLDNm-3XPlqn_bDENfYNug5801H_xfz3BEAM,9
+encommon-0.6.0.dist-info/RECORD,,