encommon 0.11.1__tar.gz → 0.12.0__tar.gz

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

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: encommon
-Version: 0.11.1
+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.1 → encommon-0.12.0}/encommon/times/test/test_timers.py

@@ -17,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
@@ -34,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()
 
@@ -89,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']
 
 
@@ -109,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
 

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

@@ -17,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
 
@@ -33,6 +34,7 @@ def windows(
     :returns: Newly constructed instance of related class.
     """
 
+
     source: dict[str, Any] = {
         'one': WindowParams(
             window='* * * * *',
@@ -45,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()
 
@@ -106,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']
 
 
@@ -128,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
 

{encommon-0.11.1 → encommon-0.12.0}/encommon/times/timers.py

@@ -8,35 +8,61 @@ is permitted, for more information consult the project license file.
 
 
 from copy import deepcopy
-from sqlite3 import Connection
-from sqlite3 import connect as SQLite
 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 TimersParams
 from .timer import Timer
 from .times import Times
 
 if TYPE_CHECKING:
     from .params import TimerParams
-    from .params import TimersParams
 
 
 
-CACHE_TABLE = (
+TIMERS = dict[str, Timer]
+
+
+
+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,
-      "update" text not null,
-     primary key (
-      "group", "unique"));
-    """)  # noqa: LIT003
 
 
 
-TIMERS = dict[str, Timer]
+class TimersTable(SQLBase):
+    """
+    Schematic for the database operations using SQLAlchemy.
+
+    .. note::
+       Fields are not completely documented for this model.
+    """
+
+    __tablename__ = 'timers'
+
+    group = Column(
+        String,
+        primary_key=True,
+        nullable=False)
+
+    unique = Column(
+        String,
+        primary_key=True,
+        nullable=False)
+
+    update = Column(
+        String,
+        nullable=False)
 
 
 
@@ -65,19 +91,20 @@ class Timers:
     True
 
     :param params: Parameters for instantiating the instance.
-    :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: 'TimersParams'
 
-    __sqlite: Connection
-    __file: str
-    __table: str
+    __store: str
     __group: str
 
+    __store_engine: Engine
+    __store_session: (
+        # pylint: disable=unsubscriptable-object
+        sessionmaker[Session])
+
     __timers: TIMERS
 
 
@@ -85,41 +112,52 @@ class Timers:
         self,
         params: Optional['TimersParams'] = None,
         *,
-        file: str = ':memory:',
-        table: str = 'timers',
+        store: str = 'sqlite:///:memory:',
         group: str = 'default',
     ) -> None:
         """
         Initialize instance for class using provided parameters.
         """
 
-        from .params import TimersParams
+        params = deepcopy(params)
 
         if params is None:
             params = TimersParams()
 
-        self.__params = deepcopy(params)
-
+        self.__params = params
 
-        sqlite = SQLite(file)
 
-        sqlite.execute(
-            CACHE_TABLE
-            .format(table))
-
-        sqlite.commit()
-
-        self.__sqlite = sqlite
-        self.__file = file
-        self.__table = table
+        self.__store = store
         self.__group = group
 
+        self.__make_engine()
+
 
         self.__timers = {}
 
         self.load_children()
 
 
