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

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

@@ -24,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
     -------
-    >>> Times('1/1/2000 12:00am')
-    Times('2000-01-01T00:00:00.000000+0000')
+    >>> 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
+    -------
+    >>> 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.
@@ -73,7 +122,7 @@ class Times:
         :returns: String representation for values from instance.
         """
 
-        return f"Times('{self.subsec}')"
+        return f"Time('{self.subsec}')"
 
 
     def __hash__(
@@ -85,9 +134,7 @@ class Times:
         :returns: Boolean indicating outcome from the operation.
         """
 
-        hashed = int(self.mpoch)
-
-        return int(1e9 + hashed)
+        return hash(self.__source)
 
 
     def __str__(
@@ -398,7 +445,7 @@ class Times:
     @property
     def before(
         self,
-    ) -> 'Times':
+    ) -> 'Time':
         """
         Return new object containing time just before the time.
 
@@ -410,13 +457,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.
 
@@ -428,7 +475,7 @@ class Times:
         source += timedelta(
             microseconds=1)
 
-        return Times(source)
+        return Time(source)
 
 
     def stamp(
@@ -462,7 +509,7 @@ class Times:
     def shift(
         self,
         notate: str,
-    ) -> 'Times':
+    ) -> 'Time':
         """
         Return the new instance of object shifted using snaptime.
 
@@ -472,14 +519,14 @@ class Times:
 
         source = self.__source
 
-        return Times(
+        return Time(
             notate, anchor=source)
 
 
     def shifz(
         self,
         tzname: str,
-    ) -> 'Times':
+    ) -> 'Time':
         """
         Return the new instance of object shifted using datetime.
 
@@ -498,5 +545,5 @@ class Times:
                 source
                 .astimezone(tzinfo))
 
-        return Times(
+        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
@@ -97,7 +97,7 @@ class Timers:
     >>> timers.ready('one')
     True
 
-    :param params: Parameters for instantiating the instance.
+    :param params: Parameters used to instantiate the class.
     :param store: Optional database path for keeping state.
     :param group: Optional override for default group name.
     """
@@ -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)
@@ -374,7 +374,7 @@ class Timers:
         Create a new timer using the provided input parameters.
 
         :param unique: Unique identifier for the related child.
-        :param params: Parameters for instantiating the instance.
+        :param params: Parameters used to instantiate the class.
         :returns: Newly constructed instance of related class.
         """
 

encommon/times/unitime.py

@@ -19,6 +19,15 @@ def unitime(
     """
     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.
     """

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

encommon/times/windows.py

@@ -21,7 +21,7 @@ from sqlalchemy.orm import sessionmaker
 
 from .common import PARSABLE
 from .params import WindowsParams
-from .times import Times
+from .time import Time
 from .window import Window
 
 if TYPE_CHECKING:
@@ -97,7 +97,7 @@ class Windows:
     >>> [windows.ready('one') for x in range(3)]
     [True, True, False]
 
-    :param params: Parameters for instantiating the instance.
+    :param params: Parameters used to instantiate the class.
     :param start: Determine the start for scheduling window.
     :param stop: Determine the ending for scheduling window.
     :param store: Optional database path for keeping state.
@@ -114,8 +114,8 @@ class Windows:
         # pylint: disable=unsubscriptable-object
         sessionmaker[Session])
 
-    __start: Times
-    __stop: Times
+    __start: Time
+    __stop: Time
 
     __windows: WINDOWS
 
@@ -147,8 +147,8 @@ class Windows:
         self.__make_engine()
 
 
-        start = Times(start)
-        stop = Times(stop)
+        start = Time(start)
+        stop = Time(stop)
 
         assert stop > start
 
@@ -249,27 +249,27 @@ class Windows:
     @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
@@ -386,7 +386,7 @@ class Windows:
 
         for unique, window in items:
 
-            update = Times('now')
+            update = Time('now')
 
             append = WindowsTable(
                 group=group,
@@ -439,7 +439,7 @@ class Windows:
         Create a new window using the provided input parameters.
 
         :param unique: Unique identifier for the related child.
-        :param params: Parameters for instantiating the instance.
+        :param params: Parameters used to instantiate the class.
         :returns: Newly constructed instance of related class.
         """
 

encommon/types/classes.py

@@ -7,8 +7,6 @@ is permitted, for more information consult the project license file.
 
 
 
-from typing import Any
-
 from pydantic import BaseModel as Pydantic
 
 from .types import DictStrAny
@@ -23,19 +21,8 @@ class BaseModel(Pydantic, extra='forbid'):
     """
 
 
-    def __init__(
-        self,
-        **data: Any,
-    ) -> None:
-        """
-        Initialize instance for class using provided parameters.
-        """
-
-        super().__init__(**data)
-
-
     @property
-    def model_dumped(
+    def endumped(
         self,
     ) -> DictStrAny:
         """
@@ -48,7 +35,7 @@ class BaseModel(Pydantic, extra='forbid'):
 
 
     @property
-    def model_pruned(
+    def enpruned(
         self,
     ) -> DictStrAny:
         """

encommon/types/lists.py

@@ -19,6 +19,12 @@ def inlist(
     """
     Return the boolean indicating whether needle in haystack.
 
+    Example
+    -------
+    >>> haystack = [1, 2, 3]
+    >>> inlist(2, haystack)
+    True
+
     :param needle: Provided item that may be within haystack.
     :param haystack: List of items which may contain needle.
     :returns: Boolean indicating whether needle in haystack.

encommon/types/notate.py

@@ -15,6 +15,7 @@ from typing import Optional
 from typing import Union
 
 from .empty import Empty
+from .types import DictStrAny
 
 
 
@@ -25,7 +26,7 @@ _RECURSE = dict
 
 
 _SETABLE = Union[
-    dict[str, Any],
+    DictStrAny,
     list[Any]]
 
 _GETABLE = Union[

encommon/types/strings.py

@@ -121,6 +121,11 @@ def rplstr(
     """
     Return the source string with the match value replaced.
 
+    Example
+    -------
+    >>> rplstr('foo', 'foo', 'bar')
+    'bar'
+
     :param source: String that to be processed and returned.
     :param match: What will be replaced within the string.
     :param value: Replace value for the string is matched.

encommon/types/test/test_classes.py

@@ -26,8 +26,8 @@ def test_BaseModel() -> None:
     params = LoggerParams(
         stdo_level='info')
 
-    dumped = params.model_dumped
-    pruned = params.model_pruned
+    dumped = params.endumped
+    pruned = params.enpruned
 
     assert dumped == {
         'file_level': None,

encommon/types/test/test_empty.py

@@ -10,6 +10,7 @@ is permitted, for more information consult the project license file.
 from copy import copy
 from copy import deepcopy
 
+from ..classes import lattrs
 from ..empty import Empty
 from ..empty import EmptyType
 
@@ -23,7 +24,7 @@ def test_EmptyType() -> None:
     empty = EmptyType()
 
 
-    attrs = list(empty.__dict__)
+    attrs = lattrs(empty)
 
     assert attrs == [
         '_EmptyType__empty']