encommon 0.14.0__py3-none-any.whl → 0.15.0__py3-none-any.whl

encommon/times/params.py

@@ -7,13 +7,16 @@ is permitted, for more information consult the project license file.
 
 
 
-from typing import Any
+from typing import Annotated
 from typing import Optional
 
+from pydantic import Field
+
 from .common import PARSABLE
 from .common import SCHEDULE
-from .times import Times
+from .time import Time
 from ..types import BaseModel
+from ..types import DictStrAny
 
 
 
@@ -25,33 +28,40 @@ _WINDOWS = dict[str, 'WindowParams']
 class TimerParams(BaseModel, extra='forbid'):
     """
     Process and validate the core configuration parameters.
-
-    :param timer: Seconds that are used for related timer.
-    :param start: Optional time for when the timer started.
     """
 
-    timer: float
-    start: Optional[str] = None
+    timer: Annotated[
+        float,
+        Field(...,
+              description='Seconds used for the interval')]
+
+    start: Annotated[
+        str,
+        Field(...,
+              description='Optional value of timer start',
+              min_length=1)]
 
 
     def __init__(
         self,
         timer: int | float,
-        start: Optional[PARSABLE] = None,
+        start: PARSABLE = 'now',
     ) -> None:
         """
         Initialize instance for class using provided parameters.
         """
 
+        data: DictStrAny = {}
+
+
         if timer is not None:
             timer = float(timer)
 
         if start is not None:
-            start = Times(start)
+            start = Time(start)
 
 
-        data: dict[str, Any] = {
-            'timer': timer}
+        data['timer'] = timer
 
         if start is not None:
             data['start'] = start.subsec
@@ -64,11 +74,13 @@ class TimerParams(BaseModel, extra='forbid'):
 class TimersParams(BaseModel, extra='forbid'):
     """
     Process and validate the core configuration parameters.
-
-    :param timers: Seconds that are used for related timer.
     """
 
