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

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')

encommon/times/{times.py → time.py}

@@ -9,6 +9,7 @@ is permitted, for more information consult the project license file.
 
 from contextlib import suppress
 from datetime import datetime
+from datetime import time as dtime
 from datetime import timedelta
 from typing import Optional
 
@@ -23,14 +24,63 @@ from .utils import strftime
 
 
 
-class Times:
+class Time:
     """
     Interact with various time functions through one wrapper.
 
+    .. testsetup::
+       >>> time = Time('1/1/2000 12:00am')
+
+    Example
+    -------
+    >>> time = Time('1/1/2000 12:00am')
+    >>> time.stamp()
+    '2000-01-01T00:00:00.000000+0000'
+    >>> time.stamp('%m/%d/%Y')
+    '01/01/2000'
+
+    Example
+    -------
+    >>> time.epoch
+    946684800.0
+    >>> time.time
+    datetime.time(0, 0)
+    >>> time.simple
+    '2000-01-01T00:00:00+0000'
+    >>> time.human
+    '01/01/2000 12:00AM UTC'
+
+    Example
+    -------
+    >>> time.before
+    Time('1999-12-31T23:59:59.999999+0000')
+    >>> time.after
+    Time('2000-01-01T00:00:00.000001+0000')
+
+    Example
+    -------
+    >>> time.shift('-1d')
+    Time('1999-12-31T00:00:00.000000+0000')
+
+    Example
+    -------
+    >>> time.shifz('US/Central')
+    Time('1999-12-31T18:00:00.000000-0600')
+
+    Example
+    -------
+    >>> time = Time('-1s')
+    >>> int(time.since)
+    1
+
     Example
     -------
-    >>> Times('1/1/2000 12:00am')
-    Times('2000-01-01T00:00:00.000000+0000')
+    >>> time1 = Time('1/1/2000 12:00am')
+    >>> time2 = Time('1/1/2000 12:00am')
+    >>> time1 - time2
+    0.0
+    >>> time1 + time2
+    1893369600.0
 
     :param source: Time in various forms that will be parsed.
     :param anchor: Optional relative time; for snap notation.
@@ -40,7 +90,6 @@ class Times:
     """
 
     __source: datetime
-    __hashed: int
 
 
     def __init__(
@@ -62,8 +111,6 @@ class Times:
             tzname=tzname)
 
         self.__source = parsed
-        self.__hashed = int(
-            self.mpoch * 1000)
 
 
     def __repr__(
@@ -75,7 +122,7 @@ class Times:
         :returns: String representation for values from instance.
         """
 
-        return f"Times('{self.subsec}')"
+        return f"Time('{self.subsec}')"
 
 
     def __hash__(
@@ -87,7 +134,9 @@ class Times:
         :returns: Boolean indicating outcome from the operation.
         """
 
-        return int(1e9 + self.__hashed)
+        hashed = int(self.mpoch)
+
+        return int(1e9 + hashed)
 
 
     def __str__(
@@ -291,6 +340,19 @@ class Times:
         return source.timestamp()
 
 
+    @property
+    def spoch(
+        self,
+    ) -> int:
+        """
+        Return the seconds since the Unix epoch for the instance.
+
+        :returns: Seconds since the Unix epoch for the instance.
+        """
+
+        return int(self.epoch)
+
+
     @property
     def mpoch(
         self,
@@ -304,14 +366,27 @@ class Times:
         return self.epoch * 1000
 
 
+    @property
+    def time(
+        self,
+    ) -> dtime:
+        """
+        Return the value for the attribute from class instance.
+
+        :returns: Value for the attribute from class instance.
+        """
+
+        return self.__source.time()
+
+
     @property
     def simple(
         self,
     ) -> str:
         """
-        Return the timestamp using provided format for instance.
+        Return the value for the attribute from class instance.
 
-        :returns: Timestamp using provided format for instance.
+        :returns: Value for the attribute from class instance.
         """
 
         return self.stamp(STAMP_SIMPLE)
@@ -322,9 +397,9 @@ class Times:
         self,
     ) -> str:
         """
-        Return the timestamp using provided format for instance.
+        Return the value for the attribute from class instance.
 
-        :returns: Timestamp using provided format for instance.
+        :returns: Value for the attribute from class instance.
         """
 
         return self.stamp(STAMP_SUBSEC)
@@ -335,9 +410,9 @@ class Times:
         self,
     ) -> str:
         """
-        Return the timestamp using provided format for instance.
+        Return the value for the attribute from class instance.
 
-        :returns: Timestamp using provided format for instance.
+        :returns: Value for the attribute from class instance.
         """
 
         return self.stamp(STAMP_HUMAN)
@@ -372,7 +447,7 @@ class Times:
     @property
     def before(
         self,
-    ) -> 'Times':
+    ) -> 'Time':
         """
         Return new object containing time just before the time.
 
@@ -384,13 +459,13 @@ class Times:
         source -= timedelta(
             microseconds=1)
 
-        return Times(source)
+        return Time(source)
 
 
     @property
     def after(
         self,
-    ) -> 'Times':
+    ) -> 'Time':
         """
         Return new object containing time just after the time.
 
