encommon 0.11.1__tar.gz → 0.12.1__tar.gz

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

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: encommon
-Version: 0.11.1
+Version: 0.12.1
 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
 
@@ -73,16 +74,33 @@ information found in the `htmlcov` folder in the root of the project.
 make -s pytest
 ```
 
-## Build and upload to PyPi
-Build the package.
-```
-make -s pypackage
-```
-Upload to the test PyPi.
-```
-make -s pypi-upload-test
-```
-Upload to the prod PyPi.
-```
-make -s pypi-upload-prod
-```
+## Version management
+:warning: Ensure that no changes are pending.
+
+1. Rebuild the environment.
+   ```
+   make -s check-revenv
+   ```
+
+1. Update the [version.txt](encommon/version.txt) file.
+
+1. Push to the `main` branch.
+
+1. Create [repository](https://github.com/enasisnetwork/encommon) release.
+
+1. Build the Python package.<br>
+   ```
+   make -s pypackage
+   ```
+
+1. Upload Python package to PyPi test.
+   ```
+   make -s pypi-upload-test
+   ```
+
+1. Upload Python package to PyPi prod.
+   ```
+   make -s pypi-upload-prod
+   ```
+
+1. Update [Read the Docs](https://encommon.readthedocs.io) documentation.

{encommon-0.11.1 → encommon-0.12.1}/README.md

@@ -55,16 +55,33 @@ information found in the `htmlcov` folder in the root of the project.
 make -s pytest
 ```
 
-## Build and upload to PyPi
-Build the package.
-```
-make -s pypackage
-```
-Upload to the test PyPi.
-```
-make -s pypi-upload-test
-```
-Upload to the prod PyPi.
-```
-make -s pypi-upload-prod
-```
+## Version management
+:warning: Ensure that no changes are pending.
+
+1. Rebuild the environment.
+   ```
+   make -s check-revenv
+   ```
+
+1. Update the [version.txt](encommon/version.txt) file.
+
+1. Push to the `main` branch.
+
+1. Create [repository](https://github.com/enasisnetwork/encommon) release.
+
+1. Build the Python package.<br>
+   ```
+   make -s pypackage
+   ```
+
+1. Upload Python package to PyPi test.
+   ```
+   make -s pypi-upload-test
+   ```
+
+1. Upload Python package to PyPi prod.
+   ```
+   make -s pypi-upload-prod
+   ```
+
+1. Update [Read the Docs](https://encommon.readthedocs.io) documentation.

{encommon-0.11.1 → encommon-0.12.1}/encommon/config/logger.py

@@ -266,6 +266,9 @@ class Message:
 class FileFormatter(Formatter):
     """
     Supplement class for built-in logger exception formatter.
+
+    .. note::
+       Input parameters are not defined, check parent class.
     """
 
 

{encommon-0.11.1 → encommon-0.12.1}/encommon/config/params.py

@@ -37,8 +37,6 @@ class LoggerParams(BaseModel, extra='forbid'):
     :param stdo_level: Minimum level for the message to pass.
     :param file_level: Minimum level for the message to pass.
     :param file_path: Enables writing to the filesystem path.
-    :param data: Keyword arguments passed to Pydantic model.
-        Parameter is picked up by autodoc, please ignore.
     """
 
     stdo_level: Optional[LOGLEVELS] = None

{encommon-0.11.1 → encommon-0.12.1}/encommon/times/params.py

@@ -24,8 +24,6 @@ class TimerParams(BaseModel, extra='forbid'):
 
     :param timer: Seconds that are used for related timer.
     :param start: Optional time for when the timer started.
-    :param data: Keyword arguments passed to Pydantic model.
-        Parameter is picked up by autodoc, please ignore.
     """
 
     timer: float
@@ -81,8 +79,6 @@ class WindowParams(BaseModel, extra='forbid'):
     :param stop: Determine the ending for scheduling window.
     :param anchor: Optionally define time anchor for window.
     :param delay: Period of time schedulng will be delayed.
-    :param data: Keyword arguments passed to Pydantic model.
-        Parameter is picked up by autodoc, please ignore.
     """
 
     window: SCHEDULE

{encommon-0.11.1 → encommon-0.12.1}/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.1}/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