-    timers: _TIMERS
+    timers: Annotated[
+        _TIMERS,
+        Field(...,
+              description='Seconds used for the interval',
+              min_length=0)]
 
 
     def __init__(
@@ -79,65 +91,81 @@ class TimersParams(BaseModel, extra='forbid'):
         Initialize instance for class using provided parameters.
         """
 
-        if timers is None:
-            timers = {}
+        timers = timers or {}
 
-        super().__init__(
-            timers=timers)
+        super().__init__(**{
+            'timers': timers})
 
 
 
 class WindowParams(BaseModel, extra='forbid'):
     """
     Process and validate the core configuration parameters.
-
-    :param window: Parameters for defining scheduled time.
-    :param start: Determine the start for scheduling window.
-    :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.
     """
 
-    window: SCHEDULE
-
-    start: Optional[str] = None
-    stop: Optional[str] = None
-    anchor: Optional[str] = None
-    delay: float = 0.0
+    window: Annotated[
+        SCHEDULE,
+        Field(...,
+              description='Period for scheduling window',
+              min_length=1)]
+
+    start: Annotated[
+        Optional[str],
+        Field(None,
+              description='Determine when scope begins',
+              min_length=1)]
+
+    stop: Annotated[
+        Optional[str],
+        Field(None,
+              description='Determine when scope ends',
+              min_length=1)]
+
+    anchor: Annotated[
+        Optional[str],
+        Field(None,
+              description='Optional anchor of the window',
+              min_length=1)]
+
+    delay: Annotated[
+        float,
+        Field(...,
+              description='Time period of schedule delay',
+              ge=0)]
 
 
     def __init__(
         self,
         window: SCHEDULE | int,
+        *,
         start: Optional[PARSABLE] = None,
         stop: Optional[PARSABLE] = None,
         anchor: Optional[PARSABLE] = None,
-        delay: Optional[int | float] = None,
+        delay: int | float = 0.0,
     ) -> None:
         """
         Initialize instance for class using provided parameters.
         """
 
+        data: DictStrAny = {}
+
 
         if isinstance(window, int):
             window = {'seconds': window}
 
-
         if start is not None:
-            start = Times(start)
+            start = Time(start)
 
         if stop is not None:
-            stop = Times(stop)
+            stop = Time(stop)
 
         if anchor is not None:
-            anchor = Times(anchor)
+            anchor = Time(anchor)
 
-        if delay is not None:
-            delay = float(delay)
+        delay = float(delay)
 
 
-        data: dict[str, Any] = {
-            'window': window}
+        data['window'] = window
 
         if start is not None:
             data['start'] = start.subsec
@@ -148,8 +176,7 @@ class WindowParams(BaseModel, extra='forbid'):
         if anchor is not None:
             data['anchor'] = anchor.subsec
 
-        if delay is not None:
-            data['delay'] = delay
+        data['delay'] = delay
 
 
         super().__init__(**data)
@@ -159,11 +186,13 @@ class WindowParams(BaseModel, extra='forbid'):
 class WindowsParams(BaseModel, extra='forbid'):
     """
     Process and validate the core configuration parameters.
-
-    :param windows: Parameters for defining scheduled time.
     """
 
-    windows: _WINDOWS
+    windows: Annotated[
+        _WINDOWS,
+        Field(...,
+              description='Period for scheduling windows',
+              min_length=0)]
 
 
     def __init__(
@@ -174,8 +203,7 @@ class WindowsParams(BaseModel, extra='forbid'):
         Initialize instance for class using provided parameters.
         """
 
-        if windows is None:
-            windows = {}
+        windows = windows or {}
 
-        super().__init__(
-            windows=windows)
+        super().__init__(**{
+            'windows': windows})

encommon/times/parse.py

@@ -26,7 +26,7 @@ from .utils import strptime
 from .utils import utcdatetime
 
 if TYPE_CHECKING:
-    from .times import Times  # noqa: F401
+    from .time import Time  # noqa: F401
 
 
 
@@ -51,7 +51,7 @@ def parse_time(
     +----------------------+----------------------------+
     | 'max', float('inf')  | Uses the maximum time      |
     +----------------------+----------------------------+
-    | object               | Provide datetime or Times  |
+    | object               | Provide datetime or Time   |
     +----------------------+----------------------------+
     | 2000-01-01T00:00:00Z | Uses strptime and dateutil |
     +----------------------+----------------------------+
@@ -169,7 +169,7 @@ def shift_time(
 
     parsed = snap(anchor, notate)
 
-    assert parsed.tzinfo is not None
+    assert parsed.tzinfo
 
     return parse_time(
         parsed, tzname=tzname)

encommon/times/test/test_duration.py

@@ -9,6 +9,7 @@ is permitted, for more information consult the project license file.
 
 from ..duration import Duration
 from ...types import inrepr
+from ...types import lattrs
 from ...types.strings import COMMAS
 
 
@@ -21,7 +22,7 @@ def test_Duration() -> None:
     durate = Duration(95401)
 
 
-    attrs = list(durate.__dict__)
+    attrs = lattrs(durate)
 
     assert attrs == [
         '_Duration__source',
@@ -58,7 +59,7 @@ def test_Duration() -> None:
 
     assert durate.source == 95401
 
-    assert durate.smart is True
+    assert durate.smart
 
     assert durate.groups == 7
 

encommon/times/test/test_time.py

@@ -0,0 +1,123 @@
+"""
+Functions and routines associated with Enasis Network Common Library.
+
+This file is part of Enasis Network software eco-system. Distribution
+is permitted, for more information consult the project license file.
+"""
+
+
+
+from ..common import STAMP_SIMPLE
+from ..common import UNIXEPOCH
+from ..common import UNIXHPOCH
+from ..common import UNIXMPOCH
+from ..time import Time
+from ...types import inrepr
+from ...types import instr
+from ...types import lattrs
+
+
+
+def test_Time() -> None:
+    """
+    Perform various tests associated with relevant routines.
+    """
+
+    time = Time(
+        UNIXEPOCH,
+        format=STAMP_SIMPLE)
+
+
+    attrs = lattrs(time)
+
+    assert attrs == [
+        '_Time__source']
+
+
+    assert inrepr(
+        "Time('1970-01-01T00:00",
+        time)
+
+    assert hash(time) > 0
+
+    assert instr(
+        '1970-01-01T00:00:00.000',
+        time)
+
+
+    assert int(time) == 0
+    assert float(time) == 0.0
+
+    assert time + 1 == Time(1)
+    assert time - 1 == Time(-1)
+
+    assert time == Time(0)
+    assert time != Time(-1)
+    assert time != 'invalid'
+
+    assert time > Time(-1)
+    assert time >= Time(0)
+    assert time < Time(1)
+    assert time <= Time(0)
+
+
+    assert time.source.year == 1970
+
+    assert time.epoch == 0.0
+
+    assert time.spoch == 0
+
+    assert time.mpoch == 0.0
+
+    assert str(time.time) == '00:00:00'
+
+    assert time.simple == UNIXEPOCH
+
+    assert time.subsec == UNIXMPOCH
+
+    assert time.human == UNIXHPOCH
+
+    assert time.elapsed >= 1672531200
+
+    assert time.since >= 1672531200
+
+    assert time.before == (
+        '1969-12-31T23:59:59.999999Z')
+
+    assert time.after == (
+        '1970-01-01T00:00:00.000001Z')
+
+    assert time.stamp() == UNIXMPOCH
+
+    time = time.shift('+1y')
+    assert time == '1971-01-01'
+
+    time = time.shifz('UTC-1')
+    assert time == (
+        '12/31/1970 23:00 -0100')
+
+
+
+def test_Time_tzname() -> None:
+    """
+    Perform various tests associated with relevant routines.
+    """
+
+    time1 = Time(
+        '1970-01-01T00:00:00Z')
+
+    time2 = time1.shifz(
+        'US/Central')
+
+
+    delta = time1 - time2
+
+    assert -1 < delta < 1
+
+
+    stamp1 = time1.stamp(
+        tzname='US/Central')
+
+    stamp2 = time2.stamp()
+
+    assert stamp1 == stamp2

encommon/times/test/test_timer.py

@@ -11,10 +11,11 @@ from time import sleep
 
 from pytest import fixture
 
+from ..time import Time
 from ..timer import Timer
-from ..times import Times
 from ...types import inrepr
 from ...types import instr
+from ...types import lattrs
 
 
 
@@ -40,11 +41,11 @@ def test_Timer(
     """
 
 
-    attrs = list(timer.__dict__)
+    attrs = lattrs(timer)
 
     assert attrs == [
         '_Timer__timer',
-        '_Timer__times']
+        '_Timer__time']
 
 
     assert inrepr(
@@ -60,7 +61,7 @@ def test_Timer(
 
     assert timer.timer == 1
 
-    assert timer.times >= Times('-1s')
+    assert timer.time >= Time('-1s')
 
     assert timer.since <= 1
 

encommon/times/test/test_timers.py

@@ -9,18 +9,19 @@ is permitted, for more information consult the project license file.
 
 from pathlib import Path
 from time import sleep
-from typing import Any
 
 from pytest import fixture
 from pytest import raises
 
 from ..params import TimerParams
 from ..params import TimersParams
+from ..time import Time
 from ..timers import Timers
 from ..timers import TimersTable
-from ..times import Times
+from ...types import DictStrAny
 from ...types import inrepr
 from ...types import instr
+from ...types import lattrs
 
 
 
@@ -36,7 +37,7 @@ def timers(
     """
 
 
-    source: dict[str, Any] = {
+    source: DictStrAny = {
         'one': {'timer': 1},
         'two': {'timer': 1}}
 
@@ -93,7 +94,7 @@ def test_Timers(
     """
 
 
-    attrs = list(timers.__dict__)
+    attrs = lattrs(timers)
 
     assert attrs == [
         '_Timers__params',
@@ -115,27 +116,27 @@ def test_Timers(
         timers)
 
 
-    assert timers.params is not None
+    assert timers.params
 
     assert timers.store[:6] == 'sqlite'
 
     assert timers.group == 'default'
 
-    assert timers.store_engine is not None
+    assert timers.store_engine
 
-    assert timers.store_session is not None
+    assert timers.store_session
 
     assert len(timers.children) == 2
 
 
     timer = timers.children['one']
 
-    assert timer.times >= Times('-1s')
+    assert timer.time >= Time('-1s')
 
 
     timer = timers.children['two']
 
-    assert timer.times == '1970-01-01'
+    assert timer.time == '1970-01-01'
 
 
 

encommon/times/test/test_window.py

@@ -13,12 +13,13 @@ from typing import TYPE_CHECKING
 from pytest import fixture
 from pytest import mark
 
-from ..times import Times
+from ..time import Time
 from ..window import Window
 from ..window import window_croniter
 from ..window import window_interval
 from ...types import inrepr
 from ...types import instr
+from ...types import lattrs
 
 if TYPE_CHECKING:
     from ..common import PARSABLE
@@ -51,7 +52,7 @@ def test_Window(
     """
 
 
-    attrs = list(window.__dict__)
+    attrs = lattrs(window)
 
     assert attrs == [
         '_Window__window',
@@ -169,7 +170,7 @@ def test_Window_cover(
     assert window.walked
 
 
-    anchor = Times('-0s@s')
+    anchor = Time('-0s@s')
 
 
     window = Window(

encommon/times/test/test_windows.py

@@ -9,7 +9,6 @@ is permitted, for more information consult the project license file.
 
 from pathlib import Path
 from time import sleep
-from typing import Any
 
 from pytest import fixture
 from pytest import raises
@@ -18,8 +17,10 @@ from ..params import WindowParams
 from ..params import WindowsParams
 from ..windows import Windows
 from ..windows import WindowsTable
+from ...types import DictStrAny
 from ...types import inrepr
 from ...types import instr
+from ...types import lattrs
 
 
 
@@ -35,7 +36,7 @@ def windows(
     """
 
 
-    source: dict[str, Any] = {
+    source: DictStrAny = {
         'one': WindowParams(
             window='* * * * *',
             start=310,
@@ -104,7 +105,7 @@ def test_Windows(
     """
 
 
-    attrs = list(windows.__dict__)
+    attrs = lattrs(windows)
 
     assert attrs == [
         '_Windows__params',
@@ -128,15 +129,15 @@ def test_Windows(
         windows)
 
 
-    assert windows.params is not None
+    assert windows.params
 
     assert windows.store[:6] == 'sqlite'
 
     assert windows.group == 'default'
 
-    assert windows.store_engine is not None
+    assert windows.store_engine
 
-    assert windows.store_session is not None
+    assert windows.store_session
 
     assert windows.start == (
         '1970-01-01T00:05:10Z')