@@ -402,7 +477,7 @@ class Times:
         source += timedelta(
             microseconds=1)
 
-        return Times(source)
+        return Time(source)
 
 
     def stamp(
@@ -423,15 +498,20 @@ class Times:
 
         tzinfo = findtz(tzname)
 
-        parsed = source.astimezone(tzinfo)
+        if tzname is not None:
 
-        return strftime(parsed, format)
+            source = (
+                source
+                .astimezone(tzinfo))
+
+        return strftime(
+            source, format)
 
 
     def shift(
         self,
         notate: str,
-    ) -> 'Times':
+    ) -> 'Time':
         """
         Return the new instance of object shifted using snaptime.
 
@@ -441,4 +521,31 @@ class Times:
 
         source = self.__source
 
-        return Times(notate, anchor=source)
+        return Time(
+            notate, anchor=source)
+
+
+    def shifz(
+        self,
+        tzname: str,
+    ) -> 'Time':
+        """
+        Return the new instance of object shifted using datetime.
+
+        :param tzname: Name of the timezone associated to source.
+            This is not relevant in timezone included in source.
+        :returns: New instance of the class using shifted time.
+        """
+
+        source = self.__source
+
+        tzinfo = findtz(tzname)
+
+        if tzname is not None:
+
+            source = (
+                source
+                .astimezone(tzinfo))
+
+        return Time(
+            source, tzname=tzname)

encommon/times/timer.py

@@ -11,7 +11,7 @@ from typing import Optional
 
 from .common import NUMERIC
 from .common import PARSABLE
-from .times import Times
+from .time import Time
 
 
 
@@ -36,7 +36,7 @@ class Timer:
     """
 
     __timer: float
