encommon 0.11.0__py3-none-any.whl → 0.12.0__py3-none-any.whl

encommon/times/windows.py

@@ -7,37 +7,70 @@ is permitted, for more information consult the project license file.
 
 
 
-from sqlite3 import Connection
-from sqlite3 import connect as SQLite
+from copy import deepcopy
 from typing import Optional
 from typing import TYPE_CHECKING
 
+from sqlalchemy import Column
+from sqlalchemy import String
+from sqlalchemy import create_engine
+from sqlalchemy.engine import Engine
+from sqlalchemy.orm import DeclarativeBase
+from sqlalchemy.orm import Session
+from sqlalchemy.orm import sessionmaker
+
 from .common import PARSABLE
+from .params import WindowsParams
 from .times import Times
 from .window import Window
 
 if TYPE_CHECKING:
     from .params import WindowParams
-    from .params import WindowsParams
 
 
 
-CACHE_TABLE = (
+WINDOWS = dict[str, Window]
+
+
+
+class SQLBase(DeclarativeBase):
+    """
+    Some additional class that SQLAlchemy requires to work.
     """
-    create table if not exists
-     {0} (
-      "group" text not null,
-      "unique" text not null,
-      "last" text not null,
-      "next" text not null,
-      "update" text not null,
-     primary key (
-      "group", "unique"));
-    """)  # noqa: LIT003
 
 
 
-WINDOWS = dict[str, Window]
+class WindowsTable(SQLBase):
+    """
+    Schematic for the database operations using SQLAlchemy.
+
+    .. note::
+       Fields are not completely documented for this model.
+    """
+
+    __tablename__ = 'windows'
+
+    group = Column(
+        String,
+        primary_key=True,
+        nullable=False)
+
+    unique = Column(
+        String,
+        primary_key=True,
+        nullable=False)
+
+    last = Column(
+        String,
+        nullable=False)
+
+    next = Column(
+        String,
+        nullable=False)
+
+    update = Column(
+        String,
+        nullable=False)
 
 
 
@@ -64,42 +97,53 @@ class Windows:
     :param params: Parameters for instantiating the instance.
     :param start: Determine the start for scheduling window.
     :param stop: Determine the ending for scheduling window.
-    :param file: Optional path to file for SQLite database,
-        allowing for state retention between the executions.
-    :param table: Optional override for default table name.
+    :param store: Optional database path for keeping state.
     :param group: Optional override for default group name.
     """
 
     __params: 'WindowsParams'
 
+    __store: str
+    __group: str
+
+    __store_engine: Engine
+    __store_session: (
+        # pylint: disable=unsubscriptable-object
+        sessionmaker[Session])
+
     __start: Times
     __stop: Times
 
-    __sqlite: Connection
-    __file: str
-    __table: str
-    __group: str
-
     __windows: WINDOWS
 
 
-    def __init__(  # noqa: CFQ002
+    def __init__(
         self,
-        params: 'WindowsParams',
+        params: Optional['WindowsParams'] = None,
         start: PARSABLE = 'now',
         stop: PARSABLE = '3000-01-01',
         *,
-        file: str = ':memory:',
-        table: str = 'windows',
+        store: str = 'sqlite:///:memory:',
         group: str = 'default',
     ) -> None:
         """
         Initialize instance for class using provided parameters.
         """
 
+        params = deepcopy(params)
+
+        if params is None:
+            params = WindowsParams()
+
         self.__params = params
 
 
+        self.__store = store
+        self.__group = group
+
+        self.__make_engine()
+
+
         start = Times(start)
         stop = Times(stop)
 
@@ -109,23 +153,29 @@ class Windows:
         self.__stop = stop
 
 
-        sqlite = SQLite(file)
+        self.__windows = {}
 
-        sqlite.execute(
-            CACHE_TABLE
-            .format(table))
+        self.load_children()
 
-        sqlite.commit()
 
-        self.__sqlite = sqlite
-        self.__file = file
-        self.__table = table
-        self.__group = group
+    def __make_engine(
+        self,
+    ) -> None:
+        """
+        Construct instances using the configuration parameters.
+        """
 
+        store = self.__store
 
-        self.__windows = {}
+        engine = create_engine(store)
 
-        self.load_children()
+        (SQLBase.metadata
+         .create_all(engine))
+
+        session = sessionmaker(engine)
+
+        self.__store_engine = engine
+        self.__store_session = session
 
 
     @property
@@ -142,81 +192,81 @@ class Windows:
 
 
     @property
-    def start(
+    def store(
         self,
-    ) -> Times:
+    ) -> str:
         """
         Return the value for the attribute from class instance.
 
         :returns: Value for the attribute from class instance.
         """
 
-        return Times(self.__start)
+        return self.__store
 
 
     @property
-    def stop(
+    def group(
         self,
-    ) -> Times:
+    ) -> str:
         """
         Return the value for the attribute from class instance.
 
         :returns: Value for the attribute from class instance.
         """
 
-        return Times(self.__stop)
+        return self.__group
 
 
     @property
-    def sqlite(
+    def store_engine(
         self,
-    ) -> Connection:
+    ) -> Engine:
         """
         Return the value for the attribute from class instance.
 
         :returns: Value for the attribute from class instance.
         """
 
-        return self.__sqlite
+        return self.__store_engine
 
 
     @property
-    def file(
+    def store_session(
         self,
-    ) -> str:
+    ) -> Session:
         """
         Return the value for the attribute from class instance.
 
         :returns: Value for the attribute from class instance.
         """
 
-        return self.__file
+        return self.__store_session()
 
 
     @property
-    def table(
+    def start(
         self,
-    ) -> str:
+    ) -> Times:
         """
         Return the value for the attribute from class instance.
 
         :returns: Value for the attribute from class instance.
         """
 
-        return self.__table
+        return Times(self.__start)
 
 
     @property
-    def group(
+    def stop(
         self,
-    ) -> str:
+    ) -> Times:
         """
         Return the value for the attribute from class instance.
 
         :returns: Value for the attribute from class instance.
         """
 
-        return self.__group
+        return Times(self.__stop)
 
 
     @property
@@ -245,27 +295,24 @@ class Windows:
         start = self.__start
         stop = self.__stop
 
-        sqlite = self.__sqlite
-        table = self.__table
         group = self.__group
 
+        session = self.store_session
+        table = WindowsTable
 
-        config = params.windows
 
+        config = params.windows
 
-        cursor = sqlite.execute(
-            f"""
-            select * from {table}
-            where "group"="{group}"
-            order by "unique" asc
-            """)  # noqa: LIT003
 
-        records = cursor.fetchall()
+        records = (
+            session.query(table)
+            .filter(table.group == group)
+            .order_by(table.unique))
 
-        for record in records:
+        for record in records.all():
 
-            unique = record[1]
-            next = record[3]
+            unique = str(record.unique)
+            next = str(record.next)
 
             if unique not in config:
                 continue
@@ -284,8 +331,7 @@ class Windows:
 
                 window = windows[key]
 
-                window.update(
-                    value.start)
+                window.update(value.start)
 
                 continue
 
@@ -326,47 +372,28 @@ class Windows:
 
         windows = self.__windows
 
-        sqlite = self.__sqlite
-        table = self.__table
         group = self.__group
 
+        session = self.store_session
 
-        insert = tuple[
-            str,  # group
-            str,  # unique
-            str,  # last
-            str,  # next
-            str]  # update
-
-        inserts: list[insert] = []
 
         items = windows.items()
 
         for unique, window in items:
 
-            append = (
-                group, unique,
-                window.last.subsec,
-                window.next.subsec,
-                Times('now').subsec)
-
-            inserts.append(append)
+            update = Times('now')
 
+            append = WindowsTable(
+                group=group,
+                unique=unique,
+                last=window.last.subsec,
+                next=window.next.subsec,
+                update=update.subsec)
 
-        statement = (
-            f"""
-            replace into {table}
-            ("group", "unique",
-             "next", "last",
-             "update")
-            values (?, ?, ?, ?, ?)
-            """)  # noqa: LIT003
+            session.merge(append)
 
-        sqlite.executemany(
-            statement,
-            tuple(sorted(inserts)))
 
-        sqlite.commit()
+        session.commit()
 
 
     def ready(
@@ -389,7 +416,12 @@ class Windows:
 
         window = windows[unique]
 
-        return window.ready(update)
+        ready = window.ready(update)
+
+        if ready is True:
+            self.save_children()
+
+        return ready
 
 
     def create(
@@ -407,8 +439,6 @@ class Windows:
 
         windows = self.params.windows
 
-        self.save_children()
-
         if unique in windows:
             raise ValueError('unique')
 
@@ -416,6 +446,8 @@ class Windows:
 
         self.load_children()
 
+        self.save_children()
+
         return self.children[unique]
 
 
@@ -438,6 +470,8 @@ class Windows:
 
         window = windows[unique]
 
+        self.save_children()
+
         return window.update(value)
 
 

encommon/version.txt

@@ -1 +1 @@
-0.11.0
+0.12.0

{encommon-0.11.0.dist-info → encommon-0.12.0.dist-info}/METADATA

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

@@ -1,48 +1,48 @@
 encommon/__init__.py,sha256=VoXUcphq-gcXCraaU47EtXBftF6UVuQPMGr0fuCTt9A,525
 encommon/conftest.py,sha256=zoshfXjo2y_NsmWSHErOaTZx7A5tSYxNAhUf4TmUZKE,1827
 encommon/py.typed,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
-encommon/version.txt,sha256=eV1rx5V00q7AOtnP7EBLuVCDyd0hDmUh4NQZl3LSjUQ,7
+encommon/version.txt,sha256=ipMkE9QvlQgvgyNEdlI3mkiF4ygynvyjpn7Jx5PAmUA,7
 encommon/config/__init__.py,sha256=iZdbW7A4m7iN4xt5cEeQqo0Klqs-CaPLdD5ocLmUYi8,856
-encommon/config/config.py,sha256=Pk-ds6cBdRK73k4gi3w6IZSbidSLI7qod5WC4t44Srw,5405
+encommon/config/config.py,sha256=ldq1LfXGq0kfZwmlWE9mGG_hCdRuLT98QyLqnZY6ms8,5312
 encommon/config/files.py,sha256=ueXiKTOqlQ4GKUT9lLyOlE-tfr6QAkSxdUs0VPbwEnE,2385
-encommon/config/logger.py,sha256=z3UQdwpU81aC_QVkg994_f82jl9D_RZcx7Af9V2_1cQ,14105
+encommon/config/logger.py,sha256=qNizCbFNWtgb2tISJRiVx_KvNnS67mkkRrEgVzx6J_o,14141
 encommon/config/params.py,sha256=4bQ7Zz9DMLa5MrYtr89LuEkp0gAAsh7qG-b2wsSDLzI,2311
 encommon/config/paths.py,sha256=f0JDqkmd1xVd9KJ6s0b5KaFk-N6MlOjz4n1W39A5JHM,2533
 encommon/config/utils.py,sha256=VzTpBSZ-l6codt6vk4p4SpcmKk-H1OBy-9IUBPKP3t4,2039
 encommon/config/test/__init__.py,sha256=i0JAeRcM-0YH2StGfwpaDbZV9dVribNSgFDcYcPPay8,313
 encommon/config/test/test_config.py,sha256=POup-M0oIuCSceUDV1tkSCmv0bwKQS_wgFzesUgIgNM,2440
 encommon/config/test/test_files.py,sha256=qJgavSxTxilHOnGzfF6fBpViOmKFGcBdupOIRhDsXuk,2295
-encommon/config/test/test_logger.py,sha256=FVwVJ7qcsToK_ZyWNaMWHr-wPtXPx2osoZz86HlKuwA,5253
+encommon/config/test/test_logger.py,sha256=6X_ZYhKExvZsXo2o8FXneYi1uUekSj-t_B3u5wmeIDM,5246
 encommon/config/test/test_paths.py,sha256=jCrSEnPkZprsJSvolsfTKoyuYqxqyQdDymL9yk3elvQ,2633
 encommon/config/test/test_utils.py,sha256=RePpMD97HRCTkZ75ES8Eaf6_BOpcw_DknpgCFZGlQYg,1066
 encommon/crypts/__init__.py,sha256=UsGEitz8rWa7DQF3iAxEbTUAbdiEnE87LSuRs4OBeAQ,371
-encommon/crypts/crypts.py,sha256=1M7_U3HHYkfQHCeD-ZGa8N0isOxusc_Cr5xhTs11aFg,3516
+encommon/crypts/crypts.py,sha256=fD6dXqRZ_-mHv2CX3vDBAh-Fdhm6d09uA4SEUwSdqnk,4640
 encommon/crypts/hashes.py,sha256=bpQf2-Ma5SdMaEWP2nL1_9rtEQmTE0XTdDvSD-fQ9Mk,3075
-encommon/crypts/params.py,sha256=s4BWuUKsxUmc3dFPMa1pgQ_PDEPnmdOhXyTEVm2YyuQ,918
+encommon/crypts/params.py,sha256=AfuGbFvLPDdfGgday34T1Jb7NzGLi-R7tJQ_f5gVcRk,923
 encommon/crypts/test/__init__.py,sha256=PjrnBYT0efyvbaGeNx94dm3tP3EVHUHSVs-VGeLEv5g,218
-encommon/crypts/test/test_crypts.py,sha256=rBsn92QNvSqK3cvuZfMa7nGRyEbKX1sClH55GkP2cA0,2560
+encommon/crypts/test/test_crypts.py,sha256=gFkCA4-M2DLudP9nBpgU6sSchyWU1gtbvCWe6T0wg5I,3469
 encommon/crypts/test/test_hashes.py,sha256=JYpPit7ISv6u-5-HbC3wSCxuieySDLKawgnE7-xHgTY,1180
 encommon/times/__init__.py,sha256=aa3Wb2WBpZcf_RBgZu4vM3lEyPZhyuZicG5Fcg0DgEI,931
 encommon/times/common.py,sha256=g7kkZLyodZCIPpdiPCZh0-UMHwn-rwCv_Y6gdSvek6k,988
 encommon/times/duration.py,sha256=LTROiKcRXvPcs2Gz9KaB5Cmxo9NXd3TcMo5-jnTxPo0,10794
-encommon/times/params.py,sha256=Ob15P_21w2LoWYjBgteT_xgBNVSfMfx86Yp0luEM-Wk,3741
+encommon/times/params.py,sha256=llTThgIgoaKlAqPhONK1WA5RaDWURISp6XLdXxci0Tw,3753
 encommon/times/parse.py,sha256=DXoT_NyWL2Ea_j3vlGHMDY-5P6NBeYHyGhJoiavgBS0,6144
 encommon/times/timer.py,sha256=19dt7A5nJEUdr_0p3WDFGO-Q49OHt3sgPW4R2zHoScU,2901
-encommon/times/timers.py,sha256=YNT6Ek1v_J0-QTo3_6YDyqjww8bKuw0tNAW9lr2ccR8,8023
+encommon/times/timers.py,sha256=Zwb-sHjIVf6qdkxy08phw7prenXLTRbbfmRCpnE8364,8546
 encommon/times/times.py,sha256=FBOAVY1H21OV4BjGHj6iJrYbGQpSkWPj3Ss2Vepdvu4,9682
 encommon/times/utils.py,sha256=PJ5QsKb3_pYEnD3Sz81d8QDhYQtTIj4HJfMoC9gNwmo,3100
 encommon/times/window.py,sha256=3ctrDd0UWvnwrqxRZf7M-mVeEYVWvet6GZTj17YQ9sU,8526
-encommon/times/windows.py,sha256=PT67OizarogT8l63Wq2AvlQLlrR-W-dJfnYLm2d2QnQ,9639
+encommon/times/windows.py,sha256=HlANd1BB8kJwpRPjHW0zj-0XtP4FvzrEXvdL6Ti1N3k,10137
 encommon/times/test/__init__.py,sha256=PjrnBYT0efyvbaGeNx94dm3tP3EVHUHSVs-VGeLEv5g,218
 encommon/times/test/test_duration.py,sha256=ofCBdQ4-tOKP5W5U2xyTaZrCVvD-dWEgnYoCvZ99MuA,4189
 encommon/times/test/test_params.py,sha256=kHvs-WvKfPQCdCDnPU9tAyMVXmzH3eUjwQN-QdWBeh4,1407
 encommon/times/test/test_parse.py,sha256=ozP8PBgIsqdknK8cEtlYA3KusKnJzbjfAUKhcFv_eFk,4054
 encommon/times/test/test_timer.py,sha256=A5pBmkd1i71LTpG-uA9-9UGNJUK8tkw6by8Adm0AbGE,1400
-encommon/times/test/test_timers.py,sha256=ao7RF_oOTi3CQF3iynKftGI4Sg-oPo_Hx9RvxJi6lBE,4042
+encommon/times/test/test_timers.py,sha256=DxIiX4g7tbub4MAP3Z3-vAES5HbEzjDXMQPSAsIFavA,3845
 encommon/times/test/test_times.py,sha256=vxEtXI9gYFlWnBLsyPyi17a96MJzgcI79SCy8U1Co8I,1748
 encommon/times/test/test_utils.py,sha256=WkzHJY6zOt02Ujg5FItOo1nPtktz5ss8ODmG1tRQaaw,2056
 encommon/times/test/test_window.py,sha256=Sx_fd0J1ofaFx52t-uWz9Isa9KqBxPFnynzfGfiG7uo,6098
-encommon/times/test/test_windows.py,sha256=22Z0LvSpy0s1tV3osUXV-nTmovjpCqVSeKnvyRFPY0A,4936
+encommon/times/test/test_windows.py,sha256=dY7QYQ5BCBfAGotHrmkWkPGjRsI2od-8PbWkPwZ-QIM,4643
 encommon/types/__init__.py,sha256=L1pdigJyPNPEoAkkbCHM9IhmFtU2GjFRxHMRTAnPqKk,667
 encommon/types/dicts.py,sha256=lC2FmPzMEj9L73jUjf3o6OVQ-LqK_3gp5nBwYibdGfo,2265
 encommon/types/empty.py,sha256=n5y5maXkcM3xNYNYGK6iqvk98ivQSeguaedwc0HoMv4,2739
@@ -66,8 +66,8 @@ encommon/utils/test/test_match.py,sha256=QagKpTFdRo23-Y55fSaJrSMpt5jIebScKbz0h8t
 encommon/utils/test/test_paths.py,sha256=1yiZp5PCxljGk0J6fwIfWOUl-KWz40INybrwrN3JIog,1945
 encommon/utils/test/test_sample.py,sha256=sHAeWOL1mchTGYGQaFK_A3Z28tThuULumm9kQebnIdk,1710
 encommon/utils/test/test_stdout.py,sha256=TA7xQuFoPZUYW2l00e04MGp4P9gHkkVxVflvPlhpQXg,4878
-encommon-0.11.0.dist-info/LICENSE,sha256=otnXKCtMjPlbHs0wgZ_BWULrp3g_2dWQJ6icRk9nkgg,1071
-encommon-0.11.0.dist-info/METADATA,sha256=PD5srG41aBZLkqV7YQ00mxTR_hx3Gw_CqcmJ9XWy_Ro,2918
-encommon-0.11.0.dist-info/WHEEL,sha256=GJ7t_kWBFywbagK5eo9IoUwLW6oyOeTKmQ-9iHFVNxQ,92
-encommon-0.11.0.dist-info/top_level.txt,sha256=bP8q7-5tLDNm-3XPlqn_bDENfYNug5801H_xfz3BEAM,9
-encommon-0.11.0.dist-info/RECORD,,
+encommon-0.12.0.dist-info/LICENSE,sha256=otnXKCtMjPlbHs0wgZ_BWULrp3g_2dWQJ6icRk9nkgg,1071
+encommon-0.12.0.dist-info/METADATA,sha256=E10Deqzzz2nz7bUAJNPY0AzAmn2sWwl6b38qS1jk_nI,2944
+encommon-0.12.0.dist-info/WHEEL,sha256=GJ7t_kWBFywbagK5eo9IoUwLW6oyOeTKmQ-9iHFVNxQ,92
+encommon-0.12.0.dist-info/top_level.txt,sha256=bP8q7-5tLDNm-3XPlqn_bDENfYNug5801H_xfz3BEAM,9
+encommon-0.12.0.dist-info/RECORD,,