+    def __make_engine(
+        self,
+    ) -> None:
+        """
+        Construct instances using the configuration parameters.
+        """
+
+        store = self.__store
+
+        engine = create_engine(store)
+
+        (SQLBase.metadata
+         .create_all(engine))
+
+        session = sessionmaker(engine)
+
+        self.__store_engine = engine
+        self.__store_session = session
+
+
     @property
     def params(
         self,
@@ -134,20 +172,20 @@ class Timers:
 
 
     @property
-    def sqlite(
+    def store(
         self,
-    ) -> Connection:
+    ) -> str:
         """
         Return the value for the attribute from class instance.
 
         :returns: Value for the attribute from class instance.
         """
 
-        return self.__sqlite
+        return self.__store
 
 
     @property
-    def file(
+    def group(
         self,
     ) -> str:
         """
@@ -156,33 +194,33 @@ class Timers:
         :returns: Value for the attribute from class instance.
         """
 
-        return self.__file
+        return self.__group
 
 
     @property
-    def table(
+    def store_engine(
         self,
-    ) -> str:
+    ) -> Engine:
         """
         Return the value for the attribute from class instance.
 
         :returns: Value for the attribute from class instance.
         """
 
-        return self.__table
+        return self.__store_engine
 
 
     @property
-    def group(
+    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.__group
+        return self.__store_session()
 
 
     @property
@@ -208,27 +246,24 @@ class Timers:
         params = self.__params
         timers = self.__timers
 
-        sqlite = self.__sqlite
-        table = self.__table
         group = self.__group
 
+        session = self.store_session
+        table = TimersTable
 
-        config = params.timers
 
+        config = params.timers
 
-        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]
-            update = record[2]
+            unique = str(record.unique)
+            update = str(record.update)
 
             if unique not in config:
                 continue
@@ -246,8 +281,7 @@ class Timers:
 
                 timer = timers[key]
 
-                timer.update(
-                    value.start)
+                timer.update(value.start)
 
                 continue
 
@@ -270,42 +304,26 @@ class Timers:
 
         timers = self.__timers
 
-        sqlite = self.__sqlite
-        table = self.__table
         group = self.__group
 
+        session = self.store_session
 
-        insert = tuple[
-            str,  # group
-            str,  # unique
-            str]  # update
-
-        inserts: list[insert] = []
 
         items = timers.items()
 
         for unique, timer in items:
 
-            append = (
-                group, unique,
-                Times('now').subsec)
-
-            inserts.append(append)
+            update = Times('now')
 
+            append = TimersTable(
+                group=group,
+                unique=unique,
+                update=update.subsec)
 
-        statement = (
-            f"""
-            replace into {table}
-            ("group", "unique",
-             "update")
-            values (?, ?, ?)
-            """)  # noqa: LIT003
+            session.merge(append)
 
-        sqlite.executemany(
-            statement,
-            tuple(sorted(inserts)))
 
-        sqlite.commit()
+        session.commit()
 
 
     def ready(

{encommon-0.11.1 → encommon-0.12.0}/encommon/times/windows.py

@@ -8,37 +8,69 @@ is permitted, for more information consult the project license file.
 
 
 from copy import deepcopy
-from sqlite3 import Connection
-from sqlite3 import connect as SQLite
 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)
 
 
 
@@ -65,45 +97,51 @@ 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: 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.
         """
 
-        from .params import WindowsParams
+        params = deepcopy(params)
 
         if params is None:
             params = WindowsParams()
 
-        self.__params = deepcopy(params)
+        self.__params = params
+
+
+        self.__store = store
+        self.__group = group
+
+        self.__make_engine()
 
 
         start = Times(start)
@@ -115,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
@@ -148,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
@@ -251,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
@@ -290,8 +331,7 @@ class Windows:
 
                 window = windows[key]
 
-                window.update(
-                    value.start)
+                window.update(value.start)
 
                 continue
 
@@ -332,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(

encommon-0.12.0/encommon/version.txt

@@ -0,0 +1 @@
+0.12.0

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

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: encommon
-Version: 0.11.1
+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.1 → encommon-0.12.0}/encommon.egg-info/requires.txt

@@ -4,3 +4,4 @@ pydantic
 python-dateutil
 pyyaml
 snaptime
+sqlalchemy

{encommon-0.11.1 → encommon-0.12.0}/reqs-install.txt

@@ -4,3 +4,4 @@ pydantic
 python-dateutil
 pyyaml
 snaptime
+sqlalchemy

encommon-0.11.1/encommon/version.txt

@@ -1 +0,0 @@
-0.11.1