-    __times: Times
+    __time: Time
 
 
     def __init__(
@@ -50,10 +50,10 @@ class Timer:
         """
 
         timer = float(timer)
-        start = Times(start)
+        start = Time(start)
 
         self.__timer = timer
-        self.__times = start
+        self.__time = start
 
 
     @property
@@ -70,16 +70,16 @@ class Timer:
 
 
     @property
-    def times(
+    def time(
         self,
-    ) -> Times:
+    ) -> Time:
         """
         Return the value for the attribute from class instance.
 
         :returns: Value for the attribute from class instance.
         """
 
-        return self.__times
+        return self.__time
 
 
     @property
@@ -92,7 +92,7 @@ class Timer:
         :returns: Seconds that have elapsed since the interval.
         """
 
-        return self.times.since
+        return self.time.since
 
 
     @property
@@ -141,7 +141,7 @@ class Timer:
         :param value: Override the time updated for timer value.
         """
 
-        value = Times(
+        value = Time(
             value or 'now')
 
-        self.__times = value
+        self.__time = value

encommon/times/timers.py

@@ -21,8 +21,8 @@ from sqlalchemy.orm import sessionmaker
 
 from .common import PARSABLE
 from .params import TimersParams
+from .time import Time
 from .timer import Timer
-from .times import Times
 
 if TYPE_CHECKING:
     from .params import TimerParams
@@ -322,12 +322,12 @@ class Timers:
 
         for unique, timer in items:
 
-            update = Times('now')
+            update = Time('now')
 
             append = TimersTable(
                 group=group,
                 unique=unique,
-                last=timer.times.subsec,
+                last=timer.time.subsec,
                 update=update.subsec)
 
             session.merge(append)

encommon/times/unitime.py

@@ -0,0 +1,57 @@
+"""
+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 re import match as re_match
+
+from .parse import since_time
+
+
+
+def unitime(
+    input: int | float | str,
+) -> int:
+    """
+    Return the seconds in integer format for provided input.
+
+    Example
+    -------
+    >>> unitime('1d')
+    86400
+    >>> unitime('1y')
+    31536000
+    >>> unitime('1w3d4h')
+    878400
+
+    :param input: Input that will be converted into seconds.
+    :returns: Seconds in integer format for provided input.
+    """
+
+    notate = r'^(\d+(s|m|h|d|w|y))*$'
+    strint = r'^\d+$'
+    strflt = r'^\d+\.\d+$'
+
+    if isinstance(input, str):
+
+        if re_match(notate, input):
+            input = since_time(
+                'now', f'+{input}')
+
+        elif re_match(strint, input):
+            input = int(input)
+
+        elif re_match(strflt, input):
+            input = int(
+                input.split('.')[0])
+
+    if isinstance(input, float):
+        input = int(input)
+
+    assert isinstance(input, int)
+
+    return input

encommon/times/window.py

@@ -17,7 +17,7 @@ from croniter import croniter
 from .common import PARSABLE
 from .common import SCHEDULE
 from .parse import parse_time
-from .times import Times
+from .time import Time
 
 
 
@@ -42,13 +42,13 @@ class Window:
     """
 
     __window: SCHEDULE
-    __start: Times
-    __stop: Times
-    __anchor: Times
+    __start: Time
+    __stop: Time
+    __anchor: Time
     __delay: float
 
-    __wlast: Times
-    __wnext: Times
+    __wlast: Time
+    __wnext: Time
 
 
     def __init__(
@@ -67,9 +67,9 @@ class Window:
         anchor = anchor or start
 
         window = copy(window)
-        start = Times(start)
-        stop = Times(stop)
-        anchor = Times(anchor)
+        start = Time(start)
+        stop = Time(stop)
+        anchor = Time(anchor)
         delay = float(delay)
 
         assert stop > start
@@ -114,40 +114,40 @@ class Window:
     @property
     def start(
         self,
-    ) -> Times:
+    ) -> Time:
         """
         Return the value for the attribute from class instance.
 
         :returns: Value for the attribute from class instance.
         """
 
-        return Times(self.__start)
+        return Time(self.__start)
 
 
     @property
     def stop(
         self,
-    ) -> Times:
+    ) -> Time:
         """
         Return the value for the attribute from class instance.
 
         :returns: Value for the attribute from class instance.
         """
 
-        return Times(self.__stop)
+        return Time(self.__stop)
 
 
     @property
     def anchor(
         self,
-    ) -> Times:
+    ) -> Time:
         """
         Return the value for the attribute from class instance.
 
         :returns: Value for the attribute from class instance.
         """
 
-        return Times(self.__anchor)
+        return Time(self.__anchor)
 
 
     @property
@@ -166,51 +166,51 @@ class Window:
     @property
     def last(
         self,
-    ) -> Times:
+    ) -> Time:
         """
         Return the value for the attribute from class instance.
 
         :returns: Value for the attribute from class instance.
         """
 
-        return Times(self.__wlast)
+        return Time(self.__wlast)
 
 
     @property
     def next(
         self,
-    ) -> Times:
+    ) -> Time:
         """
         Return the value for the attribute from class instance.
 
         :returns: Value for the attribute from class instance.
         """
 
-        return Times(self.__wnext)
+        return Time(self.__wnext)
 
 
     @property
     def soonest(
         self,
-    ) -> Times:
+    ) -> Time:
         """
         Return the value for the attribute from class instance.
 
         :returns: Value for the attribute from class instance.
         """
-        return Times(Times() - self.delay)
+        return Time(Time() - self.delay)
 
 
     @property
     def latest(
         self,
-    ) -> Times:
+    ) -> Time:
         """
         Return the value for the attribute from class instance.
 
         :returns: Value for the attribute from class instance.
         """
-        return Times(self.stop - self.delay)
+        return Time(self.stop - self.delay)
 
 
     @property
@@ -230,7 +230,7 @@ class Window:
         self,
         anchor: PARSABLE,
         backward: bool = False,
-    ) -> tuple[Times, Times]:
+    ) -> tuple[Time, Time]:
         """
         Determine next and last windows for window using anchor.
 
@@ -299,7 +299,7 @@ class Window:
         :param value: Override the time updated for window value.
         """
 
-        value = Times(
+        value = Time(
             value or 'now')
 
         wlast, wnext = (
@@ -314,7 +314,7 @@ def window_croniter(  # noqa: CFQ004
     schedule: str,
     anchor: PARSABLE,
     backward: bool = False,
-) -> tuple[Times, Times]:
+) -> tuple[Time, Time]:
     """
     Determine next and previous times for cronjob schedule.
 
@@ -365,8 +365,8 @@ def window_croniter(  # noqa: CFQ004
 
 
     return (
-        Times(wlast),
-        Times(wnext))
+        Time(wlast),
+        Time(wnext))
 
 
 
@@ -374,7 +374,7 @@ def window_interval(
     schedule: dict[str, int],
     anchor: PARSABLE,
     backward: bool = False,
-) -> tuple[Times, Times]:
+) -> tuple[Time, Time]:
     """
     Determine next and previous times for interval schedule.
 
@@ -403,5 +403,5 @@ def window_interval(
 
 
     return (
-        Times(wlast),
-        Times(wnext))
+        Time(wlast),
+        Time(wnext))