encommon 0.22.8__py3-none-any.whl → 0.22.10__py3-none-any.whl

encommon/times/windows.py

@@ -8,8 +8,13 @@ is permitted, for more information consult the project license file.
 
 
 from copy import deepcopy
+from threading import Lock
+from typing import Annotated
 from typing import Optional
 from typing import TYPE_CHECKING
+from typing import Type
+
+from pydantic import Field
 
 from sqlalchemy import Column
 from sqlalchemy import String
@@ -23,6 +28,8 @@ from .common import PARSABLE
 from .params import WindowsParams
 from .time import Time
 from .window import Window
+from ..types import BaseModel
+from ..types import DictStrAny
 
 if TYPE_CHECKING:
     from .params import WindowParams
@@ -33,17 +40,7 @@ WINDOWS = dict[str, Window]
 
 
 
-class SQLBase(DeclarativeBase):
-    """
-    Some additional class that SQLAlchemy requires to work.
-
-    .. note::
-       Input parameters are not defined, check parent class.
-    """
-
-
-
-class WindowsTable(SQLBase):
+class WindowsTable(DeclarativeBase):
     """
     Schematic for the database operations using SQLAlchemy.
 
@@ -73,7 +70,83 @@ class WindowsTable(SQLBase):
         String,
         nullable=False)
 
-    __tablename__ = 'windows'
+
+
+class WindowsRecord(BaseModel):
+    """
+    Contain the information of the record from the database.
+
+    :param record: Record from the SQLAlchemy query routine.
+    """
+
+    group: Annotated[
+        str,
+        Field(...,
+              description='Group the children by category',
+              min_length=1)]
+
+    unique: Annotated[
+        str,
+        Field(...,
+              description='Unique identifier for the child',
+              min_length=1)]
+
+    last: Annotated[
+        str,
+        Field(...,
+              description='Last schedule for the period',
+              min_length=20,
+              max_length=32)]
+
+    next: Annotated[
+        str,
+        Field(...,
+              description='Next schedule for the period',
+              min_length=20,
+              max_length=32)]
+
+    update: Annotated[
+        str,
+        Field(...,
+              description='When the record was updated',
+              min_length=20,
+              max_length=32)]
+
+
+    def __init__(
+        self,
+        record: Optional[DeclarativeBase] = None,
+    ) -> None:
+        """
+        Initialize instance for class using provided parameters.
+        """
+
+        fields = [
+            'group',
+            'unique',
+            'last',
+            'next',
+            'update']
+
+        params = {
+            x: getattr(record, x)
+            for x in fields}
+
+
+        timefs = [
+            'last',
+            'next',
+            'update']
+
+        params |= {
+            k: (Time(v).simple
+                if v else None)
+            for k, v in
+            params.items()
+            if k in timefs}
+
+
+        super().__init__(**params)
 
 
 
@@ -108,6 +181,8 @@ class Windows:
 
     __store: str
     __group: str
+    __table: Type[WindowsTable]
+    __locker: Lock
 
     __sengine: Engine
     __session: (
@@ -117,16 +192,17 @@ class Windows:
     __start: Time
     __stop: Time
 
-    __windows: WINDOWS
+    __childs: WINDOWS
 
 
-    def __init__(
+    def __init__(  # noqa: CFQ002
         self,
         params: Optional['WindowsParams'] = None,
         start: PARSABLE = 'now',
         stop: PARSABLE = '3000-01-01',
         *,
         store: str = 'sqlite:///:memory:',
+        table: str = 'windows',
         group: str = 'default',
     ) -> None:
         """
@@ -144,7 +220,17 @@ class Windows:
         self.__store = store
         self.__group = group
 
-        self.__make_engine()
+        class SQLBase(DeclarativeBase):
+            pass
+
+        self.__table = type(
+            f'encommon_windows_{table}',
+            (SQLBase, WindowsTable),
+            {'__tablename__': table})
+
+        self.__locker = Lock()
+
+        self.__build_engine()
 
 
         start = Time(start)
@@ -156,12 +242,12 @@ class Windows:
         self.__stop = stop
 
 
-        self.__windows = {}
+        self.__childs = {}
 
