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

encommon/times/params.py

@@ -7,47 +7,61 @@ 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 BaseModel
+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
+
+
+
+_TIMERS = dict[str, 'TimerParams']
+_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
@@ -60,67 +74,98 @@ 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.
-    :param data: Keyword arguments passed to Pydantic model.
-        Parameter is picked up by autodoc, please ignore.
     """
 
-    timers: dict[str, TimerParams] = {}
+    timers: Annotated[
+        _TIMERS,
+        Field(...,
+              description='Seconds used for the interval',
+              min_length=0)]
+
+
+    def __init__(
+        self,
+        timers: Optional[_TIMERS] = None,
+    ) -> None:
+        """
+        Initialize instance for class using provided parameters.
+        """
+
+        timers = timers or {}
+
+        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
@@ -131,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)
@@ -142,10 +186,24 @@ class WindowParams(BaseModel, extra='forbid'):
 class WindowsParams(BaseModel, extra='forbid'):
     """
     Process and validate the core configuration parameters.
-
-    :param windows: Parameters for defining scheduled time.
-    :param data: Keyword arguments passed to Pydantic model.
-        Parameter is picked up by autodoc, please ignore.
     """
 
-    windows: dict[str, WindowParams] = {}
+    windows: Annotated[
+        _WINDOWS,
+        Field(...,
+              description='Period for scheduling windows',
+              min_length=0)]
+
+
+    def __init__(
+        self,
+        windows: Optional[_WINDOWS] = None,
+    ) -> None:
+        """
+        Initialize instance for class using provided parameters.
+        """
+
+        windows = windows or {}
+
+        super().__init__(**{
+            'windows': windows})

encommon/times/parse.py

@@ -9,7 +9,6 @@ is permitted, for more information consult the project license file.
 
 from contextlib import suppress
 from datetime import datetime
-from datetime import timezone
 from re import match as re_match
 from typing import Optional
 from typing import TYPE_CHECKING
@@ -27,11 +26,11 @@ from .utils import strptime
 from .utils import utcdatetime
 
 if TYPE_CHECKING:
-    from .times import Times  # noqa: F401
+    from .time import Time  # noqa: F401
 
 
 
-def parse_time(  # noqa: CFQ004
+def parse_time(
     source: Optional[PARSABLE] = None,
     *,
     anchor: Optional[PARSABLE] = None,
@@ -52,7 +51,7 @@ def parse_time(  # noqa: CFQ004
     +----------------------+----------------------------+
     | '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 |
     +----------------------+----------------------------+
@@ -79,14 +78,20 @@ def parse_time(  # noqa: CFQ004
     :returns: Python datetime object containing related time.
     """
 
+
     if (source is not None
             and hasattr(source, 'source')):
+
         source = source.source
+        assert isinstance(
+            source, datetime)
+
 
     if (isinstance(source, str)
             and re_match(NUMERISH, source)):
         source = float(source)
 
+
     tzinfo = findtz(tzname)
 
 
@@ -94,8 +99,11 @@ def parse_time(  # noqa: CFQ004
         source = datetime.fromtimestamp(
             float(source), tz=tzinfo)
 
-    if str(source) in STRINGNOW:
-        return utcdatetime()
+
+    if source in STRINGNOW:
+        source = (
+            utcdatetime()
+            .astimezone(tzinfo))
 
     if source in ['max', float('inf')]:
         source = datetime.max
@@ -116,11 +124,15 @@ def parse_time(  # noqa: CFQ004
             formats=format,
             tzname=tzname)
 
-    if isinstance(source, datetime):
-        return (
-            source.replace(tzinfo=tzinfo)
-            .astimezone(timezone.utc))
 
+    if (isinstance(source, datetime)
+            and not source.tzinfo):
+        source = source.replace(
+            tzinfo=findtz(tzname))
+
+
+    if isinstance(source, datetime):
+        return source
 
     raise ValueError('source')  # NOCVR
 
@@ -155,7 +167,12 @@ def shift_time(
     anchor = parse_time(
         anchor, tzname=tzname)
 
-    return snap(anchor, notate)
+    parsed = snap(anchor, notate)
+
+    assert parsed.tzinfo
+
+    return parse_time(
+        parsed, tzname=tzname)
 
 
 
@@ -186,11 +203,21 @@ def string_time(
     """
 
     if formats is not None:
+
         with suppress(ValueError):
-            return strptime(source, formats)
+
+            return strptime(
+                source, formats)
 
     parsed = parser.parse(source)
 
+    if parsed.tzinfo is None:
+
+        tzinfo = findtz(tzname)
+
+        parsed = parsed.replace(
+            tzinfo=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_parse.py

@@ -8,6 +8,7 @@ is permitted, for more information consult the project license file.
 
 
 from datetime import timedelta
+from datetime import timezone
 
 from pytest import mark
 
@@ -41,10 +42,10 @@ def test_parse_time() -> None:
         '12/31/1969 6:00pm',
         tzname='US/Central')
 
-    assert parsed.year == 1970
-    assert parsed.month == 1
-    assert parsed.day == 1
-    assert parsed.hour == 0
+    assert parsed.year == 1969
+    assert parsed.month == 12
+    assert parsed.day == 31
+    assert parsed.hour == 18
 
 
     parsed = parse_time(0)
@@ -139,7 +140,10 @@ def test_string_time() -> None:
     Perform various tests associated with relevant routines.
     """
 
-    expect = utcdatetime(1980, 1, 1)
+    utc = timezone.utc
+    expect = (
+        utcdatetime(1980, 1, 1)
+        .astimezone(None))
 
 
     strings = [
@@ -151,7 +155,9 @@ def test_string_time() -> None:
 
     for string in strings:
 
-        parsed = string_time(string)
+        parsed = (
+            string_time(string)
+            .astimezone(utc))
 
         assert parsed == expect
 
@@ -170,9 +176,10 @@ def test_string_time() -> None:
     assert parsed == expect
 
 
-    parsed = string_time(
-        '1979-12-31 18:00:00',
-        tzname='US/Central')
+    parsed = (
+        string_time(
+            '1979-12-31 18:00:00',
+            tzname='US/Central'))
 
     assert parsed == expect
 

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_unitime.py

@@ -0,0 +1,23 @@
+"""
+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 ..unitime import unitime
+
+
+
+def test_unitime() -> None:
+    """
+    Perform various tests associated with relevant routines.
+    """
+
+    assert unitime('1s') == 1
+    assert unitime('1h') == 3600
+    assert unitime('1') == 1
+    assert unitime(1) == 1
+    assert unitime('1.0') == 1