-        self.load_children()
+        self.__build_objects()
 
 
-    def __make_engine(
+    def __build_engine(
         self,
     ) -> None:
         """
@@ -172,7 +258,7 @@ class Windows:
             self.__store,
             pool_pre_ping=True)
 
-        (SQLBase.metadata
+        (self.__table.metadata
          .create_all(sengine))
 
         session = (
@@ -182,6 +268,23 @@ class Windows:
         self.__session = session
 
 
+    def __build_objects(
+        self,
+    ) -> None:
+        """
+        Construct instances using the configuration parameters.
+        """
+
+        params = self.__params
+
+        items = (
+            params.windows
+            .items())
+
+        for name, item in items:
+            self.create(name, item)
+
+
     @property
     def params(
         self,
@@ -221,6 +324,19 @@ class Windows:
         return self.__group
 
 
+    @property
+    def store_table(
+        self,
+    ) -> Type[WindowsTable]:
+        """
+        Return the value for the attribute from class instance.
+
+        :returns: Value for the attribute from class instance.
+        """
+
+        return self.__table
+
+
     @property
     def store_engine(
         self,
@@ -283,152 +399,146 @@ class Windows:
         :returns: Value for the attribute from class instance.
         """
 
-        return dict(self.__windows)
+        return dict(self.__childs)
 
 
-    def load_children(
+    def save_children(
         self,
     ) -> None:
         """
-        Construct the children instances for the primary class.
+        Save the child caches from the attribute into database.
         """
 
-        params = self.__params
-        windows = self.__windows
-
-        start = self.__start
-        stop = self.__stop
+        sess = self.__session()
+        lock = self.__locker
 
+        table = self.__table
         group = self.__group
-
-        session = self.store_session
-
-        config = params.windows
+        childs = self.__childs
 
 
-        _table = WindowsTable
-        _group = _table.group
-        _unique = _table.unique
+        inserts: list[DictStrAny] = []
 
-        query = (
-            session.query(_table)
-            .filter(_group == group)
-            .order_by(_unique))
+        update = Time('now')
 
-        for record in query.all():
 
-            unique = str(record.unique)
-            next = str(record.next)
+        items = childs.items()
 
-            if unique not in config:
-                continue
+        for unique, cache in items:
 
-            _config = config[unique]
+            _last = cache.last.subsec
+            _next = cache.next.subsec
+            _update = update.subsec
 
-            _config.start = next
-            _config.anchor = next
+            inputs: DictStrAny = {
+                'group': group,
+                'unique': unique,
+                'last': _last,
+                'next': _next,
+                'update': _update}
 
+            inserts.append(inputs)
 
-        items = config.items()
 
-        for key, value in items:
+        with lock, sess as session:
 
-            if key in windows:
+            for insert in inserts:
 
-                window = windows[key]
+                session.merge(
+                    table(**insert))
 
-                window.update(value.start)
+            session.commit()
 
-                continue
 
-            _start = (
-                value.start or start)
-
-            _stop = (
-                value.stop or stop)
+    def ready(
+        self,
+        unique: str,
+        update: bool = True,
+    ) -> bool:
+        """
+        Determine whether or not the appropriate time has passed.
 
-            if _start < start:
-                _start = start
+        :param unique: Unique identifier for the related child.
+        :param update: Determines whether or not time is updated.
+        :returns: Boolean indicating whether enough time passed.
+        """
 
-            if _stop > stop:
-                _stop = stop
+        childs = self.__childs
 
-            _anchor = (
-                value.anchor or _start)
+        if unique not in childs:
+            raise ValueError('unique')
 
-            window = Window(
-                value.window,
-                start=_start,
-                stop=_stop,
-                anchor=_anchor,
-                delay=value.delay)
+        child = childs[unique]
 
-            windows[key] = window
+        ready = child.ready(update)
 
+        if ready is True:
+            self.save_children()
 
-        self.__windows = windows
+        return ready
 
 
-    def save_children(
+    def pause(
         self,
-    ) -> None:
+        unique: str,
+        update: bool = True,
+    ) -> bool:
         """
-        Save the child caches from the attribute into database.
+        Determine whether or not the appropriate time has passed.
+
+        :param unique: Unique identifier for the related child.
+        :param update: Determines whether or not time is updated.
+        :returns: Boolean indicating whether enough time passed.
         """
 
-        windows = self.__windows
+        return not self.ready(
+            unique, update)
 
-        group = self.__group
 
-        session = self.store_session
+    def select(
+        self,
+        unique: str,
+    ) -> Optional[WindowsRecord]:
+        """
+        Return the record from within the table in the database.
 
+        :returns: Record from within the table in the database.
+        """
 
-        items = windows.items()
+        sess = self.__session()
+        lock = self.__locker
 
-        for unique, window in items:
+        table = self.__table
+        model = WindowsRecord
 
-            update = Time('now')
+        table = self.__table
+        group = self.__group
 
-            append = WindowsTable(
-                group=group,
-                unique=unique,
-                last=window.last.subsec,
-                next=window.next.subsec,
-                update=update.subsec)
+        _unique = table.unique
+        _group = table.group
 
-            session.merge(append)
 
+        with lock, sess as session:
 
-        session.commit()
-        session.close()
+            query = (
+                session.query(table)
+                .filter(_unique == unique)
+                .filter(_group == group))
 
+            _records = list(query.all())
 
-    def ready(
-        self,
-        unique: str,
-        update: bool = True,
-    ) -> bool:
-        """
-        Determine whether or not the appropriate time has passed.
-
-        :param unique: Unique identifier for the related child.
-        :param update: Determines whether or not time is updated.
-        :returns: Boolean indicating whether enough time passed.
-        """
-
-        windows = self.__windows
 
-        if unique not in windows:
-            raise ValueError('unique')
+        records = [
+            model(x)
+            for x in _records]
 
-        window = windows[unique]
 
-        ready = window.ready(update)
+        if len(records) == 0:
+            return None
 
-        if ready is True:
-            self.save_children()
+        assert len(records) == 1
 
-        return ready
+        return records[0]
 
 
     def create(
@@ -444,20 +554,58 @@ class Windows:
         :returns: Newly constructed instance of related class.
         """
 
-        config = (
-            self.params
-            .windows)
+        childs = self.__childs
+        _start = self.__start
+        _stop = self.__stop
 
-        if unique in config:
+        if unique in childs:
             raise ValueError('unique')
 
-        config[unique] = params
+        window = params.window
+        start = params.start
+        stop = params.stop
+        anchor = params.anchor
+        delay = params.delay
+
+
+        select = self.select(unique)
+
+        if select is not None:
+            start = select.next
+            anchor = select.next
+
+
+        child_start = Time(
+            start if start
+            else _start)
+
+        child_stop = Time(
+            stop if stop
+            else _stop)
+
+        anchor = anchor or start
+
+
+        if child_start < _start:
+            child_start = _start
+
+        if child_stop > _stop:
+            child_stop = _stop
+
+
+        child = Window(
+            window=window,
+            start=child_start,
+            stop=child_stop,
+            anchor=anchor,
+            delay=delay)
+
+        childs[unique] = child
 
-        self.load_children()
 
         self.save_children()
 
-        return self.children[unique]
+        return child
 
 
     def update(
@@ -472,14 +620,14 @@ class Windows:
         :param value: Override the time updated for window value.
         """
 
-        windows = self.__windows
+        childs = self.__childs
 
-        if unique not in windows:
+        if unique not in childs:
             raise ValueError('unique')
 
-        window = windows[unique]
+        child = childs[unique]
 
-        window.update(value)
+        child.update(value)
 
         self.save_children()
 
@@ -498,32 +646,26 @@ class Windows:
         :param unique: Unique identifier for the related child.
         """
 
-        params = self.__params
-        windows = self.__windows
+        sess = self.__session()
+        lock = self.__locker
+        childs = self.__childs
 
+        table = self.__table
         group = self.__group
 
-        session = self.store_session
-
-        config = params.windows
-
-
-        if unique in config:
-            del config[unique]
+        _unique = table.unique
+        _group = table.group
 
-        if unique in windows:
-            del windows[unique]
 
+        with lock, sess as session:
 
-        _table = WindowsTable
-        _group = _table.group
-        _unique = _table.unique
+            (session.query(table)
+             .filter(_unique == unique)
+             .filter(_group == group)
+             .delete())
 
-        (session.query(_table)
-         .filter(_unique == unique)
-         .filter(_group == group)
-         .delete())
+            session.commit()
 
 
-        session.commit()
-        session.close()
+        if unique in childs:
+            del childs[unique]

encommon/version.txt

@@ -1 +1 @@
-0.22.8
+0.22.10

{encommon-0.22.8.dist-info → encommon-0.22.10.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: encommon
-Version: 0.22.8
+Version: 0.22.10
 Summary: Enasis Network Common Library
 License: MIT
 Project-URL: Source, https://github.com/enasisnetwork/encommon

{encommon-0.22.8.dist-info → encommon-0.22.10.dist-info}/RECORD

@@ -1,7 +1,7 @@
 encommon/__init__.py,sha256=YDGzuhpk5Gd1hq54LI0hw1NrrDvrJDrvH20TEy_0l5E,443
 encommon/conftest.py,sha256=I7Zl2cMytnA-mwSPh0rRjsU0YSlES94jQq6mocRhVUE,1884
 encommon/py.typed,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
-encommon/version.txt,sha256=PWO17KUk16MCfu9n1dOBerjjrIJCvNcG3hxrb1RUDCY,7
+encommon/version.txt,sha256=Wq9IWpzuJ4CrvFmxsUki3zG6ICOaWS0zYSOJ3mERGuo,8
 encommon/colors/__init__.py,sha256=XRiGimMj8oo040NO5a5ZsbsIUxaGVW4tf4xWTPWgnZY,269
 encommon/colors/color.py,sha256=vdOqOsJYJcrGq0b4udegrn4E8gcuVGx6iTRg3_s8Z-Q,11798
 encommon/colors/test/__init__.py,sha256=PjrnBYT0efyvbaGeNx94dm3tP3EVHUHSVs-VGeLEv5g,218
@@ -36,25 +36,25 @@ encommon/times/__init__.py,sha256=QX4iuZ59UlsMbEWbubnVJXJtrOubNxAAAv510urcLUA,97
 encommon/times/common.py,sha256=tLlQUKU-KMrf1Dy_9qgg2J-8ytVpyqPs5ZXV9_TlvVk,1036
 encommon/times/duration.py,sha256=ffmzBHGZvUucactH6yjUZGrvG6VEuAgMUgdvuEkKMhU,10785
 encommon/times/params.py,sha256=qg0mLkXVsl54m72kd9uXRvmYKqUR_Ag5PBfnTsrwQhE,4360
-encommon/times/parse.py,sha256=_PF12z-UOa75SyeUpBXVn7Jjt-c-Pfnzt6pAs_PjXmQ,6496
+encommon/times/parse.py,sha256=KGHGdtimrqpbyTwjhZUPgXHQqGaeDdxX8t8PrVEbwSc,6626
 encommon/times/time.py,sha256=Px_9Ifae7GKSY557FAbG1g9cwy3a6VZL09puAbinztQ,11745
 encommon/times/timer.py,sha256=xxS6KVXFuRLq-RkXWMR7MMX5x0HGrEhLlOhRCecuCZY,3225
-encommon/times/timers.py,sha256=4kRUd_posGCLSi6hW8aBDypNgnUjnfkbuKpAr4mjOLg,9815
+encommon/times/timers.py,sha256=DMcLJB5x_KLSicp-vuxYkAfwfgFMnLMXQOHebi_VWno,12252
 encommon/times/unitime.py,sha256=MwYUJBdX_Rj7pW8QoMtZMUyHa4lsdZKryTdBCpVjnpY,1316
 encommon/times/utils.py,sha256=PJ5QsKb3_pYEnD3Sz81d8QDhYQtTIj4HJfMoC9gNwmo,3100
 encommon/times/window.py,sha256=_b55R4U5X5oeTS2PbTZHfOaNANl2WM2TRCP4-J6QLnE,8423
-encommon/times/windows.py,sha256=mdoOMF4Igyw-mZGMqr2e4s22iFCijeqamCfiyFrRjlY,10867
+encommon/times/windows.py,sha256=Tfs9SF0PPhecCAA6Ck9IWpSSHu3VGqt0mmmRdoqJ02Y,14071
 encommon/times/test/__init__.py,sha256=PjrnBYT0efyvbaGeNx94dm3tP3EVHUHSVs-VGeLEv5g,218
 encommon/times/test/test_duration.py,sha256=3Tw6Y_ah36GCJl4vZ76z4Jt7rIxcm9P18-A69qsbLjI,4224
 encommon/times/test/test_params.py,sha256=kHvs-WvKfPQCdCDnPU9tAyMVXmzH3eUjwQN-QdWBeh4,1407
 encommon/times/test/test_parse.py,sha256=3Dihhu8xKmgbcq_dqKcO-itAeGtqAJxjGFQ6dPsJ4XM,4210
 encommon/times/test/test_time.py,sha256=XTgtsil2dgkeBUlJyORsNKUapcZWDFvOU-JwtypA6zw,2257
 encommon/times/test/test_timer.py,sha256=cBZvO-k-FG7k4LICLLGVFxNBJuTjH4-eL4FNaa14uyY,1563
-encommon/times/test/test_timers.py,sha256=HePWaNNH4MTDZoa2H-S_XkmN32lZLXW3g5xv-zTCyl0,3881
+encommon/times/test/test_timers.py,sha256=gfRSJ97PTzID9veTqWuqlhzRhWav9aGzqltkPhqJG2I,3977
 encommon/times/test/test_unitime.py,sha256=5i4UjBCw8R9h-Lw963GfB_dHBMEQhjvv1k-t27Wyyls,510
 encommon/times/test/test_utils.py,sha256=WkzHJY6zOt02Ujg5FItOo1nPtktz5ss8ODmG1tRQaaw,2056
 encommon/times/test/test_window.py,sha256=6ySO5DaYzg1bsVNCqB6u71rKWc0vpolxQ09ruoswN2c,6138
-encommon/times/test/test_windows.py,sha256=HTn34YvDS56rAFm6T0fQ0DE7zF2TvWWHJr7hxj6kwz4,4515
+encommon/times/test/test_windows.py,sha256=HCx3SmAgAcuFoAm4YbRVWooKO38fcajul1zf6rsTIUk,4810
 encommon/types/__init__.py,sha256=rly7loMD1R7YU83u90KqPYiifjZAX_UAXpVGcB_Xerk,1269
 encommon/types/classes.py,sha256=FYFTu8Uj-74JWudHOlhaOrsXXPxitorBfM9_QM3EGSU,1689
 encommon/types/dicts.py,sha256=IuLoVdtilhM83ujT74mcz0Zi1HI87P4k7wjnnyMxPag,2821
@@ -131,8 +131,8 @@ encommon/webkit/test/test_moderate.py,sha256=KitKGBtwHOQm0pXXZA5nl9MwAi2pbHOsKhM
 encommon/webkit/test/test_numeric.py,sha256=9Jqiyo-Bh572QJSyd3gqRwYTifnqqzE7_cNCmLn0CG0,3531
 encommon/webkit/test/test_statate.py,sha256=4VvmyJhsK3TSK-hq3TzkzwPkXY-GPTU_7uJf-zG_y_s,1760
 encommon/webkit/test/test_tagues.py,sha256=LQWk6rSBoBxAu-YmUOU8uWNki5RBzk5lp0dbFpySg68,1431
-encommon-0.22.8.dist-info/licenses/LICENSE,sha256=otnXKCtMjPlbHs0wgZ_BWULrp3g_2dWQJ6icRk9nkgg,1071
-encommon-0.22.8.dist-info/METADATA,sha256=y0Sf05hR54o4Ofj2J8LN9jOqN5tiXTzjwA7Qy6np3vY,4304
-encommon-0.22.8.dist-info/WHEEL,sha256=CmyFI0kx5cdEMTLiONQRbGQwjIoR1aIYB7eCAQ4KPJ0,91
-encommon-0.22.8.dist-info/top_level.txt,sha256=bP8q7-5tLDNm-3XPlqn_bDENfYNug5801H_xfz3BEAM,9
-encommon-0.22.8.dist-info/RECORD,,
+encommon-0.22.10.dist-info/licenses/LICENSE,sha256=otnXKCtMjPlbHs0wgZ_BWULrp3g_2dWQJ6icRk9nkgg,1071
+encommon-0.22.10.dist-info/METADATA,sha256=XuW6IBVPYWx6Weg-oBCP_FSG9SAASWlqt6Y-hWOA-nY,4305
+encommon-0.22.10.dist-info/WHEEL,sha256=CmyFI0kx5cdEMTLiONQRbGQwjIoR1aIYB7eCAQ4KPJ0,91
+encommon-0.22.10.dist-info/top_level.txt,sha256=bP8q7-5tLDNm-3XPlqn_bDENfYNug5801H_xfz3BEAM,9
+encommon-0.22.10.dist-info/RECORD,,